SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Member Functions | Protected Attributes | List of all members
smtk::view::LockedResourceBadge Class Reference

A badge that appears next to resources that are locked. More...

#include <LockedResourceBadge.h>

Inheritance diagram for smtk::view::LockedResourceBadge:
[legend]
Collaboration diagram for smtk::view::LockedResourceBadge:
[legend]

Public Member Functions

 smtkTypeMacro (smtk::view::LockedResourceBadge)
 
 LockedResourceBadge (BadgeSet &, const Configuration::Component &)
 
bool appliesToPhrase (const DescriptivePhrase *phrase) const override
 This badge only applies to phrases whose subject is a locked resource.
 
std::string tooltip (const DescriptivePhrase *phrase) const override
 The tool-tip string describes the lock type (read/write).
 
std::string icon (const DescriptivePhrase *phrase, const std::array< float, 4 > &background) const override
 Returns an SVG string for rendering the badge icon.
 
- Public Member Functions inherited from smtk::view::Badge
 smtkTypeMacroBase (Badge)
 
 Badge (const Badge &)=delete
 
Badgeoperator= (const Badge &)=delete
 
virtual bool action (const DescriptivePhrase *, const BadgeAction &)
 Take an action when the badge is clicked. More...
 
bool isDefault () const
 Return whether this badge be invoked by non-specific user gestures. More...
 
void setIsDefault (bool isDefault)
 Set this badge as a default.
 

Protected Attributes

const BadgeSetm_parent { nullptr }
 
- Protected Attributes inherited from smtk::view::Badge
bool m_isDefault { false }
 Should this badge be invoked by non-specific user gestures when it is applicable?
 

Detailed Description

A badge that appears next to resources that are locked.


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