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