| Version: 3.0.1

- Main Page
- Related Pages
- Categories
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
wxHtmlContainerCell Class Reference
HTML

`#include <wx/html/htmlcell.h>`

Inheritance diagram for wxHtmlContainerCell:
[legend]

## Detailed Description

The wxHtmlContainerCell class is an implementation of a cell that may contain more cells in it.

It is heavily used in the wxHTML layout algorithm.

##

Library: wxHTML
Category: HTML

See Also
  Cells and Containers

## Public Member Functions

| wxHtmlContainerCell (wxHtmlContainerCell *parent)
| Constructor.
int | GetAlignHor () const
| Returns container's horizontal alignment.
int | GetAlignVer () const
| Returns container's vertical alignment.
wxColour | GetBackgroundColour ()
| Returns the background colour of the container or `wxNullColour` if no background colour is set.
int | GetIndent (int ind) const
| Returns the indentation.
int | GetIndentUnits (int ind) const
| Returns the units of indentation for ind where ind is one of the wxHTML_INDENT_* constants.
void | InsertCell (wxHtmlCell *cell)
| Inserts a new cell into the container.
void | SetAlign (const wxHtmlTag &tag)
| Sets the container's alignment (both horizontal and vertical) according to the values stored in tag.
void | SetAlignHor (int al)
| Sets the container's horizontal alignment.
void | SetAlignVer (int al)
| Sets the container's vertical alignment.
void | SetBackgroundColour (const wxColour &clr)
| Sets the background colour for this container.
void | SetBorder (const wxColour &clr1, const wxColour &clr2, int border=1)
| Sets the border (frame) colours.
void | SetIndent (int i, int what, int units=wxHTML_UNITS_PIXELS)
| Sets the indentation (free space between borders of container and subcells).
void | SetMinHeight (int h, int align=wxHTML_ALIGN_TOP)
| Sets minimal height of the container.
void | SetWidthFloat (int w, int units)
| Sets floating width adjustment.
void | SetWidthFloat (const wxHtmlTag &tag, double pixel_scale=1.0)
| Sets floating width adjustment.
Public Member Functions inherited from wxHtmlCell
| wxHtmlCell ()
| Constructor.
virtual bool | AdjustPagebreak (int *pagebreak, const wxArrayInt &known_pagebreaks, int pageHeight) const
| This method is used to adjust pagebreak position.
virtual void | Draw (wxDC &dc, int x, int y, int view_y1, int view_y2, wxHtmlRenderingInfo &info)
| Renders the cell.
virtual void | DrawInvisible (wxDC &dc, int x, int y, wxHtmlRenderingInfo &info)
| This method is called instead of Draw() when the cell is certainly out of the screen (and thus invisible).
virtual const wxHtmlCell * | Find (int condition, const void *param) const
| Returns pointer to itself if this cell matches condition (or if any of the cells following in the list matches), NULL otherwise.
int | GetDescent () const
| Returns descent value of the cell (m_Descent member).
virtual wxHtmlCell * | GetFirstChild () const
| Returns pointer to the first cell in the list.
int | GetHeight () const
| Returns height of the cell (m_Height member).
const wxString & | GetId () const
| Returns unique cell identifier if there is any, the empty string otherwise.
virtual wxHtmlLinkInfo * | GetLink (int x=0, int y=0) const
| Returns hypertext link if associated with this cell or NULL otherwise.
virtual wxCursor | GetMouseCursor (wxHtmlWindowInterface *window) const
| Returns cursor to show when mouse pointer is over the cell.
virtual wxCursor | GetMouseCursorAt (wxHtmlWindowInterface *window, const wxPoint &rePos) const
| Returns cursor to show when mouse pointer is over the specified point.
wxHtmlCell * | GetNext () const
| Returns pointer to the next cell in list (see htmlcell.h if you're interested in details).
wxHtmlContainerCell * | GetParent () const
| Returns pointer to parent container.
int | GetPosX () const
| Returns X position within parent (the value is relative to parent's upper left corner).
int | GetPosY () const
| Returns Y position within parent (the value is relative to parent's upper left corner).
int | GetWidth () const
| Returns width of the cell (m_Width member).
virtual void | Layout (int w)
| Layouts the cell.
virtual bool | ProcessMouseClick (wxHtmlWindowInterface *window, const wxPoint &pos, const wxMouseEvent &event)
| This function is simple event handler.
void | SetId (const wxString &id)
| Sets unique cell identifier.
void | SetLink (const wxHtmlLinkInfo &link)
| Sets the hypertext link associated with this cell.
void | SetNext (wxHtmlCell *cell)
| Sets the next cell in the list.
void | SetParent (wxHtmlContainerCell *p)
| Sets parent container of this cell.
virtual void | SetPos (int x, int y)
| Sets the cell's position within parent container.
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data.
| wxObject (const wxObject &other)
| Copy ctor.
virtual | ~wxObject ()
| Destructor.
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class.
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj.
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone.
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer.
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data.
void | UnShare ()
| This is the same of AllocExclusive() but this method is public.
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

## Additional Inherited Members

Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object.
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data.

## Constructor & Destructor Documentation

wxHtmlContainerCell::wxHtmlContainerCell | ( | wxHtmlContainerCell * | parent | ) |

Constructor.

parent is pointer to parent container or NULL.

## Member Function Documentation

int wxHtmlContainerCell::GetAlignHor | ( |  | ) | const

Returns container's horizontal alignment.

int wxHtmlContainerCell::GetAlignVer | ( |  | ) | const

Returns container's vertical alignment.

wxColour wxHtmlContainerCell::GetBackgroundColour | ( |  | ) |

Returns the background colour of the container or `wxNullColour` if no background colour is set.

int wxHtmlContainerCell::GetIndent | ( | int | ind | ) | const

Returns the indentation.

ind is one of the wxHTML_INDENT_* constants.

Note
  You must call GetIndentUnits() with same ind parameter in order to correctly interpret the returned integer value. It is NOT always in pixels!

int wxHtmlContainerCell::GetIndentUnits | ( | int | ind | ) | const

Returns the units of indentation for ind where ind is one of the wxHTML_INDENT_* constants.

void wxHtmlContainerCell::InsertCell | ( | wxHtmlCell * | cell | ) |

Inserts a new cell into the container.

void wxHtmlContainerCell::SetAlign | ( | const wxHtmlTag & | tag | ) |

Sets the container's alignment (both horizontal and vertical) according to the values stored in tag.

(Tags `ALIGN` parameter is extracted.) In fact it is only a front-end to SetAlignHor() and SetAlignVer().

void wxHtmlContainerCell::SetAlignHor | ( | int | al | ) |

Sets the container's horizontal alignment.

During wxHtmlCell::Layout each line is aligned according to al value.

Parameters

  al

  new horizontal alignment. May be one of these values:
  - wxHTML_ALIGN_LEFT: lines are left-aligned (default)
  - wxHTML_ALIGN_JUSTIFY: lines are justified
  - wxHTML_ALIGN_CENTER: lines are centered
  - wxHTML_ALIGN_RIGHT: lines are right-aligned

void wxHtmlContainerCell::SetAlignVer | ( | int | al | ) |

Sets the container's vertical alignment.

This is per-line alignment!

Parameters

  al

  new vertical alignment. May be one of these values:
  - wxHTML_ALIGN_BOTTOM: cells are over the line (default)
  - wxHTML_ALIGN_CENTER: cells are centered on line
  - wxHTML_ALIGN_TOP: cells are under the line

void wxHtmlContainerCell::SetBackgroundColour | ( | const wxColour & | clr | ) |

Sets the background colour for this container.

void wxHtmlContainerCell::SetBorder | ( | const wxColour & | clr1,
|  | const wxColour & | clr2,
|  | int | border = `1`
| ) |  |

Sets the border (frame) colours.

A border is a rectangle around the container.

Parameters

  clr1 | Colour of top and left lines
  clr2 | Colour of bottom and right lines
  border | Size of the border in pixels

void wxHtmlContainerCell::SetIndent | ( | int | i,
|  | int | what,
|  | int | units = `wxHTML_UNITS_PIXELS`
| ) |  |

Sets the indentation (free space between borders of container and subcells).

Parameters

  i | Indentation value.

  what

  Determines which of the four borders we're setting. It is OR combination of following constants:
  - wxHTML_INDENT_TOP: top border
  - wxHTML_INDENT_BOTTOM: bottom
  - wxHTML_INDENT_LEFT: left
  - wxHTML_INDENT_RIGHT: right
  - wxHTML_INDENT_HORIZONTAL: left and right
  - wxHTML_INDENT_VERTICAL: top and bottom
  - wxHTML_INDENT_ALL: all 4 borders

  units

  Units of i. This parameter affects interpretation of value.
  - wxHTML_UNITS_PIXELS: i is number of pixels
  - wxHTML_UNITS_PERCENT: i is interpreted as percents of width of parent container

void wxHtmlContainerCell::SetMinHeight | ( | int | h,
|  | int | align = `wxHTML_ALIGN_TOP`
| ) |  |

Sets minimal height of the container.

When container's wxHtmlCell::Layout is called, m_Height is set depending on layout of subcells to the height of area covered by layed-out subcells. Calling this method guarantees you that the height of container is never smaller than h - even if the subcells cover much smaller area.

Parameters

  h | The minimal height.
  align | If height of the container is lower than the minimum height, empty space must be inserted somewhere in order to ensure minimal height. This parameter is one of `wxHTML_ALIGN_TOP`, `wxHTML_ALIGN_BOTTOM`, `wxHTML_ALIGN_CENTER`. It refers to the contents, not to the empty place.

void wxHtmlContainerCell::SetWidthFloat | ( | int | w,
|  | int | units
| ) |  |

Sets floating width adjustment.

The normal behaviour of container is that its width is the same as the width of parent container (and thus you can have only one sub-container per line). You can change this by setting the floating width adjustment.

Parameters

  w | Width of the container. If the value is negative it means complement to full width of parent container. E.g. SetWidthFloat(-50, wxHTML_UNITS_PIXELS) sets the width of container to parent's width minus 50 pixels. This is useful when creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50).

  units

  Units of w This parameter affects the interpretation of value.
  - wxHTML_UNITS_PIXELS: w is number of pixels
  - wxHTML_UNITS_PERCENT: w is interpreted as percents of width of parent container

void wxHtmlContainerCell::SetWidthFloat | ( | const wxHtmlTag & | tag,
|  | double | pixel_scale = `1.0`
| ) |  |

Sets floating width adjustment.

The normal behaviour of container is that its width is the same as the width of parent container (and thus you can have only one sub-container per line). You can change this by setting the floating width adjustment.

Parameters

  tag | In the second version of method, w and units info is extracted from tag's WIDTH parameter.
  pixel_scale | This is number of real pixels that equals to 1 HTML pixel.