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