Abstract base class for Attributes_v4_2 interface. More...

#include <attributes.h>

Inheritance diagram for Ufe::Attributes_v4_2:

Collaboration diagram for Ufe::Attributes_v4_2:

Public Types
typedef std::shared_ptr< Attributes_v4_2 >	Ptr

typedef std::vector< std::pair< std::string, std::string > >	Enums

Public Types inherited from Ufe::Attributes
typedef std::shared_ptr< Attributes >	Ptr

Public Member Functions
	~Attributes_v4_2 () override
	Destructor. More...

virtual Enums	getEnums (const std::string &attrName) const =0

Public Member Functions inherited from Ufe::Attributes
	Attributes ()
	Constructor. More...

	Attributes (const Attributes &)=default
	Default copy constructor. More...

virtual	~Attributes ()
	Destructor. More...

virtual SceneItem::Ptr	sceneItem () const =0

virtual Attribute::Type	attributeType (const std::string &name)=0

virtual Attribute::Ptr	attribute (const std::string &name)=0

virtual std::vector< std::string >	attributeNames () const =0

virtual bool	hasAttribute (const std::string &name) const =0

virtual Attribute::Ptr	addAttribute (const std::string &name, const Attribute::Type &type)

virtual AddAttributeUndoableCommand::Ptr	addAttributeCmd (const std::string &name, const Attribute::Type &type)=0

virtual bool	removeAttribute (const std::string &name)

virtual UndoableCommand::Ptr	removeAttributeCmd (const std::string &name)=0

virtual Attribute::Ptr	renameAttribute (const std::string &originalName, const std::string &newName)

virtual RenameAttributeUndoableCommand::Ptr	renameAttributeCmd (const std::string &originalName, const std::string &newName)=0

Additional Inherited Members
Static Public Member Functions inherited from Ufe::Attributes
static Ptr	attributes (const SceneItem::Ptr &item)

static bool	addObserver (const SceneItem::Ptr &item, const Observer::Ptr &obs)

static bool	addObserver (const Observer::Ptr &obs)

static bool	removeObserver (const SceneItem::Ptr &item, const Observer::Ptr &obs)

static bool	removeObserver (const Observer::Ptr &obs)

static std::size_t	nbObservers (const SceneItem::Ptr &item)

static std::size_t	nbObservers ()

static bool	hasObserver (const SceneItem::Ptr &item, const Observer::Ptr &obs)

static bool	hasObserver (const Observer::Ptr &obs)

static bool	hasObservers (const Path &path)

static bool	hasObservers (Rtid runTimeId)

static void	notify (const AttributeChanged &notification)

Detailed Description

Abstract base class for Attributes_v4_2 interface.

This base class defines an interface for factory objects that runtimes can implement to create v4.2 attribute interface objects that support getting enums.

Definition at line 260 of file attributes.h.

Member Typedef Documentation

◆ Enums

typedef std::vector< std::pair< std::string, std::string> > Ufe::Attributes_v4_2::Enums

Definition at line 264 of file attributes.h.

◆ Ptr

typedef std::shared_ptr<Attributes_v4_2> Ufe::Attributes_v4_2::Ptr

Definition at line 263 of file attributes.h.

Constructor & Destructor Documentation

◆ ~Attributes_v4_2()

Ufe::Attributes_v4_2::~Attributes_v4_2 ( )

override

Destructor.

Member Function Documentation

◆ getEnums()

virtual Enums Ufe::Attributes_v4_2::getEnums ( const std::string & attrName ) const

pure virtual

Gets the enums associated with the named attribute

Parameters

attrName The name of the attribute to return the enums for.

Returns: The list of allowed enum label and value pairs for the named attribute. Returns empty Enums structure if there are no enums for this attribute.

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

common/include/ufe/attributes.h

Public Types

Public Member Functions

Additional Inherited Members