CL_CSSBox Class Reference
[clanCore CSS]

#include <css_box_layout.h>

Inheritance diagram for CL_CSSBox:

CL_CSSInlineObjectBox CL_CSSInlineTextBox List of all members.

Attributes

enum  Type {
  NULL_BOX, INLINE_BOX, INLINE_TEXT_BOX, INLINE_OBJECT_BOX,
  BLOCK_BOX, LIST_ITEM_BOX, RUN_IN_BOX, COMPACT_BOX,
  MARKER_BOX, TABLE_BOX, INLINE_TABLE_BOX, TABLE_ROW_GROUP_BOX,
  TABLE_HEADER_GROUP_BOX, TABLE_FOOTER_GROUP_BOX, TABLE_ROW_BOX, TABLE_COLUMN_GROUP_BOX,
  TABLE_COLUMN_BOX, TABLE_CELL_BOX, TABLE_CAPTION_BOX
}
CL_CSSBoxLayout get_box_layout ()
 Get Box layout.
Type get_type () const
 Get Type.
CL_CSSBox get_parent_box () const
 Returns the parent of this box.
CL_CSSBox get_first_child () const
 The first child of this box.
CL_CSSBox get_last_child () const
 The last child of this box.
CL_CSSBox get_previous_sibling () const
 The box immediately preceding this box.
CL_CSSBox get_next_sibling () const
 The box immediately following this box.
bool is_null () const
 Returns true if this is a null box.
bool is_anonymous () const
 Returns true if this is an anonymous (generated) box.
bool is_inline_box () const
 Returns true if this is an inline box.
bool is_inline_text_box () const
 Returns true if this is an inline text box.
bool is_inline_object_box () const
 Returns true if this is an inline object box.
bool is_block_box () const
 Returns true if this is a block box.
bool is_list_item_box () const
 Returns true if this is a list item box.
bool is_run_in_box () const
 Returns true if this is a run-in box.
bool is_compact_box () const
 Returns true if this is a compact box.
bool is_marker_box () const
 Returns true if this is a marker box.
bool is_table_box () const
 Returns true if this is a table box.
bool is_inline_table_box () const
 Returns true if this is an inline-table box.
bool is_table_row_group_box () const
 Returns true if this is a table row group box.
bool is_table_header_group_box () const
 Returns true if this is a table header group box.
bool is_table_footer_group_box () const
 Returns true if this is a table footer group box.
bool is_table_row_box () const
 Returns true if this is a table row box.
bool is_table_column_group_box () const
 Returns true if this is a table column group box.
bool is_table_column_box () const
 Returns true if this is a table column box.
bool is_table_cell_box () const
 Returns true if this is a table cell box.
bool is_table_caption_box () const
 Returns true if this is a table caption box.

Public Member Functions

Construction
 CL_CSSBox ()
 CL_CSSBox (CL_SharedPtr< CL_CSSBox_Impl > impl)
 ~CL_CSSBox ()
Operations
CL_CSSInlineTextBox to_inline_text_box () const
 To inline text box.
CL_CSSInlineObjectBox to_inline_object_box () const
 To inline object box.
CL_CSSBox append_child (CL_CSSBox new_child)
 Adds the box new_box to the end of the list of children of this box.
CL_CSSBox remove_child (CL_CSSBox child)
 Removes the box from the list of children of this box.

Protected Attributes

Implementation
CL_SharedPtr< CL_CSSBox_Impl > impl

Detailed Description

(Internal ClanLib Class)


Member Enumeration Documentation

enum CL_CSSBox::Type
 

Enumerator:
NULL_BOX 
INLINE_BOX 
INLINE_TEXT_BOX 
INLINE_OBJECT_BOX 
BLOCK_BOX 
LIST_ITEM_BOX 
RUN_IN_BOX 
COMPACT_BOX 
MARKER_BOX 
TABLE_BOX 
INLINE_TABLE_BOX 
TABLE_ROW_GROUP_BOX 
TABLE_HEADER_GROUP_BOX 
TABLE_FOOTER_GROUP_BOX 
TABLE_ROW_BOX 
TABLE_COLUMN_GROUP_BOX 
TABLE_COLUMN_BOX 
TABLE_CELL_BOX 
TABLE_CAPTION_BOX 


