renamed m_boxes to m_buttons because, well, it contains the radio buttons and not...

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

diff --git a/include/wx/html/htmlcell.h b/include/wx/html/htmlcell.h
index 3edeabacc3e440852a258f786e66404be5b4a014..f5610c6e3d1daf49a822e2743641226f4dceb3ba 100644 (file)
--- a/include/wx/html/htmlcell.h
+++ b/include/wx/html/htmlcell.h
@@ -5,17 +5,12 @@
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999-2003 Vaclav Slavik
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999-2003 Vaclav Slavik

-// 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,6 +20,7 @@
 #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_HTML wxHtmlLinkInfo;
 class WXDLLIMPEXP_HTML wxHtmlCell;
 class WXDLLIMPEXP_HTML wxHtmlContainerCell;


@@ -36,7 +32,7 @@ class WXDLLIMPEXP_HTML wxHtmlContainerCell;
 class WXDLLIMPEXP_HTML wxHtmlSelection
 {
 public:
 class WXDLLIMPEXP_HTML wxHtmlSelection
 {
 public:

-    wxHtmlSelection() 
+    wxHtmlSelection()

         : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),
           m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition),
           m_fromCell(NULL), m_toCell(NULL) {}
         : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),
           m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition),
           m_fromCell(NULL), m_toCell(NULL) {}


@@ -44,14 +40,14 @@ public:
     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);

-    
+

     const wxHtmlCell *GetFromCell() const { return m_fromCell; }
     const wxHtmlCell *GetToCell() const { return m_toCell; }
     const wxHtmlCell *GetFromCell() const { return m_fromCell; }
     const wxHtmlCell *GetToCell() const { return m_toCell; }

-    
+

     // these values are in absolute coordinates:
     const wxPoint& GetFromPos() const { return m_fromPos; }
     const wxPoint& GetToPos() const { return m_toPos; }
     // these values are in absolute coordinates:
     const wxPoint& GetFromPos() const { return m_fromPos; }
     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; }
     // these are From/ToCell's private data
     const wxPoint& GetFromPrivPos() const { return m_fromPrivPos; }
     const wxPoint& GetToPrivPos() const { return m_toPrivPos; }


@@ -59,8 +55,8 @@ public:
     void SetToPrivPos(const wxPoint& pos) { m_toPrivPos = pos; }
     void ClearPrivPos() { m_toPrivPos = m_fromPrivPos = wxDefaultPosition; }
 
     void SetToPrivPos(const wxPoint& pos) { m_toPrivPos = pos; }
     void ClearPrivPos() { m_toPrivPos = m_fromPrivPos = wxDefaultPosition; }
 

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

                  m_toPos == wxDefaultPosition; }
 
 private:
                  m_toPos == wxDefaultPosition; }
 
 private:


@@ -85,14 +81,14 @@ class WXDLLIMPEXP_HTML wxHtmlRenderingState
 public:
     wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {}
 
 public:
     wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {}
 

-    void SetSelectionState(wxHtmlSelectionState s) { m_selState = s; }  
+    void SetSelectionState(wxHtmlSelectionState s) { m_selState = s; }

     wxHtmlSelectionState GetSelectionState() const { return m_selState; }
 
     void SetFgColour(const wxColour& c) { m_fgColour = c; }
     const wxColour& GetFgColour() const { return m_fgColour; }
     void SetBgColour(const wxColour& c) { m_bgColour = c; }
     const wxColour& GetBgColour() const { return m_bgColour; }
     wxHtmlSelectionState GetSelectionState() const { return m_selState; }
 
     void SetFgColour(const wxColour& c) { m_fgColour = c; }
     const wxColour& GetFgColour() const { return m_fgColour; }
     void SetBgColour(const wxColour& c) { m_bgColour = c; }
     const wxColour& GetBgColour() const { return m_bgColour; }

-    
+

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


@@ -104,6 +100,7 @@ private:
 class WXDLLIMPEXP_HTML wxHtmlRenderingStyle
 {
 public:
 class WXDLLIMPEXP_HTML wxHtmlRenderingStyle
 {
 public:

+    virtual ~wxHtmlRenderingStyle() {}

     virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
     virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
 };
     virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
     virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
 };


@@ -127,12 +124,12 @@ public:
 
     void SetSelection(wxHtmlSelection *s) { m_selection = s; }
     wxHtmlSelection *GetSelection() const { return m_selection; }
 
     void SetSelection(wxHtmlSelection *s) { m_selection = s; }
     wxHtmlSelection *GetSelection() const { return m_selection; }

-    
+

     void SetStyle(wxHtmlRenderingStyle *style) { m_style = style; }
     wxHtmlRenderingStyle& GetStyle() { return *m_style; }
 
     wxHtmlRenderingState& GetState() { return m_state; }
     void SetStyle(wxHtmlRenderingStyle *style) { m_style = style; }
     wxHtmlRenderingStyle& GetStyle() { return *m_style; }
 
     wxHtmlRenderingState& GetState() { return m_state; }

-    
+

 protected:
     wxHtmlSelection      *m_selection;
     wxHtmlRenderingStyle *m_style;
 protected:
     wxHtmlSelection      *m_selection;
     wxHtmlRenderingStyle *m_style;


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

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

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


@@ -172,7 +176,7 @@ public:
     int GetPosX() const {return m_PosX;}
     int GetPosY() const {return m_PosY;}
     int GetWidth() const {return m_Width;}
     int GetPosX() const {return m_PosX;}
     int GetPosY() const {return m_PosY;}
     int GetWidth() const {return m_Width;}

-    
+

     // Returns the maximum possible length of the cell.
     // Call Layout at least once before using GetMaxTotalWidth()
     virtual int GetMaxTotalWidth() const { return m_Width; }
     // Returns the maximum possible length of the cell.
     // Call Layout at least once before using GetMaxTotalWidth()
     virtual int GetMaxTotalWidth() const { return m_Width; }


@@ -180,6 +184,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; }


@@ -194,7 +202,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;}


@@ -237,12 +250,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


@@ -259,7 +283,7 @@ public:
     // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
     // is true - the cell can be split on two pages
     void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; }
     // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
     // is true - the cell can be split on two pages
     void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; }

-    
+

     // Can the line be broken before this cell?
     virtual bool IsLinebreakAllowed() const
         { return !IsFormattingCell(); }
     // Can the line be broken before this cell?
     virtual bool IsLinebreakAllowed() const
         { return !IsFormattingCell(); }


@@ -276,46 +300,57 @@ 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.

-    virtual wxHtmlCell *GetFirstTerminal() const 
+    virtual wxHtmlCell *GetFirstTerminal() const

         { return wxConstCast(this, wxHtmlCell); }
         { return wxConstCast(this, wxHtmlCell); }

-    virtual wxHtmlCell *GetLastTerminal() const 
+    virtual wxHtmlCell *GetLastTerminal() const

         { return wxConstCast(this, wxHtmlCell); }
 
     // Returns cell's depth, i.e. how far under the root cell it is
     // (if it is the root, depth is 0)
     unsigned GetDepth() const;
         { return wxConstCast(this, wxHtmlCell); }
 
     // Returns cell's depth, i.e. how far under the root cell it is
     // (if it is the root, depth is 0)
     unsigned GetDepth() const;

-    
+

     // Returns true if the cell appears before 'cell' in natural order of
     // cells (= as they are read). If cell A is (grand)parent of cell B,
     // then both A.IsBefore(B) and B.IsBefore(A) always return true.
     bool IsBefore(wxHtmlCell *cell) const;
     // Returns true if the cell appears before 'cell' in natural order of
     // cells (= as they are read). If cell A is (grand)parent of cell B,
     // then both A.IsBefore(B) and B.IsBefore(A) always return true.
     bool IsBefore(wxHtmlCell *cell) const;

-    
+

     // Converts the cell into text representation. If sel != NULL then
     // only part of the cell inside the selection is converted.
     virtual wxString ConvertToText(wxHtmlSelection *WXUNUSED(sel)) const
         { return wxEmptyString; }
 
 protected:
     // Converts the cell into text representation. If sel != NULL then
     // only part of the cell inside the selection is converted.
     virtual wxString ConvertToText(wxHtmlSelection *WXUNUSED(sel)) const
         { 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_NO_COPY_CLASS(wxHtmlCell)
 
     DECLARE_ABSTRACT_CLASS(wxHtmlCell)
     DECLARE_NO_COPY_CLASS(wxHtmlCell)


@@ -337,21 +372,21 @@ 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;
+    virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;

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

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

-    
+

     wxString m_Word;
     bool     m_allowLinebreak;
 
     wxString m_Word;
     bool     m_allowLinebreak;
 


@@ -412,26 +447,36 @@ public:
     void SetBorder(const wxColour& clr1, const wxColour& clr2) {m_UseBorder = true; 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;
     void SetBorder(const wxColour& clr1, const wxColour& clr2) {m_UseBorder = true; 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);
+
+#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; }
 #if WXWIN_COMPATIBILITY_2_4
     wxDEPRECATED( wxHtmlCell* GetFirstCell() const );
 #endif
 
     virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
 #if WXWIN_COMPATIBILITY_2_4
     wxDEPRECATED( wxHtmlCell* GetFirstCell() const );
 #endif

+    // returns last child cell:
+    wxHtmlCell* GetLastChild() const { return m_LastCell; }

 
     // see comment in wxHtmlCell about this method
     virtual bool IsTerminalCell() const { return false; }
 
     virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
                                   unsigned flags = wxHTML_FIND_EXACT) const;
 
     // see comment in wxHtmlCell about this method
     virtual bool IsTerminalCell() const { return false; }
 
     virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
                                   unsigned flags = wxHTML_FIND_EXACT) const;

-    
+

     virtual wxHtmlCell *GetFirstTerminal() const;
     virtual wxHtmlCell *GetLastTerminal() const;
     virtual wxHtmlCell *GetFirstTerminal() const;
     virtual wxHtmlCell *GetLastTerminal() const;

-    
-    
+
+

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


@@ -442,7 +487,7 @@ protected:
                                  wxHtmlCell *cell) const;
     void UpdateRenderingStatePost(wxHtmlRenderingInfo& info,
                                   wxHtmlCell *cell) const;
                                  wxHtmlCell *cell) const;
     void UpdateRenderingStatePost(wxHtmlRenderingInfo& info,
                                   wxHtmlCell *cell) const;

-    
+

 protected:
     int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom;
             // indentation of subcells. There is always m_Indent pixels
 protected:
     int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom;
             // indentation of subcells. There is always m_Indent pixels


@@ -469,7 +514,7 @@ protected:
     int m_MaxTotalWidth;
             // Maximum possible length if ignoring line wrap
 
     int m_MaxTotalWidth;
             // Maximum possible length if ignoring line wrap
 

-    
+

     DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)
     DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
 };
     DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)
     DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
 };