other interface revisions of html headers

[wxWidgets.git] / interface / wx / html / winpars.h

diff --git a/interface/wx/html/winpars.h b/interface/wx/html/winpars.h
index 232ba50760fc5cd32cd2c9bf98a3c1d192777317..4a2f2aed3646eb956ae6986c14e9c392e9f500d6 100644 (file)
--- a/interface/wx/html/winpars.h
+++ b/interface/wx/html/winpars.h
@@ -11,13 +11,12 @@
 
     This class provides easy way of filling wxHtmlWinParser's table of
     tag handlers. It is used almost exclusively together with the set of
 
     This class provides easy way of filling wxHtmlWinParser's table of
     tag handlers. It is used almost exclusively together with the set of

-    @ref overview_handlers "TAGS_MODULE_* macros"
+    @ref overview_html_handlers "TAGS_MODULE_* macros"

 
     @library{wxhtml}
 
     @library{wxhtml}

-    @category{FIXME}
+    @category{html}

 
 

-    @see @ref overview_handlers "Tag Handlers", wxHtmlTagHandler,
-    wxHtmlWinTagHandler,
+    @see @ref overview_html_handlers, wxHtmlTagHandler, wxHtmlWinTagHandler

 */
 class wxHtmlTagsModule : public wxModule
 {
 */
 class wxHtmlTagsModule : public wxModule
 {


@@ -25,13 +24,16 @@ public:
     /**
         You must override this method. In most common case its body consists
         only of lines of the following type:
     /**
         You must override this method. In most common case its body consists
         only of lines of the following type:

-        
-        I recommend using the @b TAGS_MODULE_* macros.
-        
+        @code
+        parser -> AddTagHandler(new MyHandler);
+        @endcode
+
+        It's recommended to use the @b TAGS_MODULE_* macros.
+

         @param parser
             Pointer to the parser that requested tables filling.
     */
         @param parser
             Pointer to the parser that requested tables filling.
     */

-    virtual void FillHandlersTable(wxHtmlWinParser*);
+    virtual void FillHandlersTable(wxHtmlWinParser* parser);

 };
 
 
 };
 
 


@@ -39,23 +41,22 @@ public:
 /**
     @class wxHtmlWinTagHandler
 
 /**
     @class wxHtmlWinTagHandler
 

-    This is basically wxHtmlTagHandler except that
-    it is extended with protected member m_WParser pointing to
-    the wxHtmlWinParser object (value of this member is identical
-    to wxHtmlParser's m_Parser).
+    This is basically wxHtmlTagHandler except that it is extended with protected
+    member m_WParser pointing to the wxHtmlWinParser object (value of this member
+    is identical to wxHtmlParser's m_Parser).

 
     @library{wxhtml}
     @category{html}
 */
 class wxHtmlWinTagHandler : public wxHtmlTagHandler
 {
 
     @library{wxhtml}
     @category{html}
 */
 class wxHtmlWinTagHandler : public wxHtmlTagHandler
 {

-public:
+protected:

     /**
     /**

-        @b wxHtmlWinParser* m_WParser
-        Value of this attribute is identical to value of m_Parser. The only different
-        is that m_WParser points to wxHtmlWinParser object while m_Parser
-        points to wxHtmlParser object. (The same object, but overcast.)
+        Value of this attribute is identical to value of m_Parser.
+        The only difference is that m_WParser points to wxHtmlWinParser object
+        while m_Parser points to wxHtmlParser object. (The same object, but overcast.)

     */
     */

+    wxHtmlWinParser* m_WParser;

 };
 
 
 };
 
 


