wxhtmlcontainercell

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.

derived from

wxhtmlcell

include files

<wx/html/htmlcell.h>

see also

cells overview

members

wxhtmlcontainercell::wxhtmlcontainercell
wxhtmlcontainercell::getalignhor
wxhtmlcontainercell::getalignver
wxhtmlcontainercell::getbackgroundcolour
wxhtmlcontainercell::getindent
wxhtmlcontainercell::getindentunits
wxhtmlcontainercell::insertcell
wxhtmlcontainercell::setalign
wxhtmlcontainercell::setalignhor
wxhtmlcontainercell::setalignver
wxhtmlcontainercell::setbackgroundcolour
wxhtmlcontainercell::setborder
wxhtmlcontainercell::setindent
wxhtmlcontainercell::setminheight
wxhtmlcontainercell::setwidthfloat

wxhtmlcontainercell::wxhtmlcontainercell

wxhtmlcontainercell(wxhtmlcontainercell *parent)

constructor. parent is pointer to parent container or null.

wxhtmlcontainercell::getalignhor

int getalignhor() const

returns container's horizontal alignment.

wxhtmlcontainercell::getalignver

int getalignver() const

returns container's vertical alignment.

wxhtmlcontainercell::getbackgroundcolour

wxcolour getbackgroundcolour()

returns the background colour of the container or wxnullcolour if no background colour is set.

wxhtmlcontainercell::getindent

int 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!

wxhtmlcontainercell::getindentunits

int getindentunits(int ind) const

returns the units of indentation for ind where ind is one of the wxhtml_indent_* constants.

wxhtmlcontainercell::insertcell

void insertcell(wxhtmlcell *cell)

inserts new cell into the container.

wxhtmlcontainercell::setalign

void 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.

wxhtmlcontainercell::setalignhor

void setalignhor(int al)

sets the container's horizontal alignment. during 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

wxhtmlcontainercell::setalignver

void 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

wxhtmlcontainercell::setbackgroundcolour

void setbackgroundcolour(const wxcolour& clr)

sets the background colour for this container.

wxhtmlcontainercell::setborder

void setborder(const wxcolour& clr1, const wxcolour& clr2)

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

wxhtmlcontainercell::setindent

void 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

wxhtmlcontainercell::setminheight

void setminheight(int h, int align = wxhtml_align_top)

sets minimal height of the container.

when container's 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.

wxhtmlcontainercell::setwidthfloat

void setwidthfloat(int w, int units)

void 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 fwa.

pixel_scale is number of real pixels that equals to 1 html pixel.

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

tag

in the second version of method, w and units info is extracted from tag's width parameter.

wxpython note: the second form of this method is named setwidthfloatfromtag in wxpython.