Allow setting long version field in About dialog.

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

diff --git a/interface/wx/html/htmlwin.h b/interface/wx/html/htmlwin.h
index 50efdf2166c8e446f591bf0b5f09b4090dc43bb5..0e88ed1eb3e83c16c73f91c02f8a53dcae6df607 100644 (file)
--- a/interface/wx/html/htmlwin.h
+++ b/interface/wx/html/htmlwin.h
@@ -35,7 +35,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxHtmlCellEvent, wxHtmlLinkEvent}
+    @beginEventEmissionTable{wxHtmlCellEvent, wxHtmlLinkEvent}
     @event{EVT_HTML_CELL_CLICKED(id, func)}
         A wxHtmlCell was clicked.
     @event{EVT_HTML_CELL_HOVER(id, func)}
@@ -61,12 +61,11 @@ public:
         Constructor.
         The parameters are the same as wxScrolled::wxScrolled() constructor.
     */
-    wxHtmlWindow(wxWindow parent, wxWindowID id = -1,
+    wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = wxHW_DEFAULT_STYLE,
                  const wxString& name = "htmlWindow");
-    //@}
 
     /**
         Adds @ref overview_html_filters "input filter" to the static list of available
@@ -75,7 +74,7 @@ public:
         - @c image/* MIME types
         - Plain Text filter (this filter is used if no other filter matches)
     */
-    static void AddFilter(wxHtmlFilter filter);
+    static void AddFilter(wxHtmlFilter* filter);
 
     /**
         Appends HTML fragment to currently displayed text and refreshes the window.
@@ -229,7 +228,7 @@ public:
         @param path
             Optional path in config tree. If not given current path is used.
     */
-    virtual void ReadCustomization(wxConfigBase cfg,
+    virtual void ReadCustomization(wxConfigBase* cfg,
                                    wxString path = wxEmptyString);
 
     /**
@@ -267,7 +266,7 @@ public:
     /**
         This function sets the space between border of window and HTML contents.
         See image:
-        @image html border.png
+        @image html htmlwin_border.png
 
         @param b
             indentation from borders in pixels
@@ -275,28 +274,22 @@ 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.
+        @see SetSize()
+    */
+    void SetFonts(const wxString& normal_face, const wxString& fixed_face,
+                  const int* sizes = 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.
+    /**
+        Sets default font sizes and/or default font size. 
+        See wxHtmlDCRenderer::SetStandardFonts for detailed description.
+        @see SetFonts()
     */
-    void SetFonts(const wxString& normal_face,
-                  const wxString& fixed_face,
-                  const int sizes = NULL);
+    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!!
@@ -364,7 +357,7 @@ public:
         @param path
             Optional path in config tree. If not given, the current path is used.
     */
-    virtual void WriteCustomization(wxConfigBase cfg,
+    virtual void WriteCustomization(wxConfigBase* cfg,
                                     wxString path = wxEmptyString);
 
 protected:
@@ -389,7 +382,7 @@ protected:
 
         @return @true if a link was clicked, @false otherwise.
     */
-    virtual bool OnCellClicked(wxHtmlCell cell, wxCoord x, wxCoord y,
+    virtual bool OnCellClicked(wxHtmlCell* cell, wxCoord x, wxCoord y,
                                const wxMouseEvent& event);
 
     /**
@@ -406,7 +399,7 @@ protected:
         @param y
             The logical y coordinate of the click point
     */
-    virtual void OnCellMouseHover(wxHtmlCell cell, wxCoord x, wxCoord y);
+    virtual void OnCellMouseHover(wxHtmlCell* cell, wxCoord x, wxCoord y);
 };
 
 
@@ -430,7 +423,7 @@ public:
     /**
         The constructor is not normally used by the user code.
     */
-    wxHyperlinkEvent(int id, const wxHtmlLinkInfo& linkinfo);
+    wxHtmlLinkEvent(int id, const wxHtmlLinkInfo& linkinfo);
 
     /**
         Returns the wxHtmlLinkInfo which contains info about the cell clicked
@@ -465,7 +458,8 @@ public:
     */
     wxHtmlCellEvent(wxEventType commandType, int id,
                     wxHtmlCell* cell,
-                    const wxPoint& point);
+                    const wxPoint& point,
+                    const wxMouseEvent& ev);
 
     /**
         Returns the wxHtmlCellEvent associated with the event.
@@ -490,6 +484,6 @@ public:
         With this function the event handler can return info to the wxHtmlWindow
         which sent the event.
     */
-    bool SetLinkClicked(bool linkclicked);
+    void SetLinkClicked(bool linkclicked);
 };