1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxHtmlCell class is used by wxHtmlWindow/wxHtmlWinParser
4 // as a basic visual element of HTML page
5 // Author: Vaclav Slavik
7 // Copyright: (c) 1999-2003 Vaclav Slavik
8 // Licence: wxWindows Licence
9 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_HTMLCELL_H_
13 #define _WX_HTMLCELL_H_
15 #if defined(__GNUG__) && !defined(__APPLE__)
16 #pragma interface "htmlcell.h"
23 #include "wx/html/htmltag.h"
24 #include "wx/html/htmldefs.h"
25 #include "wx/window.h"
28 class WXDLLEXPORT wxHtmlLinkInfo
;
29 class WXDLLEXPORT wxHtmlCell
;
30 class WXDLLEXPORT wxHtmlContainerCell
;
33 // wxHtmlSelection is data holder with information about text selection.
34 // Selection is defined by two positions (beginning and end of the selection)
35 // and two leaf(!) cells at these positions.
36 class WXDLLEXPORT wxHtmlSelection
40 : m_fromPos(wxDefaultPosition
), m_toPos(wxDefaultPosition
),
41 m_fromPrivPos(wxDefaultPosition
), m_toPrivPos(wxDefaultPosition
),
42 m_fromCell(NULL
), m_toCell(NULL
) {}
44 void Set(const wxPoint
& fromPos
, wxHtmlCell
*fromCell
,
45 const wxPoint
& toPos
, wxHtmlCell
*toCell
);
46 void Set(wxHtmlCell
*fromCell
, wxHtmlCell
*toCell
);
48 const wxHtmlCell
*GetFromCell() const { return m_fromCell
; }
49 const wxHtmlCell
*GetToCell() const { return m_toCell
; }
51 // these values are in absolute coordinates:
52 const wxPoint
& GetFromPos() const { return m_fromPos
; }
53 const wxPoint
& GetToPos() const { return m_toPos
; }
55 // these are From/ToCell's private data
56 const wxPoint
& GetFromPrivPos() const { return m_fromPrivPos
; }
57 const wxPoint
& GetToPrivPos() const { return m_toPrivPos
; }
58 void SetFromPrivPos(const wxPoint
& pos
) { m_fromPrivPos
= pos
; }
59 void SetToPrivPos(const wxPoint
& pos
) { m_toPrivPos
= pos
; }
61 const bool IsEmpty() const
62 { return m_fromPos
== wxDefaultPosition
&&
63 m_toPos
== wxDefaultPosition
; }
66 wxPoint m_fromPos
, m_toPos
;
67 wxPoint m_fromPrivPos
, m_toPrivPos
;
68 wxHtmlCell
*m_fromCell
, *m_toCell
;
73 enum wxHtmlSelectionState
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
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.
82 class WXDLLEXPORT wxHtmlRenderingState
85 wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT
) {}
87 void SetSelectionState(wxHtmlSelectionState s
) { m_selState
= s
; }
88 wxHtmlSelectionState
GetSelectionState() const { return m_selState
; }
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
; }
96 wxHtmlSelectionState m_selState
;
97 wxColour m_fgColour
, m_bgColour
;
101 // HTML rendering customization. This class is used when rendering wxHtmlCells
103 class WXDLLEXPORT wxHtmlRenderingStyle
106 virtual wxColour
GetSelectedTextColour(const wxColour
& clr
) = 0;
107 virtual wxColour
GetSelectedTextBgColour(const wxColour
& clr
) = 0;
111 class WXDLLEXPORT wxDefaultHtmlRenderingStyle
: public wxHtmlRenderingStyle
114 virtual wxColour
GetSelectedTextColour(const wxColour
& clr
);
115 virtual wxColour
GetSelectedTextBgColour(const wxColour
& clr
);
119 // Information given to cells when drawing them. Contains rendering state,
120 // selection information and rendering style object that can be used to
121 // customize the output.
122 class WXDLLEXPORT wxHtmlRenderingInfo
125 wxHtmlRenderingInfo() : m_selection(NULL
), m_style(NULL
) {}
127 void SetSelection(wxHtmlSelection
*s
) { m_selection
= s
; }
128 wxHtmlSelection
*GetSelection() const { return m_selection
; }
130 void SetStyle(wxHtmlRenderingStyle
*style
) { m_style
= style
; }
131 wxHtmlRenderingStyle
& GetStyle() { return *m_style
; }
133 wxHtmlRenderingState
& GetState() { return m_state
; }
136 wxHtmlSelection
*m_selection
;
137 wxHtmlRenderingStyle
*m_style
;
138 wxHtmlRenderingState m_state
;
142 // Flags for wxHtmlCell::FindCellByPos
145 wxHTML_FIND_EXACT
= 1,
146 wxHTML_FIND_NEAREST_BEFORE
= 2,
147 wxHTML_FIND_NEAREST_AFTER
= 4,
153 // ---------------------------------------------------------------------------
155 // Internal data structure. It represents fragments of parsed
156 // HTML page - a word, picture, table, horizontal line and so
157 // on. It is used by wxHtmlWindow to represent HTML page in
159 // ---------------------------------------------------------------------------
162 class WXDLLEXPORT wxHtmlCell
: public wxObject
166 virtual ~wxHtmlCell();
168 void SetParent(wxHtmlContainerCell
*p
) {m_Parent
= p
;}
169 wxHtmlContainerCell
*GetParent() const {return m_Parent
;}
171 int GetPosX() const {return m_PosX
;}
172 int GetPosY() const {return m_PosY
;}
173 int GetWidth() const {return m_Width
;}
174 int GetHeight() const {return m_Height
;}
175 int GetDescent() const {return m_Descent
;}
177 const wxString
& GetId() const { return m_id
; }
178 void SetId(const wxString
& id
) { m_id
= id
; }
180 // returns the link associated with this cell. The position is position
181 // within the cell so it varies from 0 to m_Width, from 0 to m_Height
182 virtual wxHtmlLinkInfo
* GetLink(int WXUNUSED(x
) = 0,
183 int WXUNUSED(y
) = 0) const
186 // return next cell among parent's cells
187 wxHtmlCell
*GetNext() const {return m_Next
;}
188 // returns first child cell (if there are any, i.e. if this is container):
189 virtual wxHtmlCell
* GetFirstChild() const { return NULL
; }
191 // members writing methods
192 virtual void SetPos(int x
, int y
) {m_PosX
= x
, m_PosY
= y
;}
193 void SetLink(const wxHtmlLinkInfo
& link
);
194 void SetNext(wxHtmlCell
*cell
) {m_Next
= cell
;}
196 // 1. adjust cell's width according to the fact that maximal possible width
197 // is w. (this has sense when working with horizontal lines, tables
199 // 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height)
200 // members) = place items to fit window, according to the width w
201 virtual void Layout(int w
);
204 virtual void Draw(wxDC
& WXUNUSED(dc
),
205 int WXUNUSED(x
), int WXUNUSED(y
),
206 int WXUNUSED(view_y1
), int WXUNUSED(view_y2
),
207 wxHtmlRenderingInfo
& WXUNUSED(info
)) {}
209 // proceed drawing actions in case the cell is not visible (scrolled out of
210 // screen). This is needed to change fonts, colors and so on.
211 virtual void DrawInvisible(wxDC
& WXUNUSED(dc
),
212 int WXUNUSED(x
), int WXUNUSED(y
),
213 wxHtmlRenderingInfo
& WXUNUSED(info
)) {}
215 // This method returns pointer to the FIRST cell for that
217 // is true. It first checks if the condition is true for this
218 // cell and then calls m_Next->Find(). (Note: it checks
219 // all subcells if the cell is container)
220 // Condition is unique condition identifier (see htmldefs.h)
221 // (user-defined condition IDs should start from 10000)
222 // and param is optional parameter
223 // Example : m_Cell->Find(wxHTML_COND_ISANCHOR, "news");
224 // returns pointer to anchor news
225 virtual const wxHtmlCell
* Find(int condition
, const void* param
) const;
227 // This function is called when mouse button is clicked over the cell.
229 // Parent is pointer to wxHtmlWindow that generated the event
230 // HINT: if this handling is not enough for you you should use
232 virtual void OnMouseClick(wxWindow
*parent
, int x
, int y
, const wxMouseEvent
& event
);
234 // This method used to adjust pagebreak position. The parameter is variable
235 // that contains y-coordinate of page break (= horizontal line that should
236 // not be crossed by words, images etc.). If this cell cannot be divided
237 // into two pieces (each one on another page) then it moves the pagebreak
240 // Returned value : true if pagebreak was modified, false otherwise
241 // Usage : while (container->AdjustPagebreak(&p)) {}
242 virtual bool AdjustPagebreak(int *pagebreak
,
243 int *known_pagebreaks
= NULL
,
244 int number_of_pages
= 0) const;
246 // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
247 // is true - the cell can be split on two pages
248 void SetCanLiveOnPagebreak(bool can
) { m_CanLiveOnPagebreak
= can
; }
250 // Returns y-coordinates that contraint the cell, i.e. left is highest
251 // and right lowest coordinate such that the cell lays between then.
252 // Note: this method does not return meaningful values if you haven't
253 // called Layout() before!
254 virtual void GetHorizontalConstraints(int *left
, int *right
) const;
256 // Returns true for simple == terminal cells, i.e. not composite ones.
257 // This if for internal usage only and may disappear in future versions!
258 virtual bool IsTerminalCell() const { return TRUE
; }
260 // Find a cell inside this cell positioned at the given coordinates
261 // (relative to this's positions). Returns NULL if no such cell exists.
262 // The flag can be used to specify whether to look for terminal or
263 // nonterminal cells or both. In either case, returned cell is deepest
264 // cell in cells tree that contains [x,y].
265 virtual wxHtmlCell
*FindCellByPos(wxCoord x
, wxCoord y
,
266 unsigned flags
= wxHTML_FIND_EXACT
) const;
268 // Returns absolute position of the cell on HTML canvas
269 wxPoint
GetAbsPos() const;
271 // Returns first (last) terminal cell inside this cell. It may return NULL,
272 // but it is rare -- only if there are no terminals in the tree.
273 virtual wxHtmlCell
*GetFirstTerminal() const
274 { return wxConstCast(this, wxHtmlCell
); }
275 virtual wxHtmlCell
*GetLastTerminal() const
276 { return wxConstCast(this, wxHtmlCell
); }
278 // Returns cell's depth, i.e. how far under the root cell it is
279 // (if it is the root, depth is 0)
280 unsigned GetDepth() const;
282 // Returns true if the cell appears before 'cell' in natural order of
283 // cells (= as they are read). If cell A is (grand)parent of cell B,
284 // then both A.IsBefore(B) and B.IsBefore(A) always return true.
285 bool IsBefore(wxHtmlCell
*cell
) const;
287 // Sets cell's private position values in wxHtmlSelection
288 virtual void SetSelectionPrivPos(wxDC
& dc
, wxHtmlSelection
*s
) const {}
290 // Converts the cell into text representation. If sel != NULL then
291 // only part of the cell inside the selection is converted.
292 virtual wxString
ConvertToText(wxHtmlSelection
*WXUNUSED(sel
)) const
293 { return wxEmptyString
; }
297 // pointer to the next cell
298 wxHtmlContainerCell
*m_Parent
;
299 // pointer to parent cell
300 long m_Width
, m_Height
, m_Descent
;
301 // dimensions of fragment
302 // m_Descent is used to position text&images..
304 // position where the fragment is drawn
305 wxHtmlLinkInfo
*m_Link
;
306 // destination address if this fragment is hypertext link, NULL otherwise
307 bool m_CanLiveOnPagebreak
;
308 // true if this cell can be placed on pagebreak, false otherwise
310 // unique identifier of the cell, generated from "id" property of tags
312 DECLARE_NO_COPY_CLASS(wxHtmlCell
)
318 // ----------------------------------------------------------------------------
320 // ----------------------------------------------------------------------------
323 // ----------------------------------------------------------------------------
325 // Single word in input stream.
326 // ----------------------------------------------------------------------------
328 class WXDLLEXPORT wxHtmlWordCell
: public wxHtmlCell
331 wxHtmlWordCell(const wxString
& word
, wxDC
& dc
);
332 void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
333 wxHtmlRenderingInfo
& info
);
334 wxString
ConvertToText(wxHtmlSelection
*sel
) const;
335 void SetSelectionPrivPos(wxDC
& dc
, wxHtmlSelection
*s
) const;
339 const wxPoint
& selFrom
, const wxPoint
& selTo
,
340 unsigned& pos1
, unsigned& pos2
) const;
349 // Container contains other cells, thus forming tree structure of rendering
350 // elements. Basic code of layout algorithm is contained in this class.
351 class WXDLLEXPORT wxHtmlContainerCell
: public wxHtmlCell
354 wxHtmlContainerCell(wxHtmlContainerCell
*parent
);
355 ~wxHtmlContainerCell();
357 virtual void Layout(int w
);
358 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
359 wxHtmlRenderingInfo
& info
);
360 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
361 wxHtmlRenderingInfo
& info
);
362 virtual bool AdjustPagebreak(int *pagebreak
, int *known_pagebreaks
= NULL
, int number_of_pages
= 0) const;
364 // insert cell at the end of m_Cells list
365 void InsertCell(wxHtmlCell
*cell
);
367 // sets horizontal/vertical alignment
368 void SetAlignHor(int al
) {m_AlignHor
= al
; m_LastLayout
= -1;}
369 int GetAlignHor() const {return m_AlignHor
;}
370 void SetAlignVer(int al
) {m_AlignVer
= al
; m_LastLayout
= -1;}
371 int GetAlignVer() const {return m_AlignVer
;}
373 // sets left-border indentation. units is one of wxHTML_UNITS_* constants
374 // what is combination of wxHTML_INDENT_*
375 void SetIndent(int i
, int what
, int units
= wxHTML_UNITS_PIXELS
);
376 // returns the indentation. ind is one of wxHTML_INDENT_* constants
377 int GetIndent(int ind
) const;
378 // returns type of value returned by GetIndent(ind)
379 int GetIndentUnits(int ind
) const;
381 // sets alignment info based on given tag's params
382 void SetAlign(const wxHtmlTag
& tag
);
383 // sets floating width adjustment
384 // (examples : 32 percent of parent container,
385 // -15 pixels percent (this means 100 % - 15 pixels)
386 void SetWidthFloat(int w
, int units
) {m_WidthFloat
= w
; m_WidthFloatUnits
= units
; m_LastLayout
= -1;}
387 void SetWidthFloat(const wxHtmlTag
& tag
, double pixel_scale
= 1.0);
388 // sets minimal height of this container.
389 void SetMinHeight(int h
, int align
= wxHTML_ALIGN_TOP
) {m_MinHeight
= h
; m_MinHeightAlign
= align
; m_LastLayout
= -1;}
391 void SetBackgroundColour(const wxColour
& clr
) {m_UseBkColour
= TRUE
; m_BkColour
= clr
;}
392 // returns background colour (of wxNullColour if none set), so that widgets can
394 wxColour
GetBackgroundColour();
395 void SetBorder(const wxColour
& clr1
, const wxColour
& clr2
) {m_UseBorder
= TRUE
; m_BorderColour1
= clr1
, m_BorderColour2
= clr2
;}
396 virtual wxHtmlLinkInfo
* GetLink(int x
= 0, int y
= 0) const;
397 virtual const wxHtmlCell
* Find(int condition
, const void* param
) const;
398 virtual void OnMouseClick(wxWindow
*parent
, int x
, int y
, const wxMouseEvent
& event
);
399 virtual void GetHorizontalConstraints(int *left
, int *right
) const;
401 virtual wxHtmlCell
* GetFirstChild() const { return m_Cells
; }
402 #if WXWIN_COMPATIBILITY_2_4
403 wxDEPRECATED( wxHtmlCell
* GetFirstCell() const );
406 // see comment in wxHtmlCell about this method
407 virtual bool IsTerminalCell() const { return FALSE
; }
409 virtual wxHtmlCell
*FindCellByPos(wxCoord x
, wxCoord y
,
410 unsigned flags
= wxHTML_FIND_EXACT
) const;
412 virtual wxHtmlCell
*GetFirstTerminal() const;
413 virtual wxHtmlCell
*GetLastTerminal() const;
416 void UpdateRenderingStatePre(wxHtmlRenderingInfo
& info
,
417 wxHtmlCell
*cell
) const;
418 void UpdateRenderingStatePost(wxHtmlRenderingInfo
& info
,
419 wxHtmlCell
*cell
) const;
422 int m_IndentLeft
, m_IndentRight
, m_IndentTop
, m_IndentBottom
;
423 // indentation of subcells. There is always m_Indent pixels
424 // big space between given border of the container and the subcells
425 // it m_Indent < 0 it is in PERCENTS, otherwise it is in pixels
426 int m_MinHeight
, m_MinHeightAlign
;
428 wxHtmlCell
*m_Cells
, *m_LastCell
;
429 // internal cells, m_Cells points to the first of them, m_LastCell to the last one.
430 // (LastCell is needed only to speed-up InsertCell)
431 int m_AlignHor
, m_AlignVer
;
432 // alignment horizontal and vertical (left, center, right)
433 int m_WidthFloat
, m_WidthFloatUnits
;
434 // width float is used in adjustWidth
437 // background color of this container
439 wxColour m_BorderColour1
, m_BorderColour2
;
440 // borders color of this container
442 // if != -1 then call to Layout may be no-op
443 // if previous call to Layout has same argument
445 DECLARE_NO_COPY_CLASS(wxHtmlContainerCell
)
448 #if WXWIN_COMPATIBILITY_2_4
449 inline wxHtmlCell
* wxHtmlContainerCell::GetFirstCell() const
450 { return GetFirstChild(); }
456 // ---------------------------------------------------------------------------
459 // ---------------------------------------------------------------------------
461 class WXDLLEXPORT wxHtmlColourCell
: public wxHtmlCell
464 wxHtmlColourCell(const wxColour
& clr
, int flags
= wxHTML_CLR_FOREGROUND
) : wxHtmlCell() {m_Colour
= clr
; m_Flags
= flags
;}
465 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
466 wxHtmlRenderingInfo
& info
);
467 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
468 wxHtmlRenderingInfo
& info
);
478 //--------------------------------------------------------------------------------
480 // Sets actual font used for text rendering
481 //--------------------------------------------------------------------------------
483 class WXDLLEXPORT wxHtmlFontCell
: public wxHtmlCell
486 wxHtmlFontCell(wxFont
*font
) : wxHtmlCell() { m_Font
= (*font
); }
487 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
488 wxHtmlRenderingInfo
& info
);
489 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
490 wxHtmlRenderingInfo
& info
);
501 //--------------------------------------------------------------------------------
503 // This cell is connected with wxWindow object
504 // You can use it to insert windows into HTML page
505 // (buttons, input boxes etc.)
506 //--------------------------------------------------------------------------------
508 class WXDLLEXPORT wxHtmlWidgetCell
: public wxHtmlCell
511 // !!! wnd must have correct parent!
512 // if w != 0 then the m_Wnd has 'floating' width - it adjust
513 // it's width according to parent container's width
514 // (w is percent of parent's width)
515 wxHtmlWidgetCell(wxWindow
*wnd
, int w
= 0);
516 ~wxHtmlWidgetCell() { m_Wnd
->Destroy(); }
517 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
518 wxHtmlRenderingInfo
& info
);
519 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
520 wxHtmlRenderingInfo
& info
);
521 virtual void Layout(int w
);
526 // width float is used in adjustWidth (it is in percents)
528 DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell
)
533 //--------------------------------------------------------------------------------
535 // Internal data structure. It represents hypertext link
536 //--------------------------------------------------------------------------------
538 class WXDLLEXPORT wxHtmlLinkInfo
: public wxObject
541 wxHtmlLinkInfo() : wxObject()
542 { m_Href
= m_Target
= wxEmptyString
; m_Event
= NULL
, m_Cell
= NULL
; }
543 wxHtmlLinkInfo(const wxString
& href
, const wxString
& target
= wxEmptyString
) : wxObject()
544 { m_Href
= href
; m_Target
= target
; m_Event
= NULL
, m_Cell
= NULL
; }
545 wxHtmlLinkInfo(const wxHtmlLinkInfo
& l
) : wxObject()
546 { m_Href
= l
.m_Href
, m_Target
= l
.m_Target
, m_Event
= l
.m_Event
;
548 wxHtmlLinkInfo
& operator=(const wxHtmlLinkInfo
& l
)
549 { m_Href
= l
.m_Href
, m_Target
= l
.m_Target
, m_Event
= l
.m_Event
;
550 m_Cell
= l
.m_Cell
; return *this; }
552 void SetEvent(const wxMouseEvent
*e
) { m_Event
= e
; }
553 void SetHtmlCell(const wxHtmlCell
*e
) { m_Cell
= e
; }
555 wxString
GetHref() const { return m_Href
; }
556 wxString
GetTarget() const { return m_Target
; }
557 const wxMouseEvent
* GetEvent() const { return m_Event
; }
558 const wxHtmlCell
* GetHtmlCell() const { return m_Cell
; }
561 wxString m_Href
, m_Target
;
562 const wxMouseEvent
*m_Event
;
563 const wxHtmlCell
*m_Cell
;
568 // ----------------------------------------------------------------------------
569 // wxHtmlTerminalCellsInterator
570 // ----------------------------------------------------------------------------
572 class WXDLLEXPORT wxHtmlTerminalCellsInterator
575 wxHtmlTerminalCellsInterator(const wxHtmlCell
*from
, const wxHtmlCell
*to
)
576 : m_to(to
), m_pos(from
) {}
578 operator bool() const { return m_pos
!= NULL
; }
579 const wxHtmlCell
* operator++();
580 const wxHtmlCell
* operator->() const { return m_pos
; }
581 const wxHtmlCell
* operator*() const { return m_pos
; }
584 const wxHtmlCell
*m_to
, *m_pos
;
591 #endif // _WX_HTMLCELL_H_