wx.Html.HtmlCell Class Reference

Inheritance diagram for wx.Html.HtmlCell:

wx.Object wx.Html.HtmlColourCell wx.Html.HtmlContainerCell wx.Html.HtmlFontCell wx.Html.HtmlWidgetCell wx.Html.HtmlWordCell

List of all members.

Public Member Functions

virtual bool AdjustPagebreak (ref int pagebreak)
virtual void Draw (DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info)
</param > *void Draw (DC dc, int x, int y, int view_y1, int view_y2)
virtual void DrawInvisible (DC dc, int x, int y, HtmlRenderingInfo info)
virtual HtmlCell Find (HtmlCond condition, Object param)
HtmlCell Find (HtmlCond condition, string text)
HtmlCell FindCellByPos (int x, int y, HtmlFind mode)
HtmlCell FindCellByPos (Point pos, HtmlFind mode)
HtmlCell FindCellByPos (int x, int y)
HtmlCell FindCellByPos (Point pos)
void GetHorizontalConstraints (out int left, out int right)
string GetTextUpToLength (int maxLength)
 HtmlCell ()
 HtmlCell (IntPtr wxObject)
static IntPtr HtmlCell_GetWxClassInfo ()
bool IsBefore (HtmlCell otherCell)
virtual void Layout (int w)
virtual void OnMouseClick (Window parent, int x, int y, MouseEvent evt)
Point RelativePos (HtmlCell root)
void SetPos (int x, int y)

Static Public Member Functions

static implicit operator HtmlCell (IntPtr obj)

Properties

Point AbsPos [get]
bool CanLiveOnPagebreak [set]
int Descent [get]
HtmlCell FirstChild [get]
HtmlCell FirstTerminal [get]
int Height [get]
virtual string Id [get, set]
bool IsFormattingCell [get]
bool IsTerminalCell [get]
HtmlCell LastTerminal [get]
HtmlLinkInfo Link [get, set]
HtmlCell Next [get, set]
HtmlContainerCell Parent [get, set]
Point Pos [get, set]
int PosX [get]
int PosY [get]
HtmlCell RootCell [get]
string Text [get]
int Width [get]


Detailed Description

Internal representation of HTML in a wx.HtmlWindow. HTML is represented as a tree of nodes, the so-called cells. The framework uses several classes of nodes.

Please note, that the current implementation might not call all virtual methods.


Constructor & Destructor Documentation

wx.Html.HtmlCell.HtmlCell ( IntPtr  wxObject  ) 

wx.Html.HtmlCell.HtmlCell (  ) 


Member Function Documentation

virtual bool wx.Html.HtmlCell.AdjustPagebreak ( ref int  pagebreak  )  [virtual]

Reimplemented in wx.Html.HtmlContainerCell.

virtual void wx.Html.HtmlCell.Draw ( DC  dc,
int  x,
int  y,
int  view_y1,
int  view_y2,
HtmlRenderingInfo  info 
) [virtual]

Renders the cell.

Parameters:
dc Device context to which the cell is to be drawn
x X-Coordinate of the parent's upper left corner (origin). You must add this to m_PosX when passing coordinates to dc's methods Example: dc.DrawText("hello",x+m_PosX,y+m_PosY)
y X-Coordinate of the parent's upper left corner (origin). You must add this to m_PosY when passing coordinates to dc's methods Example: dc.DrawText("hello",x+m_PosX,y+m_PosY)
view_y1 y-coord of the first line visible in window. This is used to optimize rendering speed
view_y2 y-coord of the last line visible in window. This is used to optimize rendering speed
info is optional information on selections etc. that influence the presentation. You may use null here.

Reimplemented in wx.Html.HtmlFontCell, wx.Html.HtmlColourCell, wx.Html.HtmlWidgetCell, wx.Html.HtmlWordCell, and wx.Html.HtmlContainerCell.

</param> * void wx.Html.HtmlCell.Draw ( DC  dc,
int  x,
int  y,
int  view_y1,
int  view_y2 
)

Renders the cell.

Parameters:
dc Device context to which the cell is to be drawn
x X-Coordinate of the parent's upper left corner (origin). You must add this to m_PosX when passing coordinates to dc's methods Example: dc.DrawText("hello",x+m_PosX,y+m_PosY)
y X-Coordinate of the parent's upper left corner (origin). You must add this to m_PosY when passing coordinates to dc's methods Example: dc.DrawText("hello",x+m_PosX,y+m_PosY)
view_y1 y-coord of the first line visible in window. This is used to optimize rendering speed
view_y2 y-coord of the last line visible in window. This is used to optimize rendering speed

virtual void wx.Html.HtmlCell.DrawInvisible ( DC  dc,
int  x,
int  y,
HtmlRenderingInfo  info 
) [virtual]

