Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials

irr::gui::IGUIEnvironment Class Reference

GUI Environment. Used as factory and manager of all other GUI elements. More...

#include <IGUIEnvironment.h>

Inheritance diagram for irr::gui::IGUIEnvironment:
irr::IReferenceCounted

List of all members.

Public Member Functions

virtual IGUIButtonaddButton (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0, const wchar_t *tooltiptext=0)=0
 Adds a button element.
virtual IGUICheckBoxaddCheckBox (bool checked, const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)=0
 Adds a checkbox element.
virtual IGUIColorSelectDialogaddColorSelectDialog (const wchar_t *title=0, bool modal=true, IGUIElement *parent=0, s32 id=-1)=0
 Adds a color select dialog.
virtual IGUIComboBoxaddComboBox (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)=0
 Adds a combo box to the environment.
virtual IGUIContextMenuaddContextMenu (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)=0
 Adds a context menu to the environment.
virtual IGUIEditBoxaddEditBox (const wchar_t *text, const core::rect< s32 > &rectangle, bool border=true, IGUIElement *parent=0, s32 id=-1)=0
 Adds an edit box.
virtual IGUISpriteBankaddEmptySpriteBank (const io::path &name)=0
 Adds an empty sprite bank to the manager.
virtual IGUIFileOpenDialogaddFileOpenDialog (const wchar_t *title=0, bool modal=true, IGUIElement *parent=0, s32 id=-1)=0
 Adds a file open dialog.
virtual IGUIFontaddFont (const io::path &name, IGUIFont *font)=0
 Adds an externally loaded font to the font list.
virtual IGUIElementaddGUIElement (const c8 *elementName, IGUIElement *parent=0)=0
 Adds a GUI element by its name.
virtual IGUIImageaddImage (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)=0
 Adds an image element.
virtual IGUIImageaddImage (video::ITexture *image, core::position2d< s32 > pos, bool useAlphaChannel=true, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)=0
 Adds an image element.
virtual IGUIInOutFaderaddInOutFader (const core::rect< s32 > *rectangle=0, IGUIElement *parent=0, s32 id=-1)=0
 Adds an element for fading in or out.
virtual IGUIListBoxaddListBox (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, bool drawBackground=false)=0
 Adds a list box element.
virtual IGUIContextMenuaddMenu (IGUIElement *parent=0, s32 id=-1)=0
 Adds a menu to the environment.
virtual IGUIMeshVieweraddMeshViewer (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)=0
 Adds a mesh viewer. Not 100% implemented yet.
virtual IGUIWindowaddMessageBox (const wchar_t *caption, const wchar_t *text=0, bool modal=true, s32 flags=EMBF_OK, IGUIElement *parent=0, s32 id=-1, video::ITexture *image=0)=0
 Adds a message box.
virtual IGUIElementaddModalScreen (IGUIElement *parent)=0
 Adds a modal screen.
virtual IGUIScrollBaraddScrollBar (bool horizontal, const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)=0
 Adds a scrollbar.
virtual IGUISpinBoxaddSpinBox (const wchar_t *text, const core::rect< s32 > &rectangle, bool border=true, IGUIElement *parent=0, s32 id=-1)=0
 Adds a spin box.
virtual IGUIStaticTextaddStaticText (const wchar_t *text, const core::rect< s32 > &rectangle, bool border=false, bool wordWrap=true, IGUIElement *parent=0, s32 id=-1, bool fillBackground=false)=0
 Adds a static text.
virtual IGUITabaddTab (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)=0
 Adds tab to the environment.
virtual IGUITabControladdTabControl (const core::rect< s32 > &rectangle, IGUIElement *parent=0, bool fillbackground=false, bool border=true, s32 id=-1)=0
 Adds a tab control to the environment.
virtual IGUITableaddTable (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, bool drawBackground=false)=0
 Adds a table to the environment.
virtual IGUIToolBaraddToolBar (IGUIElement *parent=0, s32 id=-1)=0
 Adds a toolbar to the environment.
virtual IGUITreeViewaddTreeView (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, bool drawBackground=false, bool scrollBarVertical=true, bool scrollBarHorizontal=false)=0
 Adds a tree view element.
