]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/htmlcell.h
IS_HATCH macro replaced with wxBrush::IsHatch() + source and docs little cleaning.
[wxWidgets.git] / include / wx / html / htmlcell.h
index 390af0c9ea627bb269d6a7b4383654f674ce73ac..046fb2085e7ab58d5a7dca2a8092b769167daffb 100644 (file)
@@ -4,15 +4,15 @@
 //              as a basic visual element of HTML page
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
-// Copyright:   (c) 1999 Vaclav Slavik
-// Licence:     wxWindows Licence
+// Copyright:   (c) 1999-2003 Vaclav Slavik
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 #ifndef _WX_HTMLCELL_H_
 #define _WX_HTMLCELL_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "htmlcell.h"
 #endif
 
 #include "wx/window.h"
 
 
-class WXDLLEXPORT wxHtmlLinkInfo;
-class WXDLLEXPORT wxHtmlCell;
-class WXDLLEXPORT wxHtmlContainerCell;
+class WXDLLIMPEXP_HTML wxHtmlLinkInfo;
+class WXDLLIMPEXP_HTML wxHtmlCell;
+class WXDLLIMPEXP_HTML wxHtmlContainerCell;
 
 
 // wxHtmlSelection is data holder with information about text selection.
 // Selection is defined by two positions (beginning and end of the selection)
 // and two leaf(!) cells at these positions.
-class WXDLLEXPORT wxHtmlSelection
+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) {}
 
-    void Set(const wxPoint& fromPos, wxHtmlCell *fromCell,
-             const wxPoint& toPos, wxHtmlCell *toCell)
-    {
-        m_fromCell = fromCell;
-        m_toCell = toCell;
-        m_fromPos = fromPos;
-        m_toPos = toPos;
-    }
-    
-    wxHtmlCell *GetFromCell() const { return m_fromCell; }
-    wxHtmlCell *GetToCell() const { return m_toCell; }
-    
-    // these values are *relative* to From/To cell's origin:
+    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; }
+
+    // these values are in absolute coordinates:
     const wxPoint& GetFromPos() const { return m_fromPos; }
     const wxPoint& GetToPos() const { return m_toPos; }
 
-    const bool IsEmpty() const 
-        { return m_fromPos == wxDefaultPosition && 
+    // 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; }
+
+    bool IsEmpty() const
+        { return m_fromPos == wxDefaultPosition &&
                  m_toPos == wxDefaultPosition; }
 
 private:
-    wxPoint     m_fromPos,   m_toPos;
-    wxHtmlCell *m_fromCell, *m_toCell;
+    wxPoint m_fromPos, m_toPos;
+    wxPoint m_fromPrivPos, m_toPrivPos;
+    const wxHtmlCell *m_fromCell, *m_toCell;
 };
 
 
@@ -76,35 +80,77 @@ enum wxHtmlSelectionState
 
 // Selection state is passed to wxHtmlCell::Draw so that it can render itself
 // differently e.g. when inside text selection or outside it.
-class WXDLLEXPORT wxHtmlRenderingState
+class WXDLLIMPEXP_HTML wxHtmlRenderingState
 {
 public:
-    wxHtmlRenderingState(wxHtmlSelection *s)
-        : m_selection(s), m_selState(wxHTML_SEL_OUT) {}
-    wxHtmlSelection *GetSelection() const { return m_selection; }
+    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; }
-    
+
 private:
-    wxHtmlSelection      *m_selection;
     wxHtmlSelectionState  m_selState;
     wxColour              m_fgColour, m_bgColour;
 };
 
+
+// HTML rendering customization. This class is used when rendering wxHtmlCells
+// as a callback:
+class WXDLLIMPEXP_HTML wxHtmlRenderingStyle
+{
+public:
+    virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
+    virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
+};
+
+// Standard style:
+class WXDLLIMPEXP_HTML wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
+{
+public:
+    virtual wxColour GetSelectedTextColour(const wxColour& clr);
+    virtual wxColour GetSelectedTextBgColour(const wxColour& clr);
+};
+
+
+// Information given to cells when drawing them. Contains rendering state,
+// selection information and rendering style object that can be used to
+// customize the output.
+class WXDLLIMPEXP_HTML wxHtmlRenderingInfo
+{
+public:
+    wxHtmlRenderingInfo() : m_selection(NULL), m_style(NULL) {}
+
+    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; }
+
+protected:
+    wxHtmlSelection      *m_selection;
+    wxHtmlRenderingStyle *m_style;
+    wxHtmlRenderingState m_state;
+};
+
+
 // Flags for wxHtmlCell::FindCellByPos
 enum
 {
-    wxHTML_FIND_TERMINAL    = 0x0001,
-    wxHTML_FIND_NONTERMINAL = 0x0002
+    wxHTML_FIND_EXACT             = 1,
+    wxHTML_FIND_NEAREST_BEFORE    = 2,
+    wxHTML_FIND_NEAREST_AFTER     = 4
 };
 
 
+
+
 // ---------------------------------------------------------------------------
 // wxHtmlCell
 //                  Internal data structure. It represents fragments of parsed
@@ -114,7 +160,7 @@ enum
 // ---------------------------------------------------------------------------
 
 
-class WXDLLEXPORT wxHtmlCell : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlCell : public wxObject
 {
 public:
     wxHtmlCell();
@@ -126,19 +172,34 @@ public:
     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; }
+
     int GetHeight() const {return m_Height;}
     int GetDescent() const {return m_Descent;}
 
+    // Formatting cells are not visible on the screen, they only alter
+    // renderer's state.
+    bool IsFormattingCell() const { return m_Width == 0 && m_Height == 0; }
+
     const wxString& GetId() const { return m_id; }
     void SetId(const wxString& id) { m_id = id; }
 
     // returns the link associated with this cell. The position is position
     // within the cell so it varies from 0 to m_Width, from 0 to m_Height
-    virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0, int WXUNUSED(y) = 0) const
+    virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0,
+                                    int WXUNUSED(y) = 0) const
         { return m_Link; }
 
-    // members access methods
+    // Returns cursor to be used when mouse is over the cell:
+    virtual wxCursor GetCursor() const;
+
+    // return next cell among parent's cells
     wxHtmlCell *GetNext() const {return m_Next;}
+    // returns first child cell (if there are any, i.e. if this is container):
+    virtual wxHtmlCell* GetFirstChild() const { return NULL; }
 
     // members writing methods
     virtual void SetPos(int x, int y) {m_PosX = x, m_PosY = y;}
@@ -156,13 +217,13 @@ public:
     virtual void Draw(wxDC& WXUNUSED(dc),
                       int WXUNUSED(x), int WXUNUSED(y),
                       int WXUNUSED(view_y1), int WXUNUSED(view_y2),
-                      wxHtmlRenderingState& WXUNUSED(state)) {}
+                      wxHtmlRenderingInfo& WXUNUSED(info)) {}
 
     // proceed drawing actions in case the cell is not visible (scrolled out of
     // screen).  This is needed to change fonts, colors and so on.
     virtual void DrawInvisible(wxDC& WXUNUSED(dc),
                                int WXUNUSED(x), int WXUNUSED(y),
-                               wxHtmlRenderingState& WXUNUSED(state)) {}
+                               wxHtmlRenderingInfo& WXUNUSED(info)) {}
 
     // This method returns pointer to the FIRST cell for that
     // the condition
@@ -199,15 +260,13 @@ public:
     // is true - the cell can be split on two pages
     void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; }
 
