CGUIEnvironment Class Reference

#include <CGUIEnvironment.h>

Inheritance diagram for CGUIEnvironment:

Public Member Functions

• virtual IGUIAnimatedImage * addAnimatedImage (core::array< video::STextureAnimation > &textureAnimations, const s32 &timePerFrame, const video::E_TEXTURE_ANIMATION_TYPE &animationMode, const f32 &rotationPerSecond, const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)

  Adds an animated image element.
  

• virtual IGUIButton * addButton (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0, const wchar_t *tooltiptext=0)

  adds an button. The returned pointer must not be dropped.
  

• virtual IGUICheckBox * addCheckBox (bool checked, const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)

  adds a checkbox
  

• virtual void addChild (IGUIElement *child)

  Adds a GUI element as new child of this element.
  

• virtual IGUIColorSelectDialog * addColorSelectDialog (const wchar_t *title=0, bool modal=true, IGUIElement *parent=0, s32 id=-1)

  adds a color select dialog. The returned pointer must not be dropped.
  

• virtual IGUIComboBox * addComboBox (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)

  Adds a combo box to the environment.
  

• virtual IGUIContextMenu * addContextMenu (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)

  Adds a context menu to the environment.
  

• virtual IGUIEditBox * addEditBox (const wchar_t *text, const core::rect< s32 > &rectangle, bool border=false, IGUIElement *parent=0, s32 id=-1)

  Adds an edit box. The returned pointer must not be dropped.
  

• virtual IGUIFileOpenDialog * addFileOpenDialog (const wchar_t *title=0, bool modal=true, IGUIElement *parent=0, s32 id=-1)

  adds a file open dialog. The returned pointer must not be dropped.
  

• virtual IGUIImage * addImage (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)

  adds an image. The returned pointer must not be dropped.
  

• virtual IGUIImage * addImage (video::ITexture *image, core::position2d< s32 > pos, bool useAlphaChannel=true, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)

  Adds an image element.
  

• virtual IGUIInOutFader * addInOutFader (const core::rect< s32 > *rectangle=0, IGUIElement *parent=0, s32 id=-1)

  Adds an element for fading in or out.
  

• virtual IGUIListBox * addListBox (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, bool drawBackground=false)

  adds a list box
  

• virtual IGUIContextMenu * addMenu (IGUIElement *parent=0, s32 id=-1)

  Adds a menu to the environment.
  

• virtual IGUIMeshViewer * addMeshViewer (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1, const wchar_t *text=0)

  adds an mesh viewer. The returned pointer must not be dropped.
  

• virtual IGUIWindow * addMessageBox (const wchar_t *caption, const wchar_t *text=0, bool modal=true, s32 flag=EMBF_OK, IGUIElement *parent=0, s32 id=-1, s32 okID=-1, s32 cancelID=-1, s32 yesID=-1, s32 noID=-1)

  Adds a message box.
  

• virtual IGUIScrollBar * addScrollBar (bool horizontal, const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)

  adds a scrollbar. The returned pointer must not be dropped.
  

• virtual IGUISlider * addSlider (bool horizontal, const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)

  adds a scrollbar. The returned pointer must not be dropped.
  

• virtual IGUIStaticText * addStaticText (const wchar_t *text, const core::rect< s32 > &rectangle, bool border=false, bool wordWrap=true, IGUIElement *parent=0, s32 id=-1, bool drawBackground=false)

  adds a static text. The returned pointer must not be dropped.
  

• virtual IGUITab * addTab (const core::rect< s32 > &rectangle, IGUIElement *parent=0, s32 id=-1)

  Adds tab to the environment.
  

• virtual IGUITabControl * addTabControl (const core::rect< s32 > &rectangle, IGUIElement *parent=0, bool fillbackground=false, bool border=true, s32 id=-1)

  Adds a tab control to the environment.
  

