From e37870dd38374cce7ca0fe0fabf2070ebc8218b3 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 3 Jul 2009 12:03:39 +0000 Subject: [PATCH] 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 --- interface/wx/html/htmlwin.h | 31 +++++++++----------- interface/wx/html/htmprint.h | 55 +++++++++++++++++++++++++++++++++--- 2 files changed, 64 insertions(+), 22 deletions(-) diff --git a/interface/wx/html/htmlwin.h b/interface/wx/html/htmlwin.h index dd08acaa0e..0e88ed1eb3 100644 --- a/interface/wx/html/htmlwin.h +++ b/interface/wx/html/htmlwin.h @@ -274,28 +274,23 @@ public: void SetBorders(int b); /** - 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 ( \..\ ) - @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 - ( \ to \ ). - 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. + This function sets font sizes and faces. See wxHtmlDCRenderer::SetFonts + for detailed description. + + @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: diff --git a/interface/wx/html/htmprint.h b/interface/wx/html/htmprint.h index a7dd53b286..ea13f16f99 100644 --- a/interface/wx/html/htmprint.h +++ b/interface/wx/html/htmprint.h @@ -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 ( \..\ ) + @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 + ( \ to \ ). + 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 ( \..\ ) + + @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,10 +259,19 @@ 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: @@ -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); -- 2.45.2