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