IMS2  Pre-Alpha
An Orbiter add-on to allow on-runtime construction of spacecraft from predefined modules
GUIpopup Class Reference
Inheritance diagram for GUIpopup:
GUIplugin GUIentity GUIalert GUIlistPopup

Protected Member Functions

 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

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.
 
FontsAndStylesfontsandstyles
 Pointer to the global FontsAndStyles instance.
 
string styleset = "default"
 Identifier of the defualt styleset of this entity.
 

Static Protected Attributes

static const int POPUP = 1
 identifier for the page on which the popups controlls will be drawn
 

Additional Inherited Members

- Public Member Functions inherited from GUIplugin
virtual bool ProcessChildren (GUI_MOUSE_EVENT _event, int _x, int _y)
 Sends an event received from the containing GUI_BaseElement to its children. More...
 
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_BaseElementGetFirstVisibleChild ()
 
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_BaseElementGetElementById (int _id)
 
GUI_PageCreatePage (RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_DEFAULT, bool drawbackground=false)
 Creates a new GUI_Page element. More...
 
GUI_LabelCreateLabel (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_ListBoxCreateListBox (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_StaticButtonCreateStaticButton (RECT _rect, int srcX, int srcY, SURFHANDLE _src, int parent, int _id=-1)
 Creates a new GUI_StaticButton. More...
 
GUI_DynamicButtonCreateDynamicButton (string text, RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_BUTTON)
 Creates a new GUI_DynamicButton. More...
 
GUI_CheckBoxCreateCheckBox (string text, RECT _rect, int parent, int _id=-1, GUI_STYLE styleId=STYLE_CHECKBOX)
 Creates a new GUI_CheckBox. More...
 
GUI_RadioButtonCreateRadioButton (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_ElementStyleGetStyle (GUI_STYLE _styleId=STYLE_DEFAULT)
 
GUI_fontGetFont (GUI_FONT _fontid)
 

Detailed Description

Base class for popup dialogs

A Popup is a pre-fabricated plugin that can be easily spawned on top of any GUI element. It can be passed a function pointer that will be invoked with data appropriate for the respective popup when certain actions in the popup are performed (see documentation of popup implementations). Popups are also designed to be "fire and forgett", i.e. the popup will clean itself up when it gets closed.


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