• virtual IGUIToolBar * addToolBar (IGUIElement *parent=0, s32 id=-1)
• virtual IGUIWindow * addWindow (const core::rect< s32 > &rectangle, bool modal=false, const wchar_t *text=0, IGUIElement *parent=0, s32 id=-1)

  adds a window. The returned pointer must not be dropped.
  

• virtual void animateMoveToPoint (const core::position2d< s32 > &destination, const u32 &timeToMove)

  animate image uses the top left corner to animate
  

• virtual bool bringToFront (IGUIElement *element)

  Brings a child to front.
  

• CGUIEnvironment (io::IFileSystem *fs, video::IVideoDriver *driver, IOSOperator *op)

  constructor
  

• virtual void clear ()

  clear all GUI elements
  

• virtual IGUISkin * createSkin (EGUI_SKIN_TYPE type)

  Creates a new GUI Skin based on a template.
  

• virtual void draw ()

  Draws the element and its children.
  

• virtual void drawAll ()

  draws all gui elements
  

• bool drop ()
• bool drop ()
• core::rect< s32 > getAbsolutePosition ()

  Returns the absolute rectangle of element.
  

• virtual IGUIFont * getBuiltInFont ()

  returns default font
  

• virtual const core::list<
  IGUIElement * > & getChildren () const

  Returns list with children of this element.
  

• const c8 * getDebugName () const
• const c8 * getDebugName () const
• *virtual IGUIElement * getElementFromId (s32 id, bool searchchildren=false) const
• IGUIElement * getElementFromPoint (const core::position2d< s32 > &point)

  Returns the child element, which is at the position of the point.
  

• virtual IGUIFont * getFont (const c8 *filename)

  returns the font
  

• virtual s32 getID ()

  Returns id. Can be used to identify the element.
  

• IGUIElement * getParent ()

  Returns parent of this element.
  

• core::rect< s32 > getRelativePosition ()

  Returns the relative rectangle of this element.
  

• virtual IGUIElement * getRootGUIElement ()

  Returns the root gui element.
  

• virtual IGUISkin * getSkin ()

  returns the current gui skin
  

• virtual const wchar_t * getText ()

  Returns caption of this element.
  

• virtual core::stringw & getToolTipText ()

  Returns caption of this element.
  

• EGUI_ELEMENT_TYPE getType ()

  Returns the type of the gui element.
  

• virtual video::IVideoDriver * getVideoDriver ()

  returns the current video driver
  

• void grab ()
• void grab ()
• virtual bool hasFocus (IGUIElement *element)

  Returns if the element has focus.
  

• virtual bool isEnabled ()

  Returns true if element is enabled.
  

• virtual bool isVisible ()

  Returns true if element is visible.
  

• virtual void move (core::position2d< s32 > absoluteMovement)

  Moves this element.
  

• virtual bool OnEvent (const SEvent &event)

  called by ui if an event happened.
  

• virtual void OnPostRender (u32 time)

  animate the element and its children.
  

• virtual void overrideDefaultClipping (const core::rect< s32 > &clipRect)

  override default clipping and use this rectangle to clip
  

• virtual bool postEventFromUser (const SEvent &event)

  posts an input event to the environment
  

• virtual void remove ()

  Removes this element from its parent.
  

• virtual void removeChild (IGUIElement *child)

  Removes a child.
  

• virtual void removeFocus (IGUIElement *element)

  removes the focus from an element
  

• virtual void setEnabled (bool enabled)

  Sets the enabled state of this element.
  

• virtual void setFocus (IGUIElement *element)

  sets the focus to an element
  

• virtual void setID (s32 id)

  Sets the id of this element.
  

• void setRelativePosition (const core::rect< s32 > &r)

  Sets the relative rectangle of this element.
  

• virtual void setSkin (IGUISkin *skin)

  Sets a new GUI Skin.
  

• virtual void setText (const wchar_t *text)

  Sets the new caption of this element.
  

• virtual void setToolTipText (const wchar_t *text)

  Sets the new caption of this element.
  