virtual IGUIWindowaddWindow (const core::rect< s32 > &rectangle, bool modal=false, const wchar_t *text=0, IGUIElement *parent=0, s32 id=-1)=0
 Adds an empty window element.
virtual void clear ()=0
 Removes all elements from the environment.
virtual IGUIImageListcreateImageList (video::ITexture *texture, core::dimension2d< s32 > imageSize, bool useAlphaChannel)=0
 Creates the image list from the given texture.
virtual IGUISkincreateSkin (EGUI_SKIN_TYPE type)=0
 Creates a new GUI Skin based on a template.
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)=0
 Reads attributes of the gui environment.
virtual void drawAll ()=0
 Draws all gui elements by traversing the GUI environment starting at the root node.
virtual IGUIFontgetBuiltInFont () const =0
 Returns the default built-in font.
virtual IGUIElementFactorygetDefaultGUIElementFactory () const =0
 Get the default element factory which can create all built-in elements.
virtual io::IFileSystemgetFileSystem () const =0
 Returns the file system.
virtual IGUIElementgetFocus () const =0
 Returns the element which holds the focus.
virtual IGUIFontgetFont (const io::path &filename)=0
 Returns pointer to the font with the specified filename.
virtual IGUIElementFactorygetGUIElementFactory (u32 index) const =0
 Get a gui element factory by index.
virtual IOSOperatorgetOSOperator () const =0
 returns a pointer to the OS operator
virtual u32 getRegisteredGUIElementFactoryCount () const =0
 Get amount of registered gui element factories.
virtual IGUIElementgetRootGUIElement ()=0
 Returns the root gui element.
virtual IGUISkingetSkin () const =0
 Returns pointer to the current gui skin.
virtual IGUISpriteBankgetSpriteBank (const io::path &filename)=0
 Returns pointer to the sprite bank with the specified file name.
virtual video::IVideoDrivergetVideoDriver () const =0
 Returns the current video driver.
virtual bool hasFocus (IGUIElement *element) const =0
 Returns whether the element has focus.
virtual bool loadGUI (io::IReadFile *file, IGUIElement *parent=0)=0
 Loads the gui. Note that the current gui is not cleared before.
virtual bool loadGUI (const io::path &filename, IGUIElement *parent=0)=0
 Loads the gui. Note that the current gui is not cleared before.
virtual bool postEventFromUser (const SEvent &event)=0
 Posts an input event to the environment.
virtual void readGUIElement (io::IXMLReader *reader, IGUIElement *node)=0
 reads an element
virtual void registerGUIElementFactory (IGUIElementFactory *factoryToAdd)=0
 Adds an element factory to the gui environment.
virtual bool removeFocus (IGUIElement *element)=0
 Removes the focus from an element.
virtual bool saveGUI (io::IWriteFile *file, IGUIElement *start=0)=0
 Saves the current gui into a file.
virtual bool saveGUI (const io::path &filename, IGUIElement *start=0)=0
 Saves the current gui into a file.
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const =0
 Writes attributes of the gui environment.
virtual bool setFocus (IGUIElement *element)=0
 Sets the focus to an element.
virtual void setSkin (IGUISkin *skin)=0
 Sets a new GUI Skin.
virtual void setUserEventReceiver (IEventReceiver *evr)=0
 This sets a new event receiver for gui events.
virtual void writeGUIElement (io::IXMLWriter *writer, IGUIElement *node)=0
 writes an element

Detailed Description

GUI Environment. Used as factory and manager of all other GUI elements.

Definition at line 59 of file IGUIEnvironment.h.


Member Function Documentation

virtual IGUIButton* irr::gui::IGUIEnvironment::addButton ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
const wchar_t *  text = 0,
const wchar_t *  tooltiptext = 0 
) [pure virtual]

Adds a button element.

Parameters:
rectangle Rectangle specifying the borders of the button.
parent Parent gui element of the button.
id Id with which the gui element can be identified.
text Text displayed on the button.
tooltiptext Text displayed in the tooltip.
Returns:
Pointer to the created button. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUICheckBox* irr::gui::IGUIEnvironment::addCheckBox ( bool  checked,
const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
const wchar_t *  text = 0 
) [pure virtual]

Adds a checkbox element.

