WizardObject Class Reference
The basic wizard type. More...
#include <WizardObject.h>
Public Member Functions | |
| virtual void | setName (const std::string &name)=0 |
| virtual const std::string & | getName () const =0 |
| virtual const std::vector < WizardItem * > & | getItems () const =0 |
| virtual bool | isBatch () const =0 |
| virtual const std::string & | getMenuLocation () const =0 |
| virtual int | getExecutionOrder (WizardItem *pItem) const =0 |
Protected Member Functions | |
| virtual | ~WizardObject () |
Detailed Description
The basic wizard type.The WizardObject class is the basic class containing items representing plug-ins, desktop services, and specifically defined values that are sequenced together to define a unique process. To use the WizardObject in a plug-in, the wizard items must already be defined. The getItems() method returns a vector of WizardItem pointers containing the specific information about each item.
This subclass of Subject will notify upon the following conditions:
- The wizard is populated from an XML file.
- Everything documented in Subject.
- See also:
- WizardItem
Definition at line 36 of file WizardObject.h.
Constructor & Destructor Documentation
| virtual WizardObject::~WizardObject | ( | ) | [protected, virtual] |
This should be destroyed by calling ObjectFactory::destroyObject.
Definition at line 115 of file WizardObject.h.
Member Function Documentation
| virtual void WizardObject::setName | ( | const std::string & | name | ) | [pure virtual] |
Sets the wizard name.
- Parameters:
-
name The wizard name.
| virtual const std::string& WizardObject::getName | ( | ) | const [pure virtual] |
Returns the wizard name.
- Returns:
- The wizard name.
| virtual const std::vector<WizardItem*>& WizardObject::getItems | ( | ) | const [pure virtual] |
Returns all items in the wizard.
This method returns pointers to all of the items stored in the wizard. The order within the returned vector defines the execution order for each item.
- Returns:
- The vector of WizardItem pointers. The pointers in this vector will never be
NULL.
- See also:
- WizardItem
| virtual bool WizardObject::isBatch | ( | ) | const [pure virtual] |
Queries whether this wizard operates entirely in batch mode.
- Returns:
- TRUE if the wizard operates in batch mode, otherwise FALSE.
- See also:
- WizardObject
| virtual const std::string& WizardObject::getMenuLocation | ( | ) | const [pure virtual] |
Returns the menu location and command name from which the wizard is executed.
The menu location of the wizard is returned as a string, which is formatted with bracket characters ([,]) to specify a toolbar, and a slash (/) to indicate submenu levels. The toolbar name must come first in the string. A slash immediately following the toolbar name specifys that the submenus and command should be added to the default toolbar menu, which has the same name as the toolbar. If a slash does not follow the toolbar name, the menus and command are added directly to the toolbar. If the string does not include a toolbar name, the menus and command are added to the main menu bar. The string cannot end with a slash, and the name after the last slash indicates the command name. Examples of the menu string include "[Wizard]Import/MyLoadWizard", "&Tools/PlotManager", and "[Geo]/Georeference".
- Returns:
- The plug-in menu location and command name. An empty string is returned if the wizard does not have a menu location, indicating that it should not be executed from the menus.
| virtual int WizardObject::getExecutionOrder | ( | WizardItem * | pItem | ) | const [pure virtual] |
Returns the execution order of a wizard item.
- Parameters:
-
pItem The wizard item to query for its execution order.
- Returns:
- The one-based execution order for the wizard item. If
NULLis passed in or the given item does not exist in the wizard, a value of -1 is returned.