docs/latex/wx/htcell.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % htmlcell.tex at 21/Mar/99 22:45:23
   4 %
   5
   6 \section{\class{wxHtmlCell}}\label{wxhtmlcell}
   7
   8 Internal data structure. It represents fragments of parsed HTML
   9 page, the so-called {\bf cell} - a word, picture, table, horizontal line and so on.
  10 It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and
  11 \helpref{wxHtmlWinParser}{wxhtmlwinparser} to represent HTML page in memory.
  12
  13 You can divide cells into two groups : {\it visible} cells with non-zero width and
  14 height and {\it helper} cells (usually with zero width and height) that
  15 perform special actions such as color or font change.
  16
  17 \wxheading{Derived from}
  18
  19 \helpref{wxObject}{wxobject}
  20
  21 \wxheading{Include files}
  22
  23 <wx/html/htmlcell.h>
  24
  25 \wxheading{See Also}
  26
  27 \helpref{Cells Overview}{cells},
  28 \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
  29
  30 \latexignore{\rtfignore{\wxheading{Members}}}
  31
  32 \membersection{wxHtmlCell::wxHtmlCell}\label{wxhtmlcellwxhtmlcell}
  33
  34 \func{}{wxHtmlCell}{\void}
  35
  36 Constructor.
  37
  38 \membersection{wxHtmlCell::AdjustPagebreak}\label{wxhtmlcelladjustpagebreak}
  39
  40 \func{virtual bool}{AdjustPagebreak}{\param{int * }{pagebreak}}
  41
  42 This method is used to adjust pagebreak position. The parameter is
  43 variable that contains y-coordinate of page break (= horizontal line that
  44 should not be crossed by words, images etc.). If this cell cannot be divided
  45 into two pieces (each one on another page) then it moves the pagebreak
  46 few pixels up.
  47
  48 Returns TRUE if pagebreak was modified, FALSE otherwise
  49
  50 Usage:
  51 \begin{verbatim}
  52 while (container->AdjustPagebreak(&p)) {}
  53 \end{verbatim}
  54
  55 \membersection{wxHtmlCell::Draw}\label{wxhtmlcelldraw}
  56
  57 \func{virtual void}{Draw}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{view\_y1}, \param{int }{view\_y2}}
  58
  59 Renders the cell.
  60
  61 \wxheading{Parameters}
  62
  63 \docparam{dc}{Device context to which the cell is to be drawn}
  64
  65 \docparam{x,y}{Coordinates of parent's upper left corner (origin). You must
  66 add this to m\_PosX,m\_PosY when passing coordinates to dc's methods
  67 Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}}
  68
  69 \docparam{view\_y1}{y-coord of the first line visible in window. This is
  70 used to optimize rendering speed}
  71
  72 \docparam{view\_y2}{y-coord of the last line visible in window. This is
  73 used to optimize rendering speed}
  74
  75 \membersection{wxHtmlCell::DrawInvisible}\label{wxhtmlcelldrawinvisible}
  76
  77 \func{virtual void}{DrawInvisible}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}}
  78
  79 This method is called instead of \helpref{Draw}{wxhtmlcelldraw} when the
  80 cell is certainly out of the screen (and thus invisible). This is not
  81 nonsense - some tags (like \helpref{wxHtmlColourCell}{wxhtmlcolourcell}
  82 or font setter) must be drawn even if they are invisible!
  83
  84 \wxheading{Parameters}
  85
  86 \docparam{dc}{Device context to which the cell is to be drawn}
  87
  88 \docparam{x,y}{Coordinates of parent's upper left corner. You must
  89 add this to m\_PosX,m\_PosY when passing coordinates to dc's methods
  90 Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}}
  91
  92 \membersection{wxHtmlCell::Find}\label{wxhtmlcellfind}
  93
  94 \func{virtual const wxHtmlCell*}{Find}{\param{int }{condition}, \param{const void* }{param}}
  95
  96 Returns pointer to itself if this cell matches condition (or if any of the cells
  97 following in the list matches), NULL otherwise.
  98 (In other words if you call top-level container's Find it will
  99 return pointer to the first cell that matches the condition)
 100
 101 It is recommended way how to obtain pointer to particular cell or
 102 to cell of some type (e.g. wxHtmlAnchorCell reacts on
 103 wxHTML\_COND\_ISANCHOR condition)
 104
 105 \wxheading{Parameters}
 106
 107 \docparam{condition}{Unique integer identifier of condition}
 108
 109 \docparam{param}{Optional parameters}
 110
 111 \wxheading{Defined conditions}
 112
 113 \begin{twocollist}\itemsep=0pt
 114 \twocolitem{{\bf wxHTML\_COND\_ISANCHOR}}{Finds particular anchor.
 115 {\it param} is pointer to wxString with name of the anchor.}
 116 \twocolitem{{\bf wxHTML\_COND\_USER}}{User-defined conditions start
 117 from this number.}
 118 \end{twocollist}
 119
 120 \membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent}
 121
 122 \constfunc{int}{GetDescent}{\void}
 123
 124 Returns descent value of the cell (m\_Descent member).
 125 \helponly{See explanation:
 126
 127 \image{}{descent.bmp}
 128 }
 129
 130 \membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight}
 131
 132 \constfunc{int}{GetHeight}{\void}
 133
 134 Returns height of the cell (m\_Height member).
 135
 136 \membersection{wxHtmlCell::GetId}\label{wxhtmlcellgetid}
 137
 138 \constfunc{virtual wxString}{GetId}{\void}
 139
 140 Returns unique cell identifier if there is any, empty string otherwise.
 141
 142 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 143
 144 \constfunc{virtual wxHtmlLinkInfo*}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}
 145
 146 Returns hypertext link if associated with this cell or NULL otherwise.
 147 See \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 148 (Note: this makes sense only for visible tags).
 149
 150 \wxheading{Parameters}
 151
 152 \docparam{x,y}{Coordinates of position where the user pressed mouse button.
 153 These coordinates are used e.g. by COLORMAP. Values are relative to the
 154 upper left corner of THIS cell (i.e. from 0 to m\_Width or m\_Height)}
 155
 156 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 157
 158 \constfunc{wxHtmlCell*}{GetNext}{\void}
 159
 160 Returns pointer to the next cell in list (see htmlcell.h if you're
 161 interested in details).
 162
 163 \membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent}
 164
 165 \constfunc{wxHtmlContainerCell*}{GetParent}{\void}
 166
 167 Returns pointer to parent container.
 168
 169 \membersection{wxHtmlCell::GetPosX}\label{wxhtmlcellgetposx}
 170
 171 \constfunc{int}{GetPosX}{\void}
 172
 173 Returns X position within parent (the value is relative to parent's
 174 upper left corner). The returned value is meaningful only if
 175 parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
 176
 177 \membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy}
 178
 179 \constfunc{int}{GetPosY}{\void}
 180
 181 Returns Y position within parent (the value is relative to parent's
 182 upper left corner). The returned value is meaningful only if
 183 parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
 184
 185 \membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth}
 186
 187 \constfunc{int}{GetWidth}{\void}
 188
 189 Returns width of the cell (m\_Width member).
 190
 191 \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout}
 192
 193 \func{virtual void}{Layout}{\param{int }{w}}
 194
 195 This method performs two actions:
 196
 197 \begin{enumerate}\itemsep=0pt
 198 \item adjusts the cell's width according to the fact that maximal possible width is {\it w}.
 199 (this has sense when working with horizontal lines, tables etc.)
 200 \item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members)
 201 based on actual width {\it w}
 202 \end{enumerate}
 203
 204 It must be called before displaying cells structure because
 205 m\_PosX and m\_PosY are undefined (or invalid)
 206 before calling Layout.
 207
 208 \membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick}
 209
 210 \func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int}{x}, \param{int }{y}, \param{const wxMouseEvent\& }{event}}
 211
 212 This function is simple event handler. Each time the user clicks mouse button over a cell
 213 within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is
 214 that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
 215
 216 \wxheading{Note}
 217
 218 If you need more "advanced" event handling
 219 you should use wxHtmlBinderCell instead.
 220
 221 \wxheading{Parameters}
 222
 223 \docparam{parent}{parent window (always wxHtmlWindow!)}
 224
 225 \docparam{x, y}{coordinates of mouse click (this is relative to cell's origin}
 226
 227 \docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right
 228 button is pressed, FALSE otherwise}
 229
 230 \membersection{wxHtmlCell::SetId}\label{wxhtmlcellsetid}
 231
 232 \func{void}{SetId}{\param{const wxString\& }{id}}
 233
 234 Sets unique cell identifier. Default value is no identifier, i.e. empty string.
 235
 236 \membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
 237
 238 \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
 239
 240 Sets the hypertext link asocciated with this cell. (Default value
 241 is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
 242
 243 \membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}
 244
 245 \func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
 246
 247 Sets the next cell in the list. This shouldn't be called by user - it is
 248 to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
 249
 250 \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}
 251
 252 \func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}}
 253
 254 Sets parent container of this cell. This is called from
 255 \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
 256
 257 \membersection{wxHtmlCell::SetPos}\label{wxhtmlcellsetpos}
 258
 259 \func{void}{SetPos}{\param{int }{x}, \param{int }{y}}
 260
 261 Sets the cell's position within parent container.
 262