VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
makVrf::DtEntityCreatePaletteInterface Class Referenceabstract

Abstract interface for the entity creation palette.

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

Public Member Functions

virtual ~DtEntityCreatePaletteInterface ()
 
virtual void clear ()=0
 
virtual void update ()=0
 
virtual QString currentForce () const =0
 
virtual int currentForceType () const =0
 
virtual int forceTypeAtIndex (int) const =0
 
virtual std::vector< std::string > currentCategories () const =0
 
virtual std::string currentDeployedCountry () const =0
 
virtual int numForces () const =0
 
virtual void setAccessibleCategories (const std::set< std::string > &)=0
 
virtual int numCategories () const =0
 
virtual void addForce (const QString &, int, const QColor &, const std::string &countryCode, bool forceLayout=false)=0
 
virtual QString force (int) const =0
 
virtual bool hasForce (int) const =0
 
virtual bool hasDeployedCountries () const =0
 
virtual bool combinePalettes () const =0
 
virtual bool hasCategory (const QString &) const =0
 
virtual void resetVisuals ()=0
 
virtual void setHideCountries (const std::set< std::string > &)=0
 
virtual void setCategoriesFromCounts (const std::map< std::string, int > &counts, const std::set< std::string > &categoriesReferenced, int totalItems)=0
 
virtual void setCategories (const DtTagSelectorWidget::Categories &)=0
 
virtual void selectDeployedCountry (const std::string &)=0
 
virtual void initializeCountries ()=0
 
virtual void selectDeployedCountry (int)=0
 
virtual void selectForce (const QString &)=0
 
virtual void selectForce (int)=0
 
virtual void showForce (bool)=0
 
virtual void selectCategories (const std::vector< std::string > &)=0
 
virtual void clearCreateList ()=0
 
virtual void setSortingEnabled (bool)=0
 
virtual void sizeColumns ()=0
 
virtual void addItem (const DtEntityPaletteItem &, int force)=0
 
virtual void addPaletteItem (const DtEntityPaletteItem &)=0
 
virtual void removePaletteItem (const DtEntityMapperKey &key, bool matchesPattern=false)=0
 
virtual void setEnabled (bool)=0
 
virtual void filterItems ()=0
 
virtual const std::string & pageClassName () const =0
 
virtual void clearForces ()=0
 
virtual void clearDeployedCountries ()=0
 
virtual void clearCategories ()=0
 
virtual DtEntityMapperKey selectedObjectType () const =0
 
virtual std::vector
< DtEntityMapperKey > 		selectedObjects () const =0
 
virtual void selectObject (const DtEntityMapperKey &key)=0
 

Public Attributes

boost::signals2::signal< void()> signal_closeEvent
 
boost::signals2::signal< void()> signal_paletteCleared
 
boost::signals2::signal< void()> signal_forceChanged
 
boost::signals2::signal< void(std::vector
< std::string >)> 		signal_categoriesChanged
 
boost::signals2::signal< void(std::string)> signal_deployedCountryChanged
 
boost::signals2::signal< void(const
DtEntityMapperKey &)> 		signal_createObject
 
boost::signals2::signal< void(const
DtEntityMapperKey &)> 		signal_executedFilter
 
boost::signals2::signal< void()> signal_itemsAdded
 
boost::signals2::signal< void(std::string,
const DtEntityMapperKey &)> 		signal_itemSelected
 
boost::signals2::signal< void(DtEntityCreatePaletteInterface *)> signal_updated
 
boost::signals2::signal< void()> signal_modelSetChanged
 

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::forceTypeAtIndex ( int  ) const
pure virtual

Force type at index.

Implemented in makVrf::DtEntityCreatePalette.

virtual std::vector<std::string> makVrf::DtEntityCreatePaletteInterface::currentCategories ( ) const
pure virtual

Returns currently selected category.

Implemented in makVrf::DtEntityCreatePalette.

virtual std::string makVrf::DtEntityCreatePaletteInterface::currentDeployedCountry ( ) const
pure virtual

