X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..b02f1c862d1a3fcd714aef37e67decaa9d67b611:/interface/html/winpars.h diff --git a/interface/html/winpars.h b/interface/html/winpars.h index 51ffa9bd61..4b6a71af1d 100644 --- a/interface/html/winpars.h +++ b/interface/html/winpars.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/winpars.h -// Purpose: documentation for wxHtmlTagsModule class +// Purpose: interface of wxHtmlTagsModule // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,8 @@ @library{wxhtml} @category{FIXME} - @seealso - @ref overview_handlers "Tag Handlers", wxHtmlTagHandler, wxHtmlWinTagHandler, + @see @ref overview_handlers "Tag Handlers", wxHtmlTagHandler, + wxHtmlWinTagHandler, */ class wxHtmlTagsModule : public wxModule { @@ -36,6 +36,7 @@ public: }; + /** @class wxHtmlWinTagHandler @headerfile winpars.h wx/html/winpars.h @@ -60,6 +61,7 @@ public: }; + /** @class wxHtmlWinParser @headerfile winpars.h wx/html/winpars.h @@ -72,8 +74,7 @@ public: @library{wxhtml} @category{html} - @seealso - @ref overview_handlers "Handlers overview" + @see @ref overview_handlers "Handlers overview" */ class wxHtmlWinParser : public wxHtmlParser { @@ -90,13 +91,13 @@ public: //@} /** - Adds module to the list of wxHtmlWinParser tag handler. + Adds module() to the list of wxHtmlWinParser tag handler. */ static void AddModule(wxHtmlTagsModule module); /** Closes the container, sets actual container to the parent one - and returns pointer to it (see Overview). + and returns pointer to it (see Overview()). */ wxHtmlContainerCell* CloseContainer(); @@ -115,12 +116,12 @@ public: /** Returns actual text colour. */ - const wxColour GetActualColor(); + const wxColour GetActualColor() const; /** Returns default horizontal alignment. */ - int GetAlign(); + int GetAlign() const; /** Returns (average) char height in standard font. It is used as DC-independent @@ -128,7 +129,7 @@ public: @b Note: This function doesn't return the @e actual height. If you want to know the height of the current font, call @c GetDC - GetCharHeight(). */ - int GetCharHeight(); + int GetCharHeight() const; /** Returns average char width in standard font. It is used as DC-independent @@ -136,13 +137,13 @@ public: @b Note: This function doesn't return the @e actual width. If you want to know the height of the current font, call @c GetDC - GetCharWidth() */ - int GetCharWidth(); + int GetCharWidth() const; /** - Returns pointer to the currently opened container (see Overview). + Returns pointer to the currently opened container (see Overview()). Common use: */ - wxHtmlContainerCell* GetContainer(); + wxHtmlContainerCell* GetContainer() const; /** Returns pointer to the DC used during parsing. @@ -154,42 +155,42 @@ public: to do conversion between @ref getinputencoding() "input encoding" and @ref getoutputencoding() "output encoding". */ - wxEncodingConverter* GetEncodingConverter(); + wxEncodingConverter* GetEncodingConverter() const; /** Returns @true if actual font is bold, @false otherwise. */ - int GetFontBold(); + int GetFontBold() const; /** Returns actual font face name. */ - wxString GetFontFace(); + wxString GetFontFace() const; /** Returns @true if actual font is fixed face, @false otherwise. */ - int GetFontFixed(); + int GetFontFixed() const; /** Returns @true if actual font is italic, @false otherwise. */ - int GetFontItalic(); + int GetFontItalic() const; /** Returns actual font size (HTML size varies from -2 to +4) */ - int GetFontSize(); + int GetFontSize() const; /** Returns @true if actual font is underlined, @false otherwise. */ - int GetFontUnderlined(); + int GetFontUnderlined() const; /** Returns input encoding. */ - wxFontEncoding GetInputEncoding(); + wxFontEncoding GetInputEncoding() const; /** Returns actual hypertext link. (This value has a non-empty @@ -197,18 +198,18 @@ public: if the parser is between @c A and @c /A tags, wxEmptyString otherwise.) */ - const wxHtmlLinkInfo GetLink(); + const wxHtmlLinkInfo GetLink() const; /** Returns the colour of hypertext link text. */ - const wxColour GetLinkColor(); + const wxColour GetLinkColor() const; /** Returns output encoding, i.e. closest match to document's input encoding that is supported by operating system. */ - wxFontEncoding GetOutputEncoding(); + wxFontEncoding GetOutputEncoding() const; /** Returns associated window (wxHtmlWindow). This may be @NULL! (You should always @@ -218,7 +219,7 @@ public: wxHtmlWindow* GetWindow(); /** - Opens new container and returns pointer to it (see Overview). + Opens new container and returns pointer to it (see Overview()). */ wxHtmlContainerCell* OpenContainer(); @@ -310,3 +311,4 @@ public: */ void SetLinkColor(const wxColour& clr); }; +