synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/html/htmlcell.h b/include/wx/html/htmlcell.h
index 09e3cd29b060f95af62fd5fc270d2538438d1709..a474030726a0ad1b3fbf12d525db1d0e1ff93342 100644 (file)
--- a/include/wx/html/htmlcell.h
+++ b/include/wx/html/htmlcell.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        htmlcell.h
+// Name:        wx/html/htmlcell.h

 // Purpose:     wxHtmlCell class is used by wxHtmlWindow/wxHtmlWinParser
 //              as a basic visual element of HTML page
 // Author:      Vaclav Slavik
 // Purpose:     wxHtmlCell class is used by wxHtmlWindow/wxHtmlWinParser
 //              as a basic visual element of HTML page
 // Author:      Vaclav Slavik


@@ -8,14 +8,9 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-

 #ifndef _WX_HTMLCELL_H_
 #define _WX_HTMLCELL_H_
 
 #ifndef _WX_HTMLCELL_H_
 #define _WX_HTMLCELL_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "htmlcell.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_HTML
 #include "wx/defs.h"
 
 #if wxUSE_HTML


@@ -25,9 +20,10 @@
 #include "wx/window.h"
 
 
 #include "wx/window.h"
 
 

-class WXDLLIMPEXP_HTML wxHtmlLinkInfo;
-class WXDLLIMPEXP_HTML wxHtmlCell;
-class WXDLLIMPEXP_HTML wxHtmlContainerCell;
+class WXDLLIMPEXP_FWD_HTML wxHtmlWindowInterface;
+class WXDLLIMPEXP_FWD_HTML wxHtmlLinkInfo;
+class WXDLLIMPEXP_FWD_HTML wxHtmlCell;
+class WXDLLIMPEXP_FWD_HTML wxHtmlContainerCell;

 
 
 // wxHtmlSelection is data holder with information about text selection.
 
 
 // wxHtmlSelection is data holder with information about text selection.


@@ -38,9 +34,10 @@ class WXDLLIMPEXP_HTML wxHtmlSelection
 public:
     wxHtmlSelection()
         : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),
 public:
     wxHtmlSelection()
         : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),

-          m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition),
+          m_fromCharacterPos(-1), m_toCharacterPos(-1),

           m_fromCell(NULL), m_toCell(NULL) {}
 
           m_fromCell(NULL), m_toCell(NULL) {}
 

+    // this version is used for the user selection defined with the mouse

     void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell,
              const wxPoint& toPos, const wxHtmlCell *toCell);
     void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell);
     void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell,
              const wxPoint& toPos, const wxHtmlCell *toCell);
     void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell);


@@ -53,11 +50,13 @@ public:
     const wxPoint& GetToPos() const { return m_toPos; }
 
     // these are From/ToCell's private data
     const wxPoint& GetToPos() const { return m_toPos; }
 
     // these are From/ToCell's private data

-    const wxPoint& GetFromPrivPos() const { return m_fromPrivPos; }
-    const wxPoint& GetToPrivPos() const { return m_toPrivPos; }
-    void SetFromPrivPos(const wxPoint& pos) { m_fromPrivPos = pos; }
-    void SetToPrivPos(const wxPoint& pos) { m_toPrivPos = pos; }
-    void ClearPrivPos() { m_toPrivPos = m_fromPrivPos = wxDefaultPosition; }
+    void ClearFromToCharacterPos() { m_toCharacterPos = m_fromCharacterPos = -1; }
+    bool AreFromToCharacterPosSet() const { return m_toCharacterPos != -1 && m_fromCharacterPos != -1; }
+
+    void SetFromCharacterPos (wxCoord pos) { m_fromCharacterPos = pos; }
+    void SetToCharacterPos (wxCoord pos) { m_toCharacterPos = pos; }
+    wxCoord GetFromCharacterPos () const { return m_fromCharacterPos; }
+    wxCoord GetToCharacterPos () const { return m_toCharacterPos; }

 
     bool IsEmpty() const
         { return m_fromPos == wxDefaultPosition &&
 
     bool IsEmpty() const
         { return m_fromPos == wxDefaultPosition &&


@@ -65,7 +64,7 @@ public:
 
 private:
     wxPoint m_fromPos, m_toPos;
 
 private:
     wxPoint m_fromPos, m_toPos;

-    wxPoint m_fromPrivPos, m_toPrivPos;
+    wxCoord m_fromCharacterPos, m_toCharacterPos;

     const wxHtmlCell *m_fromCell, *m_toCell;
 };
 
     const wxHtmlCell *m_fromCell, *m_toCell;
 };
 


