interface/wx/html/htmlcell.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html/htmlcell.h
   3 // Purpose:     interface of wxHtml*Cell
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxHtmlColourCell
  11
  12     This cell changes the colour of either the background or the foreground.
  13
  14     @library{wxhtml}
  15     @category{html}
  16 */
  17 class wxHtmlColourCell : public wxHtmlCell
  18 {
  19 public:
  20     /**
  21         Constructor.
  22
  23         @param clr
  24             The color
  25         @param flags
  26             Can be one of following:
  27             - wxHTML_CLR_FOREGROUND: change color of text
  28             - wxHTML_CLR_BACKGROUND: change background color
  29     */
  30     wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND);
  31 };
  32
  33
  34
  35 /**
  36     @class wxHtmlWidgetCell
  37
  38     wxHtmlWidgetCell is a class that provides a connection between HTML cells and
  39     widgets (an object derived from wxWindow).
  40     You can use it to display things like forms, input boxes etc. in an HTML window.
  41
  42     wxHtmlWidgetCell takes care of resizing and moving window.
  43
  44     @library{wxhtml}
  45     @category{html}
  46 */
  47 class wxHtmlWidgetCell : public wxHtmlCell
  48 {
  49 public:
  50     /**
  51         Constructor.
  52
  53         @param wnd
  54             Connected window. It is parent window @b must be the wxHtmlWindow object
  55             within which it is displayed!
  56         @param w
  57             Floating width. If non-zero width of wnd window is adjusted so that it is
  58             always w percents of parent container's width. (For example w = 100 means
  59             that the window will always have same width as parent container).
  60     */
  61     wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
  62 };
  63
  64
  65
  66 /**
  67     @class wxHtmlCell
  68
  69     Internal data structure. It represents fragments of parsed HTML page, the
  70     so-called @b cell - a word, picture, table, horizontal line and so on.
  71     It is used by wxHtmlWindow and wxHtmlWinParser to represent HTML page in memory.
  72
  73     You can divide cells into two groups : @e visible cells with non-zero width and
  74     height and @e helper cells (usually with zero width and height) that perform
  75     special actions such as color or font change.
  76
  77     @library{wxhtml}
  78     @category{html}
  79
  80     @see @ref overview_html_cells, wxHtmlContainerCell
  81 */
  82 class wxHtmlCell : public wxObject
  83 {
  84 public:
  85     /**
  86         Constructor.
  87     */
  88     wxHtmlCell();
  89
  90     /**
  91         This method is used to adjust pagebreak position.
  92         The parameter is variable that contains y-coordinate of page break
  93         (= horizontal line that should not be crossed by words, images etc.).
  94         If this cell cannot be divided into two pieces (each one on another page)
  95         then it moves the pagebreak few pixels up.
  96         Returns @true if pagebreak was modified, @false otherwise.
  97
  98         Usage:
  99         @code
 100         while (container->AdjustPagebreak(&p)) {}
 101         @endcode
 102     */
 103     virtual bool AdjustPagebreak(int* pagebreak);
 104
 105     /**
 106         Renders the cell.
 107
 108         @param dc
 109             Device context to which the cell is to be drawn
 110         @param x,y
 111             Coordinates of parent's upper left corner (origin). You must
 112             add this to m_PosX,m_PosY when passing coordinates to dc's methods
 113             Example:
 114             @code
 115                 dc->DrawText("hello", x + m_PosX, y + m_PosY)
 116             @endcode
 117         @param view_y1
 118             y-coord of the first line visible in window.
 119             This is used to optimize rendering speed
 120         @param view_y2
 121             y-coord of the last line visible in window.
 122             This is used to optimize rendering speed
 123     */
 124     virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
 125
 126     /**
 127         This method is called instead of Draw() when the cell is certainly out of
 128         the screen (and thus invisible). This is not nonsense - some tags (like
 129         wxHtmlColourCell or font setter) must be drawn even if they are invisible!
 130
 131         @param dc
 132             Device context to which the cell is to be drawn.
 133         @param x,y
 134             Coordinates of parent's upper left corner. You must
 135             add this to m_PosX,m_PosY when passing coordinates to dc's methods
 136             Example:
 137             @code
 138                 dc->DrawText("hello", x + m_PosX, y + m_PosY)
 139             @endcode
 140     */
 141     virtual void DrawInvisible(wxDC& dc, int x, int y);
 142
 143     /**
 144         Returns pointer to itself if this cell matches condition (or if any of the
 145         cells following in the list matches), @NULL otherwise.
 146         (In other words if you call top-level container's Find() it will
 147         return pointer to the first cell that matches the condition)
 148
 149         It is recommended way how to obtain pointer to particular cell or
 150         to cell of some type (e.g. wxHtmlAnchorCell reacts on wxHTML_COND_ISANCHOR
 151         condition).
 152
 153         @param condition
 154             Unique integer identifier of condition
 155         @param param
 156             Optional parameters
 157     */
 158     virtual const wxHtmlCell* Find(int condition, const void* param) const;
 159
 160     /**
 161         Returns descent value of the cell (m_Descent member).
 162         See explanation:
 163         @image html descent.png
 164     */
 165     int GetDescent() const;
 166
 167     /**
 168         Returns pointer to the first cell in the list.
 169         You can then use child's GetNext() method to obtain pointer to the next
 170         cell in list.
 171
 172         @note This shouldn't be used by the end user. If you need some way of
 173               finding particular cell in the list, try Find() method instead.
 174     */
 175     virtual wxHtmlCell* GetFirstChild() const;
 176
 177     /**
 178         Returns height of the cell (m_Height member).
 179     */
 180     int GetHeight() const;
 181
 182     /**
 183         Returns unique cell identifier if there is any, the empty string otherwise.
 184     */
 185     virtual wxString GetId() const;
 186
 187     /**
 188         Returns hypertext link if associated with this cell or @NULL otherwise.
 189         See wxHtmlLinkInfo. (Note: this makes sense only for visible tags).
 190
 191         @param x,y
 192             Coordinates of position where the user pressed mouse button.
 193             These coordinates are used e.g. by COLORMAP. Values are relative to the
 194             upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)
 195     */
 196     virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const;
 197
 198     /**
 199         Returns cursor to show when mouse pointer is over the cell.
 200
 201         @param window
 202             interface to the parent HTML window
 203     */
 204     virtual wxCursor GetMouseCursor(wxHtmlWindowInterface* window) const;
 205
 206     /**
 207         Returns pointer to the next cell in list (see htmlcell.h if you're
 208         interested in details).
 209     */
 210     wxHtmlCell* GetNext() const;
 211
 212     /**
 213         Returns pointer to parent container.
 214     */
 215     wxHtmlContainerCell* GetParent() const;
 216
 217     /**
 218         Returns X position within parent (the value is relative to parent's
 219         upper left corner). The returned value is meaningful only if
 220         parent's Layout() was called before!
 221     */
 222     int GetPosX() const;
 223
 224     /**
 225         Returns Y position within parent (the value is relative to parent's
 226         upper left corner). The returned value is meaningful only if
 227         parent's Layout() was called before!
 228     */
 229     int GetPosY() const;
 230
 231     /**
 232         Returns width of the cell (m_Width member).
 233     */
 234     int GetWidth() const;
 235
 236     /**
 237         This method performs two actions:
 238         -# adjusts the cell's width according to the fact that maximal possible
 239            width is @e w. (this has sense when working with horizontal lines, tables etc.)
 240         -# prepares layout (=fill-in m_PosX, m_PosY (and sometimes m_Height) members)
 241            based on actual width @e w
 242
 243         It must be called before displaying cells structure because m_PosX and
 244         m_PosY are undefined (or invalid) before calling Layout().
 245     */
 246     virtual void Layout(int w);
 247
 248     /**
 249         This function is simple event handler.
 250         Each time the user clicks mouse button over a cell within wxHtmlWindow
 251         this method of that cell is called.
 252         Default behavior is to call wxHtmlWindow::LoadPage.
 253
 254         @param window
 255             interface to the parent HTML window
 256         @param pos
 257             coordinates of mouse click (this is relative to cell's origin
 258         @param event
 259             mouse event that triggered the call
 260
 261         @return @true if a link was clicked, @false otherwise.
 262
 263         @since 2.7.0 (before OnMouseClick() method served a similar purpose).
 264
 265         @note
 266         If you need more "advanced" event handling you should use wxHtmlBinderCell instead.
 267     */
 268     virtual bool ProcessMouseClick(wxHtmlWindowInterface* window,
 269                                    const wxPoint& pos,
 270                                    const wxMouseEvent& event);
 271
 272     /**
 273         Sets unique cell identifier. Default value is no identifier, i.e. empty string.
 274     */
 275     void SetId(const wxString& id);
 276
 277     /**
 278         Sets the hypertext link associated with this cell.
 279         (Default value is wxHtmlLinkInfo("", "") (no link))
 280     */
 281     void SetLink(const wxHtmlLinkInfo& link);
 282
 283     /**
 284         Sets the next cell in the list. This shouldn't be called by user - it is
 285         to be used only by wxHtmlContainerCell::InsertCell.
 286     */
 287     void SetNext(wxHtmlCell cell);
 288
 289     /**
 290         Sets parent container of this cell.
 291         This is called from wxHtmlContainerCell::InsertCell.
 292     */
 293     void SetParent(wxHtmlContainerCell p);
 294
 295     /**
 296         Sets the cell's position within parent container.
 297     */
 298     virtual void SetPos(int x, int y);
 299 };
 300
 301
 302
 303 /**
 304     @class wxHtmlContainerCell
 305
 306     The wxHtmlContainerCell class is an implementation of a cell that may
 307     contain more cells in it. It is heavily used in the wxHTML layout algorithm.
 308
 309     @library{wxhtml}
 310     @category{html}
 311
 312     @see @ref overview_html_cells
 313 */
 314 class wxHtmlContainerCell : public wxHtmlCell
 315 {
 316 public:
 317     /**
 318         Constructor. @a parent is pointer to parent container or @NULL.
 319     */
 320     wxHtmlContainerCell(wxHtmlContainerCell* parent);
 321
 322     /**
 323         Returns container's horizontal alignment.
 324     */
 325     int GetAlignHor() const;
 326
 327     /**
 328         Returns container's vertical alignment.
 329     */
 330     int GetAlignVer() const;
 331
 332     /**
 333         Returns the background colour of the container or @c wxNullColour if no
 334         background colour is set.
 335     */
 336     wxColour GetBackgroundColour();
 337
 338     /**
 339         Returns the indentation. @a ind is one of the @b wxHTML_INDENT_* constants.
 340
 341         @note You must call GetIndentUnits() with same @a ind parameter in order
 342               to correctly interpret the returned integer value.
 343               It is NOT always in pixels!
 344     */
 345     int GetIndent(int ind) const;
 346
 347     /**
 348         Returns the units of indentation for @a ind where @a ind is one
 349         of the @b wxHTML_INDENT_* constants.
 350     */
 351     int GetIndentUnits(int ind) const;
 352
 353     /**
 354         Inserts a new cell into the container.
 355     */
 356     void InsertCell(wxHtmlCell cell);
 357
 358     /**
 359         Sets the container's alignment (both horizontal and vertical) according to
 360         the values stored in @e tag. (Tags @c ALIGN parameter is extracted.)
 361         In fact it is only a front-end to SetAlignHor() and SetAlignVer().
 362     */
 363     void SetAlign(const wxHtmlTag& tag);
 364
 365     /**
 366         Sets the container's @e horizontal alignment.
 367         During wxHtmlCell::Layout each line is aligned according to @a al value.
 368
 369         @param al
 370             new horizontal alignment. May be one of these values:
 371             - wxHTML_ALIGN_LEFT: lines are left-aligned (default)
 372             - wxHTML_ALIGN_JUSTIFY: lines are justified
 373             - wxHTML_ALIGN_CENTER: lines are centered
 374             - wxHTML_ALIGN_RIGHT: lines are right-aligned
 375     */
 376     void SetAlignHor(int al);
 377
 378     /**
 379         Sets the container's @e vertical alignment. This is per-line alignment!
 380
 381         @param al
 382             new vertical alignment. May be one of these values:
 383             - wxHTML_ALIGN_BOTTOM: cells are over the line (default)
 384             - wxHTML_ALIGN_CENTER: cells are centered on line
 385             - wxHTML_ALIGN_TOP: cells are under the line
 386
 387         @image html alignv.png
 388     */
 389     void SetAlignVer(int al);
 390
 391     /**
 392         Sets the background colour for this container.
 393     */
 394     void SetBackgroundColour(const wxColour& clr);
 395
 396     /**
 397         Sets the border (frame) colours. A border is a rectangle around the container.
 398
 399         @param clr1
 400             Colour of top and left lines
 401         @param clr2
 402             Colour of bottom and right lines
 403     */
 404     void SetBorder(const wxColour& clr1, const wxColour& clr2);
 405
 406     /**
 407         Sets the indentation (free space between borders of container and subcells).
 408
 409         @image html indent.png
 410
 411         @param i
 412             Indentation value.
 413         @param what
 414             Determines which of the four borders we're setting. It is OR
 415             combination of following constants:
 416             - wxHTML_INDENT_TOP: top border
 417             - wxHTML_INDENT_BOTTOM: bottom
 418             - wxHTML_INDENT_LEFT: left
 419             - wxHTML_INDENT_RIGHT: right
 420             - wxHTML_INDENT_HORIZONTAL: left and right
 421             - wxHTML_INDENT_VERTICAL: top and bottom
 422             - wxHTML_INDENT_ALL: all 4 borders
 423         @param units
 424             Units of i. This parameter affects interpretation of value.
 425             - wxHTML_UNITS_PIXELS: @a i is number of pixels
 426             - wxHTML_UNITS_PERCENT: @a i is interpreted as percents of width
 427                                     of parent container
 428     */
 429     void SetIndent(int i, int what, int units = wxHTML_UNITS_PIXELS);
 430
 431     /**
 432         Sets minimal height of the container.
 433         When container's wxHtmlCell::Layout is called, m_Height is set depending
 434         on layout of subcells to the height of area covered by layed-out subcells.
 435         Calling this method guarantees you that the height of container is never
 436         smaller than @a h - even if the subcells cover much smaller area.
 437
 438         @param h
 439             The minimal height.
 440         @param align
 441             If height of the container is lower than the minimum height, empty space
 442             must be inserted somewhere in order to ensure minimal height.
 443             This parameter is one of @c wxHTML_ALIGN_TOP, @c wxHTML_ALIGN_BOTTOM,
 444             @c wxHTML_ALIGN_CENTER. It refers to the contents, not to the
 445             empty place.
 446     */
 447     void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
 448
 449     /**
 450         Sets floating width adjustment.
 451
 452         The normal behaviour of container is that its width is the same as the width of
 453         parent container (and thus you can have only one sub-container per line).
 454         You can change this by setting the floating width adjustment.
 455
 456         @param w
 457             Width of the container. If the value is negative it means
 458             complement to full width of parent container.
 459             E.g. @code SetWidthFloat(-50, wxHTML_UNITS_PIXELS) @endcode sets the
 460             width of container to parent's width minus 50 pixels. This is useful when
 461             creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50).
 462         @param units
 463             Units of w This parameter affects the interpretation of  value.
 464             - wxHTML_UNITS_PIXELS: @a w is number of pixels
 465             - wxHTML_UNITS_PERCENT: @a w is interpreted as percents of width
 466                                     of parent container
 467     */
 468     void SetWidthFloat(int w, int units);
 469
 470     /**
 471         Sets floating width adjustment.
 472
 473         The normal behaviour of container is that its width is the same as the width of
 474         parent container (and thus you can have only one sub-container per line).
 475         You can change this by setting the floating width adjustment.
 476
 477         @param tag
 478             In the second version of method, @a w and @a units info is extracted
 479             from tag's WIDTH parameter.
 480         @param pixel_scale
 481             This is number of real pixels that equals to 1 HTML pixel.
 482     */
 483     void SetWidthFloat(const wxHtmlTag& tag,
 484                        double pixel_scale = 1.0);
 485 };
 486
 487
 488
 489 /**
 490     @class wxHtmlLinkInfo
 491
 492     This class stores all necessary information about hypertext links
 493     (as represented by \<A\> tag in HTML documents).
 494     In current implementation it stores URL and target frame name.
 495
 496     @note Frames are not currently supported by wxHTML!
 497
 498     @library{wxhtml}
 499     @category{html}
 500 */
 501 class wxHtmlLinkInfo : public wxObject
 502 {
 503 public:
 504     /**
 505         Default ctor.
 506     */
 507     wxHtmlLinkInfo();
 508
 509     /**
 510         Construct hypertext link from HREF (aka URL) and TARGET (name of target frame).
 511     */
 512     wxHtmlLinkInfo(const wxString& href,
 513                    const wxString& target = wxEmptyString);
 514
 515     /**
 516         Return pointer to event that generated OnLinkClicked() event.
 517         Valid only within wxHtmlWindow::OnLinkClicked, @NULL otherwise.
 518     */
 519     const wxMouseEvent* GetEvent() const;
 520
 521     /**
 522         Return @e HREF value of the \<A\> tag.
 523     */
 524     wxString GetHref() const;
 525
 526     /**
 527         Return pointer to the cell that was clicked.
 528         Valid only within wxHtmlWindow::OnLinkClicked, @NULL otherwise.
 529     */
 530     const wxHtmlCell* GetHtmlCell() const;
 531
 532     /**
 533         Return @e TARGET value of the \<A\> tag (this value is used to specify
 534         in which frame should be the page pointed by @ref GetHref() Href opened).
 535     */
 536     wxString GetTarget() const;
 537 };
 538