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 6e50289cc99a10be4319670d19b497d2f2ef44eb..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


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

-class WXDLLIMPEXP_HTML wxHtmlWindowInterface;
-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.


@@ -34,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);


@@ -49,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 &&


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


@@ -277,10 +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,

-                                 wxArrayInt& known_pagebreaks) 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?


@@ -352,7 +358,7 @@ protected:
     wxString m_id;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlCell)
     wxString m_id;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlCell);

 };
 
 
 };
 
 


@@ -375,12 +381,17 @@ public:
     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
               wxHtmlRenderingInfo& info);
     virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
               wxHtmlRenderingInfo& info);
     virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;

-    wxString ConvertToText(wxHtmlSelection *sel) 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:

+    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,
     void SetSelectionPrivPos(const wxDC& dc, wxHtmlSelection *s) const;
     void Split(const wxDC& dc,
                const wxPoint& selFrom, const wxPoint& selTo,


@@ -390,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


@@ -410,8 +442,10 @@ public:
                       wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
                                wxHtmlRenderingInfo& info);
                       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, wxArrayInt& known_pagebreaks) 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);


@@ -444,7 +478,7 @@ 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;
 


@@ -503,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;


@@ -514,7 +549,7 @@ protected:
 
 
     DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)
 
 
     DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)

-    DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlContainerCell);

 };
 
 
 };
 
 


@@ -538,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);

 };
 
 
 };
 
 


@@ -562,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);

 };
 
 
 };
 
 


@@ -598,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);

 };
 
 
 };