@@ -150,6 +149,13 @@ enum
 };
 
 
 };
 
 

+// Superscript/subscript/normal script mode of a cell
+enum wxHtmlScriptMode
+{
+    wxHTML_SCRIPT_NORMAL,
+    wxHTML_SCRIPT_SUB,
+    wxHTML_SCRIPT_SUP
+};

 
 
 // ---------------------------------------------------------------------------
 
 
 // ---------------------------------------------------------------------------


@@ -181,6 +187,10 @@ public:
     int GetHeight() const {return m_Height;}
     int GetDescent() const {return m_Descent;}
 
     int GetHeight() const {return m_Height;}
     int GetDescent() const {return m_Descent;}
 

+    void SetScriptMode(wxHtmlScriptMode mode, long previousBase);
+    wxHtmlScriptMode GetScriptMode() const { return m_ScriptMode; }
+    long GetScriptBaseline() { return m_ScriptBaseline; }
+

     // Formatting cells are not visible on the screen, they only alter
     // renderer's state.
     bool IsFormattingCell() const { return m_Width == 0 && m_Height == 0; }
     // Formatting cells are not visible on the screen, they only alter
     // renderer's state.
     bool IsFormattingCell() const { return m_Width == 0 && m_Height == 0; }


@@ -195,7 +205,12 @@ public:
         { return m_Link; }
 
     // Returns cursor to be used when mouse is over the cell:
         { return m_Link; }
 
     // Returns cursor to be used when mouse is over the cell:

+    virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
+
+#if WXWIN_COMPATIBILITY_2_6
+    // this was replaced by GetMouseCursor, don't use in new code!

     virtual wxCursor GetCursor() const;
     virtual wxCursor GetCursor() const;

+#endif

 
     // return next cell among parent's cells
     wxHtmlCell *GetNext() const {return m_Next;}
 
     // return next cell among parent's cells
     wxHtmlCell *GetNext() const {return m_Next;}


@@ -238,12 +253,23 @@ public:
     //   returns pointer to anchor news
     virtual const wxHtmlCell* Find(int condition, const void* param) const;
 
     //   returns pointer to anchor news
     virtual const wxHtmlCell* Find(int condition, const void* param) const;
 

+

     // This function is called when mouse button is clicked over the cell.
     // This function is called when mouse button is clicked over the cell.

+    // Returns true if a link is clicked, false otherwise.

     //
     //

-    // Parent is pointer to wxHtmlWindow that generated the event
+    // 'window' is pointer to wxHtmlWindowInterface of the window which
+    // generated the event.

     // HINT: if this handling is not enough for you you should use
     //       wxHtmlWidgetCell
     // HINT: if this handling is not enough for you you should use
     //       wxHtmlWidgetCell

-    virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event);
+    virtual bool ProcessMouseClick(wxHtmlWindowInterface *window,
+                                   const wxPoint& pos,
+                                   const wxMouseEvent& event);
+
+#if WXWIN_COMPATIBILITY_2_6
+    // this was replaced by ProcessMouseClick, don't use in new code!
+    virtual void OnMouseClick(wxWindow *window,
+                              int x, int y, const wxMouseEvent& event);
+#endif

 
     // This method used to adjust pagebreak position. The parameter is variable
     // that contains y-coordinate of page break (= horizontal line that should
 
     // This method used to adjust pagebreak position. The parameter is variable
     // that contains y-coordinate of page break (= horizontal line that should