Reimplemented in wx.Html.HtmlFontCell, wx.Html.HtmlColourCell, wx.Html.HtmlWidgetCell, and wx.Html.HtmlContainerCell.

virtual HtmlCell wx.Html.HtmlCell.Find ( HtmlCond  condition,
Object  param 
) [virtual]

This method returns a pointer to the FIRST cell for that the condition is true.

It first checks if the condition is true for this cell and then calls the next ones. (Note: it checks all subcells if the cell is container). Condition is unique condition identifier (see htmldefs.h) (user-defined condition IDs should start from 10000) and param is optional parameter Example:

         cell.Find(HtmlCond.IS_ANCHOR, "news");
returns pointer to anchor news.

Reimplemented in wx.Html.HtmlContainerCell.

HtmlCell wx.Html.HtmlCell.Find ( HtmlCond  condition,
string  text 
)

This method returns the first cell complying with the designated condition referring to the provided string.

HtmlCell wx.Html.HtmlCell.FindCellByPos ( int  x,
int  y,
HtmlFind  mode 
)

Find a cell which is part of this one according to the provided position relative to this cell. Cf. RelativePos().

HtmlCell wx.Html.HtmlCell.FindCellByPos ( Point  pos,
HtmlFind  mode 
)

Find a cell which is part of this one according to the provided position relative to this cell. Cf. RelativePos().

HtmlCell wx.Html.HtmlCell.FindCellByPos ( int  x,
int  y 
)

Find a cell which is part of this one according to the provided position relative to this cell. Cf. RelativePos().

HtmlCell wx.Html.HtmlCell.FindCellByPos ( Point  pos  ) 

Find a cell which is part of this one according to the provided position relative to this cell. Cf. RelativePos().

void wx.Html.HtmlCell.GetHorizontalConstraints ( out int  left,
out int  right 
)

Reimplemented in wx.Html.HtmlContainerCell.

string wx.Html.HtmlCell.GetTextUpToLength ( int  maxLength  ) 

This will load all texts from this node or the children up to the maximum length. Words will be separated by a single blank.

static IntPtr wx.Html.HtmlCell.HtmlCell_GetWxClassInfo (  ) 

Returns Ptr to the wxWidgets RTTI.

bool wx.Html.HtmlCell.IsBefore ( HtmlCell  otherCell  ) 

Returns true if the cell appears before 'cell' in natural order of cells (as they are read). If cell A is (grand)parent of cell B, then both A.IsBefore(B) and B.IsBefore(A) returns true.

virtual void wx.Html.HtmlCell.Layout ( int  w  )  [virtual]

Reimplemented in wx.Html.HtmlWidgetCell, and wx.Html.HtmlContainerCell.

virtual void wx.Html.HtmlCell.OnMouseClick ( Window  parent,
int  x,
int  y,
MouseEvent  evt 
) [virtual]

Reimplemented in wx.Html.HtmlContainerCell.

static implicit wx.Html.HtmlCell.operator HtmlCell ( IntPtr  obj  )  [static]

Point wx.Html.HtmlCell.RelativePos ( HtmlCell  root  ) 

This returns the position of this cell relative to the argument. The argument shall be a parent or a parent of the parent etc.

void wx.Html.HtmlCell.SetPos ( int  x,
int  y 
)

Deprecated: Use property pos.


Property Documentation

Point wx.Html.HtmlCell.AbsPos [get]

This returns the absolute position of the cell relative to the root.

bool wx.Html.HtmlCell.CanLiveOnPagebreak [set]

int wx.Html.HtmlCell.Descent [get]

HtmlCell wx.Html.HtmlCell.FirstChild [get]

First cell that is part of this node. Follow the HtmlCell.Next() cells to enumerate all direct siblings of this node.

HtmlCell wx.Html.HtmlCell.FirstTerminal [get]

First terminal cell below.

int wx.Html.HtmlCell.Height [get]

virtual string wx.Html.HtmlCell.Id [get, set]

bool wx.Html.HtmlCell.IsFormattingCell [get]

bool wx.Html.HtmlCell.IsTerminalCell [get]

HtmlCell wx.Html.HtmlCell.LastTerminal [get]

Last terminal cell below.

HtmlLinkInfo wx.Html.HtmlCell.Link [get, set]

Get or set the information on contained hyper link. Note, that this infor may be null.

HtmlCell wx.Html.HtmlCell.Next [get, set]

HtmlContainerCell wx.Html.HtmlCell.Parent [get, set]

Point wx.Html.HtmlCell.Pos [get, set]

This is the position of the cell within its parent.

int wx.Html.HtmlCell.PosX [get]

This is the position of the cell within its parent.

int wx.Html.HtmlCell.PosY [get]

This is the position of the cell within its parent.

HtmlCell wx.Html.HtmlCell.RootCell [get]

string wx.Html.HtmlCell.Text [get]

The contained text.

int wx.Html.HtmlCell.Width [get]


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads