pawsListBoxRow Class Reference

A List Box Row. More...

#include <pawslistbox.h>

List of all members.

Public Member Functions
void	AddColumn (int column, ColumnDef *def)
	adds a column to this row
void	AddTitleColumn (int column, ColumnDef *def)
	creates the title row
pawsWidget *	GetColumn (size_t column)
	get a pointer to one of the columns of this row
int	GetLastIndex () const
	Returns the last index of the row.
size_t	GetTotalColumns ()
	Get total columns.
void	Hide ()
	Handles hiding of the row.
bool	IsHeading ()
bool	OnDoubleClick (int button, int modifiers, int x, int y)
	A double click selects the row.
bool	OnKeyDown (utf32_char keyCode, utf32_char keyChar, int modifiers)
	Process keydown messages.
bool	OnMouseDown (int button, int modifiers, int x, int y)
	A single mouse click (left button) highlights the row.
	pawsListBoxRow (const pawsListBoxRow &origin)
	pawsListBoxRow ()
void	SetHeading (bool flag)
	Heading rows exist within the list but are not clickable.
void	SetLastIndex (int index)
	Sets the last index of the row. Is used by pawsListBox to update lastIndex variable when sorting.
void	SetTitleRow (bool flag)
	Mark a row as title.

---

Detailed Description

A List Box Row.

This is just a container of widgets that represent a list box record.

Definition at line 85 of file pawslistbox.h.

---

Constructor & Destructor Documentation

pawsListBoxRow::pawsListBoxRow

(

)

pawsListBoxRow::pawsListBoxRow

(

const pawsListBoxRow &

origin

)

---

Member Function Documentation

void pawsListBoxRow::AddColumn	(	int	column,
		ColumnDef *	def
	)

adds a column to this row

void pawsListBoxRow::AddTitleColumn	(	int	column,
		ColumnDef *	def
	)

creates the title row

pawsWidget* pawsListBoxRow::GetColumn

(

size_t

column

)

get a pointer to one of the columns of this row

int pawsListBoxRow::GetLastIndex

(

)

const [inline]

Returns the last index of the row.

Definition at line 120 of file pawslistbox.h.

size_t pawsListBoxRow::GetTotalColumns

(

)

[inline]

Get total columns.

Definition at line 94 of file pawslistbox.h.

void pawsListBoxRow::Hide

(

)

[virtual]

Handles hiding of the row.

Used to give focus back to the list box before hiding.

Reimplemented from pawsWidget.

bool pawsListBoxRow::IsHeading

(

)

[inline]

Definition at line 137 of file pawslistbox.h.

bool pawsListBoxRow::OnDoubleClick	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		[virtual]

A double click selects the row.

Reimplemented from pawsWidget.

bool pawsListBoxRow::OnKeyDown	(	utf32_char	keyCode,
		utf32_char	keyChar,
		int	modifiers
	)		[virtual]

Process keydown messages.

Parameters:

keyCode	The code for the pressed key.
keyChar	The key pressed.
modifiers	Used to modify tab behavior.

Returns:

bool TRUE for success FALSE if no action.

Remarks:

If you override this, be sure to also override GetFocusOverridesControls() as returning true

Reimplemented from pawsWidget.

bool pawsListBoxRow::OnMouseDown	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		[virtual]

A single mouse click (left button) highlights the row.

Reimplemented from pawsWidget.

void pawsListBoxRow::SetHeading

(

bool

flag

)

Heading rows exist within the list but are not clickable.

void pawsListBoxRow::SetLastIndex

(

int

index

)

[inline]

Sets the last index of the row. Is used by pawsListBox to update lastIndex variable when sorting.

Definition at line 126 of file pawslistbox.h.

void pawsListBoxRow::SetTitleRow

(

bool

flag

)

Mark a row as title.

---

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

• common/paws/pawslistbox.h