---

PG_WidgetList Class Reference

Inheritance diagram for PG_WidgetList:

[legend]Collaboration diagram for PG_WidgetList:

[legend]List of all members.

---

Detailed Description

A group of widgets arranged in a list. Generally used to make a large 'pane' of widgets that can be scrolled through in a smaller 'portal' with scrollbars.

Author:

Alexander Pipelka

Examples:

paratest.cpp.

Public Member Functions
	PG_WidgetList (PG_Widget *parent, const PG_Rect &r=PG_Rect::null, const char *style="WidgetList")
	Constructor of the PG_Widget class.
	~PG_WidgetList ()
	Destructor of the PG_Widget class.
PG_Widget *	FindWidget (int index)
	Find a widget by a given index.
int	FindIndex (PG_Widget *widget)
	Find the index of a given widget.
void	ScrollTo (Uint16 ypos)
	Scroll to the specified Y-Position.
void	PageUp ()
	Scroll one page up.
void	PageDown ()
	Scroll one page down.
void	AddChild (PG_Widget *child)
	Add a clientwidget (which will be embedded into this widget).
Protected Member Functions
PG_Widget *	GetWidgetFromPos (Sint32 y)
	Search for a widget at a given y-position.

---

Constructor & Destructor Documentation

PG_WidgetList::PG_WidgetList (  PG_Widget *  parent, const PG_Rect &  r = PG_Rect::null, const char *  style = "WidgetList" )

Constructor of the PG_Widget class.

PG_WidgetList::~PG_WidgetList (   )

Destructor of the PG_Widget class.

---

Member Function Documentation

void PG_WidgetList::AddChild (  PG_Widget *  child  )  [virtual]

Add a clientwidget (which will be embedded into this widget). Parameters: child  the widget to add Reimplemented from PG_ScrollWidget. Reimplemented in PG_ListBox.

int PG_WidgetList::FindIndex (  PG_Widget *  widget  )

Find the index of a given widget. Parameters: widget  pointer to the widget Returns: index of the widget

PG_Widget* PG_WidgetList::FindWidget (  int  index  )

Find a widget by a given index. Parameters: index  index of the widget to find Returns: pointer to the widget

PG_Widget* PG_WidgetList::GetWidgetFromPos (  Sint32  y  )  [protected]

Search for a widget at a given y-position. Parameters: y  the position Returns: pointer to the widget or NULL

void PG_WidgetList::PageDown (   )

Scroll one page down.

void PG_WidgetList::PageUp (   )

Scroll one page up.

void PG_WidgetList::ScrollTo (  Uint16  ypos  )

Scroll to the specified Y-Position. Parameters: ypos  new Y-Position Will scroll to the new position and update the scrollbars.

---

The ParaGUI Project - Alexander Pipelka