SkyGI::CategoryView Class Reference

Inheritance diagram for SkyGI::CategoryView:[legend]Collaboration diagram for SkyGI::CategoryView:[legend]List of all members.

Public Member Functions
	CategoryView (Window *pParent, const Rect rFrame, unsigned int nWindowLayoutFlags, unsigned int uiCategoryViewFlags=0)
	~CategoryView ()
void	Paint (const Rect &rDirty)
void	HandleMessage (const Message *pMessage)
void	KeyDown (const InputEvent &nInputEvent)
bool	FocusGet ()
bool	FocusLost ()
void	MouseDown (const InputEvent &nInputEvent)
void	MouseUp (const InputEvent &nInputEvent)
void	MouseWheel (const InputEvent &nInputEvent)
void	Sized (const Point &pDelta)
void	Append (CategoryViewRow *pCategoryViewRow)
void	Select (int iIndex, bool bSelect, bool bOnSelected, const InputEvent &nInputEvent)
void	Select (CategoryViewRow *pRow, bool bSelect)
void	Select (int iIndex, bool bSelect)
void	ClearSelection ()
void	SelectRange (int iStart, int iEnd, bool bOnSelected, const InputEvent &nInputEvent)
CategoryViewRow *	GetSelected ()
std::vector< CategoryViewRow * >	GetSelection ()
void	ShowIcons (bool bShow)
bool	HasIcons ()
void	SetIconSpacing (int iSpacing)
int	GetIconSpacing ()
void	ShowHeader (bool bShow)
bool	HasHeader ()
CategoryViewColumn *	GetColumn (int iIndex)
void	AppendColumn (CategoryViewColumn *pColumn)
int	GetColumnIndexAt (const Point &pPos)
int	GetColumns ()
void	LayoutColumns ()
void	SetCursor (int iIndex)
void	SetCursor (CategoryViewRow *pRow)
int	GetCursor ()
CategoryViewRow *	GetCursorRow ()
void	RemoveAll ()
virtual void	OnSelected (int iRowIndex, const InputEvent &nInputEvent)
void	RemoveColumns ()
virtual void	SortRows ()
void	Sort ()
void	Sort (int iColumnIndex)
void	SetSortColumn (int iColumnIndex)
int	GetSortColumn ()
SortOrder	GetSortOrder ()
void	SetSortOrder (SortOrder nSortOrder)
void	SetAutoSort (bool bAutoSort=true)
bool	GetAutoSort ()
void	SetKeyLookupColumn (int iColumn=-1)
CategoryViewRow *	GetRow (int iIndex)
void	RemoveRow (int iIndex)
void	InvalidateRow (int iIndex)
int	GetSelectionCount ()
void	MouseMove (const InputEvent &nInputEvent)
virtual void	OnContextMenu (const InputEvent &nInputEvent)
Public Attributes
signal2< int, const InputEvent & >	Selected
signal1< const InputEvent & >	ContextMenu

---

Constructor & Destructor Documentation

SkyGI::CategoryView::CategoryView	(	Window *	pParent,
		const Rect	rFrame,
		unsigned int	nWindowLayoutFlags,
		unsigned int	uiCategoryViewFlags = 0
	)

SkyGI::CategoryView::~CategoryView

(

)

---

Member Function Documentation

void SkyGI::CategoryView::Paint

(

const Rect &

rDirty

)

[virtual]

Paint window content

Description:

This function gets called whenever an area of the window has to be redrawn. Usually you should only draw from inside the Paint function. If you need to redraw a window (when lets say some content must be updated), simply call Invalidate() which will then (asynchronly) call this paint function.

Usually you should draw the background using Window::DrawBackground(rDirty) and the border with DrawBorder(rRect). This way the user has full control over the appearance of your window, meaning he can change the background and border style.
The window content area itself is defined by the border margin and the window margin. Every window may define a margin. If you draw content into this window always make sure to not draw into the margin area. Additionally, the border has a margin too. As the user has full control to select any border for your window make sure to user the current borders margin when drawing window content. the dra Window::Paint() just redraws the background using DrawBackground. Overload this member function to add custom dawing code

Overload this member function to add custom dawing code

Parameters:

rDirty

- Dirty rectangular region which has to be redrawn. Prior entering this function the painters clip region is automatically set to this dirty region.

See also:

DrawBorder, DrawBackground, Border, GetBorder, GetBorder::Margin, GetMargin

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::HandleMessage

(

const Message *

pMessage

)

[virtual]

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::KeyDown

(

const InputEvent &

nInputEvent

)

[virtual]

Reimplemented from SkyGI::Window.

bool SkyGI::CategoryView::FocusGet

(

)

[virtual]

Reimplemented from SkyGI::Window.

bool SkyGI::CategoryView::FocusLost

(

)

[virtual]

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::MouseDown

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse pressed

Description:

This function gets called when a mouse press occured inside this window.

Overload this member function to react on mouse presses.

Parameters:

	nButton	- MouseButton which was pressed
	nMouseButtonMask	- Mask showing which mouse buttons were pressed when the mouse press occured
	nInputEvent	- INPUT_EVENT_MOUSE_PRESS for a single and INPUTE_EVENT_MOUSE_DOUBLECLICK for a doubleclick

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::MouseUp

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse release

Description:

