HTML::Renderer::TableLayout::Row

HTML::Renderer::TableLayout::Row Struct Reference

#include <TableLayout.hpp>

List of all members.

Detailed Description

This defines the layout of a table's row.

You should use this to query a specific row structure and cells informations.


Public Types

enum  RowType { Header = 0, Data = 1, Footer = 2 }
 The row type. More...

Public Member Functions

void appendCell (const Cell &cell)
 Append a new cell in the row.
const uint32 cellCount () const
 Get the number of declared cells in this row.
void ensureSize (const uint32 size, const bool multipleCells=true)
 Make sure the row is at least "size" large.
Cell * getCellOnColumn (int32 index)
 Get the cell which is on the given column index.
const RowType getRowType () const
 Get the row types.
Cell & operator[] (const uint32 index)
 Access cell at given index.
 Row (const RowType type=Data)
 Constructor.

Public Attributes

Container::PlainOldData< Cell
>::Array 		cellArray
 The cell array.
enum HTML::Renderer::TableLayout::Row::RowType rowType
 The row type.

Member Enumeration Documentation

enum HTML::Renderer::TableLayout::Row::RowType

The row type.

Enumerator:
Header  This specifies a row within header.
Data  This specifies a row within data.
Footer  This specifies a row within footer.

Constructor & Destructor Documentation

HTML::Renderer::TableLayout::Row::Row ( const RowType  type = Data  )  [inline]

Constructor.

Member Function Documentation

void HTML::Renderer::TableLayout::Row::appendCell ( const Cell &  cell  )  [inline]

Append a new cell in the row.

The row will include this cell at the end of the cell array

Parameters:
cell The cell to be appended is copied

const uint32 HTML::Renderer::TableLayout::Row::cellCount (  )  const [inline]

Get the number of declared cells in this row.

void HTML::Renderer::TableLayout::Row::ensureSize ( const uint32  size,
const bool  multipleCells = true 
) [inline]

Make sure the row is at least "size" large.

If the row is not large enough (it doesn't have as many cells as specified), then it expanded with "blank" cells or one cell which spans the remaining area depending on the multipleCells parameter.

Parameters:
size The expected row size in cells
multipleCells Should the row be expanded with multiple cells, or 1 spanning cell

Cell* HTML::Renderer::TableLayout::Row::getCellOnColumn ( int32  index  )  [inline]

Get the cell which is on the given column index.

As cells can span on multiple column, this method is a short hand to avoid counting columns by hand.

Parameters:
index The column index to find the cell which render on it
Returns:
0 if no cell match the column index, a pointer on the cell object else

const RowType HTML::Renderer::TableLayout::Row::getRowType (  )  const [inline]

Get the row types.

Cell& HTML::Renderer::TableLayout::Row::operator[] ( const uint32  index  )  [inline]

Access cell at given index.

Member Data Documentation

Container::PlainOldData<Cell>::Array HTML::Renderer::TableLayout::Row::cellArray

The cell array.

enum HTML::Renderer::TableLayout::Row::RowType HTML::Renderer::TableLayout::Row::rowType

The row type.

The documentation for this struct was generated from the following file:

(C) An X-Ryl669 project 2007

This document describes Unlimited Zooming Interface source code. UZI stands for Unlimited Zooming Interface, and source code license is