@@ -63,29 +64,30 @@ public:
 /**
     @class wxHtmlWinParser
 
 /**
     @class wxHtmlWinParser
 

-    This class is derived from wxHtmlParser and
-    its main goal is to parse HTML input so that it can be displayed in
-    wxHtmlWindow. It uses a special
-    wxHtmlWinTagHandler.
+    This class is derived from wxHtmlParser and its main goal is to parse HTML
+    input so that it can be displayed in wxHtmlWindow.
+    It uses a special wxHtmlWinTagHandler.
+
+    @note The product of parsing is a wxHtmlCell (resp. wxHtmlContainer) object.

 
     @library{wxhtml}
     @category{html}
 
 
     @library{wxhtml}
     @category{html}
 

-    @see @ref overview_handlers "Handlers overview"
+    @see @ref overview_html_handlers

 */
 class wxHtmlWinParser : public wxHtmlParser
 {
 public:
 */
 class wxHtmlWinParser : public wxHtmlParser
 {
 public:

-    //@{
+    wxHtmlWinParser();
+

     /**
     /**

-        Constructor. Don't use the default one, use constructor with
-        @a wndIface parameter (@a wndIface is a pointer to interface object for
-        the associated wxHtmlWindow or other HTML rendering
-        window such as wxHtmlListBox).
+        Constructor.
+
+        Don't use the default one, use constructor with @a wndIface parameter
+        (@a wndIface is a pointer to interface object for the associated wxHtmlWindow
+        or other HTML rendering window such as wxHtmlListBox).

     */
     */

-    wxHtmlWinParser();

     wxHtmlWinParser(wxHtmlWindowInterface wndIface);
     wxHtmlWinParser(wxHtmlWindowInterface wndIface);

-    //@}

 
     /**
         Adds module() to the list of wxHtmlWinParser tag handler.
 
     /**
         Adds module() to the list of wxHtmlWinParser tag handler.


@@ -94,18 +96,15 @@ public:
 
     /**
         Closes the container, sets actual container to the parent one
 
     /**
         Closes the container, sets actual container to the parent one

-        and returns pointer to it (see Overview()).
+        and returns pointer to it (see @ref overview_html_cells).

     */
     wxHtmlContainerCell* CloseContainer();
 
     /**
     */
     wxHtmlContainerCell* CloseContainer();
 
     /**

-        Creates font based on current setting (see
-        SetFontSize(),
-        SetFontBold(),
-        SetFontItalic(),
-        SetFontFixed(),
-        wxHtmlWinParser::SetFontUnderlined)
+        Creates font based on current setting (see SetFontSize(), SetFontBold(),
+        SetFontItalic(), SetFontFixed(), wxHtmlWinParser::SetFontUnderlined)

         and returns pointer to it.
         and returns pointer to it.

+

         If the font was already created only a pointer is returned.
     */
     virtual wxFont* CreateCurrentFont();
         If the font was already created only a pointer is returned.
     */
     virtual wxFont* CreateCurrentFont();


@@ -121,24 +120,29 @@ public:
     int GetAlign() const;
 
     /**
     int GetAlign() const;
 
     /**

-        Returns (average) char height in standard font. It is used as DC-independent
-        metrics.
+        Returns (average) char height in standard font.
+        It is used as DC-independent metrics.
+

         @note This function doesn't return the @e actual height. If you want to
         @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().
+              know the height of the current font, call @c GetDC->GetCharHeight().

     */
     int GetCharHeight() const;
 
     /**
     */
     int GetCharHeight() const;
 
     /**

-        Returns average char width in standard font. It is used as DC-independent
-        metrics.
+        Returns average char width in standard font.
+        It is used as DC-independent metrics.
+

         @note This function doesn't return the @e actual width. If you want to
         @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()
+              know the height of the current font, call @c GetDC->GetCharWidth().

     */
     int GetCharWidth() const;
 
     /**
     */
     int GetCharWidth() const;
 
     /**

-        Returns pointer to the currently opened container (see Overview()).
+        Returns pointer to the currently opened container (see @ref overview_html_cells).

         Common use:
         Common use:

+        @code
+        m_WParser -> GetContainer() -> InsertCell(new ...);
+        @endcode

     */
     wxHtmlContainerCell* GetContainer() const;
 
     */
     wxHtmlContainerCell* GetContainer() const;
 


@@ -148,9 +152,9 @@ public:
     wxDC* GetDC();
 
     /**
     wxDC* GetDC();
 
     /**

-        Returns wxEncodingConverter class used
-        to do conversion between @ref getinputencoding() "input encoding"
-        and @ref getoutputencoding() "output encoding".
+        Returns wxEncodingConverter class used to do conversion between the
+        @ref GetInputEncoding() "input encoding" and the
+        @ref GetOutputEncoding() "output encoding".

     */
     wxEncodingConverter* GetEncodingConverter() const;
 
     */
     wxEncodingConverter* GetEncodingConverter() const;
 


@@ -190,10 +194,9 @@ public:
     wxFontEncoding GetInputEncoding() const;
 
     /**
     wxFontEncoding GetInputEncoding() const;
 
     /**

-        Returns actual hypertext link. (This value has a non-empty
-        @ref wxHtmlLinkInfo::gethref Href string
-        if the parser is between @c A and @c /A tags,
-        wxEmptyString otherwise.)
+        Returns actual hypertext link.
+        (This value has a non-empty @ref wxHtmlLinkInfo::GetHref Href string
+        if the parser is between \<A\> and \</A\> tags, wxEmptyString otherwise.)

     */
     const wxHtmlLinkInfo& GetLink() const;
 
     */
     const wxHtmlLinkInfo& GetLink() const;
 


@@ -209,14 +212,15 @@ public:
     wxFontEncoding GetOutputEncoding() const;
 
     /**
     wxFontEncoding GetOutputEncoding() const;
 
     /**

-        Returns associated window (wxHtmlWindow). This may be @NULL! (You should always
-        test if it is non-@NULL. For example @c TITLE handler sets window
-        title only if some window is associated, otherwise it does nothing)
+        Returns associated window (wxHtmlWindow). This may be @NULL!
+        (You should always test if it is non-@NULL.
+        For example @c TITLE handler sets window title only if some window is
+        associated, otherwise it does nothing.

     */
     wxHtmlWindow* GetWindow();
 
     /**
     */
     wxHtmlWindow* GetWindow();
 
     /**

-        Opens new container and returns pointer to it (see Overview()).
+        Opens new container and returns pointer to it (see @ref overview_html_cells).

     */
     wxHtmlContainerCell* OpenContainer();
 
     */
     wxHtmlContainerCell* OpenContainer();
 


@@ -227,21 +231,20 @@ public:
     void SetActualColor(const wxColour& clr);
 
     /**
     void SetActualColor(const wxColour& clr);
 
     /**

-        Sets default horizontal alignment (see
-        wxHtmlContainerCell::SetAlignHor.)
+        Sets default horizontal alignment (see wxHtmlContainerCell::SetAlignHor).

         Alignment of newly opened container is set to this value.
     */
     void SetAlign(int a);
 
     /**
         Alignment of newly opened container is set to this value.
     */
     void SetAlign(int a);
 
     /**

-        Allows you to directly set opened container. This is not recommended - you
-        should use OpenContainer
-        wherever possible.
+        Allows you to directly set opened container.
+        This is not recommended - you should use OpenContainer() wherever possible.

     */
     wxHtmlContainerCell* SetContainer(wxHtmlContainerCell* c);
 
     /**
         Sets the DC. This must be called before wxHtmlParser::Parse!
     */
     wxHtmlContainerCell* SetContainer(wxHtmlContainerCell* c);
 
     /**
         Sets the DC. This must be called before wxHtmlParser::Parse!

+

         @a pixel_scale  can be used when rendering to high-resolution
         DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in
         HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
         @a pixel_scale  can be used when rendering to high-resolution
         DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in
         HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one


@@ -255,9 +258,9 @@ public:
     void SetFontBold(int x);
 
     /**
     void SetFontBold(int x);
 
     /**

-        Sets current font face to @e face. This affects either fixed size
+        Sets current font face to @a face. This affects either fixed size

         font or proportional, depending on context (whether the parser is
         font or proportional, depending on context (whether the parser is

-        inside @c TT tag or not).
+        inside @c \<TT\> tag or not).

     */
     void SetFontFace(const wxString& face);
 
     */
     void SetFontFace(const wxString& face);
 


@@ -272,7 +275,7 @@ public:
     void SetFontItalic(int x);
 
     /**
     void SetFontItalic(int x);
 
     /**

-        Sets actual font size (HTML size varies from 1 to 7)
+        Sets actual font size (HTML size varies from 1 to 7).

     */
     void SetFontSize(int s);
 
     */
     void SetFontSize(int s);
 


@@ -282,22 +285,20 @@ public:
     void SetFontUnderlined(int x);
 
     /**
     void SetFontUnderlined(int x);
 
     /**

-        Sets fonts. See wxHtmlWindow::SetFonts for
-        detailed description.
+        Sets fonts. See wxHtmlWindow::SetFonts for detailed description.

     */
     void SetFonts(const wxString& normal_face, const wxString& fixed_face,
                   const int* sizes = 0);
 
     /**
         Sets input encoding. The parser uses this information to build conversion
     */
     void SetFonts(const wxString& normal_face, const wxString& fixed_face,
                   const int* sizes = 0);
 
     /**
         Sets input encoding. The parser uses this information to build conversion

-        tables from document's encoding to some encoding supported by operating
-        system.
+        tables from document's encoding to some encoding supported by operating system.

     */
     void SetInputEncoding(wxFontEncoding enc);
 
     /**
     */
     void SetInputEncoding(wxFontEncoding enc);
 
     /**

-        Sets actual hypertext link. Empty link is represented
-        by wxHtmlLinkInfo with @e Href equal
+        Sets actual hypertext link.
+        Empty link is represented by wxHtmlLinkInfo with @e Href equal

         to wxEmptyString.
     */
     void SetLink(const wxHtmlLinkInfo& link);
         to wxEmptyString.
     */
     void SetLink(const wxHtmlLinkInfo& link);