Wrappers for *ToText

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

diff --git a/include/wx/html/htmlcell.h b/include/wx/html/htmlcell.h
index 29554c871381b8bed711b4bbf55792bae02add2a..4bc6bb4f4da50317e146090c36b7a719b41aebf7 100644 (file)
--- a/include/wx/html/htmlcell.h
+++ b/include/wx/html/htmlcell.h
@@ -4,15 +4,15 @@
 //              as a basic visual element of HTML page
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 //              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_
 
 /////////////////////////////////////////////////////////////////////////////
 
 
 #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
 
 #pragma interface "htmlcell.h"
 #endif
 


@@ -25,39 +25,48 @@
 #include "wx/window.h"
 
 
 #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.
 
 
 // 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() 
         : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),
 {
 public:
     wxHtmlSelection() 
         : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),

+          m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition),

           m_fromCell(NULL), m_toCell(NULL) {}
 
           m_fromCell(NULL), m_toCell(NULL) {}
 

-    void Set(const wxPoint& fromPos, wxHtmlCell *fromCell,
-             const wxPoint& toPos, wxHtmlCell *toCell);
-    void Set(wxHtmlCell *fromCell, 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 *relative* to From/To cell's origin:
+    // these values are in absolute coordinates:

     const wxPoint& GetFromPos() const { return m_fromPos; }
     const wxPoint& GetToPos() const { return m_toPos; }
     const wxPoint& GetFromPos() const { return m_fromPos; }
     const wxPoint& GetToPos() const { return m_toPos; }

-
-    const bool IsEmpty() const 
+    
+    // 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:
         { 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;

 };
 
 
 };
 
 


@@ -71,7 +80,7 @@ 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.
 
 // 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() : m_selState(wxHTML_SEL_OUT) {}
 {
 public:
     wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {}


@@ -91,15 +100,16 @@ private:
 
 
 // HTML rendering customization. This class is used when rendering wxHtmlCells
 
 
 // HTML rendering customization. This class is used when rendering wxHtmlCells

-// as a callback .
-class WXDLLEXPORT wxHtmlRenderingStyle
+// as a callback:
+class WXDLLIMPEXP_HTML wxHtmlRenderingStyle

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

-class WXDLLEXPORT wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
+// Standard style:
+class WXDLLIMPEXP_HTML wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle

 {
 public:
     virtual wxColour GetSelectedTextColour(const wxColour& clr);
 {
 public:
     virtual wxColour GetSelectedTextColour(const wxColour& clr);


@@ -110,7 +120,7 @@ public:
 // Information given to cells when drawing them. Contains rendering state,
 // selection information and rendering style object that can be used to
 // customize the output.
 // 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 WXDLLEXPORT wxHtmlRenderingInfo
+class WXDLLIMPEXP_HTML wxHtmlRenderingInfo

 {
 public:
     wxHtmlRenderingInfo() : m_selection(NULL), m_style(NULL) {}
 {
 public:
     wxHtmlRenderingInfo() : m_selection(NULL), m_style(NULL) {}


@@ -135,7 +145,7 @@ enum
 {
     wxHTML_FIND_EXACT             = 1,
     wxHTML_FIND_NEAREST_BEFORE    = 2,
 {
     wxHTML_FIND_EXACT             = 1,
     wxHTML_FIND_NEAREST_BEFORE    = 2,

-    wxHTML_FIND_NEAREST_AFTER     = 4,
+    wxHTML_FIND_NEAREST_AFTER     = 4

 };
 
 
 };
 
 


@@ -150,7 +160,7 @@ enum
 // ---------------------------------------------------------------------------
 
 
 // ---------------------------------------------------------------------------
 
 

-class WXDLLEXPORT wxHtmlCell : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlCell : public wxObject

 {
 public:
     wxHtmlCell();
 {
 public:
     wxHtmlCell();


@@ -162,9 +172,18 @@ 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; }
+

     int GetHeight() const {return m_Height;}
     int GetDescent() const {return m_Descent;}
 
     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; }
 
     const wxString& GetId() const { return m_id; }
     void SetId(const wxString& id) { m_id = id; }
 


@@ -174,6 +193,9 @@ public:
                                     int WXUNUSED(y) = 0) const
         { return m_Link; }
 
                                     int WXUNUSED(y) = 0) const
         { return m_Link; }
 

+    // 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):
     // 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):


@@ -237,16 +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; }
     // 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; }

-
-    // 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!
 
     // 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.
 
     // Find a cell inside this cell positioned at the given coordinates
     // (relative to this's positions). Returns NULL if no such cell exists.


@@ -274,7 +294,7 @@ public:
     // 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;
     // 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
     // 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


@@ -297,6 +317,7 @@ protected:
     wxString m_id;
             // 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)
 };
 
     DECLARE_NO_COPY_CLASS(wxHtmlCell)
 };
 


