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 2c8ebf7763f5ca966e40ef940bdf75b719a70c13..d31dd8b880fa09f812e5254f8d736023f35fb85a 100644 (file)
--- a/include/wx/html/htmlwin.h
+++ b/include/wx/html/htmlwin.h
@@ -27,12 +27,24 @@
 #include "wx/filesys.h"
 #include "wx/html/htmlfilt.h"
 
 #include "wx/filesys.h"
 #include "wx/html/htmlfilt.h"
 

-class WXDLLEXPORT wxHtmlProcessor;
-
+class wxHtmlProcessor;

 class wxHtmlWinModule;
 class wxHtmlHistoryArray;
 class wxHtmlProcessorList;
 
 class wxHtmlWinModule;
 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.)


@@ -50,20 +62,33 @@ class WXDLLEXPORT wxHtmlWindow : public wxScrolledWindow
     friend class wxHtmlWinModule;
 
 public:
     friend class wxHtmlWinModule;
 
 public:

-    wxHtmlWindow() : wxScrolledWindow() {};
+    wxHtmlWindow() { Init(); }

     wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
     wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,

-                 const wxPoint& pos = wxDefaultPosition, 
+                 const wxPoint& pos = wxDefaultPosition,

                  const wxSize& size = wxDefaultSize,
                  long style = wxHW_SCROLLBAR_AUTO,
                  const wxSize& size = wxDefaultSize,
                  long style = wxHW_SCROLLBAR_AUTO,

-                 const wxString& name = "htmlWindow");
+                 const wxString& name = wxT("htmlWindow"))
+    {
+        Init();
+        Create(parent, id, pos, size, style, name);
+    }

     ~wxHtmlWindow();
 
     ~wxHtmlWindow();
 

+    bool Create(wxWindow *parent, wxWindowID id = -1,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxHW_SCROLLBAR_AUTO,
+                const wxString& name = wxT("htmlWindow"));
+

     // Set HTML page and display it. !! source is HTML document itself,
     // it is NOT address/filename of HTML document. If you want to
     // specify document location, use LoadPage() istead
     // Return value : FALSE if an error occured, TRUE otherwise
     bool SetPage(const wxString& source);
 
     // Set HTML page and display it. !! source is HTML document itself,
     // it is NOT address/filename of HTML document. If you want to
     // 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);
+

     // Load HTML page from given location. Location can be either
     // a) /usr/wxGTK2/docs/html/wx.htm
     // b) http://www.somewhere.uk/document.htm
     // Load HTML page from given location. Location can be either
     // a) /usr/wxGTK2/docs/html/wx.htm
     // b) http://www.somewhere.uk/document.htm


@@ -73,7 +98,7 @@ public:
     // After the page is loaded, the method calls SetPage() to display it.
     // Note : you can also use path relative to previously loaded page
     // Return value : same as SetPage
     // After the page is loaded, the method calls SetPage() to display it.
     // Note : you can also use path relative to previously loaded page
     // Return value : same as SetPage

-    bool LoadPage(const wxString& location);
+    virtual bool LoadPage(const wxString& location);

 
     // Returns full location of opened page
     wxString GetOpenedPage() const {return m_OpenedPage;}
 
     // Returns full location of opened page
     wxString GetOpenedPage() const {return m_OpenedPage;}


@@ -94,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;}
 


@@ -124,26 +145,56 @@ public:
     // Adds input filter
     static void AddFilter(wxHtmlFilter *filter);
 
     // Adds input filter
     static void AddFilter(wxHtmlFilter *filter);
 

-    // Called when users clicked on hypertext link. Default behavior is to
-    // call LoadPage(loc)
-    virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
-

     // Returns a pointer to the parser.
     wxHtmlWinParser *GetParser() const { return m_Parser; }
     // 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:
     // Adds HTML processor to this instance of wxHtmlWindow:
     void AddProcessor(wxHtmlProcessor *processor);
     // Adds HTML processor to wxHtmlWindow class as whole:

-    static void AddSharedProcessor(wxHtmlProcessor *processor);
+    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
+    // Default behaviour is to do nothing at all
+    virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
+
+    // Called when user clicks on a cell. Default behavior is to call
+    // OnLinkClicked() if this cell corresponds to a hypertext link
+    virtual void OnCellClicked(wxHtmlCell *cell,
+                               wxCoord x, wxCoord y,
+                               const wxMouseEvent& event);
+
+    // 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. 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:
 
 protected:

+    void Init();
+

     // Scrolls to anchor of this name. (Anchor is #news
     // or #features etc. it is part of address sometimes:
     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
     // Return value : TRUE if anchor exists, FALSE otherwise
     bool ScrollToAnchor(const wxString& anchor);
 
     // Scrolls to anchor of this name. (Anchor is #news
     // or #features etc. it is part of address sometimes:
     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
     // Return value : TRUE if anchor exists, FALSE otherwise
     bool ScrollToAnchor(const wxString& anchor);
 

-    // Prepares layout (= fill m_PosX, m_PosY for fragments) based on 
+    // Prepares layout (= fill m_PosX, m_PosY for fragments) based on

     // actual size of window. This method also setup scrollbars
     void CreateLayout();
 
     // actual size of window. This method also setup scrollbars
     void CreateLayout();
 


@@ -193,6 +244,8 @@ private:
     bool m_tmpMouseMoved;
     // contains last link name
     wxHtmlLinkInfo *m_tmpLastLink;
     bool m_tmpMouseMoved;
     // contains last link name
     wxHtmlLinkInfo *m_tmpLastLink;

+    // contains the last (terminal) cell which contained the mouse
+    wxHtmlCell *m_tmpLastCell;

     // if >0 contents of the window is not redrawn
     // (in order to avoid ugly blinking)
     int m_tmpCanDrawLocks;
     // if >0 contents of the window is not redrawn
     // (in order to avoid ugly blinking)
     int m_tmpCanDrawLocks;


@@ -210,10 +263,10 @@ private:
     int m_HistoryPos;
     // if this FLAG is false, items are not added to history
     bool m_HistoryOn;
     int m_HistoryPos;
     // if this FLAG is false, items are not added to history
     bool m_HistoryOn;

-    
+

     // html processors array:
     wxHtmlProcessorList *m_Processors;
     // html processors array:
     wxHtmlProcessorList *m_Processors;

-    static wxHtmlProcessorList *m_SharedProcessors;    
+    static wxHtmlProcessorList *m_GlobalProcessors;

 
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };


@@ -222,3 +275,4 @@ private:
 #endif
 
 #endif // _WX_HTMLWIN_H_
 #endif
 
 #endif // _WX_HTMLWIN_H_

+