This function gets called when a mouse release occured inside this window.

Overload this member function to react on mouse releases.

Parameters:

	nButton	- MouseButton which was released
	nMouseButtonMask	- Mask showing which additional mouse buttons were pressed when the mouse release occured
	nInputEvent	- INPUT_EVENT_MOUSE_RELEASE

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::MouseWheel

(

const InputEvent &

nInputEvent

)

[virtual]

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::Sized

(

const Point &

pDelta

)

[virtual]

Called when window is resized

Description:

Overload this function to get notified when the window is resized

Note:

Call this function from the overloaded function to perform automatic window layout on child windows

Parameters:

pDelta

- Size the window was resized

See also:

MoveTo, MoveBy, SetRect, Moved, Layout

Reimplemented from SkyGI::Window.

void SkyGI::CategoryView::Append

(

CategoryViewRow *

pCategoryViewRow

)

void SkyGI::CategoryView::Select	(	int	iIndex,
		bool	bSelect,
		bool	bOnSelected,
		const InputEvent &	nInputEvent
	)

void SkyGI::CategoryView::Select	(	CategoryViewRow *	pRow,
		bool	bSelect
	)

void SkyGI::CategoryView::Select	(	int	iIndex,
		bool	bSelect
	)

void SkyGI::CategoryView::ClearSelection

(

)

void SkyGI::CategoryView::SelectRange	(	int	iStart,
		int	iEnd,
		bool	bOnSelected,
		const InputEvent &	nInputEvent
	)

CategoryViewRow* SkyGI::CategoryView::GetSelected

(

)

std::vector<CategoryViewRow*> SkyGI::CategoryView::GetSelection

(

)

void SkyGI::CategoryView::ShowIcons

(

bool

bShow

)

bool SkyGI::CategoryView::HasIcons

(

)

void SkyGI::CategoryView::SetIconSpacing

(

int

iSpacing

)

int SkyGI::CategoryView::GetIconSpacing

(

)

void SkyGI::CategoryView::ShowHeader

(

bool

bShow

)

bool SkyGI::CategoryView::HasHeader

(

)

CategoryViewColumn* SkyGI::CategoryView::GetColumn

(

int

iIndex

)

void SkyGI::CategoryView::AppendColumn

(

CategoryViewColumn *

pColumn

)

int SkyGI::CategoryView::GetColumnIndexAt

(

const Point &

pPos

)

int SkyGI::CategoryView::GetColumns

(

)

void SkyGI::CategoryView::LayoutColumns

(

)

void SkyGI::CategoryView::SetCursor

(

int

iIndex

)

void SkyGI::CategoryView::SetCursor

(

CategoryViewRow *

pRow

)

int SkyGI::CategoryView::GetCursor

(

)

CategoryViewRow* SkyGI::CategoryView::GetCursorRow

(

)

void SkyGI::CategoryView::RemoveAll

(

)

virtual void SkyGI::CategoryView::OnSelected	(	int	iRowIndex,
		const InputEvent &	nInputEvent
	)			[virtual]

void SkyGI::CategoryView::RemoveColumns

(

)

virtual void SkyGI::CategoryView::SortRows

(

)

[virtual]

void SkyGI::CategoryView::Sort

(

)

void SkyGI::CategoryView::Sort

(

int

iColumnIndex

)

void SkyGI::CategoryView::SetSortColumn

(

int

iColumnIndex

)

int SkyGI::CategoryView::GetSortColumn

(

)

SortOrder SkyGI::CategoryView::GetSortOrder

(

)

void SkyGI::CategoryView::SetSortOrder

(

SortOrder

nSortOrder

)

void SkyGI::CategoryView::SetAutoSort

(

bool

bAutoSort = true

)

bool SkyGI::CategoryView::GetAutoSort

(

)

void SkyGI::CategoryView::SetKeyLookupColumn

(

int

iColumn = -1

)

CategoryViewRow* SkyGI::CategoryView::GetRow

(

int

iIndex

)

void SkyGI::CategoryView::RemoveRow

(

int

iIndex

)

void SkyGI::CategoryView::InvalidateRow

(

int

iIndex

)

int SkyGI::CategoryView::GetSelectionCount

(

)

void SkyGI::CategoryView::MouseMove

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse move

Description:

This function gets called when the mouse cursor was moved inside the window. Mouse move events are only generated after a call to EnableMouseMoveEvents(). Use DisableMouseMoveEvents() to disable further generation of mouse move events.

Overload this member function to react on mouse move events.

Parameters:

	pNewPosition	- Current mouse cursor position
	pOldPosition	- Old mouse cursor position
	nMouseButtonMask	- Mask showing which mouse buttons were pressed when the mouse move occured

Reimplemented from SkyGI::Window.

virtual void SkyGI::CategoryView::OnContextMenu

(

const InputEvent &

nInputEvent

)

[virtual]

---

Member Data Documentation

signal2<int, const InputEvent&> SkyGI::CategoryView::Selected

Emitted when an entry was selected

Parameters:

	iRowIndex	Selected row index
	nInputEvent	InputEvent

See also:

OnSelected

signal1<const InputEvent&> SkyGI::CategoryView::ContextMenu

Emitted when context menu is requested

Parameters:

	iRowIndex	Current selected row index
	nInputEvent	InputEvent

See also:

OnSelected

---