]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/htmlcell.h
I changed wxUSE_HTML (and other related wxUSEs) to 1. wxHTML is stable enough and...
[wxWidgets.git] / include / wx / html / htmlcell.h
index e413f3764b390993d5bf63e492ea5c80681da1c0..0dd32f2fea5c8bfcd16de22bd3b4af69a7ceae17 100644 (file)
@@ -3,16 +3,17 @@
 // 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 Vaclav Slavik
 // Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 
 
-#ifndef __HTMLCELL_H__
-#define __HTMLCELL_H__
+#ifndef _WX_HTMLCELL_H_
+#define _WX_HTMLCELL_H_
 
 #ifdef __GNUG__
-#pragma interface "htmlcell.h"
+#pragma interface
 #endif
 
 #include "wx/defs.h"
@@ -36,32 +37,21 @@ class wxHtmlContainerCell;
 
 class WXDLLEXPORT wxHtmlCell : public wxObject
 {
-    protected:
-        wxHtmlCell *m_Next;
-                // pointer to the next cell
-        wxHtmlContainerCell *m_Parent;
-            // pointer to parent cell
-        long m_Width, m_Height, m_Descent;
-                // dimensions of fragment
-                // m_Descent is used to position text&images..
-        long m_PosX, m_PosY;
-                // position where the fragment is drawn
-        wxString m_Link;
-                // destination address if this fragment is hypertext link, "" otherwise
-
     public:
-        wxHtmlCell() : wxObject() {m_Next = NULL; m_Parent = NULL; m_Width = m_Height = m_Descent = 0;};
+        wxHtmlCell() : wxObject() {m_Next = NULL; m_Parent = NULL; m_Width = m_Height = m_Descent = 0; m_CanLiveOnPagebreak = TRUE;}
         virtual ~wxHtmlCell() {if (m_Next) delete m_Next;};
-    
+
         void SetParent(wxHtmlContainerCell *p) {m_Parent = p;}
         wxHtmlContainerCell *GetParent() const {return m_Parent;}
-            
+
         int GetPosX() const {return m_PosX;}
         int GetPosY() const {return m_PosY;}
         int GetWidth() const {return m_Width;}
         int GetHeight() const {return m_Height;}
         int GetDescent() const {return m_Descent;}
-        virtual wxString GetLink(int x = 0, int y = 0) const {return m_Link;}
+        virtual wxString GetLink(int WXUNUSED(x) = 0,
+                                 int WXUNUSED(y) = 0) const
+            { return m_Link; }
                 // 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
         wxHtmlCell *GetNext() const {return m_Next;}
@@ -84,7 +74,7 @@ class WXDLLEXPORT wxHtmlCell : public wxObject
         virtual void DrawInvisible(wxDC& dc, int x, int y) {if (m_Next) m_Next -> DrawInvisible(dc, x, y);};
                 // 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 const wxHtmlCell* Find(int condition, const void* param) const {if (m_Next) return m_Next -> Find(condition, param); else return NULL;}
                 // This method returns pointer to the FIRST cell for that
                 // the condition
@@ -94,7 +84,7 @@ class WXDLLEXPORT wxHtmlCell : public wxObject
                 // Condition is unique condition identifier (see htmldefs.h)
                 // (user-defined condition IDs should start from 10000)
                 // and param is optional parameter
-                // Example : m_Cell -> Find(HTML_COND_ISANCHOR, "news");
+                // Example : m_Cell -> Find(wxHTML_COND_ISANCHOR, "news");
                 //   returns pointer to anchor news
 
         virtual void OnMouseClick(wxWindow *parent, int x, int y, bool left, bool middle, bool right);
@@ -104,6 +94,37 @@ class WXDLLEXPORT wxHtmlCell : public wxObject
                 // Parent is pointer to wxHtmlWindow that generated the event
                 // HINT: if this handling is not enough for you you should use
                 //       wxHtmlBinderCell
+                
+        virtual bool AdjustPagebreak(int *pagebreak);
+                // This method used to adjust pagebreak position. The parameter is
+                // variable that contains y-coordinate of page break (= horizontal line that
+                // should not be crossed by words, images etc.). If this cell cannot be divided
+                // into two pieces (each one on another page) then it moves the pagebreak
+                // few pixels up.
+                //
+                // Returned value : true if pagebreak was modified, false otherwise
+                // Usage : while (container->AdjustPagebreak(&p)) {}
+                
+        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
+
+
+    protected:
+        wxHtmlCell *m_Next;
+                // pointer to the next cell
+        wxHtmlContainerCell *m_Parent;
+            // pointer to parent cell
+        long m_Width, m_Height, m_Descent;
+                // dimensions of fragment
+                // m_Descent is used to position text&images..
+        long m_PosX, m_PosY;
+                // position where the fragment is drawn
+        wxString m_Link;
+                // destination address if this fragment is hypertext link, "" otherwise
+        bool m_CanLiveOnPagebreak;
+                // true if this cell can be placed on pagebreak, false otherwise
+
 };
 
 
@@ -170,7 +191,8 @@ class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell
         virtual void Layout(int w);
         virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
         virtual void DrawInvisible(wxDC& dc, int x, int y);
-        
+        virtual bool AdjustPagebreak(int *pagebreak);
+
         void InsertCell(wxHtmlCell *cell);
                 // insert cell at the end of m_Cells list
         void SetAlignHor(int al) {m_AlignHor = al;}
@@ -178,11 +200,11 @@ class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell
         void SetAlignVer(int al) {m_AlignVer = al;}
                 // sets horizontal/vertical alignment
         int GetAlignVer() const {return m_AlignVer;}
-        void SetIndent(int i, int what, int units = HTML_UNITS_PIXELS);
-                // sets left-border indentation. units is one of HTML_UNITS_* constants
-                // what is combination of HTML_INDENT_*
+        void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
+                // sets left-border indentation. units is one of wxHTML_UNITS_* constants
+                // what is combination of wxHTML_INDENT_*
         int GetIndent(int ind) const;
-                // returns the indentation. ind is one of HTML_INDENT_* constants
+                // returns the indentation. ind is one of wxHTML_INDENT_* constants
         int GetIndentUnits(int ind) const;
                 // returns type of value returned by GetIndent(ind)
         void SetAlign(const wxHtmlTag& tag);
@@ -192,7 +214,7 @@ class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell
                 // sets floating width adjustment
                 // (examples : 32 percent of parent container,
                 // -15 pixels percent (this means 100 % - 15 pixels)
-        void SetMinHeight(int h, int align = HTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align;}
+        void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align;}
                 // sets minimal height of this container.
         int GetMaxLineWidth() const {return m_MaxLineWidth;}
             // returns maximal line width in this container.
@@ -223,7 +245,7 @@ class WXDLLEXPORT wxHtmlColourCell : public wxHtmlCell
         wxColour m_Colour;
         unsigned m_Flags;
 
-        wxHtmlColourCell(wxColour clr, int flags = HTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;}
+        wxHtmlColourCell(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);
         virtual void DrawInvisible(wxDC& dc, int x, int y);
 };
@@ -279,15 +301,7 @@ class WXDLLEXPORT wxHtmlWidgetCell : public wxHtmlCell
 
 
 
-
-#endif // __HTMLCELL_H__
-
 #endif
 
-
-
-
-
-
-
+#endif // _WX_HTMLCELL_H_