@@ -254,11 +280,13 @@ public:
     // Returned value : true if pagebreak was modified, false otherwise
     // Usage : while (container->AdjustPagebreak(&p)) {}
     virtual bool AdjustPagebreak(int *pagebreak,
     // Returned value : true if pagebreak was modified, false otherwise
     // Usage : while (container->AdjustPagebreak(&p)) {}
     virtual bool AdjustPagebreak(int *pagebreak,

-                                 int *known_pagebreaks = NULL,
-                                 int number_of_pages = 0) const;
+                                 const wxArrayInt& known_pagebreaks,
+                                 int pageHeight) const;

 
     // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
     // is true - the cell can be split on two pages
 
     // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
     // is true - the cell can be split on two pages

+    // If there is no way to fit a cell in the current page size, the cell
+    // is always split, ignoring this setting.

     void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; }
 
     // Can the line be broken before this cell?
     void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; }
 
     // Can the line be broken before this cell?


@@ -277,8 +305,14 @@ public:
     virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
                                   unsigned flags = wxHTML_FIND_EXACT) const;
 
     virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
                                   unsigned flags = wxHTML_FIND_EXACT) const;
 

-    // Returns absolute position of the cell on HTML canvas
-    wxPoint GetAbsPos() const;
+    // Returns absolute position of the cell on HTML canvas.
+    // If rootCell is provided, then it's considered to be the root of the
+    // hierarchy and the returned value is relative to it.
+    wxPoint GetAbsPos(wxHtmlCell *rootCell = NULL) const;
+
+    // Returns root cell of the hierarchy (i.e. grand-grand-...-parent that
+    // doesn't have a parent itself)
+    wxHtmlCell *GetRootCell() const;

 
     // Returns first (last) terminal cell inside this cell. It may return NULL,
     // but it is rare -- only if there are no terminals in the tree.
 
     // Returns first (last) terminal cell inside this cell. It may return NULL,
     // but it is rare -- only if there are no terminals in the tree.


@@ -302,24 +336,29 @@ public:
         { return wxEmptyString; }
 
 protected:
         { return wxEmptyString; }
 
 protected:

+    // pointer to the next cell

     wxHtmlCell *m_Next;
     wxHtmlCell *m_Next;

-            // pointer to the next cell
+    // pointer to parent cell

     wxHtmlContainerCell *m_Parent;
     wxHtmlContainerCell *m_Parent;

-            // pointer to parent cell
+
+    // dimensions of fragment (m_Descent is used to position text & images)

     long m_Width, m_Height, m_Descent;
     long m_Width, m_Height, m_Descent;

-            // dimensions of fragment
-            // m_Descent is used to position text&images..
+    // position where the fragment is drawn:

     long m_PosX, m_PosY;
     long m_PosX, m_PosY;

-            // position where the fragment is drawn
+
+    // superscript/subscript/normal:
+    wxHtmlScriptMode m_ScriptMode;
+    long m_ScriptBaseline;
+
+    // destination address if this fragment is hypertext link, NULL otherwise

     wxHtmlLinkInfo *m_Link;
     wxHtmlLinkInfo *m_Link;

-            // destination address if this fragment is hypertext link, NULL otherwise
+    // true if this cell can be placed on pagebreak, false otherwise

     bool m_CanLiveOnPagebreak;
     bool m_CanLiveOnPagebreak;

-            // true if this cell can be placed on pagebreak, false otherwise
+    // unique identifier of the cell, generated from "id" property of tags

     wxString m_id;
     wxString m_id;

-            // unique identifier of the cell, generated from "id" property of tags

 
     DECLARE_ABSTRACT_CLASS(wxHtmlCell)
 
     DECLARE_ABSTRACT_CLASS(wxHtmlCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlCell);

 };
 
 
 };
 
 


@@ -338,18 +377,23 @@ protected:
 class WXDLLIMPEXP_HTML wxHtmlWordCell : public wxHtmlCell
 {
 public:
 class WXDLLIMPEXP_HTML wxHtmlWordCell : public wxHtmlCell
 {
 public:

-    wxHtmlWordCell(const wxString& word, wxDC& dc);
+    wxHtmlWordCell(const wxString& word, const wxDC& dc);

     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
               wxHtmlRenderingInfo& info);
     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
               wxHtmlRenderingInfo& info);