Returns currently selected deployed country.

Implemented in makVrf::DtEntityCreatePalette.

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

Returns number of forces.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::setAccessibleCategories ( const std::set< std::string > &  )
pure virtual

All categories available for this palette.

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  ,
const QColor &  ,
const std::string &  countryCode,
bool  forceLayout = false 
)
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 bool makVrf::DtEntityCreatePaletteInterface::hasDeployedCountries ( ) const
pure virtual

Returns true if supports deployed countries.

Implemented in makVrf::DtEntityCreatePalette, and makVrf::DtTacticalGraphicCreatePalette.

virtual bool makVrf::DtEntityCreatePaletteInterface::combinePalettes ( ) const
pure virtual

Implemented in makVrf::DtEntityCreatePalette.

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

Returns true if the specified deployed country exists.

Implemented in makVrf::DtEntityCreatePalette.

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

Reset icon visuals.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::setHideCountries ( const std::set< std::string > &  )
pure virtual

If has a countries list, hides the given countries.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::setCategoriesFromCounts ( const std::map< std::string, int > &  counts,
const std::set< std::string > &  categoriesReferenced,
int  totalItems 
)
pure virtual

Given a map of the counts of categories and how many there are for those counts, select them based on rank. The categoriesReferenced is the full set of categories.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::setCategories ( const DtTagSelectorWidget::Categories &  )
pure virtual

Sets the categories to be displayed to the vector of categories. If a category is used as a filter will keep that filter turned on. The map is a weighted order of how the items should be displayed.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectDeployedCountry ( const std::string &  )
pure virtual

Selects deployed country by name.

Implemented in makVrf::DtEntityCreatePalette.

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

Initializes the country list.

Implemented in makVrf::DtEntityCreatePalette.

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

Selects deployed country by index.

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::selectCategories ( const std::vector< std::string > &  )
pure virtual

Selects categories by name. If no categories are given then all are unselected.

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 
)
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,
bool  matchesPattern = false 
)
pure virtual

Removes an item from the internal list for any key that matches (or matches pattern of) 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.

virtual const std::string& makVrf::DtEntityCreatePaletteInterface::pageClassName ( ) const
pure virtual

Get the class name of the page.

Implemented in makVrf::DtEntityCreatePalette, and makVrf::DtTacticalGraphicCreatePalette.

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

Clear forces combo.

Implemented in makVrf::DtEntityCreatePalette.

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

Clear deployed countries combo.

Implemented in makVrf::DtEntityCreatePalette.

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

Clear categories combo.

Implemented in makVrf::DtEntityCreatePalette.

virtual DtEntityMapperKey makVrf::DtEntityCreatePaletteInterface::selectedObjectType ( ) const
pure virtual

Currently selected object type.

Implemented in makVrf::DtEntityCreatePalette.

virtual std::vector<DtEntityMapperKey> makVrf::DtEntityCreatePaletteInterface::selectedObjects ( ) const
pure virtual

If there is more than one, all selected objects (or just the one)

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectObject ( const DtEntityMapperKey &  key)
pure virtual

Select the given object and force, if force is not -1, in which case leave the currently selected force set.

Implemented in makVrf::DtEntityCreatePalette.

Member Data Documentation

boost::signals2::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_closeEvent
boost::signals2::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_paletteCleared
boost::signals2::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_forceChanged
boost::signals2::signal<void (std::vector<std::string>)> makVrf::DtEntityCreatePaletteInterface::signal_categoriesChanged
boost::signals2::signal<void (std::string)> makVrf::DtEntityCreatePaletteInterface::signal_deployedCountryChanged
boost::signals2::signal<void (const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_createObject
boost::signals2::signal<void (const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_executedFilter
boost::signals2::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_itemsAdded
boost::signals2::signal<void (std::string, const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_itemSelected
boost::signals2::signal<void (DtEntityCreatePaletteInterface*)> makVrf::DtEntityCreatePaletteInterface::signal_updated
boost::signals2::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_modelSetChanged
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)