VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Public Attributes
makVrf::DtEntityCreatePaletteInterface Class Reference

Abstract interface for the entity creation palette. More...

Inheritance diagram for makVrf::DtEntityCreatePaletteInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtEntityCreatePaletteInterface ()
 Virtual DTOR.
virtual void clear ()=0
 Clears contents of widget.
virtual void update ()=0
 Tells widget to update (redraw)
virtual QString currentForce () const =0
 Returns currently selected force.
virtual int currentForceType () const =0
 Returns the current force type selected.
virtual int currentForceIndex () const =0
 Returns the index of the currently selected force in the combo box.
virtual int currentCategoryIndex () const =0
 Returns the index of the currently selected category in the combo box.
virtual int forceTypeAtIndex (int) const =0
 Force type at index.
virtual QString currentCategory () const =0
 Returns currently selected category.
virtual int numForces () const =0
 Returns number of forces.
virtual int numCategories () const =0
 Returns number of categories.
virtual void addForce (const QString &, int)=0
 Adds new force and force type.
virtual QString force (int) const =0
 Returns the force string at the specified index.
virtual bool hasForce (int) const =0
 Returns true if the specified force exists.
virtual void insertCategory (const QString &, int)=0
 Adds new category at the specified index.
virtual void insertCategoryBefore (const QString &, const QString &)=0
 Adds new category before the specified item.
virtual void insertCategoryAfter (const QString &, const QString &)=0
 Adds new category after the specified item.
virtual void addCategory (const QString &)=0
 Adds new category.
virtual bool hasCategory (const QString &) const =0
 Returns true if the specified category exists.
virtual void selectForce (const QString &)=0
 Selects force by name.
virtual void selectForce (int)=0
 Selects force by index.
virtual void showForce (bool)=0
 Show/hide force.
virtual void selectCategory (const QString &)=0
 Selects category by name.
virtual void selectCategory (int)=0
 Selects category by index.
virtual void clearCreateList ()=0
 Clears the create list.
virtual void setSortingEnabled (bool)=0
 Sets whether or not to allow list soring.
virtual void sizeColumns ()=0
 Sizes the columns to contents.
virtual void addItem (const _DtEntityPaletteItem &, int force, bool newItem=false)=0
 If the entity model key type and force is not already in the list, add it.
virtual void addPaletteItem (const _DtEntityPaletteItem &)=0
 Adds the new item into the logic.
virtual void removePaletteItem (const DtEntityMapperKey &key)=0
 Removes an item from the internal list for any key that matches the supplied key.
virtual void setEnabled (bool)=0
 Enables/Disables Gui.
virtual void filterItems ()=0
 Filters items.

Public Attributes

boost::signal< void()> signal_forceChanged
boost::signal< void(std::string)> signal_categoryChanged
boost::signal< void(const
DtEntityMapperKey &)> 
signal_createObject
boost::signal< void()> signal_itemsAdded
boost::signal< void(std::string)> signal_itemSelected
boost::signal< void(DtEntityCreatePaletteInterface *)> signal_Updated

Detailed Description

Abstract interface for the entity creation palette.

Constructor & Destructor Documentation

virtual makVrf::DtEntityCreatePaletteInterface::~DtEntityCreatePaletteInterface ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrf::DtEntityCreatePaletteInterface::clear ( )
pure virtual

Clears contents of widget.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::update ( )
pure virtual

Tells widget to update (redraw)

Implemented in makVrf::DtEntityCreatePalette.

virtual QString makVrf::DtEntityCreatePaletteInterface::currentForce ( ) const
pure virtual

Returns currently selected force.

Implemented in makVrf::DtEntityCreatePalette.

virtual int makVrf::DtEntityCreatePaletteInterface::currentForceType ( ) const
pure virtual

Returns the current force type selected.

Implemented in makVrf::DtEntityCreatePalette.

virtual int makVrf::DtEntityCreatePaletteInterface::currentForceIndex ( ) const
pure virtual

Returns the index of the currently selected force in the combo box.

Implemented in makVrf::DtEntityCreatePalette.

virtual int makVrf::DtEntityCreatePaletteInterface::currentCategoryIndex ( ) const
pure virtual

Returns the index of the currently selected category in the combo box.

Implemented in makVrf::DtEntityCreatePalette.

virtual int makVrf::DtEntityCreatePaletteInterface::forceTypeAtIndex ( int  ) const
pure virtual

Force type at index.

Implemented in makVrf::DtEntityCreatePalette.

virtual QString makVrf::DtEntityCreatePaletteInterface::currentCategory ( ) const
pure virtual

Returns currently selected category.

Implemented in makVrf::DtEntityCreatePalette.

virtual int makVrf::DtEntityCreatePaletteInterface::numForces ( ) const
pure virtual

Returns number of forces.

Implemented in makVrf::DtEntityCreatePalette.

virtual int makVrf::DtEntityCreatePaletteInterface::numCategories ( ) const
pure virtual

Returns number of categories.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::addForce ( const QString &  ,
int   
)
pure virtual

Adds new force and force type.

Implemented in makVrf::DtEntityCreatePalette.

virtual QString makVrf::DtEntityCreatePaletteInterface::force ( int  ) const
pure virtual

Returns the force string at the specified index.

Implemented in makVrf::DtEntityCreatePalette.

virtual bool makVrf::DtEntityCreatePaletteInterface::hasForce ( int  ) const
pure virtual

Returns true if the specified force exists.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::insertCategory ( const QString &  ,
int   
)
pure virtual

Adds new category at the specified index.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::insertCategoryBefore ( const QString &  ,
const QString &   
)
pure virtual

Adds new category before the specified item.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::insertCategoryAfter ( const QString &  ,
const QString &   
)
pure virtual

Adds new category after the specified item.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::addCategory ( const QString &  )
pure virtual

Adds new category.

Implemented in makVrf::DtEntityCreatePalette.

virtual bool makVrf::DtEntityCreatePaletteInterface::hasCategory ( const QString &  ) const
pure virtual

Returns true if the specified category exists.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectForce ( const QString &  )
pure virtual

Selects force by name.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectForce ( int  )
pure virtual

Selects force by index.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::showForce ( bool  )
pure virtual

Show/hide force.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectCategory ( const QString &  )
pure virtual

Selects category by name.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectCategory ( int  )
pure virtual

Selects category by index.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::clearCreateList ( )
pure virtual

Clears the create list.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::setSortingEnabled ( bool  )
pure virtual

Sets whether or not to allow list soring.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::sizeColumns ( )
pure virtual

Sizes the columns to contents.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::addItem ( const _DtEntityPaletteItem ,
int  force,
bool  newItem = false 
)
pure virtual

If the entity model key type and force is not already in the list, add it.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::addPaletteItem ( const _DtEntityPaletteItem )
pure virtual

Adds the new item into the logic.

Be sure to re-execute filter if need be to get these items to show up in the dialog

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::removePaletteItem ( const DtEntityMapperKey key)
pure virtual

Removes an item from the internal list for any key that matches the supplied key.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::setEnabled ( bool  )
pure virtual

Enables/Disables Gui.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::filterItems ( )
pure virtual

Filters items.

Member Data Documentation

boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_forceChanged
boost::signal<void (std::string)> makVrf::DtEntityCreatePaletteInterface::signal_categoryChanged
boost::signal<void (const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_createObject
boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_itemsAdded
boost::signal<void (std::string)> makVrf::DtEntityCreatePaletteInterface::signal_itemSelected
boost::signal<void (DtEntityCreatePaletteInterface*)> makVrf::DtEntityCreatePaletteInterface::signal_Updated

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)