-    wxCursor GetCursor() const;
-    wxString ConvertToText(wxHtmlSelection *sel) const;
+    virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
+    virtual wxString ConvertToText(wxHtmlSelection *sel) const;

     bool IsLinebreakAllowed() const { return m_allowLinebreak; }
 
     void SetPreviousWord(wxHtmlWordCell *cell);
 
 protected:
     bool IsLinebreakAllowed() const { return m_allowLinebreak; }
 
     void SetPreviousWord(wxHtmlWordCell *cell);
 
 protected:

-    void SetSelectionPrivPos(wxDC& dc, wxHtmlSelection *s) const;
-    void Split(wxDC& dc,
+    virtual wxString GetAllAsText() const
+        { return m_Word; }
+    virtual wxString GetPartAsText(int begin, int end) const
+        { return m_Word.Mid(begin, end - begin); }
+
+    void SetSelectionPrivPos(const wxDC& dc, wxHtmlSelection *s) const;
+    void Split(const wxDC& dc,

                const wxPoint& selFrom, const wxPoint& selTo,
                unsigned& pos1, unsigned& pos2) const;
 
                const wxPoint& selFrom, const wxPoint& selTo,
                unsigned& pos1, unsigned& pos2) const;
 


@@ -357,11 +401,32 @@ protected:
     bool     m_allowLinebreak;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlWordCell)
     bool     m_allowLinebreak;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlWordCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlWordCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWordCell);

 };
 
 
 };
 
 

+// wxHtmlWordCell specialization for storing text fragments with embedded
+// '\t's; these differ from normal words in that the displayed text is
+// different from the text copied to clipboard
+class WXDLLIMPEXP_HTML wxHtmlWordWithTabsCell : public wxHtmlWordCell
+{
+public:
+    wxHtmlWordWithTabsCell(const wxString& word,
+                           const wxString& wordOrig,
+                           size_t linepos,
+                           const wxDC& dc)
+        : wxHtmlWordCell(word, dc),
+          m_wordOrig(wordOrig),
+          m_linepos(linepos)
+    {}
+
+protected:
+    virtual wxString GetAllAsText() const;
+    virtual wxString GetPartAsText(int begin, int end) const;

 
 

+    wxString m_wordOrig;
+    size_t   m_linepos;
+};

 
 
 // Container contains other cells, thus forming tree structure of rendering
 
 
 // Container contains other cells, thus forming tree structure of rendering


@@ -370,14 +435,17 @@ class WXDLLIMPEXP_HTML wxHtmlContainerCell : public wxHtmlCell
 {
 public:
     wxHtmlContainerCell(wxHtmlContainerCell *parent);
 {
 public:
     wxHtmlContainerCell(wxHtmlContainerCell *parent);

-    ~wxHtmlContainerCell();
+    virtual ~wxHtmlContainerCell();

 
     virtual void Layout(int w);
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
                       wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
                                wxHtmlRenderingInfo& info);
 
     virtual void Layout(int w);
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
                       wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
                                wxHtmlRenderingInfo& info);

-    virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const;
+
+    virtual bool AdjustPagebreak(int *pagebreak,
+                                 const wxArrayInt& known_pagebreaks,
+                                 int pageHeight) const;

 
     // insert cell at the end of m_Cells list
     void InsertCell(wxHtmlCell *cell);
 
     // insert cell at the end of m_Cells list
     void InsertCell(wxHtmlCell *cell);


@@ -410,15 +478,23 @@ public:
     // returns background colour (of wxNullColour if none set), so that widgets can
     // adapt to it:
     wxColour GetBackgroundColour();
     // returns background colour (of wxNullColour if none set), so that widgets can
     // adapt to it:
     wxColour GetBackgroundColour();

