document SetStandardFonts() and SetFonts() methods of various wxHTML classes (closes #10913)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61302 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2009-07-03 12:03:39 +00:00
parent 1034a6bbff
commit e37870dd38
2 changed files with 63 additions and 21 deletions

View File

@@ -274,28 +274,23 @@ public:
void SetBorders(int b);
/**
This function sets font sizes and faces.
This function sets font sizes and faces. See wxHtmlDCRenderer::SetFonts
for detailed description.
@param normal_face
This is face name for normal (i.e. non-fixed) font.
It can be either empty string (then the default face is chosen) or
platform-specific face name. Examples are "helvetica" under Unix or
"Times New Roman" under Windows.
@param fixed_face
The same thing for fixed face ( \<TT\>..\</TT\> )
@param sizes
This is an array of 7 items of int type.
The values represent size of font with HTML size from -2 to +4
( \<FONT SIZE=-2\> to \<FONT SIZE=+4\> ).
Default sizes are used if sizes is @NULL.
Default font sizes are defined by constants wxHTML_FONT_SIZE_1,
wxHTML_FONT_SIZE_2, ..., wxHTML_FONT_SIZE_7.
Note that they differ among platforms. Default face names are empty strings.
@see SetSize()
*/
void SetFonts(const wxString& normal_face, const wxString& fixed_face,
const int* sizes = NULL);
/**
Sets default font sizes and/or default font size.
See wxHtmlDCRenderer::SetStandardFonts for detailed description.
@see SetFonts()
*/
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxEmptyString,
const wxString& fixed_face = wxEmptyString);
/**
Sets HTML page and display it. This won't @b load the page!!
It will display the @e source. See example:

View File

@@ -91,13 +91,50 @@ public:
void SetDC(wxDC* dc, double pixel_scale = 1.0);
/**
Sets fonts. See wxHtmlWindow::SetFonts for detailed description.
This function sets font sizes and faces.
@param normal_face
This is face name for normal (i.e. non-fixed) font.
It can be either empty string (then the default face is chosen) or
platform-specific face name. Examples are "helvetica" under Unix or
"Times New Roman" under Windows.
@param fixed_face
The same thing for fixed face ( \<TT\>..\</TT\> )
@param sizes
This is an array of 7 items of int type.
The values represent size of font with HTML size from -2 to +4
( \<FONT SIZE=-2\> to \<FONT SIZE=+4\> ).
Default sizes are used if sizes is @NULL.
Default font sizes are defined by constants wxHTML_FONT_SIZE_1,
wxHTML_FONT_SIZE_2, ..., wxHTML_FONT_SIZE_7.
Note that they differ among platforms. Default face names are empty strings.
@see SetSize()
*/
void SetFonts(const wxString& normal_face, const wxString& fixed_face,
const int* sizes = NULL);
/**
Sets font sizes to be relative to the given size or the system
default size; use either specified or default font
@param size
Point size of the default HTML text
@param normal_face
This is face name for normal (i.e. non-fixed) font. It can be
either empty string (then the default face is chosen) or
platform-specific face name. Examples are "helvetica" under
Unix or "Times New Roman" under Windows.
@param fixed_face
The same thing for fixed face ( \<TT\>..\</TT\> )
@see SetSize()
*/
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxEmptyString,
const wxString& fixed_face = wxEmptyString);
/**
Assign text to the renderer. Render() then draws the text onto DC.
@@ -116,7 +153,7 @@ public:
/**
Set size of output rectangle, in pixels. Note that you @b can't change
width of the rectangle between calls to wxHtmlDCRenderer::Render!
width of the rectangle between calls to Render() !
(You can freely change height.)
*/
void SetSize(int width, int height);
@@ -222,11 +259,20 @@ public:
const wxString& basepath = wxEmptyString);
/**
Sets fonts. See wxHtmlWindow::SetFonts for detailed description.
Sets fonts. See wxHtmlDCRenderer::SetFonts for detailed description.
*/
void SetFonts(const wxString& normal_face, const wxString& fixed_face,
const int* sizes = NULL);
/**
Sets default font sizes and/or default font size.
See wxHtmlDCRenderer::SetStandardFonts for detailed description.
@see SetFonts()
*/
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxEmptyString,
const wxString& fixed_face = wxEmptyString);
/**
Set page footer. The following macros can be used inside it:
@@DATE@ is replaced by the current date in default format
@@ -311,7 +357,8 @@ public:
static void AddFilter(wxHtmlFilter* filter);
/**
Sets fonts. See wxHtmlWindow::SetFonts for detailed description.
This function sets font sizes and faces. See wxHtmlWindow::SetFonts
for detailed description.
*/
void SetFonts(const wxString& normal_face, const wxString& fixed_face,
const int* sizes = NULL);