Parameters:
checked Define the initial state of the check box.
rectangle Rectangle specifying the borders of the check box.
parent Parent gui element of the check box.
id Id to identify the gui element.
text Title text of the check box.
Returns:
Pointer to the created check box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIColorSelectDialog* irr::gui::IGUIEnvironment::addColorSelectDialog ( const wchar_t *  title = 0,
bool  modal = true,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a color select dialog.

Parameters:
title The title of the dialog.
modal Defines if the dialog is modal. This means, that all other gui elements which were created before the dialog cannot be used until it is removed.
parent The parent of the dialog.
id The ID of the dialog.
Returns:
Pointer to the created file open dialog. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIComboBox* irr::gui::IGUIEnvironment::addComboBox ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a combo box to the environment.

Parameters:
rectangle Rectangle specifying the borders of the combo box.
parent Parent item of the element, e.g. a window. Set it to 0 to place the combo box directly in the environment.
id An identifier for the combo box.
Returns:
Pointer to the created combo box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIContextMenu* irr::gui::IGUIEnvironment::addContextMenu ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a context menu to the environment.

Parameters:
rectangle Rectangle specifying the borders of the menu. Note that the menu is resizing itself based on what items you add.
parent Parent item of the element, e.g. a window. Set it to 0 to place the menu directly in the environment.
id An identifier for the menu.
Returns:
Pointer to the created context menu. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIEditBox* irr::gui::IGUIEnvironment::addEditBox ( const wchar_t *  text,
const core::rect< s32 > &  rectangle,
bool  border = true,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds an edit box.

Supports unicode input from every keyboard around the world, scrolling, copying and pasting (exchanging data with the clipboard directly), maximum character amount, marking, and all shortcuts like ctrl+X, ctrl+V, ctrl+C, shift+Left, shift+Right, Home, End, and so on.

Parameters:
text Text to be displayed. Can be altered after creation by setText().
rectangle Rectangle specifying the borders of the edit box.
border Set to true if the edit box should have a 3d border.
parent Parent item of the element, e.g. a window. Set it to 0 to place the edit box directly in the environment.
id The ID of the element.
Returns:
Pointer to the created edit box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUISpriteBank* irr::gui::IGUIEnvironment::addEmptySpriteBank ( const io::path name  )  [pure virtual]

Adds an empty sprite bank to the manager.

Parameters:
name Name of the new sprite bank.
Returns:
Pointer to the sprite bank. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIFileOpenDialog* irr::gui::IGUIEnvironment::addFileOpenDialog ( const wchar_t *  title = 0,
bool  modal = true,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a file open dialog.

Parameters:
title Text to be displayed as the title of the dialog.
modal Defines if the dialog is modal. This means, that all other gui elements which were created before the message box cannot be used until this messagebox is removed.
parent Parent gui element of the dialog.
id Id to identify the gui element.
Returns:
Pointer to the created file open dialog. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIFont* irr::gui::IGUIEnvironment::addFont ( const io::path name,
IGUIFont font 
) [pure virtual]

Adds an externally loaded font to the font list.

This method allows to attach an already loaded font to the list of existing fonts. The font is grabbed if non-null and adding was successful.

Parameters:
name Name the font should be stored as.
font Pointer to font to add.
Returns:
Pointer to the font stored. This can differ from given parameter if the name previously existed.
virtual IGUIElement* irr::gui::IGUIEnvironment::addGUIElement ( const c8 elementName,
IGUIElement parent = 0 
) [pure virtual]

Adds a GUI element by its name.

Each factory is checked if it can create an element of the given name. The first match will be created.

Parameters:
elementName Name of the element to be created.
parent Parent of the new element, if not 0.
Returns:
New GUI element, or 0 if no such element exists.
virtual IGUIImage* irr::gui::IGUIEnvironment::addImage ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
const wchar_t *  text = 0 
) [pure virtual]

Adds an image element.

Use IGUIImage::setImage later to set the image to be displayed.

Parameters:
rectangle Rectangle specifying the borders of the image.
parent Parent gui element of the image.
id Id to identify the gui element.
text Title text of the image.
Returns:
Pointer to the created image element. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIImage* irr::gui::IGUIEnvironment::addImage ( video::ITexture image,
core::position2d< s32 pos,
bool  useAlphaChannel = true,
IGUIElement parent = 0,
s32  id = -1,
const wchar_t *  text = 0 
) [pure virtual]

Adds an image element.

Parameters:
image Image to be displayed.
pos Position of the image. The width and height of the image is taken from the image.
useAlphaChannel Sets if the image should use the alpha channel of the texture to draw itself.
parent Parent gui element of the image.
id Id to identify the gui element.
text Title text of the image.
Returns:
Pointer to the created image element. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIInOutFader* irr::gui::IGUIEnvironment::addInOutFader ( const core::rect< s32 > *  rectangle = 0,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds an element for fading in or out.

Parameters:
rectangle Rectangle specifying the borders of the fader. If the pointer is NULL, the whole screen is used.
parent Parent item of the element, e.g. a window.
id An identifier for the fader.
Returns:
Pointer to the created in-out-fader. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIListBox* irr::gui::IGUIEnvironment::addListBox ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
bool  drawBackground = false 
) [pure virtual]

Adds a list box element.

Parameters:
rectangle Rectangle specifying the borders of the list box.
parent Parent gui element of the list box.
id Id to identify the gui element.
drawBackground Flag whether the background should be drawn.
Returns:
Pointer to the created list box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIContextMenu* irr::gui::IGUIEnvironment::addMenu ( IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a menu to the environment.

This is like the menu you can find on top of most windows in modern graphical user interfaces.

Parameters:
parent Parent item of the element, e.g. a window. Set it to 0 to place the menu directly in the environment.
id An identifier for the menu.
Returns:
Pointer to the created menu. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIMeshViewer* irr::gui::IGUIEnvironment::addMeshViewer ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
const wchar_t *  text = 0 
) [pure virtual]

Adds a mesh viewer. Not 100% implemented yet.

Parameters:
rectangle Rectangle specifying the borders of the mesh viewer.
parent Parent gui element of the mesh viewer.
id Id to identify the gui element.
text Title text of the mesh viewer.
Returns:
Pointer to the created mesh viewer. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIWindow* irr::gui::IGUIEnvironment::addMessageBox ( const wchar_t *  caption,
const wchar_t *  text = 0,
bool  modal = true,
s32  flags = EMBF_OK,
IGUIElement parent = 0,
s32  id = -1,
video::ITexture image = 0 
) [pure virtual]

Adds a message box.

Parameters:
caption Text to be displayed the title of the message box.
text Text to be displayed in the body of the message box.
modal Defines if the dialog is modal. This means, that all other gui elements which were created before the message box cannot be used until this messagebox is removed.
flags Flags specifying the layout of the message box. For example to create a message box with an OK and a CANCEL button on it, set this to (EMBF_OK | EMBF_CANCEL).
parent Parent gui element of the message box.
id Id with which the gui element can be identified.
image Optional texture which will be displayed beside the text as an image
Returns:
Pointer to the created message box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIElement* irr::gui::IGUIEnvironment::addModalScreen ( IGUIElement parent  )  [pure virtual]

Adds a modal screen.

This control stops its parent's members from being able to receive input until its last child is removed, it then deletes itself.

Parameters:
parent Parent gui element of the modal.
Returns:
Pointer to the created modal. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIScrollBar* irr::gui::IGUIEnvironment::addScrollBar ( bool  horizontal,
const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a scrollbar.

Parameters:
horizontal Specifies if the scroll bar is drawn horizontal or vertical.
rectangle Rectangle specifying the borders of the scrollbar.
parent Parent gui element of the scroll bar.
id Id to identify the gui element.
Returns:
Pointer to the created scrollbar. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUISpinBox* irr::gui::IGUIEnvironment::addSpinBox ( const wchar_t *  text,
const core::rect< s32 > &  rectangle,
bool  border = true,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a spin box.

An edit box with up and down buttons

Parameters:
text Text to be displayed. Can be altered after creation by setText().
rectangle Rectangle specifying the borders of the spin box.
border Set to true if the spin box should have a 3d border.
parent Parent item of the element, e.g. a window. Set it to 0 to place the spin box directly in the environment.
id The ID of the element.
Returns:
Pointer to the created spin box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIStaticText* irr::gui::IGUIEnvironment::addStaticText ( const wchar_t *  text,
const core::rect< s32 > &  rectangle,
bool  border = false,
bool  wordWrap = true,
IGUIElement parent = 0,
s32  id = -1,
bool  fillBackground = false 
) [pure virtual]

Adds a static text.

Parameters:
text Text to be displayed. Can be altered after creation by SetText().
rectangle Rectangle specifying the borders of the static text
border Set to true if the static text should have a 3d border.
wordWrap Enable if the text should wrap into multiple lines.
parent Parent item of the element, e.g. a window.
id The ID of the element.
fillBackground Enable if the background shall be filled. Defaults to false.
Returns:
Pointer to the created static text. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUITab* irr::gui::IGUIEnvironment::addTab ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds tab to the environment.

You can use this element to group other elements. This is not used for creating tabs on tab controls, please use IGUITabControl::addTab() for this instead.

Parameters:
rectangle Rectangle specifying the borders of the tab.
parent Parent item of the element, e.g. a window. Set it to 0 to place the tab directly in the environment.
id An identifier for the tab.
Returns:
Pointer to the created tab. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUITabControl* irr::gui::IGUIEnvironment::addTabControl ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
bool  fillbackground = false,
bool  border = true,
s32  id = -1 
) [pure virtual]

Adds a tab control to the environment.

Parameters:
rectangle Rectangle specifying the borders of the tab control.
parent Parent item of the element, e.g. a window. Set it to 0 to place the tab control directly in the environment.
fillbackground Specifies if the background of the tab control should be drawn.
border Specifies if a flat 3d border should be drawn. This is usually not necessary unless you place the control directly into the environment without a window as parent.
id An identifier for the tab control.
Returns:
Pointer to the created tab control element. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUITable* irr::gui::IGUIEnvironment::addTable ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
bool  drawBackground = false 
) [pure virtual]

Adds a table to the environment.

Parameters:
rectangle Rectangle specifying the borders of the table.
parent Parent item of the element, e.g. a window. Set it to 0 to place the element directly in the environment.
id An identifier for the table.
drawBackground Flag whether the background should be drawn.
Returns:
Pointer to the created table. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIToolBar* irr::gui::IGUIEnvironment::addToolBar ( IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds a toolbar to the environment.

It is like a menu that is always placed on top of its parent, and contains buttons.

Parameters:
parent Parent item of the element, e.g. a window. Set it to 0 to place the tool bar directly in the environment.
id An identifier for the tool bar.
Returns:
Pointer to the created tool bar. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUITreeView* irr::gui::IGUIEnvironment::addTreeView ( const core::rect< s32 > &  rectangle,
IGUIElement parent = 0,
s32  id = -1,
bool  drawBackground = false,
bool  scrollBarVertical = true,
bool  scrollBarHorizontal = false 
) [pure virtual]

Adds a tree view element.

Parameters:
rectangle Position and dimension of list box.
parent Parent gui element of the list box.
id Id to identify the gui element.
drawBackground Flag whether the background should be drawn.
scrollBarVertical Flag whether a vertical scrollbar should be used
scrollBarHorizontal Flag whether a horizontal scrollbar should be used
Returns:
Pointer to the created list box. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIWindow* irr::gui::IGUIEnvironment::addWindow ( const core::rect< s32 > &  rectangle,
bool  modal = false,
const wchar_t *  text = 0,
IGUIElement parent = 0,
s32  id = -1 
) [pure virtual]

Adds an empty window element.

Parameters:
rectangle Rectangle specifying the borders of the window.
modal Defines if the dialog is modal. This means, that all other gui elements which were created before the window cannot be used until it is removed.
text Text displayed as the window title.
parent Parent gui element of the window.
id Id with which the gui element can be identified.
Returns:
Pointer to the created window. Returns 0 if an error occurred. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual void irr::gui::IGUIEnvironment::clear (  )  [pure virtual]

Removes all elements from the environment.

virtual IGUIImageList* irr::gui::IGUIEnvironment::createImageList ( video::ITexture texture,
core::dimension2d< s32 imageSize,
bool  useAlphaChannel 
) [pure virtual]

Creates the image list from the given texture.

Parameters:
texture Texture to split into images
imageSize Dimension of each image
useAlphaChannel Flag whether alpha channel of the texture should be honored.
Returns:
Pointer to the font. Returns 0 if the font could not be loaded. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUISkin* irr::gui::IGUIEnvironment::createSkin ( EGUI_SKIN_TYPE  type  )  [pure virtual]

Creates a new GUI Skin based on a template.

Use setSkin() to set the created skin.

Parameters:
type The type of the new skin.
Returns:
Pointer to the created skin. If you no longer need it, you should call IGUISkin::drop(). See IReferenceCounted::drop() for more information.
virtual void irr::gui::IGUIEnvironment::deserializeAttributes ( io::IAttributes in,
io::SAttributeReadWriteOptions options = 0 
) [pure virtual]

Reads attributes of the gui environment.

virtual void irr::gui::IGUIEnvironment::drawAll (  )  [pure virtual]

Draws all gui elements by traversing the GUI environment starting at the root node.

virtual IGUIFont* irr::gui::IGUIEnvironment::getBuiltInFont (  )  const [pure virtual]

Returns the default built-in font.

Returns:
Pointer to the default built-in font. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIElementFactory* irr::gui::IGUIEnvironment::getDefaultGUIElementFactory (  )  const [pure virtual]

Get the default element factory which can create all built-in elements.

Returns:
Pointer to the factory. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual io::IFileSystem* irr::gui::IGUIEnvironment::getFileSystem (  )  const [pure virtual]

Returns the file system.

Returns:
Pointer to the file system.
virtual IGUIElement* irr::gui::IGUIEnvironment::getFocus (  )  const [pure virtual]

Returns the element which holds the focus.

Returns:
Pointer to the element with focus.
virtual IGUIFont* irr::gui::IGUIEnvironment::getFont ( const io::path filename  )  [pure virtual]

Returns pointer to the font with the specified filename.

Loads the font if it was not loaded before.

Parameters:
filename Filename of the Font.
Returns:
Pointer to the font. Returns 0 if the font could not be loaded. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUIElementFactory* irr::gui::IGUIEnvironment::getGUIElementFactory ( u32  index  )  const [pure virtual]

Get a gui element factory by index.

Parameters:
index Index of the factory.
Returns:
Factory at given index, or 0 if no such factory exists.
virtual IOSOperator* irr::gui::IGUIEnvironment::getOSOperator (  )  const [pure virtual]

returns a pointer to the OS operator

Returns:
Pointer to the OS operator.
virtual u32 irr::gui::IGUIEnvironment::getRegisteredGUIElementFactoryCount (  )  const [pure virtual]

Get amount of registered gui element factories.

Returns:
Amount of registered gui element factories.
virtual IGUIElement* irr::gui::IGUIEnvironment::getRootGUIElement (  )  [pure virtual]

Returns the root gui element.

This is the first gui element, the (direct or indirect) parent of all other gui elements. It is a valid IGUIElement, with dimensions the same size as the screen. You should not need to use this method directly, unless you wish to reparent GUI elements to the top level.

Returns:
Pointer to the root element of the GUI. The returned pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual IGUISkin* irr::gui::IGUIEnvironment::getSkin (  )  const [pure virtual]

Returns pointer to the current gui skin.

Returns:
Pointer to the GUI skin.
virtual IGUISpriteBank* irr::gui::IGUIEnvironment::getSpriteBank ( const io::path filename  )  [pure virtual]

Returns pointer to the sprite bank with the specified file name.

Loads the bank if it was not loaded before.

Parameters:
filename Filename of the sprite bank's origin.
Returns:
Pointer to the sprite bank. Returns 0 if it could not be loaded. This pointer should not be dropped. See IReferenceCounted::drop() for more information.
virtual video::IVideoDriver* irr::gui::IGUIEnvironment::getVideoDriver (  )  const [pure virtual]

Returns the current video driver.

Returns:
Pointer to the video driver.
virtual bool irr::gui::IGUIEnvironment::hasFocus ( IGUIElement element  )  const [pure virtual]

Returns whether the element has focus.

Parameters:
element Pointer to the element which is tested.
Returns:
True if the element has focus, else false.
virtual bool irr::gui::IGUIEnvironment::loadGUI ( io::IReadFile file,
IGUIElement parent = 0 
) [pure virtual]

Loads the gui. Note that the current gui is not cleared before.

Parameters:
file The file to load from.
parent Parent for the loaded GUI, root if 0.
Returns:
True if loading succeeded, else false.
virtual bool irr::gui::IGUIEnvironment::loadGUI ( const io::path filename,
IGUIElement parent = 0 
) [pure virtual]

Loads the gui. Note that the current gui is not cleared before.

Parameters:
filename Name of the file.
parent Parent for the loaded GUI, root if 0.
Returns:
True if loading succeeded, else false.
virtual bool irr::gui::IGUIEnvironment::postEventFromUser ( const SEvent event  )  [pure virtual]

Posts an input event to the environment.

Usually you do not have to use this method, it is used by the engine internally.

Parameters:
event The event to post.
Returns:
True if succeeded, else false.
virtual void irr::gui::IGUIEnvironment::readGUIElement ( io::IXMLReader reader,
IGUIElement node 
) [pure virtual]

reads an element

virtual void irr::gui::IGUIEnvironment::registerGUIElementFactory ( IGUIElementFactory factoryToAdd  )  [pure virtual]

Adds an element factory to the gui environment.

Use this to extend the gui environment with new element types which it should be able to create automatically, for example when loading data from xml files.

Parameters:
factoryToAdd Pointer to new factory.
virtual bool irr::gui::IGUIEnvironment::removeFocus ( IGUIElement element  )  [pure virtual]

Removes the focus from an element.

Causes a EGET_ELEMENT_FOCUS_LOST event. If the event is absorbed then the focus will not be changed.

Parameters:
element Pointer to the element which shall lose the focus.
Returns:
True on success, false on failure
virtual bool irr::gui::IGUIEnvironment::saveGUI ( io::IWriteFile file,
IGUIElement start = 0 
) [pure virtual]

Saves the current gui into a file.

Parameters:
file The file to write to.
start The GUIElement to start with. Root if 0.
Returns:
True if saving succeeded, else false.
virtual bool irr::gui::IGUIEnvironment::saveGUI ( const io::path filename,
IGUIElement start = 0 
) [pure virtual]

Saves the current gui into a file.

Parameters:
filename Name of the file.
start The GUIElement to start with. Root if 0.
Returns:
True if saving succeeded, else false.
virtual void irr::gui::IGUIEnvironment::serializeAttributes ( io::IAttributes out,
io::SAttributeReadWriteOptions options = 0 
) const [pure virtual]

Writes attributes of the gui environment.

virtual bool irr::gui::IGUIEnvironment::setFocus ( IGUIElement element  )  [pure virtual]

Sets the focus to an element.

Causes a EGET_ELEMENT_FOCUS_LOST event followed by a EGET_ELEMENT_FOCUSED event. If someone absorbed either of the events, then the focus will not be changed.

Parameters:
element Pointer to the element which shall get the focus.
Returns:
True on success, false on failure
virtual void irr::gui::IGUIEnvironment::setSkin ( IGUISkin skin  )  [pure virtual]

Sets a new GUI Skin.

You can use this to change the appearance of the whole GUI Environment. You can set one of the built-in skins or implement your own class derived from IGUISkin and enable it using this method. To set for example the built-in Windows classic skin, use the following code:

        gui::IGUISkin* newskin = environment->createSkin(gui::EGST_WINDOWS_CLASSIC);
        environment->setSkin(newskin);
        newskin->drop();
Parameters:
skin New skin to use.
virtual void irr::gui::IGUIEnvironment::setUserEventReceiver ( IEventReceiver evr  )  [pure virtual]

This sets a new event receiver for gui events.

Usually you do not have to use this method, it is used by the engine internally.

Parameters:
evr Pointer to the new receiver.
virtual void irr::gui::IGUIEnvironment::writeGUIElement ( io::IXMLWriter writer,
IGUIElement node 
) [pure virtual]

writes an element


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

The Irrlicht Engine
The Irrlicht Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated on Sun Oct 24 12:42:04 2010 by Doxygen (1.6.2)