move all appearace-related methods down to wxCalendarCtrlBase from wxGenericCalendarCtrl

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

diff --git a/interface/html/winpars.h b/interface/html/winpars.h
index cbe7197d616d2363e6f27351f91266cedc804402..ed5d5348b1c313484d9bb9b42b1095460676e05b 100644 (file)
--- a/interface/html/winpars.h
+++ b/interface/html/winpars.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/winpars.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/winpars.h

-// Purpose:     documentation for wxHtmlTagsModule class
+// Purpose:     interface of wxHtmlTagsModule

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,16 +9,16 @@
 /**
     @class wxHtmlTagsModule
     @headerfile winpars.h wx/html/winpars.h
 /**
     @class wxHtmlTagsModule
     @headerfile winpars.h wx/html/winpars.h

-    
+

     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"
     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"

-    
+

     @library{wxhtml}
     @category{FIXME}
     @library{wxhtml}
     @category{FIXME}

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

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


@@ -26,24 +26,26 @@ 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.
         
         I recommend using 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 parser);
 };
 
 
     */
     virtual void FillHandlersTable(wxHtmlWinParser parser);
 };
 
 

+

 /**
     @class wxHtmlWinTagHandler
     @headerfile winpars.h wx/html/winpars.h
 /**
     @class wxHtmlWinTagHandler
     @headerfile winpars.h wx/html/winpars.h

-    
+

     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}
 */
     @library{wxhtml}
     @category{html}
 */


@@ -52,7 +54,6 @@ class wxHtmlWinTagHandler : public wxHtmlTagHandler
 public:
     /**
         @b wxHtmlWinParser* m_WParser
 public:
     /**
         @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 different
         is that m_WParser points to wxHtmlWinParser object while m_Parser
         points to wxHtmlParser object. (The same object, but overcast.)


@@ -60,20 +61,20 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxHtmlWinParser
     @headerfile winpars.h wx/html/winpars.h
 /**
     @class wxHtmlWinParser
     @headerfile winpars.h wx/html/winpars.h

-    
+

     This class is derived from wxHtmlParser and
     its main goal is to parse HTML input so that it can be displayed in
     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 
+    wxHtmlWindow. It uses a special

     wxHtmlWinTagHandler.
     wxHtmlWinTagHandler.

-    
+

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

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

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


@@ -81,31 +82,31 @@ public:
     //@{
     /**
         Constructor. Don't use the default one, use constructor with
     //@{
     /**
         Constructor. Don't use the default one, use constructor with

-        @e wndIface parameter (@e wndIface is a pointer to interface object for
+        @a wndIface parameter (@a wndIface is a pointer to interface object for

         the associated wxHtmlWindow or other HTML rendering
         window such as wxHtmlListBox).
     */
     wxHtmlWinParser();
         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.

     */
     static void AddModule(wxHtmlTagsModule module);
 
     /**
         Closes the container, sets actual container to the parent one
     */
     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();
 
     /**
     */
     wxHtmlContainerCell* CloseContainer();
 
     /**

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

         wxHtmlWinParser::SetFontUnderlined)
         and returns pointer to it.
         If the font was already created only a pointer is returned.
         wxHtmlWinParser::SetFontUnderlined)
         and returns pointer to it.
         If the font was already created only a pointer is returned.


@@ -115,102 +116,100 @@ public:
     /**
         Returns actual text colour.
     */
     /**
         Returns actual text colour.
     */

-    const wxColour GetActualColor();
+    const wxColour GetActualColor() const;

 
     /**
         Returns default horizontal alignment.
     */
 
     /**
         Returns default horizontal alignment.
     */

-    int GetAlign();
+    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.

-        
-        @b 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();
+    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.

-        
-        @b 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();
+    int GetCharWidth() const;

 
     /**
 
     /**

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

         Common use:
     */
         Common use:
     */

-    wxHtmlContainerCell* GetContainer();
+    wxHtmlContainerCell* GetContainer() const;

 
     /**
         Returns pointer to the DC used during parsing.
     */
 
     /**
         Returns pointer to the DC used during parsing.
     */

-#define wxDC* GetDC()     /* implementation is private */
+    wxDC* GetDC();

 
     /**
         Returns wxEncodingConverter class used
 
     /**
         Returns wxEncodingConverter class used

-        to do conversion between @ref getinputencoding() "input encoding" 
+        to do conversion between @ref getinputencoding() "input encoding"

         and @ref getoutputencoding() "output encoding".
     */
         and @ref getoutputencoding() "output encoding".
     */

-    wxEncodingConverter * GetEncodingConverter();
+    wxEncodingConverter* GetEncodingConverter() const;

 
     /**
         Returns @true if actual font is bold, @false otherwise.
     */
 
     /**
         Returns @true if actual font is bold, @false otherwise.
     */

