include/wx/html/htmlcell.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmlcell.h
   3 // Purpose:     wxHtmlCell class is used by wxHtmlWindow/wxHtmlWinParser
   4 //              as a basic visual element of HTML page
   5 // Author:      Vaclav Slavik
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 1999 Vaclav Slavik
   8 // Licence:     wxWindows Licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11
  12 #ifndef _WX_HTMLCELL_H_
  13 #define _WX_HTMLCELL_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_HTML
  22
  23 #include "wx/html/htmltag.h"
  24 #include "wx/html/htmldefs.h"
  25 #include "wx/window.h"
  26
  27
  28 class WXDLLEXPORT wxHtmlLinkInfo;
  29 class WXDLLEXPORT wxHtmlCell;
  30 class WXDLLEXPORT wxHtmlContainerCell;
  31
  32 //--------------------------------------------------------------------------------
  33 // wxHtmlCell
  34 //                  Internal data structure. It represents fragments of parsed HTML
  35 //                  page - a word, picture, table, horizontal line and so on.
  36 //                  It is used by wxHtmlWindow to represent HTML page in memory.
  37 //--------------------------------------------------------------------------------
  38
  39
  40 class WXDLLEXPORT wxHtmlCell : public wxObject
  41 {
  42     public:
  43         wxHtmlCell();
  44         virtual ~wxHtmlCell();
  45
  46         void SetParent(wxHtmlContainerCell *p) {m_Parent = p;}
  47         wxHtmlContainerCell *GetParent() const {return m_Parent;}
  48
  49         int GetPosX() const {return m_PosX;}
  50         int GetPosY() const {return m_PosY;}
  51         int GetWidth() const {return m_Width;}
  52         int GetHeight() const {return m_Height;}
  53         int GetDescent() const {return m_Descent;}
  54         virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0,
  55                                  int WXUNUSED(y) = 0) const
  56             { return m_Link; }
  57                 // returns the link associated with this cell. The position is position within
  58                 // the cell so it varies from 0 to m_Width, from 0 to m_Height
  59         wxHtmlCell *GetNext() const {return m_Next;}
  60                 // members access methods
  61
  62         virtual void SetPos(int x, int y) {m_PosX = x, m_PosY = y;}
  63         void SetLink(const wxHtmlLinkInfo& link);
  64         void SetNext(wxHtmlCell *cell) {m_Next = cell;}
  65                 // members writin methods
  66
  67         virtual void Layout(int w) {SetPos(0, 0); if (m_Next) m_Next -> Layout(w);};
  68                 // 1. adjust cell's width according to the fact that maximal possible width is w.
  69                 //    (this has sense when working with horizontal lines, tables etc.)
  70                 // 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height) members)
  71                 //    = place items to fit window, according to the width w
  72
  73         virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2) {if (m_Next) m_Next -> Draw(dc, x, y, view_y1, view_y2);}
  74                 // renders the cell
  75
  76         virtual void DrawInvisible(wxDC& dc, int x, int y) {if (m_Next) m_Next -> DrawInvisible(dc, x, y);};
  77                 // proceed drawing actions in case the cell is not visible (scrolled out of screen).
  78                 // This is needed to change fonts, colors and so on
  79
  80         virtual const wxHtmlCell* Find(int condition, const void* param) const {if (m_Next) return m_Next -> Find(condition, param); else return NULL;}
  81                 // This method returns pointer to the FIRST cell for that
  82                 // the condition
  83                 // is true. It first checks if the condition is true for this
  84                 // cell and then calls m_Next -> Find(). (Note: it checks
  85                 // all subcells if the cell is container)
  86                 // Condition is unique condition identifier (see htmldefs.h)
  87                 // (user-defined condition IDs should start from 10000)
  88                 // and param is optional parameter
  89                 // Example : m_Cell -> Find(wxHTML_COND_ISANCHOR, "news");
  90                 //   returns pointer to anchor news
  91
  92         virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event);
  93                 // This function is called when mouse button is clicked over the cell.
  94                 // left, middle, right are flags indicating whether the button was or wasn't
  95                 // pressed.
  96                 // Parent is pointer to wxHtmlWindow that generated the event
  97                 // HINT: if this handling is not enough for you you should use
  98                 //       wxHtmlBinderCell
  99
 100         virtual bool AdjustPagebreak(int *pagebreak) const;
 101                 // This method used to adjust pagebreak position. The parameter is
 102                 // variable that contains y-coordinate of page break (= horizontal line that
 103                 // should not be crossed by words, images etc.). If this cell cannot be divided
 104                 // into two pieces (each one on another page) then it moves the pagebreak
 105                 // few pixels up.
 106                 //
 107                 // Returned value : true if pagebreak was modified, false otherwise
 108                 // Usage : while (container->AdjustPagebreak(&p)) {}
 109
 110         void SetCanLiveOnPagebreak(bool can) {m_CanLiveOnPagebreak = can;}
 111                 // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
 112                 // is true - the cell can be split on two pages
 113
 114
 115     protected:
 116         wxHtmlCell *m_Next;
 117                 // pointer to the next cell
 118         wxHtmlContainerCell *m_Parent;
 119             // pointer to parent cell
 120         long m_Width, m_Height, m_Descent;
 121                 // dimensions of fragment
 122                 // m_Descent is used to position text&images..
 123         long m_PosX, m_PosY;
 124                 // position where the fragment is drawn
 125         wxHtmlLinkInfo *m_Link;
 126                 // destination address if this fragment is hypertext link, "" otherwise
 127         bool m_CanLiveOnPagebreak;
 128                 // true if this cell can be placed on pagebreak, false otherwise
 129
 130 };
 131
 132
 133
 134
 135 //--------------------------------------------------------------------------------
 136 // Inherited cells:
 137 //--------------------------------------------------------------------------------
 138
 139
 140 //--------------------------------------------------------------------------------
 141 // wxHtmlWordCell
 142 //                  Single word in input stream.
 143 //--------------------------------------------------------------------------------
 144
 145 class WXDLLEXPORT wxHtmlWordCell : public wxHtmlCell
 146 {
 147     public:
 148         wxHtmlWordCell(const wxString& word, wxDC& dc);
 149         void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 150
 151     protected:
 152         wxString m_Word;
 153 };
 154
 155
 156
 157
 158
 159 //--------------------------------------------------------------------------------
 160 // wxHtmlContainerCell
 161 //                  Container - it contains other cells. Basic of layout algorithm.
 162 //--------------------------------------------------------------------------------
 163
 164 class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell
 165 {
 166     public:
 167         wxHtmlContainerCell(wxHtmlContainerCell *parent);
 168         ~wxHtmlContainerCell() {if (m_Cells) delete m_Cells;}
 169
 170         virtual void Layout(int w);
 171         virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 172         virtual void DrawInvisible(wxDC& dc, int x, int y);
 173         virtual bool AdjustPagebreak(int *pagebreak) const;
 174
 175         void InsertCell(wxHtmlCell *cell);
 176                 // insert cell at the end of m_Cells list
 177         void SetAlignHor(int al) {m_AlignHor = al; m_LastLayout = -1;}
 178         int GetAlignHor() const {return m_AlignHor;}
 179         void SetAlignVer(int al) {m_AlignVer = al; m_LastLayout = -1;}
 180                 // sets horizontal/vertical alignment
 181         int GetAlignVer() const {return m_AlignVer;}
 182         void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
 183                 // sets left-border indentation. units is one of wxHTML_UNITS_* constants
 184                 // what is combination of wxHTML_INDENT_*
 185         int GetIndent(int ind) const;
 186                 // returns the indentation. ind is one of wxHTML_INDENT_* constants
 187         int GetIndentUnits(int ind) const;
 188                 // returns type of value returned by GetIndent(ind)
 189         void SetAlign(const wxHtmlTag& tag);
 190                 // sets alignment info based on given tag's params
 191         void SetWidthFloat(int w, int units) {m_WidthFloat = w; m_WidthFloatUnits = units; m_LastLayout = -1;}
 192         void SetWidthFloat(const wxHtmlTag& tag, double pixel_scale = 1.0);
 193                 // sets floating width adjustment
 194                 // (examples : 32 percent of parent container,
 195                 // -15 pixels percent (this means 100 % - 15 pixels)
 196         void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align; m_LastLayout = -1;}
 197                 // sets minimal height of this container.
 198         int GetMaxLineWidth() const {return m_MaxLineWidth;}
 199             // returns maximal line width in this container.
 200             // Call to this method is valid only after calling
 201             // Layout()
 202         void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = TRUE; m_BkColour = clr;}
 203         void SetBorder(const wxColour& clr1, const wxColour& clr2) {m_UseBorder = TRUE; m_BorderColour1 = clr1, m_BorderColour2 = clr2;}
 204         virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const;
 205         virtual const wxHtmlCell* Find(int condition, const void* param) const;
 206         virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event);
 207
 208         wxHtmlCell* GetFirstCell() const {return m_Cells;}
 209                 // returns pointer to the first cell in container or NULL
 210
 211     protected:
 212         int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom;
 213                 // indentation of subcells. There is always m_Indent pixels
 214                 // big space between given border of the container and the subcells
 215                 // it m_Indent < 0 it is in PERCENTS, otherwise it is in pixels
 216         int m_MinHeight, m_MinHeightAlign;
 217             // minimal height.
 218         int m_MaxLineWidth;
 219             // maximal widht of line. Filled during Layout()
 220         wxHtmlCell *m_Cells, *m_LastCell;
 221                 // internal cells, m_Cells points to the first of them, m_LastCell to the last one.
 222                 // (LastCell is needed only to speed-up InsertCell)
 223         int m_AlignHor, m_AlignVer;
 224                 // alignment horizontal and vertical (left, center, right)
 225         int m_WidthFloat, m_WidthFloatUnits;
 226                 // width float is used in adjustWidth
 227         bool m_UseBkColour;
 228         wxColour m_BkColour;
 229                 // background color of this container
 230         bool m_UseBorder;
 231         wxColour m_BorderColour1, m_BorderColour2;
 232                 // borders color of this container
 233         int m_LastLayout;
 234                 // if != -1 then call to Layout may be no-op
 235                 // if previous call to Layout has same argument
 236 };
 237
 238
 239
 240
 241
 242 //--------------------------------------------------------------------------------
 243 // wxHtmlColourCell
 244 //                  Color changer.
 245 //--------------------------------------------------------------------------------
 246
 247 class WXDLLEXPORT wxHtmlColourCell : public wxHtmlCell
 248 {
 249     public:
 250         wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;}
 251         virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 252         virtual void DrawInvisible(wxDC& dc, int x, int y);
 253
 254     protected:
 255         wxColour m_Colour;
 256         unsigned m_Flags;
 257 };
 258
 259
 260
 261
 262 //--------------------------------------------------------------------------------
 263 // wxHtmlFontCell
 264 //                  Sets actual font used for text rendering
 265 //--------------------------------------------------------------------------------
 266
 267 class WXDLLEXPORT wxHtmlFontCell : public wxHtmlCell
 268 {
 269     public:
 270         wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); }
 271         virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 272         virtual void DrawInvisible(wxDC& dc, int x, int y);
 273
 274     protected:
 275         wxFont m_Font;
 276 };
 277
 278
 279
 280
 281
 282
 283 //--------------------------------------------------------------------------------
 284 // wxHtmlwidgetCell
 285 //                  This cell is connected with wxWindow object
 286 //                  You can use it to insert windows into HTML page
 287 //                  (buttons, input boxes etc.)
 288 //--------------------------------------------------------------------------------
 289
 290 class WXDLLEXPORT wxHtmlWidgetCell : public wxHtmlCell
 291 {
 292     public:
 293         wxHtmlWidgetCell(wxWindow *wnd, int w = 0);
 294                 // !!! wnd must have correct parent!
 295                 // if w != 0 then the m_Wnd has 'floating' width - it adjust
 296                 // it's width according to parent container's width
 297                 // (w is percent of parent's width)
 298         ~wxHtmlWidgetCell() {if (m_Wnd) m_Wnd -> Destroy(); }
 299         virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 300         virtual void DrawInvisible(wxDC& dc, int x, int y);
 301         virtual void Layout(int w);
 302
 303     protected:
 304         wxWindow* m_Wnd;
 305         int m_WidthFloat;
 306                 // width float is used in adjustWidth (it is in percents)
 307 };
 308
 309
 310
 311 //--------------------------------------------------------------------------------
 312 // wxHtmlLinkInfo
 313 //                  Internal data structure. It represents hypertext link
 314 //--------------------------------------------------------------------------------
 315
 316 class WXDLLEXPORT wxHtmlLinkInfo : public wxObject
 317 {
 318     public:
 319         wxHtmlLinkInfo() : wxObject()
 320                 { m_Href = m_Target = wxEmptyString; m_Event = NULL, m_Cell = NULL; }
 321         wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString) : wxObject()
 322                 { m_Href = href; m_Target = target; m_Event = NULL, m_Cell = NULL; }
 323         wxHtmlLinkInfo(const wxHtmlLinkInfo& l)
 324                 { m_Href = l.m_Href, m_Target = l.m_Target, m_Event = l.m_Event, m_Cell = l.m_Cell; }
 325         wxHtmlLinkInfo& operator=(const wxHtmlLinkInfo& l)
 326                 { m_Href = l.m_Href, m_Target = l.m_Target, m_Event = l.m_Event, m_Cell = l.m_Cell; return *this; }
 327
 328         void SetEvent(const wxMouseEvent *e) { m_Event = e; }
 329         void SetHtmlCell(const wxHtmlCell *e) { m_Cell = e; }
 330
 331         wxString GetHref() const { return m_Href; }
 332         wxString GetTarget() const { return m_Target; }
 333         const wxMouseEvent* GetEvent() const { return m_Event; }
 334         const wxHtmlCell* GetHtmlCell() const { return m_Cell; }
 335
 336     private:
 337         wxString m_Href, m_Target;
 338         const wxMouseEvent *m_Event;
 339         const wxHtmlCell *m_Cell;
 340 };
 341
 342
 343
 344
 345 #endif // wxUSE_HTML
 346
 347 #endif // _WX_HTMLCELL_H_
 348