Constructor & Destructor Documentation

CL_CSSBox::CL_CSSBox  ) 
 

CL_CSSBox::CL_CSSBox CL_SharedPtr< CL_CSSBox_Impl >  impl  ) 
 

CL_CSSBox::~CL_CSSBox  ) 
 


Member Function Documentation

CL_CSSBox CL_CSSBox::append_child CL_CSSBox  new_child  ) 
 

Adds the box new_box to the end of the list of children of this box.

If any anonymous boxes are required to make the layout valid, they are automatically generated when the child is appended. For example, if a table cell box is appended to a table box, a table row box is automatically generated and inserted in between the table and the cell.

If new_box is already in the tree, it is first removed.

CL_CSSBoxLayout CL_CSSBox::get_box_layout  ) 
 

Get Box layout.

Returns:
box_layout

CL_CSSBox CL_CSSBox::get_first_child  )  const
 

The first child of this box.

If there is no such box, this returns a null box.

CL_CSSBox CL_CSSBox::get_last_child  )  const
 

The last child of this box.

If there is no such box, this returns a null box.

CL_CSSBox CL_CSSBox::get_next_sibling  )  const
 

The box immediately following this box.

If there is no such box, this returns a null box.

CL_CSSBox CL_CSSBox::get_parent_box  )  const
 

Returns the parent of this box.

If there is no such box, this returns a null box.

CL_CSSBox CL_CSSBox::get_previous_sibling  )  const
 

The box immediately preceding this box.

If there is no such box, this returns a null box.

Type CL_CSSBox::get_type  )  const
 

Get Type.

Returns:
type

bool CL_CSSBox::is_anonymous  )  const
 

Returns true if this is an anonymous (generated) box.

bool CL_CSSBox::is_block_box  )  const
 

Returns true if this is a block box.

bool CL_CSSBox::is_compact_box  )  const
 

Returns true if this is a compact box.

bool CL_CSSBox::is_inline_box  )  const
 

Returns true if this is an inline box.

bool CL_CSSBox::is_inline_object_box  )  const
 

Returns true if this is an inline object box.

bool CL_CSSBox::is_inline_table_box  )  const
 

Returns true if this is an inline-table box.

bool CL_CSSBox::is_inline_text_box  )  const
 

Returns true if this is an inline text box.

bool CL_CSSBox::is_list_item_box  )  const
 

Returns true if this is a list item box.

bool CL_CSSBox::is_marker_box  )  const
 

Returns true if this is a marker box.

bool CL_CSSBox::is_null  )  const
 

Returns true if this is a null box.

bool CL_CSSBox::is_run_in_box  )  const
 

Returns true if this is a run-in box.

bool CL_CSSBox::is_table_box  )  const
 

Returns true if this is a table box.

bool CL_CSSBox::is_table_caption_box  )  const
 

Returns true if this is a table caption box.

bool CL_CSSBox::is_table_cell_box  )  const
 

Returns true if this is a table cell box.

bool CL_CSSBox::is_table_column_box  )  const
 

Returns true if this is a table column box.

bool CL_CSSBox::is_table_column_group_box  )  const
 

Returns true if this is a table column group box.

bool CL_CSSBox::is_table_footer_group_box  )  const
 

Returns true if this is a table footer group box.

bool CL_CSSBox::is_table_header_group_box  )  const
 

Returns true if this is a table header group box.

bool CL_CSSBox::is_table_row_box  )  const
 

Returns true if this is a table row box.

bool CL_CSSBox::is_table_row_group_box  )  const
 

Returns true if this is a table row group box.

CL_CSSBox CL_CSSBox::remove_child CL_CSSBox  child  ) 
 

Removes the box from the list of children of this box.

CL_CSSInlineObjectBox CL_CSSBox::to_inline_object_box  )  const
 

To inline object box.

Returns:
CSSInline Object Box

CL_CSSInlineTextBox CL_CSSBox::to_inline_text_box  )  const
 

To inline text box.

Returns:
CSSInline Text Box


Member Data Documentation

CL_SharedPtr<CL_CSSBox_Impl> CL_CSSBox::impl [protected]
 


The documentation for this class was generated from the following file:
Generated on Thu Dec 3 02:39:35 2009 for ClanLib by  doxygen 1.4.6