-    // Returns y-coordinates that contraint the cell, i.e. left is highest
-    // and right lowest coordinate such that the cell lays between then.
-    // Note: this method does not return meaningful values if you haven't
-    //       called Layout() before!
-    virtual void GetHorizontalConstraints(int *left, int *right) const;
+    // Can the line be broken before this cell?
+    virtual bool IsLinebreakAllowed() const
+        { return !IsFormattingCell(); }
 
     // Returns true for simple == terminal cells, i.e. not composite ones.
     // This if for internal usage only and may disappear in future versions!
-    virtual bool IsTerminalCell() const { return TRUE; }
+    virtual bool IsTerminalCell() const { return true; }
 
     // Find a cell inside this cell positioned at the given coordinates
     // (relative to this's positions). Returns NULL if no such cell exists.
@@ -215,7 +274,31 @@ public:
     // nonterminal cells or both. In either case, returned cell is deepest
     // cell in cells tree that contains [x,y].
     virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
-                                  unsigned flags = wxHTML_FIND_TERMINAL) const;
+                                  unsigned flags = wxHTML_FIND_EXACT) const;
+
+    // Returns absolute position of the cell on HTML canvas
+    wxPoint GetAbsPos() 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.
+    virtual wxHtmlCell *GetFirstTerminal() const
+        { return wxConstCast(this, wxHtmlCell); }
+    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;
+
+    // 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:
     wxHtmlCell *m_Next;
@@ -234,31 +317,46 @@ protected:
     wxString m_id;
             // unique identifier of the cell, generated from "id" property of tags
 
+    DECLARE_ABSTRACT_CLASS(wxHtmlCell)
     DECLARE_NO_COPY_CLASS(wxHtmlCell)
 };
 
 
 
 
-//--------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 // Inherited cells:
-//--------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 
 
-//--------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 // wxHtmlWordCell
 //                  Single word in input stream.
-//--------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlWordCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlWordCell : public wxHtmlCell
 {
 public:
     wxHtmlWordCell(const wxString& word, wxDC& dc);
     void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
-              wxHtmlRenderingState& state);
+              wxHtmlRenderingInfo& info);
+    wxCursor GetCursor() const;
+    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,
+               const wxPoint& selFrom, const wxPoint& selTo,
+               unsigned& pos1, unsigned& pos2) const;
+
     wxString m_Word;
+    bool     m_allowLinebreak;
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlWordCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlWordCell)
 };
 
 
@@ -267,7 +365,7 @@ protected:
 
 // Container contains other cells, thus forming tree structure of rendering
 // elements. Basic code of layout algorithm is contained in this class.
-class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlContainerCell : public wxHtmlCell
 {
 public:
     wxHtmlContainerCell(wxHtmlContainerCell *parent);
@@ -275,9 +373,9 @@ public:
 
     virtual void Layout(int w);
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
-                      wxHtmlRenderingState& state);
+                      wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
-                               wxHtmlRenderingState& state);
+                               wxHtmlRenderingInfo& info);
     virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const;
 
     // insert cell at the end of m_Cells list
@@ -307,31 +405,44 @@ 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;}
 
-    void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = TRUE; m_BkColour = clr;}
+    void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = true; m_BkColour = clr;}
     // 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) {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);
-    virtual void GetHorizontalConstraints(int *left, int *right) const;
 
-    // returns pointer to the first cell in container or NULL
-    wxHtmlCell* GetFirstCell() const {return m_Cells;}
+    virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
+#if WXWIN_COMPATIBILITY_2_4
+    wxDEPRECATED( wxHtmlCell* GetFirstCell() const );
+#endif
 
     // see comment in wxHtmlCell about this method
-    virtual bool IsTerminalCell() const { return FALSE; }
+    virtual bool IsTerminalCell() const { return false; }
 
     virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
-                                  unsigned flags = wxHTML_FIND_TERMINAL) const;
+                                  unsigned flags = wxHTML_FIND_EXACT) 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.
+    void RemoveExtraSpacing(bool top, bool bottom);
+
+    // Returns the maximum possible length of the container.
+    // Call Layout at least once before using GetMaxTotalWidth()
+    virtual int GetMaxTotalWidth() const { return m_MaxTotalWidth; }
 
 protected:
