makVrv::DtQIconConfigurations Class Reference

A collection of icon configurations. The collection maintains flags indicating whether to generate icon configurations for any combination of the following DtQIconConfigurationMode:

• Normal
• Disabled
• Selected
• Active AND DtQIconConfigurationState:
• Off
• On The actual generation of the icons is handled by the widget icon style manager since it owns the icon cache. The flags being maintained by each collection allows some icons to use the generation while others do not.

  See Also

  DtWidgetIconStyleManager

Public Member Functions
	DtQIconConfigurations (bool useDefaultGenerationFlags)
	DtQIconConfigurations ()
virtual	~DtQIconConfigurations ()
virtual void	addConfiguration (const DtQIconConfiguration &configuration)
virtual const std::unordered_set < DtQIconConfiguration > &	configurations () const
virtual std::string	iconFileNameOrPathFromQIconModeAndState (DtQIconConfigurationMode iconMode, DtQIconConfigurationState iconState) const
virtual void	setIsGenerateIconConfigurationsEnabledByModeAndState (const DtQIconModeAndState &modeAndStateToSet, bool generateConfigurationForMode)
virtual bool	isGenerateIconConfigurationsEnabledByModeAndState (const DtQIconModeAndState &modeAndStateToCheck) const

Protected Member Functions
virtual void	resetGenerateConfigurationFlags (bool useDefaultGenerationFlags)

Protected Attributes
std::unordered_set < DtQIconConfiguration >	myConfigurations
std::unordered_map < DtQIconModeAndState, bool >	myGenerateConfigurationFlags

Constructor & Destructor Documentation

makVrv::DtQIconConfigurations::DtQIconConfigurations ( bool  useDefaultGenerationFlags )

explicit

CTOR.

Parameters

useDefaultGenerationFlags

If true, icon configurations will only be generated for Normal/Off, Normal/On, Disabled/Off, and Disabled/On. Otherwise, no icon configurations will be generated until setIsGenerateIconConfigurationsEnabledByModeAndState(...) is used.

makVrv::DtQIconConfigurations::DtQIconConfigurations

(

)

Default CTOR. By default, icon configurations will only be generated for Normal/Off, Normal/On, Disabled/Off, and Disabled/On.

virtual makVrv::DtQIconConfigurations::~DtQIconConfigurations ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtQIconConfigurations::addConfiguration ( const DtQIconConfiguration &  configuration )

virtual

Add an icon configuration to this list of configurations When adding a configuration, check to see that there is not already a conflicting configuration. For example, if a configuration exists for the icon when its in the Normal mode and the On state, you cannot add another one using this function.

virtual const std::unordered_set<DtQIconConfiguration>& makVrv::DtQIconConfigurations::configurations ( ) const

virtual

Const accessor for internal std::vector of configurations.

virtual std::string makVrv::DtQIconConfigurations::iconFileNameOrPathFromQIconModeAndState ( DtQIconConfigurationMode  iconMode, DtQIconConfigurationState  iconState  ) const

virtual

Get the file name or file path of the icon asset from managed configurations based on the provided mode and state.

virtual void makVrv::DtQIconConfigurations::setIsGenerateIconConfigurationsEnabledByModeAndState ( const DtQIconModeAndState &  modeAndStateToSet, bool  generateConfigurationForMode  )

virtual

Set whether or not icon configurations, for the provided icon mode and icon state, will be generated. The actual generation is handled by the widget icon style manager.

See Also

DtWidgetIconStyleManager

virtual bool makVrv::DtQIconConfigurations::isGenerateIconConfigurationsEnabledByModeAndState ( const DtQIconModeAndState &  modeAndStateToCheck ) const

virtual

Get whether or not icon configurations, for the provided icon mode and icon state, will be generated. The actual generation is handled by the widget icon style manager.

See Also

DtWidgetIconStyleManager

virtual void makVrv::DtQIconConfigurations::resetGenerateConfigurationFlags ( bool  useDefaultGenerationFlags )

protectedvirtual

Reset the generate configuration flags.

Parameters

useDefaultGenerationFlags

If true, icon configurations will only be generated for Normal/Off, Normal/On, Disabled/Off, and Disabled/On. Otherwise, no icon configurations will be generated.

Member Data Documentation

std::unordered_set<DtQIconConfiguration> makVrv::DtQIconConfigurations::myConfigurations

protected

std::unordered_map<DtQIconModeAndState, bool> makVrv::DtQIconConfigurations::myGenerateConfigurationFlags

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtQIconConfiguration.h