]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/htmlcell.h
Rebake from clean wx tree.
[wxWidgets.git] / include / wx / html / htmlcell.h
index f06788d65bb499b3e9a6ecb484eec92af38ac5e1..9a242b09a4a23461c883b7387aa245ca6bbfe1fe 100644 (file)
 #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.
@@ -145,6 +146,13 @@ enum
 };
 
 
+// Superscript/subscript/normal script mode of a cell
+enum wxHtmlScriptMode
+{
+    wxHTML_SCRIPT_NORMAL,
+    wxHTML_SCRIPT_SUB,
+    wxHTML_SCRIPT_SUP
+};
 
 
 // ---------------------------------------------------------------------------
@@ -176,6 +184,10 @@ public:
     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; }
@@ -190,7 +202,12 @@ public:
         { 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;
+#endif
 
     // return next cell among parent's cells
     wxHtmlCell *GetNext() const {return m_Next;}
@@ -233,12 +250,23 @@ public:
     //   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.
+    // 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
-    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
@@ -249,8 +277,7 @@ public:
     // 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;
+                                 wxArrayInt& known_pagebreaks) const;
 
     // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
     // is true - the cell can be split on two pages
@@ -272,8 +299,14 @@ public:
     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.
@@ -297,24 +330,29 @@ public:
         { return wxEmptyString; }
 
 protected:
+    // pointer to the next cell
     wxHtmlCell *m_Next;
-            // pointer to the next cell
+    // pointer to parent cell
     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;
-            // dimensions of fragment
-            // m_Descent is used to position text&images..
+    // position where the fragment is drawn:
     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;
-            // destination address if this fragment is hypertext link, NULL otherwise
+    // true if this cell can be placed on pagebreak, false otherwise
     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;
-            // unique identifier of the cell, generated from "id" property of tags
 
     DECLARE_ABSTRACT_CLASS(wxHtmlCell)
-    DECLARE_NO_COPY_CLASS(wxHtmlCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlCell);
 };
 
 
@@ -336,13 +374,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);
-    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:
+    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,
@@ -352,11 +395,32 @@ protected:
     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
@@ -365,14 +429,15 @@ class WXDLLIMPEXP_HTML wxHtmlContainerCell : public wxHtmlCell
 {
 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 bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const;
+/*    virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const;*/
+    virtual bool AdjustPagebreak(int *pagebreak, wxArrayInt& known_pagebreaks) const;
 
     // insert cell at the end of m_Cells list
     void InsertCell(wxHtmlCell *cell);
@@ -405,15 +470,23 @@ public:
     // 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 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
+    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; }
@@ -456,7 +529,8 @@ protected:
     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;
@@ -467,15 +541,9 @@ protected:
 
 
     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
-
-
 
 
 // ---------------------------------------------------------------------------
@@ -497,7 +565,7 @@ protected:
     unsigned m_Flags;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)
-    DECLARE_NO_COPY_CLASS(wxHtmlColourCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlColourCell);
 };
 
 
@@ -521,7 +589,7 @@ protected:
     wxFont m_Font;
 
     DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)
-    DECLARE_NO_COPY_CLASS(wxHtmlFontCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlFontCell);
 };
 
 
@@ -544,7 +612,7 @@ public:
     // 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,
@@ -557,7 +625,7 @@ protected:
             // width float is used in adjustWidth (it is in percents)
 
     DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell)
-    DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWidgetCell);
 };