• virtual void setUserEventReceiver (IEventReceiver *evr)
• virtual void setVisible (bool visible)

  Sets the visible state of this element.
  

• virtual void updateAbsolutePosition ()

  Updates the absolute position.
  

• virtual ~CGUIEnvironment ()

  destructor
  

Protected Member Functions

• void setDebugName (const c8 *newName)
• void setDebugName (const c8 *newName)

Protected Attributes

• core::rect< s32 > AbsoluteClippingRect

  absolute clipping rect of element
  

• core::rect< s32 > AbsoluteRect

  absolute rect of element
  

• core::list< IGUIElement * > Children

  List of all children of this element.
  

• IGUIEnvironment * Environment

  GUI Environment.
  

• s32 ID

  id
  

• bool IsEnabled

  is enabled?
  

• bool IsVisible

  is visible?
  

• bool OverrideDefaultClippingRectBehavior

  whether or not to override default clipping behavior
  

• IGUIElement * Parent

  Pointer to the parent.
  

• core::rect< s32 > RelativeRect

  relative rect of element
  

• core::stringw Text

  caption
  

• core::stringw ToolTipText

  tooltip
  

• EGUI_ELEMENT_TYPE Type

  type of element
  

---

Constructor & Destructor Documentation

CGUIEnvironment	(	io::IFileSystem *	fs,
		video::IVideoDriver *	driver,
		IOSOperator *	op
	)

~CGUIEnvironment

(

)

[virtual]

---

Member Function Documentation

