---

Ogre::GuiElementFactory Class Reference

Defines the interface which all components wishing to supply GuiElement subclasses must implement. More...

#include <OgreGuiElementFactory.h>

Inheritance diagram for Ogre::GuiElementFactory:

List of all members.

Public Methods
virtual GuiElement *	createGuiElement (const String &instanceName)=0
	Creates a new GuiElement instance with the name supplied. More...
virtual void	destroyGuiElement (GuiElement *pElement)
	Destroys a GuiElement which this factory created previously. More...
virtual const String &	getTypeName (void)=0
	Gets the string uniquely identifying the type of element this factory creates. More...

---

Detailed Description

Defines the interface which all components wishing to supply GuiElement subclasses must implement.

Remarks:

To allow the GuiElement types available for inclusion on overlays to be extended, OGRE allows external apps or plugins to register their ability to create custom GuiElements with the GuiManager, using the addGuiElementFactory method. Classes wanting to do this must implement this interface.

Each GuiElementFactory creates a single type of GuiElement, identified by a 'type name' which must be unique.

---

Member Function Documentation

virtual GuiElement* Ogre::GuiElementFactory::createGuiElement (  const String &    instanceName )  [pure virtual]

Creates a new GuiElement instance with the name supplied. Implemented in Ogre::PanelGuiElementFactory.

virtual void Ogre::GuiElementFactory::destroyGuiElement (  GuiElement *    pElement )  [inline, virtual]

Destroys a GuiElement which this factory created previously.

virtual const String& Ogre::GuiElementFactory::getTypeName (  void    )  [pure virtual]

Gets the string uniquely identifying the type of element this factory creates. Implemented in Ogre::PanelGuiElementFactory.

Copyright © 2002 by The OGRE Team