]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/htmlcell.h
compilation fix (extra semicolon)
[wxWidgets.git] / include / wx / html / htmlcell.h
index b4d8af4e3b961af3ad3dc9b7c9d10f101a0bfebc..4d476606f2ec90cb5c3f68895668bd26650724f5 100644 (file)
@@ -4,7 +4,7 @@
 //              as a basic visual element of HTML page
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
-// Copyright:   (c) 1999 Vaclav Slavik
+// Copyright:   (c) 1999-2003 Vaclav Slavik
 // Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 
 #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() 
         : 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);
-    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; }
     
-    // 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; }
+    
+    // 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; }
 
     const 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;
 };
 
 
@@ -71,13 +80,10 @@ 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 = NULL)
-        : m_selection(s), m_selState(wxHTML_SEL_OUT) {}
-    void SetSelection(wxHtmlSelection *s) { m_selection = s; }
-    wxHtmlSelection *GetSelection() const { return m_selection; }
+    wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {}
 
     void SetSelectionState(wxHtmlSelectionState s) { m_selState = s; }  
     wxHtmlSelectionState GetSelectionState() const { return m_selState; }
@@ -88,17 +94,58 @@ public:
     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_EXACT             = 1,
     wxHTML_FIND_NEAREST_BEFORE    = 2,
-    wxHTML_FIND_NEAREST_AFTER     = 4,
+    wxHTML_FIND_NEAREST_AFTER     = 4
 };
 
 
@@ -113,7 +160,7 @@ enum
 // ---------------------------------------------------------------------------
 
 
-class WXDLLEXPORT wxHtmlCell : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlCell : public wxObject
 {
 public:
     wxHtmlCell();
@@ -137,6 +184,9 @@ public:
                                     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):
@@ -158,13 +208,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
@@ -237,7 +287,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;
-
+    
     // 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
@@ -276,19 +326,20 @@ protected:
 //                  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;
 
 protected:
+    void SetSelectionPrivPos(wxDC& dc, wxHtmlSelection *s) const;
     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;
 };
@@ -299,7 +350,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);
@@ -307,9 +358,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
@@ -364,9 +415,9 @@ public:
     virtual wxHtmlCell *GetLastTerminal() const;
 
 protected:
-    void UpdateRenderingStatePre(wxHtmlRenderingState& state,
+    void UpdateRenderingStatePre(wxHtmlRenderingInfo& info,
                                  wxHtmlCell *cell) const;
-    void UpdateRenderingStatePost(wxHtmlRenderingState& state,
+    void UpdateRenderingStatePost(wxHtmlRenderingInfo& info,
                                   wxHtmlCell *cell) const;
     
 protected:
@@ -409,14 +460,14 @@ inline wxHtmlCell* wxHtmlContainerCell::GetFirstCell() const
 //                  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;
@@ -431,14 +482,14 @@ 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;
@@ -456,7 +507,7 @@ protected:
 //                  (buttons, input boxes etc.)
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlWidgetCell : public wxHtmlCell
+class WXDLLIMPEXP_HTML wxHtmlWidgetCell : public wxHtmlCell
 {
 public:
     // !!! wnd must have correct parent!
@@ -466,9 +517,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:
@@ -486,7 +537,7 @@ protected:
 //                  Internal data structure. It represents hypertext link
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlLinkInfo : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlLinkInfo : public wxObject
 {
 public:
     wxHtmlLinkInfo() : wxObject()
@@ -520,7 +571,7 @@ private:
 // wxHtmlTerminalCellsInterator
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlTerminalCellsInterator
+class WXDLLIMPEXP_HTML wxHtmlTerminalCellsInterator
 {
 public:
     wxHtmlTerminalCellsInterator(const wxHtmlCell *from, const wxHtmlCell *to)