-    void SetBorder(const wxColour& clr1, const wxColour& clr2) {m_UseBorder = true; m_BorderColour1 = clr1, m_BorderColour2 = clr2;}
+    void SetBorder(const wxColour& clr1, const wxColour& clr2, int border = 1) {m_Border = border; m_BorderColour1 = clr1, m_BorderColour2 = clr2;}

     virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const;
     virtual const wxHtmlCell* Find(int condition, const void* param) const;
     virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const;
     virtual const wxHtmlCell* Find(int condition, const void* param) const;

-    virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event);

 
 

-    virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
-#if WXWIN_COMPATIBILITY_2_4
-    wxDEPRECATED( wxHtmlCell* GetFirstCell() const );
+#if WXWIN_COMPATIBILITY_2_6
+    // this was replaced by ProcessMouseClick, don't use in new code!
+    virtual void OnMouseClick(wxWindow *window,
+                              int x, int y, const wxMouseEvent& event);

 #endif
 #endif

+    virtual bool ProcessMouseClick(wxHtmlWindowInterface *window,
+                                   const wxPoint& pos,
+                                   const wxMouseEvent& event);
+
+    virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
+
+    // returns last child cell:
+    wxHtmlCell* GetLastChild() const { return m_LastCell; }

 
     // see comment in wxHtmlCell about this method
     virtual bool IsTerminalCell() const { return false; }
 
     // see comment in wxHtmlCell about this method
     virtual bool IsTerminalCell() const { return false; }


@@ -432,7 +508,7 @@ public:
 
     // Removes indentation on top or bottom of the container (i.e. above or
     // below first/last terminal cell). For internal use only.
 
     // Removes indentation on top or bottom of the container (i.e. above or
     // below first/last terminal cell). For internal use only.

-    void RemoveExtraSpacing(bool top, bool bottom);
+    virtual void RemoveExtraSpacing(bool top, bool bottom);

 
     // Returns the maximum possible length of the container.
     // Call Layout at least once before using GetMaxTotalWidth()
 
     // Returns the maximum possible length of the container.
     // Call Layout at least once before using GetMaxTotalWidth()


@@ -461,7 +537,8 @@ protected:
     bool m_UseBkColour;
     wxColour m_BkColour;
             // background color of this container
     bool m_UseBkColour;
     wxColour m_BkColour;
             // background color of this container

-    bool m_UseBorder;
+    int m_Border;
+            // border size. Draw only if m_Border > 0

     wxColour m_BorderColour1, m_BorderColour2;
             // borders color of this container
     int m_LastLayout;
     wxColour m_BorderColour1, m_BorderColour2;
             // borders color of this container
     int m_LastLayout;


@@ -472,15 +549,9 @@ protected:
 
 
     DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)
 
 
     DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlContainerCell);

 };
 
 };
 

-#if WXWIN_COMPATIBILITY_2_4
-inline wxHtmlCell* wxHtmlContainerCell::GetFirstCell() const
-    { return GetFirstChild(); }
-#endif
-
-

 
 
 // ---------------------------------------------------------------------------
 
 
 // ---------------------------------------------------------------------------


@@ -502,7 +573,7 @@ protected:
     unsigned m_Flags;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)
     unsigned m_Flags;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlColourCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlColourCell);

 };
 
 
 };
 
 


@@ -526,7 +597,7 @@ protected:
     wxFont m_Font;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)
     wxFont m_Font;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlFontCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlFontCell);

 };
 
 
 };
 
 


@@ -549,7 +620,7 @@ public:
     // it's width according to parent container's width
     // (w is percent of parent's width)
     wxHtmlWidgetCell(wxWindow *wnd, int w = 0);
     // it's width according to parent container's width
     // (w is percent of parent's width)
     wxHtmlWidgetCell(wxWindow *wnd, int w = 0);

-    ~wxHtmlWidgetCell() { m_Wnd->Destroy(); }
+    virtual ~wxHtmlWidgetCell() { m_Wnd->Destroy(); }

     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
                       wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
                       wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,


@@ -562,7 +633,7 @@ protected:
             // width float is used in adjustWidth (it is in percents)
 
     DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell)
             // width float is used in adjustWidth (it is in percents)
 
     DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWidgetCell);

 };
 
 
 };