smtk::view::BadgeSet Class Reference

A container for the badges that apply to a view. More...

#include <BadgeSet.h>

Public Types
using	BadgeList = std::vector< Badge * >

Public Member Functions
	BadgeSet ()=default
	Remove this once view::Manager uses the new factory method to construct PhraseModel with arguments.
	BadgeSet (const Configuration *viewSpec, const ManagerPtr &manager, PhraseModel *phraseModel)
	Construct and configure a set of badges for a view.
	BadgeSet (const BadgeSet &)=delete
void	operator= (const BadgeSet &)=delete
void	configure (const Configuration *viewSpec, const smtk::view::ManagerPtr &manager)
BadgeList	badgesFor (const DescriptivePhrase *phrase) const
	Return ordered list of badge ptrs, ignoring any names without a matching badge.
smtk::view::ManagerPtr	manager () const
	Return the manager (if any) used to create this badge-set. More...
PhraseModel *	phraseModel () const
	Return the phraseModel (if any) that owns this badge-set.
template<typename T >
T *	findBadgeOfType ()
	Get the first existing badge matching a type.
smtk::common::TypeContainer &	badgeData ()
const smtk::common::TypeContainer &	badgeData () const

Detailed Description

A container for the badges that apply to a view.

Member Function Documentation

manager()

smtk::view::ManagerPtr smtk::view::BadgeSet::manager ( ) const

inline

Return the manager (if any) used to create this badge-set.

Some badges may need access to the manager to function. One example is the ObjectTypeAndColorBadge, which needs access to the manager's ObjectIcons to obtain SVG icons.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/smtk/view/BadgeSet.h
• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/smtk/view/BadgeSet.cxx