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

Inheritance diagram for makVrf::DtEntityCreatePaletteInterface:

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	currentDeployedCountryIndex () const =0
	Returns the index of the currently selected deployed country in the combo box.
virtual int	forceTypeAtIndex (int) const =0
	Force type at index.
virtual std::vector< std::string >	currentCategories () const =0
	Returns currently selected category.
virtual QString	currentDeployedCountry () const =0
	Returns currently selected deployed country.
virtual int	numForces () const =0
	Returns number of forces.
virtual void	setAccessibleCategories (const std::set< std::string > &)=0
	All categories available for this palette.
virtual int	numCategories () const =0
	Returns number of categories.
virtual int	numDeployedCountries () const =0
	Returns number of deployed countries.
virtual void	addForce (const QString &, int, const QColor &, bool forceLayout=false)=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 bool	hasDeployedCountries () const =0
	Returns true if supports deployed countries.
virtual bool	combinePalettes () const =0
virtual bool	hasCategory (const QString &) const =0
	Returns true if the specified deployed country exists.
virtual void	setCategoriesFromCounts (const std::map< std::string, int > &counts, const std::set< std::string > &categoriesReferenced, int totalItems)=0
	Given a map of the counts of categories and how many there are for those counts, select them based on rank.
virtual void	setCategories (const DtTagSelectorWidget::Categories &)=0
	Sets the categories to be displayed to the vector of categories.
virtual bool	hasDeployedCountry (const QString &) const =0
	Returns true if the specified deployed country exists.
virtual void	insertDeployedCountry (const QString &, int)=0
	Adds new deployed country at the specified index.
virtual void	insertDeployedCountryBefore (const QString &, const QString &)=0
	Adds new deployed country before the specified item.
virtual void	insertDeployedCountryAfter (const QString &, const QString &)=0
	Adds new deployed country after the specified item.
virtual void	addDeployedCountry (const QString &)=0
	Adds new deployed country.
virtual void	selectDeployedCountry (const QString &)=0
	Selects deployed country by name.
virtual void	selectDeployedCountry (int)=0
	Selects deployed country by index.
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	selectCategories (const std::vector< std::string > &)=0
	Selects categories by name. If no categories are given then all are unselected.
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)=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, bool matchesPattern=false)=0
	Removes an item from the internal list for any key that matches (or matches pattern of) the supplied key.
virtual void	setEnabled (bool)=0
	Enables/Disables Gui.
virtual void	filterItems ()=0
	Filters items.
virtual const std::string &	pageClassName () const =0
	Get the class name of the page.
virtual void	clearForces ()=0
	Clear forces combo.
virtual void	clearDeployedCountries ()=0
	Clear deployed countries combo.
virtual void	clearCategories ()=0
	Clear categories combo.
virtual DtEntityMapperKey	selectedObjectType () const =0
	Currently selected object type.
virtual std::vector < DtEntityMapperKey >	selectedObjects () const =0
	If there is more than one, all selected objects (or just the one)
virtual void	selectObject (const DtEntityMapperKey &key)=0
	Select the given object and force, if force is not -1, in which case leave the currently selected force set.
virtual void	layoutForces ()=0
	Force a layout of the forces button bar.

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

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::currentDeployedCountryIndex ( ) const

pure virtual

Returns the index of the currently selected deployed country 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 std::vector<std::string> makVrf::DtEntityCreatePaletteInterface::currentCategories ( ) const

pure virtual

Returns currently selected category.

Implemented in makVrf::DtEntityCreatePalette.

virtual QString 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 int makVrf::DtEntityCreatePaletteInterface::numDeployedCountries ( ) const

pure virtual

Returns number of deployed countries.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::addForce	(	const QString &	,
		int	,
		const QColor &	,
		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::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 bool makVrf::DtEntityCreatePaletteInterface::hasDeployedCountry ( const QString & ) const

pure virtual

Returns true if the specified deployed country exists.

Implemented in makVrf::DtEntityCreatePalette.

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

pure virtual

Adds new deployed country at the specified index.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::insertDeployedCountryBefore	(	const QString &	,
		const QString &
	)

pure virtual

Adds new deployed country before the specified item.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::insertDeployedCountryAfter	(	const QString &	,
		const QString &
	)

pure virtual

Adds new deployed country after the specified item.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::addDeployedCountry ( const QString & )

pure virtual

Adds new deployed country.

Implemented in makVrf::DtEntityCreatePalette.

virtual void makVrf::DtEntityCreatePaletteInterface::selectDeployedCountry ( const QString & )

pure virtual

Selects deployed country by name.

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.

virtual void makVrf::DtEntityCreatePaletteInterface::layoutForces ( )

pure virtual

Force a layout of the forces button bar.

Implemented in makVrf::DtEntityCreatePalette.

Member Data Documentation

boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_closeEvent

boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_paletteCleared

boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_forceChanged

boost::signal<void (std::vector<std::string>)> makVrf::DtEntityCreatePaletteInterface::signal_categoriesChanged

boost::signal<void (std::string)> makVrf::DtEntityCreatePaletteInterface::signal_deployedCountryChanged

boost::signal<void (const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_createObject

boost::signal<void (const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_executedFilter

boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_itemsAdded

boost::signal<void (std::string, const DtEntityMapperKey&)> makVrf::DtEntityCreatePaletteInterface::signal_itemSelected

boost::signal<void (DtEntityCreatePaletteInterface*)> makVrf::DtEntityCreatePaletteInterface::signal_updated

boost::signal<void ()> makVrf::DtEntityCreatePaletteInterface::signal_modelSetChanged

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCoreQt/entityCreatePaletteInterface.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation