added (and documented) trivial but useful IsSingleLine() and IsMultiLine() text contr...

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

diff --git a/include/wx/html/htmlwin.h b/include/wx/html/htmlwin.h
index 22466f4856e0bdc94cd78afe771587a39feb1824..d31dd8b880fa09f812e5254f8d736023f35fb85a 100644 (file)
--- a/include/wx/html/htmlwin.h
+++ b/include/wx/html/htmlwin.h
@@ -32,6 +32,19 @@ class wxHtmlWinModule;
 class wxHtmlHistoryArray;
 class wxHtmlProcessorList;
 
 class wxHtmlHistoryArray;
 class wxHtmlProcessorList;
 

+
+// wxHtmlWindow flags:
+#define wxHW_SCROLLBAR_NEVER    0x0002
+#define wxHW_SCROLLBAR_AUTO     0x0004
+
+// enums for wxHtmlWindow::OnOpeningURL
+enum wxHtmlOpeningStatus
+{
+    wxHTML_OPEN,
+    wxHTML_BLOCK,
+    wxHTML_REDIRECT
+};
+

 //--------------------------------------------------------------------------------
 // wxHtmlWindow
 //                  (This is probably the only class you will directly use.)
 //--------------------------------------------------------------------------------
 // wxHtmlWindow
 //                  (This is probably the only class you will directly use.)


@@ -72,7 +85,7 @@ public:
     // specify document location, use LoadPage() istead
     // Return value : FALSE if an error occured, TRUE otherwise
     bool SetPage(const wxString& source);
     // specify document location, use LoadPage() istead
     // Return value : FALSE if an error occured, TRUE otherwise
     bool SetPage(const wxString& source);

-    
+

     // Append to current page
     bool AppendToPage(const wxString& source);
 
     // Append to current page
     bool AppendToPage(const wxString& source);
 


@@ -106,10 +119,6 @@ public:
     // Sets fonts to be used when displaying HTML page.
     void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
 
     // Sets fonts to be used when displaying HTML page.
     void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
 

-    // Sets the title of the window
-    // (depending on the information passed to SetRelatedFrame() method)
-    virtual void OnSetTitle(const wxString& title);
-

     // Sets space between text and window borders.
     void SetBorders(int b) {m_Borders = b;}
 
     // Sets space between text and window borders.
     void SetBorders(int b) {m_Borders = b;}
 


@@ -136,8 +145,24 @@ public:
     // Adds input filter
     static void AddFilter(wxHtmlFilter *filter);
 
     // Adds input filter
     static void AddFilter(wxHtmlFilter *filter);
 

+    // Returns a pointer to the parser.
+    wxHtmlWinParser *GetParser() const { return m_Parser; }
+
+    // Adds HTML processor to this instance of wxHtmlWindow:
+    void AddProcessor(wxHtmlProcessor *processor);
+    // Adds HTML processor to wxHtmlWindow class as whole:
+    static void AddGlobalProcessor(wxHtmlProcessor *processor);
+
+    // what would we do with it?
+    virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
+
+    // -- Callbacks --
+
+    // Sets the title of the window
+    // (depending on the information passed to SetRelatedFrame() method)
+    virtual void OnSetTitle(const wxString& title);
+

     // Called when the mouse hovers over a cell: (x, y) are logical coords
     // Called when the mouse hovers over a cell: (x, y) are logical coords

-    //

     // Default behaviour is to do nothing at all
     virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
 
     // Default behaviour is to do nothing at all
     virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
 


@@ -150,22 +175,15 @@ public:
     // Called when user clicked on hypertext link. Default behavior is to
     // call LoadPage(loc)
     virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
     // Called when user clicked on hypertext link. Default behavior is to
     // call LoadPage(loc)
     virtual void OnLinkClicked(const wxHtmlLinkInfo& link);

-    
-    // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when loading
-    // a page or loading an image). The data are downloaded if and only if 
-    // OnOpeningURL returns TRUE.
-    virtual bool OnOpeningURL(const wxString& url) const { return TRUE; }
-
-    // Returns a pointer to the parser.
-    wxHtmlWinParser *GetParser() const { return m_Parser; }

 
 

-    // Adds HTML processor to this instance of wxHtmlWindow:
-    void AddProcessor(wxHtmlProcessor *processor);
-    // Adds HTML processor to wxHtmlWindow class as whole:
-    static void AddGlobalProcessor(wxHtmlProcessor *processor);
-
-    // what would we do with it?
-    virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
+    // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
+    // loading a page or loading an image). The data are downloaded if and only if
+    // OnOpeningURL returns TRUE. If OnOpeningURL returns wxHTML_REDIRECT,
+    // it must set *redirect to the new URL
+    virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
+                                             const wxString& WXUNUSED(url),
+                                             wxString *WXUNUSED(redirect)) const
+        { return wxHTML_OPEN; }

 
 protected:
     void Init();
 
 protected:
     void Init();