]> git.saurik.com Git - wxWidgets.git/blame - include/wx/html/htmlcell.h
@wxsince -> @since in Doxygen docs
[wxWidgets.git] / include / wx / html / htmlcell.h
CommitLineData
5526e819
VS
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
69941f05 6// RCS-ID: $Id$
a99798d2 7// Copyright: (c) 1999-2003 Vaclav Slavik
65571936 8// Licence: wxWindows licence
5526e819
VS
9/////////////////////////////////////////////////////////////////////////////
10
69941f05
VS
11#ifndef _WX_HTMLCELL_H_
12#define _WX_HTMLCELL_H_
5526e819 13
5526e819 14#include "wx/defs.h"
5526e819 15
4dcaf11a 16#if wxUSE_HTML
5526e819 17
4dcaf11a
RR
18#include "wx/html/htmltag.h"
19#include "wx/html/htmldefs.h"
20#include "wx/window.h"
5526e819 21
846914d1 22
b5dbe15d
VS
23class WXDLLIMPEXP_FWD_HTML wxHtmlWindowInterface;
24class WXDLLIMPEXP_FWD_HTML wxHtmlLinkInfo;
25class WXDLLIMPEXP_FWD_HTML wxHtmlCell;
26class WXDLLIMPEXP_FWD_HTML wxHtmlContainerCell;
5526e819 27
f65a786f
VS
28
29// wxHtmlSelection is data holder with information about text selection.
30// Selection is defined by two positions (beginning and end of the selection)
31// and two leaf(!) cells at these positions.
6acba9a7 32class WXDLLIMPEXP_HTML wxHtmlSelection
f65a786f
VS
33{
34public:
6953da00 35 wxHtmlSelection()
f65a786f 36 : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),
a99798d2 37 m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition),
f65a786f
VS
38 m_fromCell(NULL), m_toCell(NULL) {}
39
1338c59a
VS
40 void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell,
41 const wxPoint& toPos, const wxHtmlCell *toCell);
42 void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell);
6953da00 43
7d96264c
VZ
44 const wxHtmlCell *GetFromCell() const { return m_fromCell; }
45 const wxHtmlCell *GetToCell() const { return m_toCell; }
6953da00 46
a99798d2 47 // these values are in absolute coordinates:
f65a786f
VS
48 const wxPoint& GetFromPos() const { return m_fromPos; }
49 const wxPoint& GetToPos() const { return m_toPos; }
6953da00 50
a99798d2
VS
51 // these are From/ToCell's private data
52 const wxPoint& GetFromPrivPos() const { return m_fromPrivPos; }
53 const wxPoint& GetToPrivPos() const { return m_toPrivPos; }
54 void SetFromPrivPos(const wxPoint& pos) { m_fromPrivPos = pos; }
55 void SetToPrivPos(const wxPoint& pos) { m_toPrivPos = pos; }
1338c59a 56 void ClearPrivPos() { m_toPrivPos = m_fromPrivPos = wxDefaultPosition; }
f65a786f 57
6953da00
WS
58 bool IsEmpty() const
59 { return m_fromPos == wxDefaultPosition &&
f65a786f
VS
60 m_toPos == wxDefaultPosition; }
61
62private:
a99798d2
VS
63 wxPoint m_fromPos, m_toPos;
64 wxPoint m_fromPrivPos, m_toPrivPos;
1338c59a 65 const wxHtmlCell *m_fromCell, *m_toCell;
f65a786f
VS
66};
67
68
69
70enum wxHtmlSelectionState
71{
72 wxHTML_SEL_OUT, // currently rendered cell is outside the selection
73 wxHTML_SEL_IN, // ... is inside selection
74 wxHTML_SEL_CHANGING // ... is the cell on which selection state changes
75};
76
77// Selection state is passed to wxHtmlCell::Draw so that it can render itself
78// differently e.g. when inside text selection or outside it.
6acba9a7 79class WXDLLIMPEXP_HTML wxHtmlRenderingState
f65a786f
VS
80{
81public:
ed9d5d17 82 wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {}
f65a786f 83
6953da00 84 void SetSelectionState(wxHtmlSelectionState s) { m_selState = s; }
f65a786f
VS
85 wxHtmlSelectionState GetSelectionState() const { return m_selState; }
86
87 void SetFgColour(const wxColour& c) { m_fgColour = c; }
88 const wxColour& GetFgColour() const { return m_fgColour; }
89 void SetBgColour(const wxColour& c) { m_bgColour = c; }
90 const wxColour& GetBgColour() const { return m_bgColour; }
6953da00 91
f65a786f 92private:
f65a786f
VS
93 wxHtmlSelectionState m_selState;
94 wxColour m_fgColour, m_bgColour;
95};
96
ed9d5d17
VS
97
98// HTML rendering customization. This class is used when rendering wxHtmlCells
a99798d2 99// as a callback:
6acba9a7 100class WXDLLIMPEXP_HTML wxHtmlRenderingStyle
ed9d5d17
VS
101{
102public:
ed62f740 103 virtual ~wxHtmlRenderingStyle() {}
ed9d5d17
VS
104 virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
105 virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
106};
107
a99798d2 108// Standard style:
6acba9a7 109class WXDLLIMPEXP_HTML wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
ed9d5d17
VS
110{
111public:
112 virtual wxColour GetSelectedTextColour(const wxColour& clr);
113 virtual wxColour GetSelectedTextBgColour(const wxColour& clr);
114};
115
116
117// Information given to cells when drawing them. Contains rendering state,
118// selection information and rendering style object that can be used to
119// customize the output.
6acba9a7 120class WXDLLIMPEXP_HTML wxHtmlRenderingInfo
ed9d5d17
VS
121{
122public:
123 wxHtmlRenderingInfo() : m_selection(NULL), m_style(NULL) {}
124
125 void SetSelection(wxHtmlSelection *s) { m_selection = s; }
126 wxHtmlSelection *GetSelection() const { return m_selection; }
6953da00 127
ed9d5d17
VS
128 void SetStyle(wxHtmlRenderingStyle *style) { m_style = style; }
129 wxHtmlRenderingStyle& GetStyle() { return *m_style; }
130
131 wxHtmlRenderingState& GetState() { return m_state; }
6953da00 132
ed9d5d17
VS
133protected:
134 wxHtmlSelection *m_selection;
135 wxHtmlRenderingStyle *m_style;
136 wxHtmlRenderingState m_state;
137};
138
139
f65a786f
VS
140// Flags for wxHtmlCell::FindCellByPos
141enum
142{
adf2eb2d
VS
143 wxHTML_FIND_EXACT = 1,
144 wxHTML_FIND_NEAREST_BEFORE = 2,
1338c59a 145 wxHTML_FIND_NEAREST_AFTER = 4
f65a786f
VS
146};
147
148
3c115835
VS
149// Superscript/subscript/normal script mode of a cell
150enum wxHtmlScriptMode
151{
152 wxHTML_SCRIPT_NORMAL,
153 wxHTML_SCRIPT_SUB,
154 wxHTML_SCRIPT_SUP
155};
61233023
VS
156
157
f65a786f 158// ---------------------------------------------------------------------------
5526e819 159// wxHtmlCell
f65a786f
VS
160// Internal data structure. It represents fragments of parsed
161// HTML page - a word, picture, table, horizontal line and so
162// on. It is used by wxHtmlWindow to represent HTML page in
163// memory.
164// ---------------------------------------------------------------------------
5526e819
VS
165
166
6acba9a7 167class WXDLLIMPEXP_HTML wxHtmlCell : public wxObject
5526e819 168{
97494971
VS
169public:
170 wxHtmlCell();
171 virtual ~wxHtmlCell();
172
173 void SetParent(wxHtmlContainerCell *p) {m_Parent = p;}
174 wxHtmlContainerCell *GetParent() const {return m_Parent;}
175
176 int GetPosX() const {return m_PosX;}
177 int GetPosY() const {return m_PosY;}
178 int GetWidth() const {return m_Width;}
6953da00 179
ca16b7a9
VS
180 // Returns the maximum possible length of the cell.
181 // Call Layout at least once before using GetMaxTotalWidth()
182 virtual int GetMaxTotalWidth() const { return m_Width; }
183
97494971
VS
184 int GetHeight() const {return m_Height;}
185 int GetDescent() const {return m_Descent;}
d50d561a 186
3c115835
VS
187 void SetScriptMode(wxHtmlScriptMode mode, long previousBase);
188 wxHtmlScriptMode GetScriptMode() const { return m_ScriptMode; }
189 long GetScriptBaseline() { return m_ScriptBaseline; }
190
b87dd6f5
VS
191 // Formatting cells are not visible on the screen, they only alter
192 // renderer's state.
193 bool IsFormattingCell() const { return m_Width == 0 && m_Height == 0; }
194
8938133d
VS
195 const wxString& GetId() const { return m_id; }
196 void SetId(const wxString& id) { m_id = id; }
97494971 197
f65a786f
VS
198 // returns the link associated with this cell. The position is position
199 // within the cell so it varies from 0 to m_Width, from 0 to m_Height
61233023
VS
200 virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0,
201 int WXUNUSED(y) = 0) const
97494971
VS
202 { return m_Link; }
203
77bae5e2 204 // Returns cursor to be used when mouse is over the cell:
88a1b648
VS
205 virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
206
207#if WXWIN_COMPATIBILITY_2_6
208 // this was replaced by GetMouseCursor, don't use in new code!
77bae5e2 209 virtual wxCursor GetCursor() const;
88a1b648 210#endif
77bae5e2 211
61233023 212 // return next cell among parent's cells
97494971 213 wxHtmlCell *GetNext() const {return m_Next;}
61233023
VS
214 // returns first child cell (if there are any, i.e. if this is container):
215 virtual wxHtmlCell* GetFirstChild() const { return NULL; }
97494971 216
f6010d8f 217 // members writing methods
97494971
VS
218 virtual void SetPos(int x, int y) {m_PosX = x, m_PosY = y;}
219 void SetLink(const wxHtmlLinkInfo& link);
220 void SetNext(wxHtmlCell *cell) {m_Next = cell;}
221
f65a786f
VS
222 // 1. adjust cell's width according to the fact that maximal possible width
223 // is w. (this has sense when working with horizontal lines, tables
224 // etc.)
225 // 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height)
226 // members) = place items to fit window, according to the width w
97494971
VS
227 virtual void Layout(int w);
228
229 // renders the cell
f65a786f
VS
230 virtual void Draw(wxDC& WXUNUSED(dc),
231 int WXUNUSED(x), int WXUNUSED(y),
232 int WXUNUSED(view_y1), int WXUNUSED(view_y2),
ed9d5d17 233 wxHtmlRenderingInfo& WXUNUSED(info)) {}
97494971 234
f65a786f
VS
235 // proceed drawing actions in case the cell is not visible (scrolled out of
236 // screen). This is needed to change fonts, colors and so on.
237 virtual void DrawInvisible(wxDC& WXUNUSED(dc),
238 int WXUNUSED(x), int WXUNUSED(y),
ed9d5d17 239 wxHtmlRenderingInfo& WXUNUSED(info)) {}
97494971
VS
240
241 // This method returns pointer to the FIRST cell for that
242 // the condition
243 // is true. It first checks if the condition is true for this
244 // cell and then calls m_Next->Find(). (Note: it checks
245 // all subcells if the cell is container)
246 // Condition is unique condition identifier (see htmldefs.h)
247 // (user-defined condition IDs should start from 10000)
248 // and param is optional parameter
249 // Example : m_Cell->Find(wxHTML_COND_ISANCHOR, "news");
250 // returns pointer to anchor news
251 virtual const wxHtmlCell* Find(int condition, const void* param) const;
252
bc55e31b 253
97494971 254 // This function is called when mouse button is clicked over the cell.
bc55e31b 255 // Returns true if a link is clicked, false otherwise.
f6010d8f 256 //
bc55e31b
VS
257 // 'window' is pointer to wxHtmlWindowInterface of the window which
258 // generated the event.
97494971 259 // HINT: if this handling is not enough for you you should use
f7b23958 260 // wxHtmlWidgetCell
bc55e31b
VS
261 virtual bool ProcessMouseClick(wxHtmlWindowInterface *window,
262 const wxPoint& pos,
263 const wxMouseEvent& event);
264
265#if WXWIN_COMPATIBILITY_2_6
266 // this was replaced by ProcessMouseClick, don't use in new code!
267 virtual void OnMouseClick(wxWindow *window,
268 int x, int y, const wxMouseEvent& event);
269#endif
97494971 270
f65a786f
VS
271 // This method used to adjust pagebreak position. The parameter is variable
272 // that contains y-coordinate of page break (= horizontal line that should
273 // not be crossed by words, images etc.). If this cell cannot be divided
97494971
VS
274 // into two pieces (each one on another page) then it moves the pagebreak
275 // few pixels up.
276 //
277 // Returned value : true if pagebreak was modified, false otherwise
278 // Usage : while (container->AdjustPagebreak(&p)) {}
f65a786f 279 virtual bool AdjustPagebreak(int *pagebreak,
fd0bab43 280 wxArrayInt& known_pagebreaks) const;
97494971
VS
281
282 // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
283 // is true - the cell can be split on two pages
79d6c018 284 void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; }
6953da00 285
8ba2f3ec
VS
286 // Can the line be broken before this cell?
287 virtual bool IsLinebreakAllowed() const
288 { return !IsFormattingCell(); }
97494971 289
f6010d8f
VZ
290 // Returns true for simple == terminal cells, i.e. not composite ones.
291 // This if for internal usage only and may disappear in future versions!
d53c798c 292 virtual bool IsTerminalCell() const { return true; }
f6010d8f 293
f65a786f
VS
294 // Find a cell inside this cell positioned at the given coordinates
295 // (relative to this's positions). Returns NULL if no such cell exists.
296 // The flag can be used to specify whether to look for terminal or
297 // nonterminal cells or both. In either case, returned cell is deepest
298 // cell in cells tree that contains [x,y].
299 virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
adf2eb2d
VS
300 unsigned flags = wxHTML_FIND_EXACT) const;
301
bc55e31b
VS
302 // Returns absolute position of the cell on HTML canvas.
303 // If rootCell is provided, then it's considered to be the root of the
304 // hierarchy and the returned value is relative to it.
305 wxPoint GetAbsPos(wxHtmlCell *rootCell = NULL) const;
306
307 // Returns root cell of the hierarchy (i.e. grand-grand-...-parent that
308 // doesn't have a parent itself)
309 wxHtmlCell *GetRootCell() const;
adf2eb2d
VS
310
311 // Returns first (last) terminal cell inside this cell. It may return NULL,
312 // but it is rare -- only if there are no terminals in the tree.
6953da00 313 virtual wxHtmlCell *GetFirstTerminal() const
adf2eb2d 314 { return wxConstCast(this, wxHtmlCell); }
6953da00 315 virtual wxHtmlCell *GetLastTerminal() const
adf2eb2d 316 { return wxConstCast(this, wxHtmlCell); }
f6010d8f 317
61233023
VS
318 // Returns cell's depth, i.e. how far under the root cell it is
319 // (if it is the root, depth is 0)
320 unsigned GetDepth() const;
6953da00 321
61233023
VS
322 // Returns true if the cell appears before 'cell' in natural order of
323 // cells (= as they are read). If cell A is (grand)parent of cell B,
324 // then both A.IsBefore(B) and B.IsBefore(A) always return true.
325 bool IsBefore(wxHtmlCell *cell) const;
6953da00 326
61233023
VS
327 // Converts the cell into text representation. If sel != NULL then
328 // only part of the cell inside the selection is converted.
329 virtual wxString ConvertToText(wxHtmlSelection *WXUNUSED(sel)) const
330 { return wxEmptyString; }
331
97494971 332protected:
3c115835 333 // pointer to the next cell
97494971 334 wxHtmlCell *m_Next;
3c115835 335 // pointer to parent cell
97494971 336 wxHtmlContainerCell *m_Parent;
3c115835
VS
337
338 // dimensions of fragment (m_Descent is used to position text & images)
97494971 339 long m_Width, m_Height, m_Descent;
3c115835 340 // position where the fragment is drawn:
97494971 341 long m_PosX, m_PosY;
3c115835
VS
342
343 // superscript/subscript/normal:
344 wxHtmlScriptMode m_ScriptMode;
345 long m_ScriptBaseline;
346
347 // destination address if this fragment is hypertext link, NULL otherwise
97494971 348 wxHtmlLinkInfo *m_Link;
3c115835 349 // true if this cell can be placed on pagebreak, false otherwise
97494971 350 bool m_CanLiveOnPagebreak;
3c115835 351 // unique identifier of the cell, generated from "id" property of tags
8938133d 352 wxString m_id;
22f3361e 353
4f44ea36 354 DECLARE_ABSTRACT_CLASS(wxHtmlCell)
22f3361e 355 DECLARE_NO_COPY_CLASS(wxHtmlCell)
5526e819
VS
356};
357
358
359
360
61233023 361// ----------------------------------------------------------------------------
5526e819 362// Inherited cells:
61233023 363// ----------------------------------------------------------------------------
5526e819
VS
364
365
61233023 366// ----------------------------------------------------------------------------
5526e819
VS
367// wxHtmlWordCell
368// Single word in input stream.
61233023 369// ----------------------------------------------------------------------------
5526e819 370
6acba9a7 371class WXDLLIMPEXP_HTML wxHtmlWordCell : public wxHtmlCell
5526e819 372{
97494971 373public:
fbfb8bcc 374 wxHtmlWordCell(const wxString& word, const wxDC& dc);
f65a786f 375 void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
ed9d5d17 376 wxHtmlRenderingInfo& info);
88a1b648 377 virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const;
61233023 378 wxString ConvertToText(wxHtmlSelection *sel) const;
8ba2f3ec
VS
379 bool IsLinebreakAllowed() const { return m_allowLinebreak; }
380
381 void SetPreviousWord(wxHtmlWordCell *cell);
60e87cb1 382
97494971 383protected:
fbfb8bcc
VZ
384 void SetSelectionPrivPos(const wxDC& dc, wxHtmlSelection *s) const;
385 void Split(const wxDC& dc,
169ee861 386 const wxPoint& selFrom, const wxPoint& selTo,
a99798d2 387 unsigned& pos1, unsigned& pos2) const;
6953da00 388
97494971 389 wxString m_Word;
8ba2f3ec 390 bool m_allowLinebreak;
fc7a2a60 391
4f44ea36 392 DECLARE_ABSTRACT_CLASS(wxHtmlWordCell)
fc7a2a60 393 DECLARE_NO_COPY_CLASS(wxHtmlWordCell)
5526e819
VS
394};
395
396
397
398
399
f65a786f
VS
400// Container contains other cells, thus forming tree structure of rendering
401// elements. Basic code of layout algorithm is contained in this class.
6acba9a7 402class WXDLLIMPEXP_HTML wxHtmlContainerCell : public wxHtmlCell
5526e819 403{
97494971
VS
404public:
405 wxHtmlContainerCell(wxHtmlContainerCell *parent);
d3c7fc99 406 virtual ~wxHtmlContainerCell();
97494971
VS
407
408 virtual void Layout(int w);
f65a786f 409 virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
ed9d5d17 410 wxHtmlRenderingInfo& info);
f65a786f 411 virtual void DrawInvisible(wxDC& dc, int x, int y,
ed9d5d17 412 wxHtmlRenderingInfo& info);
fd0bab43
VZ
413/* virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const;*/
414 virtual bool AdjustPagebreak(int *pagebreak, wxArrayInt& known_pagebreaks) const;
97494971
VS
415
416 // insert cell at the end of m_Cells list
417 void InsertCell(wxHtmlCell *cell);
418
419 // sets horizontal/vertical alignment
420 void SetAlignHor(int al) {m_AlignHor = al; m_LastLayout = -1;}
421 int GetAlignHor() const {return m_AlignHor;}
422 void SetAlignVer(int al) {m_AlignVer = al; m_LastLayout = -1;}
423 int GetAlignVer() const {return m_AlignVer;}
424
425 // sets left-border indentation. units is one of wxHTML_UNITS_* constants
426 // what is combination of wxHTML_INDENT_*
427 void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
428 // returns the indentation. ind is one of wxHTML_INDENT_* constants
429 int GetIndent(int ind) const;
430 // returns type of value returned by GetIndent(ind)
431 int GetIndentUnits(int ind) const;
432
433 // sets alignment info based on given tag's params
434 void SetAlign(const wxHtmlTag& tag);
435 // sets floating width adjustment
436 // (examples : 32 percent of parent container,
437 // -15 pixels percent (this means 100 % - 15 pixels)
438 void SetWidthFloat(int w, int units) {m_WidthFloat = w; m_WidthFloatUnits = units; m_LastLayout = -1;}
439 void SetWidthFloat(const wxHtmlTag& tag, double pixel_scale = 1.0);
440 // sets minimal height of this container.
441 void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align; m_LastLayout = -1;}
442
d53c798c 443 void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = true; m_BkColour = clr;}
2b5f62a0
VZ
444 // returns background colour (of wxNullColour if none set), so that widgets can
445 // adapt to it:
446 wxColour GetBackgroundColour();
d53c798c 447 void SetBorder(const wxColour& clr1, const wxColour& clr2) {m_UseBorder = true; m_BorderColour1 = clr1, m_BorderColour2 = clr2;}
97494971
VS
448 virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const;
449 virtual const wxHtmlCell* Find(int condition, const void* param) const;
bc55e31b
VS
450
451#if WXWIN_COMPATIBILITY_2_6
452 // this was replaced by ProcessMouseClick, don't use in new code!
453 virtual void OnMouseClick(wxWindow *window,
454 int x, int y, const wxMouseEvent& event);
455#endif
456 virtual bool ProcessMouseClick(wxHtmlWindowInterface *window,
457 const wxPoint& pos,
458 const wxMouseEvent& event);
97494971 459
61233023 460 virtual wxHtmlCell* GetFirstChild() const { return m_Cells; }
c1dc9f83 461
3c115835
VS
462 // returns last child cell:
463 wxHtmlCell* GetLastChild() const { return m_LastCell; }
97494971 464
f6010d8f 465 // see comment in wxHtmlCell about this method
d53c798c 466 virtual bool IsTerminalCell() const { return false; }
f6010d8f 467
f65a786f 468 virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
adf2eb2d 469 unsigned flags = wxHTML_FIND_EXACT) const;
6953da00 470
adf2eb2d
VS
471 virtual wxHtmlCell *GetFirstTerminal() const;
472 virtual wxHtmlCell *GetLastTerminal() const;
6953da00
WS
473
474
ace0fab4
VS
475 // Removes indentation on top or bottom of the container (i.e. above or
476 // below first/last terminal cell). For internal use only.
3bc7a423 477 virtual void RemoveExtraSpacing(bool top, bool bottom);
f6010d8f 478
ca16b7a9
VS
479 // Returns the maximum possible length of the container.
480 // Call Layout at least once before using GetMaxTotalWidth()
481 virtual int GetMaxTotalWidth() const { return m_MaxTotalWidth; }
482
f65a786f 483protected:
ed9d5d17 484 void UpdateRenderingStatePre(wxHtmlRenderingInfo& info,
f65a786f 485 wxHtmlCell *cell) const;
ed9d5d17 486 void UpdateRenderingStatePost(wxHtmlRenderingInfo& info,
f65a786f 487 wxHtmlCell *cell) const;
6953da00 488
97494971
VS
489protected:
490 int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom;
491 // indentation of subcells. There is always m_Indent pixels
492 // big space between given border of the container and the subcells
493 // it m_Indent < 0 it is in PERCENTS, otherwise it is in pixels
494 int m_MinHeight, m_MinHeightAlign;
495 // minimal height.
496 wxHtmlCell *m_Cells, *m_LastCell;
497 // internal cells, m_Cells points to the first of them, m_LastCell to the last one.
498 // (LastCell is needed only to speed-up InsertCell)
499 int m_AlignHor, m_AlignVer;
500 // alignment horizontal and vertical (left, center, right)
501 int m_WidthFloat, m_WidthFloatUnits;
502 // width float is used in adjustWidth
503 bool m_UseBkColour;
504 wxColour m_BkColour;
505 // background color of this container
506 bool m_UseBorder;
507 wxColour m_BorderColour1, m_BorderColour2;
508 // borders color of this container
509 int m_LastLayout;
510 // if != -1 then call to Layout may be no-op
511 // if previous call to Layout has same argument
ca16b7a9
VS
512 int m_MaxTotalWidth;
513 // Maximum possible length if ignoring line wrap
22f3361e 514
6953da00 515
4f44ea36 516 DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell)
22f3361e 517 DECLARE_NO_COPY_CLASS(wxHtmlContainerCell)
5526e819
VS
518};
519
5526e819
VS
520
521
61233023 522// ---------------------------------------------------------------------------
5526e819
VS
523// wxHtmlColourCell
524// Color changer.
61233023 525// ---------------------------------------------------------------------------
5526e819 526
6acba9a7 527class WXDLLIMPEXP_HTML wxHtmlColourCell : public wxHtmlCell
5526e819 528{
97494971
VS
529public:
530 wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;}
f65a786f 531 virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
ed9d5d17 532 wxHtmlRenderingInfo& info);
f65a786f 533 virtual void DrawInvisible(wxDC& dc, int x, int y,
ed9d5d17 534 wxHtmlRenderingInfo& info);
97494971
VS
535
536protected:
537 wxColour m_Colour;
538 unsigned m_Flags;
fc7a2a60 539
4f44ea36 540 DECLARE_ABSTRACT_CLASS(wxHtmlColourCell)
fc7a2a60 541 DECLARE_NO_COPY_CLASS(wxHtmlColourCell)
5526e819
VS
542};
543
544
545
546
547//--------------------------------------------------------------------------------
548// wxHtmlFontCell
549// Sets actual font used for text rendering
550//--------------------------------------------------------------------------------
551
6acba9a7 552class WXDLLIMPEXP_HTML wxHtmlFontCell : public wxHtmlCell
5526e819 553{
97494971
VS
554public:
555 wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); }
f65a786f 556 virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
ed9d5d17 557 wxHtmlRenderingInfo& info);
f65a786f 558 virtual void DrawInvisible(wxDC& dc, int x, int y,
ed9d5d17 559 wxHtmlRenderingInfo& info);
60e87cb1 560
97494971
VS
561protected:
562 wxFont m_Font;
fc7a2a60 563
4f44ea36 564 DECLARE_ABSTRACT_CLASS(wxHtmlFontCell)
fc7a2a60 565 DECLARE_NO_COPY_CLASS(wxHtmlFontCell)
5526e819
VS
566};
567
568
569
570
571
572
573//--------------------------------------------------------------------------------
574// wxHtmlwidgetCell
575// This cell is connected with wxWindow object
576// You can use it to insert windows into HTML page
577// (buttons, input boxes etc.)
578//--------------------------------------------------------------------------------
579
6acba9a7 580class WXDLLIMPEXP_HTML wxHtmlWidgetCell : public wxHtmlCell
5526e819 581{
97494971
VS
582public:
583 // !!! wnd must have correct parent!
584 // if w != 0 then the m_Wnd has 'floating' width - it adjust
585 // it's width according to parent container's width
586 // (w is percent of parent's width)
587 wxHtmlWidgetCell(wxWindow *wnd, int w = 0);
d3c7fc99 588 virtual ~wxHtmlWidgetCell() { m_Wnd->Destroy(); }
f65a786f 589 virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
ed9d5d17 590 wxHtmlRenderingInfo& info);
f65a786f 591 virtual void DrawInvisible(wxDC& dc, int x, int y,
ed9d5d17 592 wxHtmlRenderingInfo& info);
97494971
VS
593 virtual void Layout(int w);
594
595protected:
596 wxWindow* m_Wnd;
597 int m_WidthFloat;
598 // width float is used in adjustWidth (it is in percents)
22f3361e 599
4f44ea36 600 DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell)
22f3361e 601 DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell)
5526e819
VS
602};
603
604
605
846914d1
VS
606//--------------------------------------------------------------------------------
607// wxHtmlLinkInfo
608// Internal data structure. It represents hypertext link
609//--------------------------------------------------------------------------------
610
6acba9a7 611class WXDLLIMPEXP_HTML wxHtmlLinkInfo : public wxObject
846914d1 612{
97494971
VS
613public:
614 wxHtmlLinkInfo() : wxObject()
615 { m_Href = m_Target = wxEmptyString; m_Event = NULL, m_Cell = NULL; }
616 wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString) : wxObject()
617 { m_Href = href; m_Target = target; m_Event = NULL, m_Cell = NULL; }
618 wxHtmlLinkInfo(const wxHtmlLinkInfo& l) : wxObject()
619 { m_Href = l.m_Href, m_Target = l.m_Target, m_Event = l.m_Event;
620 m_Cell = l.m_Cell; }
621 wxHtmlLinkInfo& operator=(const wxHtmlLinkInfo& l)
622 { m_Href = l.m_Href, m_Target = l.m_Target, m_Event = l.m_Event;
623 m_Cell = l.m_Cell; return *this; }
624
625 void SetEvent(const wxMouseEvent *e) { m_Event = e; }
626 void SetHtmlCell(const wxHtmlCell *e) { m_Cell = e; }
627
628 wxString GetHref() const { return m_Href; }
629 wxString GetTarget() const { return m_Target; }
630 const wxMouseEvent* GetEvent() const { return m_Event; }
631 const wxHtmlCell* GetHtmlCell() const { return m_Cell; }
632
633private:
634 wxString m_Href, m_Target;
635 const wxMouseEvent *m_Event;
636 const wxHtmlCell *m_Cell;
846914d1
VS
637};
638
639
640
61233023
VS
641// ----------------------------------------------------------------------------
642// wxHtmlTerminalCellsInterator
643// ----------------------------------------------------------------------------
644
6acba9a7 645class WXDLLIMPEXP_HTML wxHtmlTerminalCellsInterator
61233023
VS
646{
647public:
648 wxHtmlTerminalCellsInterator(const wxHtmlCell *from, const wxHtmlCell *to)
649 : m_to(to), m_pos(from) {}
650
c9c61efb 651 operator bool() const { return m_pos != NULL; }
61233023
VS
652 const wxHtmlCell* operator++();
653 const wxHtmlCell* operator->() const { return m_pos; }
654 const wxHtmlCell* operator*() const { return m_pos; }
655
656private:
657 const wxHtmlCell *m_to, *m_pos;
658};
659
660
846914d1
VS
661
662#endif // wxUSE_HTML
5526e819 663
69941f05 664#endif // _WX_HTMLCELL_H_
5526e819 665