-    int GetFontBold();
+    int GetFontBold() const;

 
     /**
         Returns actual font face name.
     */
 
     /**
         Returns actual font face name.
     */

-    wxString GetFontFace();
+    wxString GetFontFace() const;

 
     /**
         Returns @true if actual font is fixed face, @false otherwise.
     */
 
     /**
         Returns @true if actual font is fixed face, @false otherwise.
     */

-    int GetFontFixed();
+    int GetFontFixed() const;

 
     /**
         Returns @true if actual font is italic, @false otherwise.
     */
 
     /**
         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)
     */
 
     /**
         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.
     */
 
     /**
         Returns @true if actual font is underlined, @false otherwise.
     */

-    int GetFontUnderlined();
+    int GetFontUnderlined() const;

 
     /**
         Returns input encoding.
     */
 
     /**
         Returns input encoding.
     */

-    wxFontEncoding GetInputEncoding();
+    wxFontEncoding GetInputEncoding() const;

 
     /**
 
     /**

-        Returns actual hypertext link. (This value has a non-empty 
+        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.)
     */
         @ref wxHtmlLinkInfo::gethref Href string
         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.
     */
 
     /**
         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.
     */
 
     /**
         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
 
     /**
         Returns associated window (wxHtmlWindow). This may be @NULL! (You should always


@@ -220,7 +219,7 @@ public:
     wxHtmlWindow* GetWindow();
 
     /**
     wxHtmlWindow* GetWindow();
 
     /**

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

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


@@ -231,7 +230,7 @@ public:
     void SetActualColor(const wxColour& clr);
 
     /**
     void SetActualColor(const wxColour& clr);
 
     /**

-        Sets default horizontal alignment (see 
+        Sets default horizontal alignment (see

         wxHtmlContainerCell::SetAlignHor.)
         Alignment of newly opened container is set to this value.
     */
         wxHtmlContainerCell::SetAlignHor.)
         Alignment of newly opened container is set to this value.
     */


@@ -242,36 +241,36 @@ public:
         should use OpenContainer
         wherever possible.
     */
         should use OpenContainer
         wherever possible.
     */

-    wxHtmlContainerCell* SetContainer(wxHtmlContainerCell * c);
+    wxHtmlContainerCell* SetContainer(wxHtmlContainerCell* c);

 
     /**
         Sets the DC. This must be called before wxHtmlParser::Parse!
 
     /**
         Sets the DC. This must be called before wxHtmlParser::Parse!

-        @e pixel_scale  can be used when rendering to high-resolution 
-        DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in 
+        @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
         inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
     */
         HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
         inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
     */

-#define virtual void SetDC(wxDC dc, double pixel_scale = 1.0)     /* implementation is private */
+    virtual void SetDC(wxDC dc, double pixel_scale = 1.0);

 
     /**
 
     /**

-        Sets bold flag of actualfont. @e x is either @true of @false.
+        Sets bold flag of actualfont. @a x is either @true of @false.

     */
     void SetFontBold(int x);
 
     /**
         Sets current font face to @e face. This affects either fixed size
     */
     void SetFontBold(int x);
 
     /**
         Sets current font face to @e 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).
     */
     void SetFontFace(const wxString& face);
 
     /**
         inside @c TT tag or not).
     */
     void SetFontFace(const wxString& face);
 
     /**

-        Sets fixed face flag of actualfont. @e x is either @true of @false.
+        Sets fixed face flag of actualfont. @a x is either @true of @false.

     */
     void SetFontFixed(int x);
 
     /**
     */
     void SetFontFixed(int x);
 
     /**

-        Sets italic flag of actualfont. @e x is either @true of @false.
+        Sets italic flag of actualfont. @a x is either @true of @false.

     */
     void SetFontItalic(int x);
 
     */
     void SetFontItalic(int x);
 


@@ -281,7 +280,7 @@ public:
     void SetFontSize(int s);
 
     /**
     void SetFontSize(int s);
 
     /**

-        Sets underlined flag of actualfont. @e x is either @true of @false.
+        Sets underlined flag of actualfont. @a x is either @true of @false.

     */
     void SetFontUnderlined(int x);
 
     */
     void SetFontUnderlined(int x);
 


@@ -291,7 +290,7 @@ public:
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,
     */
     void SetFonts(const wxString& normal_face,
                   const wxString& fixed_face,

-                  const int sizes = @NULL);
+                  const int sizes = NULL);

 
     /**
         Sets input encoding. The parser uses this information to build conversion
 
     /**
         Sets input encoding. The parser uses this information to build conversion


@@ -312,3 +311,4 @@ public:
     */
     void SetLinkColor(const wxColour& clr);
 };
     */
     void SetLinkColor(const wxColour& clr);
 };

+