Attribute which represents a filename. More...

#include <attribute.h>

Inheritance diagram for Ufe::AttributeFilename:

Collaboration diagram for Ufe::AttributeFilename:

Public Types
typedef std::shared_ptr< AttributeFilename >	Ptr

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

typedef std::string	Type

Public Member Functions
Type	type () const final

virtual std::string	get () const =0

virtual void	set (const std::string &value)=0
	Set the attribute enum value. More...

virtual UndoableCommand::Ptr	setCmd (const std::string &value)

	Attribute (const SceneItem::Ptr &)
	Constructor. More...

	Attribute (const Attribute &)=delete
	No copy or move constructor/assignment. More...

	Attribute (Attribute &&)=delete

Public Member Functions inherited from Ufe::Attribute
	Attribute (const SceneItem::Ptr &)
	Constructor. More...

virtual	~Attribute ()

	Attribute (const Attribute &)=delete
	No copy or move constructor/assignment. More...

Attribute &	operator= (const Attribute &)=delete

	Attribute (Attribute &&)=delete

Attribute &	operator= (Attribute &&)=delete

bool	operator== (const Attribute &rhs) const

bool	operator!= (const Attribute &rhs) const

SceneItem::Ptr	sceneItem () const

virtual bool	hasValue () const =0

virtual std::string	name () const =0

virtual std::string	displayName () const

virtual std::string	documentation () const =0

virtual Type	type () const =0

virtual std::string	string () const =0

virtual Value	getMetadata (const std::string &key) const =0

virtual bool	setMetadata (const std::string &key, const Value &value)=0

virtual UndoableCommand::Ptr	setMetadataCmd (const std::string &key, const Value &value)

virtual bool	clearMetadata (const std::string &key)=0

virtual UndoableCommand::Ptr	clearMetadataCmd (const std::string &key)

virtual bool	hasMetadata (const std::string &key) const =0
	Returns true if metadata key has a non-empty value. More...

Additional Inherited Members
Static Public Attributes inherited from Ufe::Attribute
static constexpr char	kInvalid [] = "Invalid"

static constexpr char	kBool [] = "Bool"

static constexpr char	kInt [] = "Int"

static constexpr char	kFloat [] = "Float"

static constexpr char	kDouble [] = "Double"

static constexpr char	kString [] = "String"

static constexpr char	kColorFloat3 [] = "ColorFloat3"

static constexpr char	kColorFloat4 [] = "ColorFloat4"

static constexpr char	kFilename [] = "Filename"

static constexpr char	kEnumString [] = "EnumString"

static constexpr char	kInt3 [] = "Int3"

static constexpr char	kFloat2 [] = "Float2"

static constexpr char	kFloat3 [] = "Float3"

static constexpr char	kFloat4 [] = "Float4"

static constexpr char	kDouble3 [] = "Double3"

static constexpr char	kMatrix3d [] = "Matrix3d"

static constexpr char	kMatrix4d [] = "Matrix4d"

static constexpr char	kGeneric [] = "Generic"

static constexpr char	kLocked [] = "Locked"

Detailed Description

Attribute which represents a filename.

Definition at line 186 of file attribute.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 190 of file attribute.h.

Member Function Documentation

◆ Attribute() [1/3]

Ufe::Attribute::Attribute ( Attribute && )

delete

◆ Attribute() [2/3]

Ufe::Attribute::Attribute ( const Attribute & )

delete

No copy or move constructor/assignment.

◆ Attribute() [3/3]

Ufe::Attribute::Attribute ( const SceneItem::Ptr & )

Constructor.

◆ get()

virtual std::string Ufe::AttributeFilename::get ( ) const

pure virtual

Returns: Attribute enum current value.

◆ set()

virtual void Ufe::AttributeFilename::set ( const std::string & value )

pure virtual

Set the attribute enum value.

◆ setCmd()

virtual UndoableCommand::Ptr Ufe::AttributeFilename::setCmd ( const std::string & value )

virtual

Return a command for undo / redo that sets the attribute enum value. The returned command is not executed; it is up to the caller to call execute().

◆ type()

Type Ufe::AttributeFilename::type ( ) const

finalvirtual

Returns: The attributes type.

Implements Ufe::Attribute.

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

common/include/ufe/attribute.h

Public Types

Public Member Functions

Additional Inherited Members