Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# 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:

[legend]
List of all members.

## Public Methods

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

## 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.

Definition at line 45 of file OgreGuiElementFactory.h.

## 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::CursorGuiElementFactory, Ogre::PanelGuiElementFactory, Ogre::BorderPanelGuiElementFactory, Ogre::TextAreaGuiElementFactory, Ogre::TextBoxGuiElementFactory, Ogre::ButtonGuiElementFactory, Ogre::BorderButtonGuiElementFactory, Ogre::ListGuiElementFactory, Ogre::ScrollBarGuiElementFactory, Ogre::PopupMenuGuiElementFactory, and Ogre::TTYGuiElementFactory.

virtual void Ogre::GuiElementFactory::destroyGuiElement | ( | GuiElement * | pElement | ) | `[virtual]`

| Destroys a GuiElement which this factory created previously. Definition at line 51 of file OgreGuiElementFactory.h.

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

Gets the string uniquely identifying the type of element this factory creates.

Implemented in Ogre::CursorGuiElementFactory, Ogre::PanelGuiElementFactory, Ogre::BorderPanelGuiElementFactory, Ogre::TextAreaGuiElementFactory, Ogre::TextBoxGuiElementFactory, Ogre::ButtonGuiElementFactory, Ogre::BorderButtonGuiElementFactory, Ogre::ListGuiElementFactory, Ogre::ScrollBarGuiElementFactory, Ogre::PopupMenuGuiElementFactory, and Ogre::TTYGuiElementFactory.

Referenced by Ogre::GuiManager::addGuiElementFactory().

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

- OgreGuiElementFactory.h

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:02 2004