@@ -313,21 +334,29 @@ protected:
 //                  Single word in input stream.
 // ----------------------------------------------------------------------------
 
 //                  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,
               wxHtmlRenderingInfo& info);
 {
 public:
     wxHtmlWordCell(const wxString& word, 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;
     wxString ConvertToText(wxHtmlSelection *sel) const;

+    bool IsLinebreakAllowed() const { return m_allowLinebreak; }
+
+    void SetPreviousWord(wxHtmlWordCell *cell);

 
 protected:
 
 protected:

+    void SetSelectionPrivPos(wxDC& dc, wxHtmlSelection *s) const;

     void Split(wxDC& dc,
                const wxPoint& selFrom, const wxPoint& selTo,
     void Split(wxDC& dc,
                const wxPoint& selFrom, const wxPoint& selTo,

-               wxString& s1, wxString& s2, wxString& s3,
-               unsigned& pos1, unsigned& pos2);
+               unsigned& pos1, unsigned& pos2) const;

     
     wxString m_Word;
     
     wxString m_Word;

+    bool     m_allowLinebreak;
+
+    DECLARE_ABSTRACT_CLASS(wxHtmlWordCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlWordCell)

 };
 
 
 };
 
 


@@ -336,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.
 
 // 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);
 {
 public:
     wxHtmlContainerCell(wxHtmlContainerCell *parent);


@@ -376,15 +405,14 @@ 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;}
 
     // 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();
     // 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 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;

 
     virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
 #if WXWIN_COMPATIBILITY_2_4
 
     virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
 #if WXWIN_COMPATIBILITY_2_4


@@ -392,13 +420,22 @@ public:
 #endif
 
     // see comment in wxHtmlCell about this method
 #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;
 
     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,
 
 protected:
     void UpdateRenderingStatePre(wxHtmlRenderingInfo& info,


@@ -429,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_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)
 };
 
     DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
 };
 


@@ -446,7 +487,7 @@ inline wxHtmlCell* wxHtmlContainerCell::GetFirstCell() const
 //                  Color changer.
 // ---------------------------------------------------------------------------
 
 //                  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;}
 {
 public:
     wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;}


@@ -458,6 +499,9 @@ public:
 protected:
     wxColour m_Colour;
     unsigned m_Flags;
 protected:
     wxColour m_Colour;
     unsigned m_Flags;

+
+    DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlColourCell)

 };
 
 
 };
 
 


@@ -468,7 +512,7 @@ protected:
 //                  Sets actual font used for text rendering
 //--------------------------------------------------------------------------------
 
 //                  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); }
 {
 public:
     wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); }


@@ -479,6 +523,9 @@ public:
 
 protected:
     wxFont m_Font;
 
 protected:
     wxFont m_Font;

+
+    DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)
+    DECLARE_NO_COPY_CLASS(wxHtmlFontCell)

 };
 
 
 };
 
 


@@ -493,7 +540,7 @@ protected:
 //                  (buttons, input boxes etc.)
 //--------------------------------------------------------------------------------
 
 //                  (buttons, input boxes etc.)
 //--------------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlWidgetCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlWidgetCell : public wxHtmlCell

 {
 public:
     // !!! wnd must have correct parent!
 {
 public:
     // !!! wnd must have correct parent!


@@ -513,6 +560,7 @@ protected:
     int m_WidthFloat;
             // width float is used in adjustWidth (it is in percents)
 
     int m_WidthFloat;
             // width float is used in adjustWidth (it is in percents)
 

+    DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell)

     DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell)
 };
 
     DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell)
 };
 


@@ -523,7 +571,7 @@ protected:
 //                  Internal data structure. It represents hypertext link
 //--------------------------------------------------------------------------------
 
 //                  Internal data structure. It represents hypertext link
 //--------------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlLinkInfo : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlLinkInfo : public wxObject

 {
 public:
     wxHtmlLinkInfo() : wxObject()
 {
 public:
     wxHtmlLinkInfo() : wxObject()


@@ -557,7 +605,7 @@ private:
 // wxHtmlTerminalCellsInterator
 // ----------------------------------------------------------------------------
 
 // wxHtmlTerminalCellsInterator
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlTerminalCellsInterator
+class WXDLLIMPEXP_HTML wxHtmlTerminalCellsInterator

 {
 public:
     wxHtmlTerminalCellsInterator(const wxHtmlCell *from, const wxHtmlCell *to)
 {
 public:
     wxHtmlTerminalCellsInterator(const wxHtmlCell *from, const wxHtmlCell *to)