Don't define __STRICT_ANSI__, we should build both with and without it.

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

diff --git a/include/wx/html/htmlcell.h b/include/wx/html/htmlcell.h
index 62afdebae42b1afd7825265f0247352c04a8d05a..7f40f94ed5c20b12b9bb8fa72d1d57d3e951f9fb 100644 (file)
--- a/include/wx/html/htmlcell.h
+++ b/include/wx/html/htmlcell.h
@@ -1,9 +1,8 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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

-// RCS-ID:      $Id$

 // Copyright:   (c) 1999-2003 Vaclav Slavik
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 1999-2003 Vaclav Slavik
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -20,9 +19,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.


@@ -33,9 +33,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);


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


@@ -60,7 +63,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;
 };
 


@@ -87,10 +90,13 @@ public:
     const wxColour& GetFgColour() const { return m_fgColour; }
     void SetBgColour(const wxColour& c) { m_bgColour = c; }
     const wxColour& GetBgColour() const { return m_bgColour; }
     const wxColour& GetFgColour() const { return m_fgColour; }
     void SetBgColour(const wxColour& c) { m_bgColour = c; }
     const wxColour& GetBgColour() const { return m_bgColour; }

+    void SetBgMode(int m) { m_bgMode = m; }
+    int GetBgMode() const { return m_bgMode; }

 
 private:
     wxHtmlSelectionState  m_selState;
     wxColour              m_fgColour, m_bgColour;
 
 private:
     wxHtmlSelectionState  m_selState;
     wxColour              m_fgColour, m_bgColour;

+    int                   m_bgMode;

 };
 
 
 };
 
 


@@ -200,8 +206,21 @@ public:
                                     int WXUNUSED(y) = 0) const
         { return m_Link; }
 
                                     int WXUNUSED(y) = 0) const
         { return m_Link; }
 

-    // Returns cursor to be used when mouse is over the cell:
+    // Returns cursor to be used when mouse is over the cell, can be
+    // overridden by the derived classes to use a different cursor whenever the
+    // mouse is over this cell.
+    virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
+
+    // Returns cursor to be used when mouse is over the given point, can be
+    // overridden if the cursor should change depending on where exactly inside
+    // the cell the mouse is.
+    virtual wxCursor GetMouseCursorAt(wxHtmlWindowInterface *window,
+                                      const wxPoint& relPos) 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;}


@@ -244,12 +263,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


@@ -260,11 +290,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?


@@ -283,8 +315,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.


@@ -314,9 +352,9 @@ protected:
     wxHtmlContainerCell *m_Parent;
 
     // dimensions of fragment (m_Descent is used to position text & images)
     wxHtmlContainerCell *m_Parent;
 
     // dimensions of fragment (m_Descent is used to position text & images)

-    long m_Width, m_Height, m_Descent;
+    int m_Width, m_Height, m_Descent;

     // position where the fragment is drawn:
     // position where the fragment is drawn:

-    long m_PosX, m_PosY;
+    int m_PosX, m_PosY;

 
     // superscript/subscript/normal:
     wxHtmlScriptMode m_ScriptMode;
 
     // superscript/subscript/normal:
     wxHtmlScriptMode m_ScriptMode;


@@ -330,7 +368,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);

 };
 
 
 };
 
 


@@ -352,13 +390,18 @@ public:
     wxHtmlWordCell(const wxString& word, const wxDC& dc);
     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
               wxHtmlRenderingInfo& info);
     wxHtmlWordCell(const wxString& word, const wxDC& dc);
     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:

+    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,


@@ -368,11 +411,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


@@ -381,14 +445,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);


@@ -417,19 +484,25 @@ public:
     // sets minimal height of this container.
     void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align; m_LastLayout = -1;}
 
     // sets minimal height of this container.
     void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align; m_LastLayout = -1;}
 

-    void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = true; m_BkColour = clr;}
+    void SetBackgroundColour(const wxColour& clr) {m_BkColour = clr;}

     // 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; }
 
     // returns last child cell:
     wxHtmlCell* GetLastChild() const { return m_LastCell; }
 


@@ -471,10 +544,10 @@ protected:
             // alignment horizontal and vertical (left, center, right)
     int m_WidthFloat, m_WidthFloatUnits;
             // width float is used in adjustWidth
             // alignment horizontal and vertical (left, center, right)
     int m_WidthFloat, m_WidthFloatUnits;
             // width float is used in adjustWidth

-    bool m_UseBkColour;

     wxColour m_BkColour;
             // background color of this container
     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;


@@ -485,15 +558,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
-
-

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


@@ -515,7 +582,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);

 };
 
 
 };
 
 


@@ -539,7 +606,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);

 };
 
 
 };
 
 


@@ -562,7 +629,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,


@@ -575,7 +642,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);

 };
 
 
 };