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(NO_GCC_PRAGMA)
16 #pragma interface "htmlcell.h"
23 #include "wx/html/htmltag.h"
24 #include "wx/html/htmldefs.h"
25 #include "wx/window.h"
28 class WXDLLIMPEXP_HTML wxHtmlLinkInfo
;
29 class WXDLLIMPEXP_HTML wxHtmlCell
;
30 class WXDLLIMPEXP_HTML 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 WXDLLIMPEXP_HTML 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
, const wxHtmlCell
*fromCell
,
45 const wxPoint
& toPos
, const wxHtmlCell
*toCell
);
46 void Set(const wxHtmlCell
*fromCell
, const 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
; }
60 void ClearPrivPos() { m_toPrivPos
= m_fromPrivPos
= wxDefaultPosition
; }
62 const bool IsEmpty() const
63 { return m_fromPos
== wxDefaultPosition
&&
64 m_toPos
== wxDefaultPosition
; }
67 wxPoint m_fromPos
, m_toPos
;
68 wxPoint m_fromPrivPos
, m_toPrivPos
;
69 const wxHtmlCell
*m_fromCell
, *m_toCell
;
74 enum wxHtmlSelectionState
76 wxHTML_SEL_OUT
, // currently rendered cell is outside the selection
77 wxHTML_SEL_IN
, // ... is inside selection
78 wxHTML_SEL_CHANGING
// ... is the cell on which selection state changes
81 // Selection state is passed to wxHtmlCell::Draw so that it can render itself
82 // differently e.g. when inside text selection or outside it.
83 class WXDLLIMPEXP_HTML wxHtmlRenderingState
86 wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT
) {}
88 void SetSelectionState(wxHtmlSelectionState s
) { m_selState
= s
; }
89 wxHtmlSelectionState
GetSelectionState() const { return m_selState
; }
91 void SetFgColour(const wxColour
& c
) { m_fgColour
= c
; }
92 const wxColour
& GetFgColour() const { return m_fgColour
; }
93 void SetBgColour(const wxColour
& c
) { m_bgColour
= c
; }
94 const wxColour
& GetBgColour() const { return m_bgColour
; }
97 wxHtmlSelectionState m_selState
;
98 wxColour m_fgColour
, m_bgColour
;
102 // HTML rendering customization. This class is used when rendering wxHtmlCells
104 class WXDLLIMPEXP_HTML wxHtmlRenderingStyle
107 virtual wxColour
GetSelectedTextColour(const wxColour
& clr
) = 0;
108 virtual wxColour
GetSelectedTextBgColour(const wxColour
& clr
) = 0;
112 class WXDLLIMPEXP_HTML wxDefaultHtmlRenderingStyle
: public wxHtmlRenderingStyle
115 virtual wxColour
GetSelectedTextColour(const wxColour
& clr
);
116 virtual wxColour
GetSelectedTextBgColour(const wxColour
& clr
);
120 // Information given to cells when drawing them. Contains rendering state,
121 // selection information and rendering style object that can be used to
122 // customize the output.
123 class WXDLLIMPEXP_HTML wxHtmlRenderingInfo
126 wxHtmlRenderingInfo() : m_selection(NULL
), m_style(NULL
) {}
128 void SetSelection(wxHtmlSelection
*s
) { m_selection
= s
; }
129 wxHtmlSelection
*GetSelection() const { return m_selection
; }
131 void SetStyle(wxHtmlRenderingStyle
*style
) { m_style
= style
; }
132 wxHtmlRenderingStyle
& GetStyle() { return *m_style
; }
134 wxHtmlRenderingState
& GetState() { return m_state
; }
137 wxHtmlSelection
*m_selection
;
138 wxHtmlRenderingStyle
*m_style
;
139 wxHtmlRenderingState m_state
;
143 // Flags for wxHtmlCell::FindCellByPos
146 wxHTML_FIND_EXACT
= 1,
147 wxHTML_FIND_NEAREST_BEFORE
= 2,
148 wxHTML_FIND_NEAREST_AFTER
= 4
154 // ---------------------------------------------------------------------------
156 // Internal data structure. It represents fragments of parsed
157 // HTML page - a word, picture, table, horizontal line and so
158 // on. It is used by wxHtmlWindow to represent HTML page in
160 // ---------------------------------------------------------------------------
163 class WXDLLIMPEXP_HTML wxHtmlCell
: public wxObject
167 virtual ~wxHtmlCell();
169 void SetParent(wxHtmlContainerCell
*p
) {m_Parent
= p
;}
170 wxHtmlContainerCell
*GetParent() const {return m_Parent
;}
172 int GetPosX() const {return m_PosX
;}
173 int GetPosY() const {return m_PosY
;}
174 int GetWidth() const {return m_Width
;}
175 int GetHeight() const {return m_Height
;}
176 int GetDescent() const {return m_Descent
;}
178 // Formatting cells are not visible on the screen, they only alter
180 bool IsFormattingCell() const { return m_Width
== 0 && m_Height
== 0; }
182 const wxString
& GetId() const { return m_id
; }
183 void SetId(const wxString
& id
) { m_id
= id
; }
185 // returns the link associated with this cell. The position is position
186 // within the cell so it varies from 0 to m_Width, from 0 to m_Height
187 virtual wxHtmlLinkInfo
* GetLink(int WXUNUSED(x
) = 0,
188 int WXUNUSED(y
) = 0) const
191 // Returns cursor to be used when mouse is over the cell:
192 virtual wxCursor
GetCursor() const;
194 // return next cell among parent's cells
195 wxHtmlCell
*GetNext() const {return m_Next
;}
196 // returns first child cell (if there are any, i.e. if this is container):
197 virtual wxHtmlCell
* GetFirstChild() const { return NULL
; }
199 // members writing methods
200 virtual void SetPos(int x
, int y
) {m_PosX
= x
, m_PosY
= y
;}
201 void SetLink(const wxHtmlLinkInfo
& link
);
202 void SetNext(wxHtmlCell
*cell
) {m_Next
= cell
;}
204 // 1. adjust cell's width according to the fact that maximal possible width
205 // is w. (this has sense when working with horizontal lines, tables
207 // 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height)
208 // members) = place items to fit window, according to the width w
209 virtual void Layout(int w
);
212 virtual void Draw(wxDC
& WXUNUSED(dc
),
213 int WXUNUSED(x
), int WXUNUSED(y
),
214 int WXUNUSED(view_y1
), int WXUNUSED(view_y2
),
215 wxHtmlRenderingInfo
& WXUNUSED(info
)) {}
217 // proceed drawing actions in case the cell is not visible (scrolled out of
218 // screen). This is needed to change fonts, colors and so on.
219 virtual void DrawInvisible(wxDC
& WXUNUSED(dc
),
220 int WXUNUSED(x
), int WXUNUSED(y
),
221 wxHtmlRenderingInfo
& WXUNUSED(info
)) {}
223 // This method returns pointer to the FIRST cell for that
225 // is true. It first checks if the condition is true for this
226 // cell and then calls m_Next->Find(). (Note: it checks
227 // all subcells if the cell is container)
228 // Condition is unique condition identifier (see htmldefs.h)
229 // (user-defined condition IDs should start from 10000)
230 // and param is optional parameter
231 // Example : m_Cell->Find(wxHTML_COND_ISANCHOR, "news");
232 // returns pointer to anchor news
233 virtual const wxHtmlCell
* Find(int condition
, const void* param
) const;
235 // This function is called when mouse button is clicked over the cell.
237 // Parent is pointer to wxHtmlWindow that generated the event
238 // HINT: if this handling is not enough for you you should use
240 virtual void OnMouseClick(wxWindow
*parent
, int x
, int y
, const wxMouseEvent
& event
);
242 // This method used to adjust pagebreak position. The parameter is variable
243 // that contains y-coordinate of page break (= horizontal line that should
244 // not be crossed by words, images etc.). If this cell cannot be divided
245 // into two pieces (each one on another page) then it moves the pagebreak
248 // Returned value : true if pagebreak was modified, false otherwise
249 // Usage : while (container->AdjustPagebreak(&p)) {}
250 virtual bool AdjustPagebreak(int *pagebreak
,
251 int *known_pagebreaks
= NULL
,
252 int number_of_pages
= 0) const;
254 // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
255 // is true - the cell can be split on two pages
256 void SetCanLiveOnPagebreak(bool can
) { m_CanLiveOnPagebreak
= can
; }
258 // Can the line be broken before this cell?
259 virtual bool IsLinebreakAllowed() const
260 { return !IsFormattingCell(); }
262 // Returns true for simple == terminal cells, i.e. not composite ones.
263 // This if for internal usage only and may disappear in future versions!
264 virtual bool IsTerminalCell() const { return TRUE
; }
266 // Find a cell inside this cell positioned at the given coordinates
267 // (relative to this's positions). Returns NULL if no such cell exists.
268 // The flag can be used to specify whether to look for terminal or
269 // nonterminal cells or both. In either case, returned cell is deepest
270 // cell in cells tree that contains [x,y].
271 virtual wxHtmlCell
*FindCellByPos(wxCoord x
, wxCoord y
,
272 unsigned flags
= wxHTML_FIND_EXACT
) const;
274 // Returns absolute position of the cell on HTML canvas
275 wxPoint
GetAbsPos() const;
277 // Returns first (last) terminal cell inside this cell. It may return NULL,
278 // but it is rare -- only if there are no terminals in the tree.
279 virtual wxHtmlCell
*GetFirstTerminal() const
280 { return wxConstCast(this, wxHtmlCell
); }
281 virtual wxHtmlCell
*GetLastTerminal() const
282 { return wxConstCast(this, wxHtmlCell
); }
284 // Returns cell's depth, i.e. how far under the root cell it is
285 // (if it is the root, depth is 0)
286 unsigned GetDepth() const;
288 // Returns true if the cell appears before 'cell' in natural order of
289 // cells (= as they are read). If cell A is (grand)parent of cell B,
290 // then both A.IsBefore(B) and B.IsBefore(A) always return true.
291 bool IsBefore(wxHtmlCell
*cell
) const;
293 // Converts the cell into text representation. If sel != NULL then
294 // only part of the cell inside the selection is converted.
295 virtual wxString
ConvertToText(wxHtmlSelection
*WXUNUSED(sel
)) const
296 { return wxEmptyString
; }
300 // pointer to the next cell
301 wxHtmlContainerCell
*m_Parent
;
302 // pointer to parent cell
303 long m_Width
, m_Height
, m_Descent
;
304 // dimensions of fragment
305 // m_Descent is used to position text&images..
307 // position where the fragment is drawn
308 wxHtmlLinkInfo
*m_Link
;
309 // destination address if this fragment is hypertext link, NULL otherwise
310 bool m_CanLiveOnPagebreak
;
311 // true if this cell can be placed on pagebreak, false otherwise
313 // unique identifier of the cell, generated from "id" property of tags
315 DECLARE_NO_COPY_CLASS(wxHtmlCell
)
321 // ----------------------------------------------------------------------------
323 // ----------------------------------------------------------------------------
326 // ----------------------------------------------------------------------------
328 // Single word in input stream.
329 // ----------------------------------------------------------------------------
331 class WXDLLIMPEXP_HTML wxHtmlWordCell
: public wxHtmlCell
334 wxHtmlWordCell(const wxString
& word
, wxDC
& dc
);
335 void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
336 wxHtmlRenderingInfo
& info
);
337 wxCursor
GetCursor() const;
338 wxString
ConvertToText(wxHtmlSelection
*sel
) const;
339 bool IsLinebreakAllowed() const { return m_allowLinebreak
; }
341 void SetPreviousWord(wxHtmlWordCell
*cell
);
344 void SetSelectionPrivPos(wxDC
& dc
, wxHtmlSelection
*s
) const;
346 const wxPoint
& selFrom
, const wxPoint
& selTo
,
347 unsigned& pos1
, unsigned& pos2
) const;
350 bool m_allowLinebreak
;
352 DECLARE_NO_COPY_CLASS(wxHtmlWordCell
)
359 // Container contains other cells, thus forming tree structure of rendering
360 // elements. Basic code of layout algorithm is contained in this class.
361 class WXDLLIMPEXP_HTML wxHtmlContainerCell
: public wxHtmlCell
364 wxHtmlContainerCell(wxHtmlContainerCell
*parent
);
365 ~wxHtmlContainerCell();
367 virtual void Layout(int w
);
368 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
369 wxHtmlRenderingInfo
& info
);
370 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
371 wxHtmlRenderingInfo
& info
);
372 virtual bool AdjustPagebreak(int *pagebreak
, int *known_pagebreaks
= NULL
, int number_of_pages
= 0) const;
374 // insert cell at the end of m_Cells list
375 void InsertCell(wxHtmlCell
*cell
);
377 // sets horizontal/vertical alignment
378 void SetAlignHor(int al
) {m_AlignHor
= al
; m_LastLayout
= -1;}
379 int GetAlignHor() const {return m_AlignHor
;}
380 void SetAlignVer(int al
) {m_AlignVer
= al
; m_LastLayout
= -1;}
381 int GetAlignVer() const {return m_AlignVer
;}
383 // sets left-border indentation. units is one of wxHTML_UNITS_* constants
384 // what is combination of wxHTML_INDENT_*
385 void SetIndent(int i
, int what
, int units
= wxHTML_UNITS_PIXELS
);
386 // returns the indentation. ind is one of wxHTML_INDENT_* constants
387 int GetIndent(int ind
) const;
388 // returns type of value returned by GetIndent(ind)
389 int GetIndentUnits(int ind
) const;
391 // sets alignment info based on given tag's params
392 void SetAlign(const wxHtmlTag
& tag
);
393 // sets floating width adjustment
394 // (examples : 32 percent of parent container,
395 // -15 pixels percent (this means 100 % - 15 pixels)
396 void SetWidthFloat(int w
, int units
) {m_WidthFloat
= w
; m_WidthFloatUnits
= units
; m_LastLayout
= -1;}
397 void SetWidthFloat(const wxHtmlTag
& tag
, double pixel_scale
= 1.0);
398 // sets minimal height of this container.
399 void SetMinHeight(int h
, int align
= wxHTML_ALIGN_TOP
) {m_MinHeight
= h
; m_MinHeightAlign
= align
; m_LastLayout
= -1;}
401 void SetBackgroundColour(const wxColour
& clr
) {m_UseBkColour
= TRUE
; m_BkColour
= clr
;}
402 // returns background colour (of wxNullColour if none set), so that widgets can
404 wxColour
GetBackgroundColour();
405 void SetBorder(const wxColour
& clr1
, const wxColour
& clr2
) {m_UseBorder
= TRUE
; m_BorderColour1
= clr1
, m_BorderColour2
= clr2
;}
406 virtual wxHtmlLinkInfo
* GetLink(int x
= 0, int y
= 0) const;
407 virtual const wxHtmlCell
* Find(int condition
, const void* param
) const;
408 virtual void OnMouseClick(wxWindow
*parent
, int x
, int y
, const wxMouseEvent
& event
);
410 virtual wxHtmlCell
* GetFirstChild() const { return m_Cells
; }
411 #if WXWIN_COMPATIBILITY_2_4
412 wxDEPRECATED( wxHtmlCell
* GetFirstCell() const );
415 // see comment in wxHtmlCell about this method
416 virtual bool IsTerminalCell() const { return FALSE
; }
418 virtual wxHtmlCell
*FindCellByPos(wxCoord x
, wxCoord y
,
419 unsigned flags
= wxHTML_FIND_EXACT
) const;
421 virtual wxHtmlCell
*GetFirstTerminal() const;
422 virtual wxHtmlCell
*GetLastTerminal() const;
425 // Removes indentation on top or bottom of the container (i.e. above or
426 // below first/last terminal cell). For internal use only.
427 void RemoveExtraSpacing(bool top
, bool bottom
);
430 void UpdateRenderingStatePre(wxHtmlRenderingInfo
& info
,
431 wxHtmlCell
*cell
) const;
432 void UpdateRenderingStatePost(wxHtmlRenderingInfo
& info
,
433 wxHtmlCell
*cell
) const;
436 int m_IndentLeft
, m_IndentRight
, m_IndentTop
, m_IndentBottom
;
437 // indentation of subcells. There is always m_Indent pixels
438 // big space between given border of the container and the subcells
439 // it m_Indent < 0 it is in PERCENTS, otherwise it is in pixels
440 int m_MinHeight
, m_MinHeightAlign
;
442 wxHtmlCell
*m_Cells
, *m_LastCell
;
443 // internal cells, m_Cells points to the first of them, m_LastCell to the last one.
444 // (LastCell is needed only to speed-up InsertCell)
445 int m_AlignHor
, m_AlignVer
;
446 // alignment horizontal and vertical (left, center, right)
447 int m_WidthFloat
, m_WidthFloatUnits
;
448 // width float is used in adjustWidth
451 // background color of this container
453 wxColour m_BorderColour1
, m_BorderColour2
;
454 // borders color of this container
456 // if != -1 then call to Layout may be no-op
457 // if previous call to Layout has same argument
459 DECLARE_NO_COPY_CLASS(wxHtmlContainerCell
)
462 #if WXWIN_COMPATIBILITY_2_4
463 inline wxHtmlCell
* wxHtmlContainerCell::GetFirstCell() const
464 { return GetFirstChild(); }
470 // ---------------------------------------------------------------------------
473 // ---------------------------------------------------------------------------
475 class WXDLLIMPEXP_HTML wxHtmlColourCell
: public wxHtmlCell
478 wxHtmlColourCell(const wxColour
& clr
, int flags
= wxHTML_CLR_FOREGROUND
) : wxHtmlCell() {m_Colour
= clr
; m_Flags
= flags
;}
479 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
480 wxHtmlRenderingInfo
& info
);
481 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
482 wxHtmlRenderingInfo
& info
);
488 DECLARE_NO_COPY_CLASS(wxHtmlColourCell
)
494 //--------------------------------------------------------------------------------
496 // Sets actual font used for text rendering
497 //--------------------------------------------------------------------------------
499 class WXDLLIMPEXP_HTML wxHtmlFontCell
: public wxHtmlCell
502 wxHtmlFontCell(wxFont
*font
) : wxHtmlCell() { m_Font
= (*font
); }
503 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
504 wxHtmlRenderingInfo
& info
);
505 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
506 wxHtmlRenderingInfo
& info
);
511 DECLARE_NO_COPY_CLASS(wxHtmlFontCell
)
519 //--------------------------------------------------------------------------------
521 // This cell is connected with wxWindow object
522 // You can use it to insert windows into HTML page
523 // (buttons, input boxes etc.)
524 //--------------------------------------------------------------------------------
526 class WXDLLIMPEXP_HTML wxHtmlWidgetCell
: public wxHtmlCell
529 // !!! wnd must have correct parent!
530 // if w != 0 then the m_Wnd has 'floating' width - it adjust
531 // it's width according to parent container's width
532 // (w is percent of parent's width)
533 wxHtmlWidgetCell(wxWindow
*wnd
, int w
= 0);
534 ~wxHtmlWidgetCell() { m_Wnd
->Destroy(); }
535 virtual void Draw(wxDC
& dc
, int x
, int y
, int view_y1
, int view_y2
,
536 wxHtmlRenderingInfo
& info
);
537 virtual void DrawInvisible(wxDC
& dc
, int x
, int y
,
538 wxHtmlRenderingInfo
& info
);
539 virtual void Layout(int w
);
544 // width float is used in adjustWidth (it is in percents)
546 DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell
)
551 //--------------------------------------------------------------------------------
553 // Internal data structure. It represents hypertext link
554 //--------------------------------------------------------------------------------
556 class WXDLLIMPEXP_HTML wxHtmlLinkInfo
: public wxObject
559 wxHtmlLinkInfo() : wxObject()
560 { m_Href
= m_Target
= wxEmptyString
; m_Event
= NULL
, m_Cell
= NULL
; }
561 wxHtmlLinkInfo(const wxString
& href
, const wxString
& target
= wxEmptyString
) : wxObject()
562 { m_Href
= href
; m_Target
= target
; m_Event
= NULL
, m_Cell
= NULL
; }
563 wxHtmlLinkInfo(const wxHtmlLinkInfo
& l
) : wxObject()
564 { m_Href
= l
.m_Href
, m_Target
= l
.m_Target
, m_Event
= l
.m_Event
;
566 wxHtmlLinkInfo
& operator=(const wxHtmlLinkInfo
& l
)
567 { m_Href
= l
.m_Href
, m_Target
= l
.m_Target
, m_Event
= l
.m_Event
;
568 m_Cell
= l
.m_Cell
; return *this; }
570 void SetEvent(const wxMouseEvent
*e
) { m_Event
= e
; }
571 void SetHtmlCell(const wxHtmlCell
*e
) { m_Cell
= e
; }
573 wxString
GetHref() const { return m_Href
; }
574 wxString
GetTarget() const { return m_Target
; }
575 const wxMouseEvent
* GetEvent() const { return m_Event
; }
576 const wxHtmlCell
* GetHtmlCell() const { return m_Cell
; }
579 wxString m_Href
, m_Target
;
580 const wxMouseEvent
*m_Event
;
581 const wxHtmlCell
*m_Cell
;
586 // ----------------------------------------------------------------------------
587 // wxHtmlTerminalCellsInterator
588 // ----------------------------------------------------------------------------
590 class WXDLLIMPEXP_HTML wxHtmlTerminalCellsInterator
593 wxHtmlTerminalCellsInterator(const wxHtmlCell
*from
, const wxHtmlCell
*to
)
594 : m_to(to
), m_pos(from
) {}
596 operator bool() const { return m_pos
!= NULL
; }
597 const wxHtmlCell
* operator++();
598 const wxHtmlCell
* operator->() const { return m_pos
; }
599 const wxHtmlCell
* operator*() const { return m_pos
; }
602 const wxHtmlCell
*m_to
, *m_pos
;
609 #endif // _WX_HTMLCELL_H_