Class: Wx::HTML::HtmlContainerCell

Inherits:
HtmlCell show all
Defined in:
lib/wx/doc/gen/html/html_cell.rb

Overview

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

It is heavily used in the Wx::HTML layout algorithm.

Category: Wx::HTML

See Also:

  • and Containers

Requires:

  • USE_HTML

Instance Method Summary collapse

Methods inherited from HtmlCell

#convert_to_text, #find_cell_by_pos, #get_descent, #get_first_child, #get_height, #get_id, #get_link, #get_next, #get_parent, #get_pos_x, #get_pos_y, #get_width, #set_id, #set_link, #set_next, #set_parent, #set_pos

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(parent) ⇒ Wx::HTML::HtmlContainerCell

Constructor.

parent is pointer to parent container or NULL.

Parameters:



338
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 338

def initialize(parent) end

Instance Method Details

#detach(cell) ⇒ void

This method returns an undefined value.

Detach a child cell.

Detaching a cell removes it from this container and allows reattaching it to another one by using #insert_cell. Alternatively, this method can be used to selectively remove some elements of the HTML document tree by deleting the cell after calling it.

Parameters:



345
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 345

def detach(cell) end

#get_align_hor ⇒ Integer Also known as: align_hor

Returns container’s horizontal alignment.

Returns:

  • (Integer) 


349
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 349

def get_align_hor; end

#get_align_ver ⇒ Integer Also known as: align_ver

Returns container’s vertical alignment.

Returns:

  • (Integer) 


354
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 354

def get_align_ver; end

#get_background_colour ⇒ Wx::Colour Also known as: background_colour

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

Returns:



359
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 359

def get_background_colour; end

#get_indent(ind) ⇒ Integer Also known as: indent

Returns the indentation.

ind is one of the Wx::HTML_INDENT_* constants.

Note:

You must call #get_indent_units with same ind parameter in order to correctly interpret the returned integer value. It is NOT always in pixels!

Parameters:

  • ind (Integer)

Returns:

  • (Integer) 


373
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 373

def get_indent(ind) end

#get_indent_units(ind) ⇒ Integer Also known as: indent_units

Returns the units of indentation for ind where ind is one of the Wx::HTML_INDENT_* constants.

Parameters:

  • ind (Integer)

Returns:

  • (Integer) 


379
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 379

def get_indent_units(ind) end

#insert_cell(cell) ⇒ void

This method returns an undefined value.

Inserts a new cell into the container.

Note that the container takes ownership of the cell and will delete it when it itself is destroyed.

Parameters:



387
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 387

def insert_cell(cell) end

#set_align_hor(al) ⇒ void Also known as: align_hor=

This method returns an undefined value.

Sets the container’s horizontal alignment.

During Wx::HTML::HtmlCell#layout each line is aligned according to al value.

Parameters:



399
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 399

def set_align_hor(al) end

#set_align_ver(al) ⇒ void Also known as: align_ver=

This method returns an undefined value.

Sets the container’s vertical alignment.

This is per-line alignment!

Parameters:



411
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 411

def set_align_ver(al) end

#set_background_colour(clr) ⇒ void Also known as: background_colour=

This method returns an undefined value.

Sets the background colour for this container.

Parameters:



417
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 417

def set_background_colour(clr) end

#set_border(clr1, clr2, border = 1) ⇒ void

This method returns an undefined value.

Sets the border (frame) colours.

A border is a rectangle around the container.

Parameters:

  • clr1 (Wx::Colour, String, Symbol) —

    Colour of top and left lines

  • clr2 (Wx::Colour, String, Symbol) —

    Colour of bottom and right lines

  • border (Integer) (defaults to: 1) —

    Size of the border in pixels



427
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 427

def set_border(clr1, clr2, border=1) end

#set_indent(i, what, units = Wx::HTML::HTML_UNITS_PIXELS) ⇒ void

This method returns an undefined value.

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

Parameters:



445
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 445

def set_indent(i, what, units=Wx::HTML::HTML_UNITS_PIXELS) end

#set_min_height(h, align = Wx::HTML::HTML_ALIGN_TOP) ⇒ void Also known as: min_height=

This method returns an undefined value.

Sets minimal height of the container.

When container’s Wx::HTML::HtmlCell#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 (Integer) —

    The minimal height.

  • align (Integer) (defaults to: Wx::HTML::HTML_ALIGN_TOP) —

    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 Wx::HTML::HTML_ALIGN_TOP, Wx::HTML::HTML_ALIGN_BOTTOM, Wx::HTML::HTML_ALIGN_CENTER. It refers to the contents, not to the empty place.



453
 
# File 'lib/wx/doc/gen/html/html_cell.rb', line 453

def set_min_height(h, align=Wx::HTML::HTML_ALIGN_TOP) end