GUIlistPopup Class Reference

Inheritance diagram for GUIlistPopup:

Public Member Functions
	GUIlistPopup (string title, vector< string > items, GUI_BaseElement *parent, RECT rect, bool(*callback)(int, void *), void *usrdata=NULL, GUI_STYLE styleid=STYLE_DEFAULT)
bool	ProcessChildren (GUI_MOUSE_EVENT _event, int _x, int _y)
	Sends an event received from the containing GUI_BaseElement to its children. More...
Public Member Functions inherited from GUIplugin
void	DrawChildren (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
	Draws all visible children of the GUIplugin. More...
bool	IsVisible ()
void	SetVisible (bool visible)
bool	IsFixed ()
void	SetFixed (bool fixed)
GUI_BaseElement *	GetFirstVisibleChild ()
bool	Update ()
	checks all children if any of them need a redraw. More...
Public Member Functions inherited from GUIentity
void	RegisterGuiElement (GUI_BaseElement *_element, int _parentId)
	Registers a GUI element that has not been created by this GUIentity. More...
int	GetDynamicUID ()
virtual GUI_BaseElement *	GetElementById (int _id)
GUI_Page *	CreatePage (RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_DEFAULT, bool drawbackground=false)
	Creates a new GUI_Page element. More...
GUI_Label *	CreateLabel (string text, RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_HEADING)
	Creates a new GUI_Label element. More...
GUI_LabelValuePair *	CreateLabelValuePair (string label, string value, RECT _rect, int parent, int id=-1, GUI_STYLE styleId=STYLE_HEADING, GUI_FONT valueFontId=GUI_NO_FONT)
	Creates a new GUI_LabelValuePair. More...
GUI_ListBox *	CreateListBox (RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_LISTBOX, GUI_STYLE scrollbar_styleId=STYLE_LISTBOX, bool _multiselect=false, bool _noSelect=false)
	Creates a new GUI_ListBox. More...
GUI_StaticButton *	CreateStaticButton (RECT _rect, int srcX, int srcY, SURFHANDLE _src, int parent, int _id=-1)
	Creates a new GUI_StaticButton. More...
GUI_DynamicButton *	CreateDynamicButton (string text, RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_BUTTON)
	Creates a new GUI_DynamicButton. More...
GUI_CheckBox *	CreateCheckBox (string text, RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_CHECKBOX)
	Creates a new GUI_CheckBox. More...
GUI_RadioButton *	CreateRadioButton (string text, RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_CHECKBOX)
	Creates a new GUI_RadioButton. More...
GUI_StatusBar *	CreateStatusBar (RECT _rect, int parent, int _id=-1, GUI_STYLE styleid=STYLE_STATUSBAR)
void	SetStyleSet (string _styleset)
	Sets the styleset this GUIentity uses. More...
GUI_ElementStyle *	GetStyle (GUI_STYLE _styleId=STYLE_DEFAULT)
GUI_font *	GetFont (GUI_FONT _fontid)

Private Attributes
GUI_ListBox *	list
GUI_DynamicButton *	okbtn
GUI_DynamicButton *	cancelbtn
bool(*	clbk )(int, void *)
	callback function pointer
void *	usrdata
	the user data that will be passed to the callback

Additional Inherited Members
Protected Member Functions inherited from GUIpopup
	GUIpopup (GUI_BaseElement *parent, RECT rect, GUI_STYLE styleid)
void	close ()
	closes and destroys the popup
Protected Member Functions inherited from GUIplugin
bool	AddChildToParent (GUI_BaseElement *child, int parentId)
	Adds a child to an element in this GUIplugin child: Pointer to the GUI element to be added to a parent parentId: uid of the intended parent. pass -1 if the element is a root element in this plugin. More...
Protected Attributes inherited from GUIpopup
int	width
int	height
Protected Attributes inherited from GUIplugin
bool	isvisible = false
	Tells the plugin whether to draw its elements or not.
bool	isfixed = false
	Whether the plugin has a fixed position inside a scrollable element.
vector< GUI_BaseElement * >	rootelements
	The GUImanager can assume that all its registered GUI_Surfaces are root elements. The plugin doesn't have that luxury, but still needs to know which elements are at the root.
Protected Attributes inherited from GUIentity
map< int, GUI_BaseElement * >	elements
	a searchtree containing all GUI_Elements of this entity
UINT	newuid = GUI_UID_DOMAIN
	Variable used to pass out dynamic UIDs for GUI elements.
FontsAndStyles *	fontsandstyles
	Pointer to the global FontsAndStyles instance.
string	styleset = "default"
	Identifier of the defualt styleset of this entity.
Static Protected Attributes inherited from GUIpopup
static const int	POPUP = 1
	identifier for the page on which the popups controlls will be drawn

Detailed Description

Presents a list to select from, with a cancel and ok button.

Member Function Documentation

bool GUIlistPopup::ProcessChildren ( GUI_MOUSE_EVENT  _event, int  _x, int  _y  )

virtual

Sends an event received from the containing GUI_BaseElement to its children.

Does NOT return the uid of the triggered element! First of all uids are local to GUIentities, so there is no guarantee that the trigered uid will refer to another element in the underlying GUIentity. Second, the underlying GUIentity isn't aware of individual elements in this plugin, so it couldn't do anything with the element even if it could reliably identify it. The underlying element will report itself as triggering element to its underlying GUIentity.

Parameters

_event	The event that got fired in the GUI_Surface
_x	The x-position of the mouse click relative to the parent
_y	the y-position of the mouse click relative to the parent

Returns

True if a child of this plugin has been clicked.

Reimplemented from GUIplugin.

---

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

• C:/Orbiter2016/Orbitersdk/IMS2/GUIlistPopup.h
• C:/Orbiter2016/Orbitersdk/IMS2/GUIlistPopup.cpp