IGUIAnimatedImage * addAnimatedImage	(	core::array< video::STextureAnimation > &	textureAnimations,
		const s32 &	timePerFrame,
		const video::E_TEXTURE_ANIMATION_TYPE &	animationMode,
		const f32 &	rotationPerSecond,
		const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

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

Implements IGUIEnvironment.

IGUICheckBox * addCheckBox	(	bool	checked,
		const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1,
		const wchar_t *	text = 0
	)			[virtual]

Implements IGUIEnvironment.

virtual void addChild

(

IGUIElement *

child

)

[inline, virtual, inherited]

IGUIColorSelectDialog * addColorSelectDialog	(	const wchar_t *	title = 0,
		bool	modal = true,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIComboBox * addComboBox	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIContextMenu * addContextMenu	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIEditBox * addEditBox	(	const wchar_t *	text,
		const core::rect< s32 > &	rectangle,
		bool	border = false,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIFileOpenDialog * addFileOpenDialog	(	const wchar_t *	title = 0,
		bool	modal = true,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIImage * addImage	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1,
		const wchar_t *	text = 0
	)			[virtual]

Implements IGUIEnvironment.

IGUIImage * addImage	(	video::ITexture *	image,
		core::position2d< s32 >	pos,
		bool	useAlphaChannel = true,
		IGUIElement *	parent = 0,
		s32	id = -1,
		const wchar_t *	text = 0
	)			[virtual]

Implements IGUIEnvironment.

IGUIInOutFader * addInOutFader	(	const core::rect< s32 > *	rectangle = 0,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIListBox * addListBox	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1,
		bool	drawBackground = false
	)			[virtual]

Implements IGUIEnvironment.

IGUIContextMenu * addMenu	(	IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIMeshViewer * addMeshViewer	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1,
		const wchar_t *	text = 0
	)			[virtual]

Implements IGUIEnvironment.

IGUIWindow * addMessageBox	(	const wchar_t *	caption,
		const wchar_t *	text = 0,
		bool	modal = true,
		s32	flag = EMBF_OK,
		IGUIElement *	parent = 0,
		s32	id = -1,
		s32	okID = -1,
		s32	cancelID = -1,
		s32	yesID = -1,
		s32	noID = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIScrollBar * addScrollBar	(	bool	horizontal,
		const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUISlider * addSlider	(	bool	horizontal,
		const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIStaticText * addStaticText	(	const wchar_t *	text,
		const core::rect< s32 > &	rectangle,
		bool	border = false,
		bool	wordWrap = true,
		IGUIElement *	parent = 0,
		s32	id = -1,
		bool	drawBackground = false
	)			[virtual]

Implements IGUIEnvironment.

IGUITab * addTab	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUITabControl * addTabControl	(	const core::rect< s32 > &	rectangle,
		IGUIElement *	parent = 0,
		bool	fillbackground = false,
		bool	border = true,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

IGUIToolBar * addToolBar	(	IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Adds a toolbar to the environment. It is like a menu is always placed on top in its parent, and contains buttons.

Implements IGUIEnvironment.

IGUIWindow * addWindow	(	const core::rect< s32 > &	rectangle,
		bool	modal = false,
		const wchar_t *	text = 0,
		IGUIElement *	parent = 0,
		s32	id = -1
	)			[virtual]

Implements IGUIEnvironment.

virtual void animateMoveToPoint	(	const core::position2d< s32 > &	destination,
		const u32 &	timeToMove
	)			[inline, virtual, inherited]

Reimplemented in CGUIImage, CGUIStaticText, and IGUIImage.

virtual bool bringToFront

(

IGUIElement *

element

)

[inline, virtual, inherited]

Returns:

Returns true if successful, false if not.

void clear

(

)

[virtual]

Implements IGUIEnvironment.

IGUISkin * createSkin

(

EGUI_SKIN_TYPE

type

)

[virtual]

Returns:

Returns a pointer to the created skin. If you no longer need the image, you should call IGUISkin::drop(). See IrrUnknown::drop() for more information.

Implements IGUIEnvironment.

virtual void draw

(

)

[inline, virtual, inherited]

Reimplemented in CGUIAnimatedImage, CGUIButton, CGUICheckBox, CGUIColorSelectDialog, CGUIComboBox, CGUIContextMenu, CGUIEditBox, CGUIFileOpenDialog, CGUIImage, CGUIInOutFader, CGUIListBox, CGUIMenu, CGUIMeshViewer, CGUIModalScreen, CGUIScrollBar, CGUISlider, CGUIStaticText, CGUITab, CGUITabControl, CGUIToolBar, and CGUIWindow.

void drawAll

(

)

[virtual]

Implements IGUIEnvironment.

bool drop

(

)

[inline, inherited]

Drops the object. Decrements the reference counter by one. Returns true, if the object was deleted. The IrrUnknown class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of the Irrlicht Engine are derived from IrrUnknown, and so they are reference counted.

When you create an object in the Irrlicht engine, calling a method which starts with 'create', an object is created, and you get a pointer to the new object. If you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only need to call drop() to the object, if you created it, and the method had a 'create' in it.

A simple example:

If you want to create a texture, you may want to call an imaginable method IDriver::createTexture. You call ITexture* texture = driver->createTexture(dimension2d<s32>(128, 128)); If you no longer need the texture, call texture->drop(). If you want to load a texture, you may want to call imaginable method IDriver::loadTexture. You do this like ITexture* texture = driver->loadTexture("example.jpg"); You will not have to drop the pointer to the loaded texture, because the name of the method does not start with 'create'. The texture is stored somewhere by the driver.

bool drop

(

)

[inline, inherited]

Drops the object. Decrements the reference counter by one. Returns true, if the object was deleted. The IrrUnknown class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of the Irrlicht Engine are derived from IrrUnknown, and so they are reference counted.

When you create an object in the Irrlicht engine, calling a method which starts with 'create', an object is created, and you get a pointer to the new object. If you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only need to call drop() to the object, if you created it, and the method had a 'create' in it.

A simple example:

If you want to create a texture, you may want to call an imaginable method IDriver::createTexture. You call ITexture* texture = driver->createTexture(dimension2d<s32>(128, 128)); If you no longer need the texture, call texture->drop(). If you want to load a texture, you may want to call imaginable method IDriver::loadTexture. You do this like ITexture* texture = driver->loadTexture("example.jpg"); You will not have to drop the pointer to the loaded texture, because the name of the method does not start with 'create'. The texture is stored somewhere by the driver.

core::rect<s32> getAbsolutePosition

(

)

[inline, inherited]

IGUIFont * getBuiltInFont

(

)

[virtual]

Implements IGUIEnvironment.

virtual const core::list<IGUIElement*>& getChildren

(

)

const [inline, virtual, inherited]

const c8* getDebugName

(

)

const [inline, inherited]

Returns the debug name of the object. The Debugname may only be set and changed by the object itself. This method should only be used in Debug mode.

Returns:

Returns a string, previously set by setDebugName();

const c8* getDebugName

(

)

const [inline, inherited]

Returns the debug name of the object. The Debugname may only be set and changed by the object itself. This method should only be used in Debug mode.

Returns:

Returns a string, previously set by setDebugName();

* virtual IGUIElement* getElementFromId	(	s32	id,
		bool	searchchildren = false
	)			const [inline, virtual, inherited]

Finds the first element with the given id.

Parameters:

	id,:	Id to search for.
	searchchildren,:	Set this to true, if you want to search this elements children.

Returns:

Returns the first element with the given id. If no element with this id was found, 0 is returned.

IGUIElement* getElementFromPoint

(

const core::position2d< s32 > &

point

)

[inline, inherited]

IGUIFont * getFont

(

const c8 *

filename

)

[virtual]

Implements IGUIEnvironment.

virtual s32 getID

(

)

[inline, virtual, inherited]

IGUIElement* getParent

(

)

[inline, inherited]

core::rect<s32> getRelativePosition

(

)

[inline, inherited]

IGUIElement * getRootGUIElement

(

)

[virtual]

Implements IGUIEnvironment.

IGUISkin * getSkin

(

)

[virtual]

Implements IGUIEnvironment.

virtual const wchar_t* getText

(

)

[inline, virtual, inherited]

virtual core::stringw& getToolTipText

(

)

[inline, virtual, inherited]

EGUI_ELEMENT_TYPE getType

(

)

[inline, inherited]

This is needed for the .NET wrapper but will be used later for serializing and deserializing. If you wrote your own GUIElements, you need to set the type for your element as first parameter in the constructor of IGUIElement. For own (=unknown) elements, simply use EGUIET_ELEMENT as type

video::IVideoDriver * getVideoDriver

(

)

[virtual]

Implements IGUIEnvironment.

void grab

(

)

[inline, inherited]

Grabs the object. Increments the reference counter by one. Someone who calls grab() to an object, should later also call drop() to it. If an object never gets as much drop() as grab() calls, it will never be destroyed. The IrrUnknown class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of the Irrlicht Engine are derived from IrrUnknown, and so they are reference counted.

When you create an object in the Irrlicht engine, calling a method which starts with 'create', an object is created, and you get a pointer to the new object. If you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only need to call drop() to the object, if you created it, and the method had a 'create' in it.

A simple example:

If you want to create a texture, you may want to call an imaginable method IDriver::createTexture. You call ITexture* texture = driver->createTexture(dimension2d<s32>(128, 128)); If you no longer need the texture, call texture->drop(). If you want to load a texture, you may want to call imaginable method IDriver::loadTexture. You do this like ITexture* texture = driver->loadTexture("example.jpg"); You will not have to drop the pointer to the loaded texture, because the name of the method does not start with 'create'. The texture is stored somewhere by the driver.

void grab

(

)

[inline, inherited]

Grabs the object. Increments the reference counter by one. Someone who calls grab() to an object, should later also call drop() to it. If an object never gets as much drop() as grab() calls, it will never be destroyed. The IrrUnknown class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of the Irrlicht Engine are derived from IrrUnknown, and so they are reference counted.

When you create an object in the Irrlicht engine, calling a method which starts with 'create', an object is created, and you get a pointer to the new object. If you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only need to call drop() to the object, if you created it, and the method had a 'create' in it.

A simple example:

If you want to create a texture, you may want to call an imaginable method IDriver::createTexture. You call ITexture* texture = driver->createTexture(dimension2d<s32>(128, 128)); If you no longer need the texture, call texture->drop(). If you want to load a texture, you may want to call imaginable method IDriver::loadTexture. You do this like ITexture* texture = driver->loadTexture("example.jpg"); You will not have to drop the pointer to the loaded texture, because the name of the method does not start with 'create'. The texture is stored somewhere by the driver.

bool hasFocus

(

IGUIElement *

element

)

[virtual]

Implements IGUIEnvironment.

virtual bool isEnabled

(

)

[inline, virtual, inherited]

virtual bool isVisible

(

)

[inline, virtual, inherited]

virtual void move

(

core::position2d< s32 >

absoluteMovement

)

[inline, virtual, inherited]

bool OnEvent

(

const SEvent &

event

)

[virtual]

Reimplemented from IGUIElement.

void OnPostRender

(

u32

time

)

[virtual]

Reimplemented from IGUIElement.

virtual void overrideDefaultClipping

(

const core::rect< s32 > &

clipRect

)

[inline, virtual, inherited]

bool postEventFromUser

(

const SEvent &

event

)

[virtual]

Implements IGUIEnvironment.

virtual void remove

(

)

[inline, virtual, inherited]

virtual void removeChild

(

IGUIElement *

child

)

[inline, virtual, inherited]

Reimplemented in CGUIModalScreen, and CGUITabControl.

void removeFocus

(

IGUIElement *

element

)

[virtual]

Implements IGUIEnvironment.

void setDebugName

(

const c8 *

newName

)

[inline, protected, inherited]

Sets the debug name of the object. The Debugname may only be set and changed by the object itself. This method should only be used in Debug mode.

Parameters:

newName,:

New debug name to set.

void setDebugName

(

const c8 *

newName

)

[inline, protected, inherited]

Sets the debug name of the object. The Debugname may only be set and changed by the object itself. This method should only be used in Debug mode.

Parameters:

newName,:

New debug name to set.

virtual void setEnabled

(

bool

enabled

)

[inline, virtual, inherited]

void setFocus

(

IGUIElement *

element

)

[virtual]

Implements IGUIEnvironment.

virtual void setID

(

s32

id

)

[inline, virtual, inherited]

void setRelativePosition

(

const core::rect< s32 > &

r

)

[inline, inherited]

void setSkin

(

IGUISkin *

skin

)

[virtual]

Implements IGUIEnvironment.

virtual void setText

(

const wchar_t *

text

)

[inline, virtual, inherited]

Reimplemented in CGUIEditBox, and CGUIStaticText.

virtual void setToolTipText

(

const wchar_t *

text

)

[inline, virtual, inherited]

void setUserEventReceiver

(

IEventReceiver *

evr

)

[virtual]

This sets a new event receiver for gui events. Usually you do not have to use this method, it is used by the internal engine.

Implements IGUIEnvironment.

virtual void setVisible

(

bool

visible

)

[inline, virtual, inherited]

Reimplemented in CGUIContextMenu.

virtual void updateAbsolutePosition

(

)

[inline, virtual, inherited]

Reimplemented in CGUIMenu, CGUIModalScreen, and CGUIToolBar.

---

Field Documentation

core::rect<s32> AbsoluteClippingRect [protected, inherited]

core::rect<s32> AbsoluteRect [protected, inherited]

core::list<IGUIElement*> Children [protected, inherited]

IGUIEnvironment* Environment [protected, inherited]

s32 ID [protected, inherited]

bool IsEnabled [protected, inherited]

bool IsVisible [protected, inherited]

bool OverrideDefaultClippingRectBehavior [protected, inherited]

IGUIElement* Parent [protected, inherited]

core::rect<s32> RelativeRect [protected, inherited]

core::stringw Text [protected, inherited]

core::stringw ToolTipText [protected, inherited]

EGUI_ELEMENT_TYPE Type [protected, inherited]

---