-    void UpdateRenderingStatePre(wxHtmlRenderingState& state,
+    void UpdateRenderingStatePre(wxHtmlRenderingInfo& info,
                                  wxHtmlCell *cell) const;
-    void UpdateRenderingStatePost(wxHtmlRenderingState& state,
+    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
@@ -355,31 +466,42 @@ protected:
     int m_LastLayout;
             // if != -1 then call to Layout may be no-op
             // if previous call to Layout has same argument
+    int m_MaxTotalWidth;
+            // Maximum possible length if ignoring line wrap
 
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)
     DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
 };
 
+#if WXWIN_COMPATIBILITY_2_4
+inline wxHtmlCell* wxHtmlContainerCell::GetFirstCell() const
+    { return GetFirstChild(); }
+#endif
 
 
 
 
-//--------------------------------------------------------------------------------
+// ---------------------------------------------------------------------------
 // wxHtmlColourCell
 //                  Color changer.
-//--------------------------------------------------------------------------------
+// ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlColourCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlColourCell : public wxHtmlCell
 {
 public:
     wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;}
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
-                      wxHtmlRenderingState& state);
+                      wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
-                               wxHtmlRenderingState& state);
+                               wxHtmlRenderingInfo& info);
 
 protected:
     wxColour m_Colour;
     unsigned m_Flags;
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlColourCell)
 };
 
 
@@ -390,17 +512,20 @@ protected:
 //                  Sets actual font used for text rendering
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlFontCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlFontCell : public wxHtmlCell
 {
 public:
     wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); }
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
-                      wxHtmlRenderingState& state);
+                      wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
-                               wxHtmlRenderingState& state);
+                               wxHtmlRenderingInfo& info);
 
 protected:
     wxFont m_Font;
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlFontCell)
 };
 
 
@@ -415,7 +540,7 @@ protected:
 //                  (buttons, input boxes etc.)
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlWidgetCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlWidgetCell : public wxHtmlCell
 {
 public:
     // !!! wnd must have correct parent!
@@ -425,9 +550,9 @@ public:
     wxHtmlWidgetCell(wxWindow *wnd, int w = 0);
     ~wxHtmlWidgetCell() { m_Wnd->Destroy(); }
     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
-                      wxHtmlRenderingState& state);
+                      wxHtmlRenderingInfo& info);
     virtual void DrawInvisible(wxDC& dc, int x, int y,
-                               wxHtmlRenderingState& state);
+                               wxHtmlRenderingInfo& info);
     virtual void Layout(int w);
 
 protected:
@@ -435,6 +560,7 @@ protected:
     int m_WidthFloat;
             // width float is used in adjustWidth (it is in percents)
 
+    DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell)
     DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell)
 };
 
@@ -445,7 +571,7 @@ protected:
 //                  Internal data structure. It represents hypertext link
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlLinkInfo : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlLinkInfo : public wxObject
 {
 public:
     wxHtmlLinkInfo() : wxObject()
@@ -475,6 +601,26 @@ private:
 
 
 
+// ----------------------------------------------------------------------------
+// wxHtmlTerminalCellsInterator
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_HTML wxHtmlTerminalCellsInterator
+{
+public:
+    wxHtmlTerminalCellsInterator(const wxHtmlCell *from, const wxHtmlCell *to)
+        : m_to(to), m_pos(from) {}
+
+    operator bool() const { return m_pos != NULL; }
+    const wxHtmlCell* operator++();
+    const wxHtmlCell* operator->() const { return m_pos; }
+    const wxHtmlCell* operator*() const { return m_pos; }
+
+private:
+    const wxHtmlCell *m_to, *m_pos;
+};
+
+
 
 #endif // wxUSE_HTML