Rocket::Controls::ElementDataGridRow Class Reference

#include <ElementDataGridRow.h>

Inheritance diagram for Rocket::Controls::ElementDataGridRow:

Collaboration diagram for Rocket::Controls::ElementDataGridRow:


Public Member Functions
	ElementDataGridRow (const Rocket::Core::String &tag)
void	Initialise (ElementDataGrid parent_grid, ElementDataGridRow parent_row=NULL, int child_index=-1, ElementDataGridRow *header_row=NULL, int depth=-1)
void	SetChildIndex (int child_index)
int	GetDepth ()
void	SetDataSource (const Rocket::Core::String &data_source_name)
bool	UpdateChildren ()
int	GetNumLoadedChildren ()
	Returns the number of children that aren't dirty (have been loaded).
void	RefreshRows ()
bool	IsRowExpanded ()
	Returns whether this row is expanded or not.
void	ExpandRow ()
	Shows all of this row's descendants.
void	CollapseRow ()
	Hides all of this row's descendants.
void	ToggleRow ()
	Expands the row if collapsed, or collapses the row if expanded.
int	GetParentRelativeIndex ()
	Returns the index of this row, relative to its parent.
int	GetTableRelativeIndex ()
	Returns the index of this row, relative to the table rather than its parent.
ElementDataGridRow *	GetParentRow ()
	Returns the parent row of this row.
ElementDataGrid *	GetParentGrid ()
	Returns the grid that this row belongs to.
Protected Member Functions
virtual void	OnDataSourceDestroy (DataSource *data_source)
virtual void	OnRowAdd (DataSource *data_source, const Rocket::Core::String &table, int first_row_added, int num_rows_added)
virtual void	OnRowRemove (DataSource *data_source, const Rocket::Core::String &table, int first_row_removed, int num_rows_removed)
virtual void	OnRowChange (DataSource *data_source, const Rocket::Core::String &table, int first_row_changed, int num_rows_changed)
virtual void	OnRowChange (DataSource *data_source, const Rocket::Core::String &table)
Friends
class	ElementDataGrid

Detailed Description

Class for rows inside a data table. Used for both the header and the individual rows.

Author:: Robert Curry

Member Function Documentation

bool Rocket::Controls::ElementDataGridRow::UpdateChildren ( )

Checks dirty children and cells, and loads them if necessary.

Returns:: True if any children were updated.

virtual void Rocket::Controls::ElementDataGridRow::OnDataSourceDestroy ( DataSource * data_source ) [protected, virtual]

Notification of the destruction of an observed data source.

Parameters:

[in] data_source Data source being destroyed.

Reimplemented from Rocket::Controls::DataSourceListener.

void Rocket::Controls::ElementDataGridRow::OnRowAdd	(	DataSource *	data_source,
		const Rocket::Core::String &	table,
		int	first_row_added,
		int	num_rows_added
	)			`[protected, virtual]`

Notification of the addition of one or more rows to an observed data source's table.

Parameters:

`[in]`	data_source	Data source being changed.
`[in]`	table	The name of the changing table within the data source.
`[in]`	first_row_added	Index of the first new row.
`[in]`	num_rows_added	Number of new sequential rows being added.

Reimplemented from Rocket::Controls::DataSourceListener.

void Rocket::Controls::ElementDataGridRow::OnRowRemove	(	DataSource *	data_source,
		const Rocket::Core::String &	table,
		int	first_row_removed,
		int	num_rows_removed
	)			`[protected, virtual]`

Notification of the removal of one or more rows from an observed data source's table.

Parameters:

`[in]`	data_source	Data source being changed.
`[in]`	table	The name of the changing table within the data source.
`[in]`	first_row_removed	Index of the first removed row.
`[in]`	num_rows_removed	Number of new sequential rows being removed.

Reimplemented from Rocket::Controls::DataSourceListener.

void Rocket::Controls::ElementDataGridRow::OnRowChange	(	DataSource *	data_source,
		const Rocket::Core::String &	table,
		int	first_row_changed,
		int	num_rows_changed
	)			`[protected, virtual]`

Notification of the changing of one or more rows from an observed data source's table.

Parameters:

`[in]`	data_source	Data source being changed.
`[in]`	table	The name of the changing table within the data source.
`[in]`	first_row_removed	Index of the first changed row.
`[in]`	num_rows_removed	Number of new sequential rows being changed.

Reimplemented from Rocket::Controls::DataSourceListener.

void Rocket::Controls::ElementDataGridRow::OnRowChange	(	DataSource *	data_source,
		const Rocket::Core::String &	table
	)			`[protected, virtual]`

Notification of the change of all of the data of an observed data source's table.

Parameters:

`[in]`	data_source	Data source being changed.
`[in]`	table	The name of the changing table within the data source.

Reimplemented from Rocket::Controls::DataSourceListener.

The documentation for this class was generated from the following files:

Include/Rocket/Controls/ElementDataGridRow.h
Source/Controls/ElementDataGridRow.cpp

Rocket::Controls::ElementDataGridRow Class Reference

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation