]> 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 3404b1592c2e2a699f10c4b24e96608343d27d31..046fb2085e7ab58d5a7dca2a8092b769167daffb 100644 (file)
@@ -5,14 +5,14 @@
 // 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_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "htmlcell.h"
 #endif
 
@@ -36,7 +36,7 @@ class WXDLLIMPEXP_HTML wxHtmlContainerCell;
 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) {}
@@ -44,14 +44,14 @@ public:
     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; }
-    
+
     // these are From/ToCell's private data
     const wxPoint& GetFromPrivPos() const { return m_fromPrivPos; }
     const wxPoint& GetToPrivPos() const { return m_toPrivPos; }
@@ -59,8 +59,8 @@ public:
     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:
@@ -85,14 +85,14 @@ class WXDLLIMPEXP_HTML wxHtmlRenderingState
 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; }
-    
+
 private:
     wxHtmlSelectionState  m_selState;
     wxColour              m_fgColour, m_bgColour;
@@ -127,12 +127,12 @@ public:
 
     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;
@@ -172,6 +172,11 @@ 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;}
 
@@ -254,14 +259,14 @@ 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; }
-    
+
     // 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.
@@ -276,20 +281,20 @@ public:
 
     // 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); }
-    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;
-    
+
     // 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
@@ -312,6 +317,7 @@ protected:
     wxString m_id;
             // unique identifier of the cell, generated from "id" property of tags
 
+    DECLARE_ABSTRACT_CLASS(wxHtmlCell)
     DECLARE_NO_COPY_CLASS(wxHtmlCell)
 };
 
@@ -345,9 +351,12 @@ protected:
     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)
 };
 
 
@@ -396,11 +405,11 @@ 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);
@@ -411,20 +420,29 @@ public:
 #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_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(wxHtmlRenderingInfo& info,
                                  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
@@ -448,7 +466,11 @@ 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)
 };
 
@@ -477,6 +499,9 @@ public:
 protected:
     wxColour m_Colour;
     unsigned m_Flags;
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlColourCell)
 };
 
 
@@ -498,6 +523,9 @@ public:
 
 protected:
     wxFont m_Font;
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlFontCell)
 };
 
 
@@ -532,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)
 };