Class: Wx::HTML::HtmlCell

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

Overview

Internal data structure.

It represents fragments of parsed HTML page, the so-called cell - a word, picture, table, horizontal line and so on. It is used by HtmlWindow and Wx::HtmlWinParser to represent HTML page in memory. You can divide cells into two groups : visible cells with non-zero width and height and helper cells (usually with zero width and height) that perform special actions such as color or font change.

Category: Wx::HTML

See Also:

Requires:

  • USE_HTML

Direct Known Subclasses

HtmlContainerCell

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::HTML::HtmlCell

Constructor.



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

def initialize; end

Instance Method Details

#convert_to_text(sel) ⇒ String

Converts the cell into text representation.

If sel != NULL then only part of the cell inside the selection is converted.

Parameters:

Returns:

  • (String) 


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

def convert_to_text(sel) end

#find_cell_by_pos(x, y, flags = Wx::HTML::HTML_FIND_EXACT) ⇒ Wx::HTML::HtmlCell, Wx::HTML::HtmlContainerCell

Find a cell inside this cell positioned at the given coordinates (relative to this’s positions).

Returns NULL if no such cell exists. The flag can be used to specify whether to look for terminal or nonterminal cells or both. In either case, returned cell is deepest cell in cells tree that contains [x,y].

Parameters:

  • x (Integer)
  • y (Integer)
  • flags (unsigned) (defaults to: Wx::HTML::HTML_FIND_EXACT)

Returns:



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

def find_cell_by_pos(x, y, flags=Wx::HTML::HTML_FIND_EXACT) end

#get_descent ⇒ Integer Also known as: descent

Returns descent value of the cell (m_Descent member).

See explanation:

Returns:

  • (Integer) 


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

def get_descent; end

#get_first_child ⇒ Wx::HTML::HtmlCell, Wx::HTML::HtmlContainerCell Also known as: first_child

Returns pointer to the first cell in the list.

You can then use child’s #get_next method to obtain pointer to the next cell in list.

Note:

This shouldn't be used by the end user. If you need some way of finding particular cell in the list, try find method instead.

Returns:



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

def get_first_child; end

#get_height ⇒ Integer Also known as: height

Returns height of the cell (m_Height member).

Returns:

  • (Integer) 


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

def get_height; end

#get_id ⇒ Wx::String Also known as: id

Returns unique cell identifier if there is any, the empty string otherwise.

Returns:

  • (Wx::String) 


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

def get_id; end

#get_link(x = 0, y = 0) ⇒ Wx::HTML::HtmlLinkInfo Also known as: link

Returns hypertext link if associated with this cell or NULL otherwise.

See Wx::HTML::HtmlLinkInfo. (Note: this makes sense only for visible tags).

Parameters:

  • x (Integer) (defaults to: 0) —

    Coordinates of position where the user pressed mouse button. These coordinates are used e.g. by COLORMAP. Values are relative to the upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)

  • y (Integer) (defaults to: 0)

Returns:



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

def get_link(x=0, y=0) end

#get_next ⇒ Wx::HTML::HtmlCell, Wx::HTML::HtmlContainerCell Also known as: next_

Returns pointer to the next cell in list (see htmlcell.h if you’re interested in details).

Returns:



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

def get_next; end

#get_parent ⇒ Wx::HTML::HtmlContainerCell Also known as: parent

Returns pointer to parent container.

Returns:



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

def get_parent; end

#get_pos_x ⇒ Integer Also known as: pos_x

Returns X position within parent (the value is relative to parent’s upper left corner).

The returned value is meaningful only if parent’s layout was called before!

Returns:

  • (Integer) 


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

def get_pos_x; end

#get_pos_y ⇒ Integer Also known as: pos_y

Returns Y position within parent (the value is relative to parent’s upper left corner).

The returned value is meaningful only if parent’s layout was called before!

Returns:

  • (Integer) 


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

def get_pos_y; end

#get_width ⇒ Integer Also known as: width

Returns width of the cell (m_Width member).

Returns:

  • (Integer) 


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

def get_width; end

#set_id(id) ⇒ void Also known as: id=

This method returns an undefined value.

Sets unique cell identifier.

Default value is no identifier, i.e. empty string.

Parameters:

  • id (String) 


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

def set_id(id) end

#set_link(link) ⇒ void Also known as: link=

This method returns an undefined value.

Sets the hypertext link associated with this cell.

(Default value is Wx::HTML::HtmlLinkInfo(“”, “”) (no link))

Parameters:



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

def set_link(link) end

#set_next(cell) ⇒ void Also known as: next_=

This method returns an undefined value.

Sets the next cell in the list.

This shouldn’t be called by user - it is to be used only by Wx::HTML::HtmlContainerCell#insert_cell.

Parameters:



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

def set_next(cell) end

#set_parent(p) ⇒ void Also known as: parent=

This method returns an undefined value.

Sets parent container of this cell.

This is called from Wx::HTML::HtmlContainerCell#insert_cell.

Parameters:



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

def set_parent(p) end

#set_pos(x, y) ⇒ void

This method returns an undefined value.

Sets the cell’s position within parent container.

Parameters:

  • x (Integer)
  • y (Integer) 


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

def set_pos(x, y) end