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

Value	value () const override

UndoableCommand::Ptr	setCmd (const Value &value) override

virtual std::string	get () const =0

virtual bool	isDefault () const =0

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

virtual void	reset ()=0
	Reset the attribute value to its default setting. More...

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

virtual UndoableCommand::Ptr	resetCmd ()

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

	Attribute (const Attribute &)=delete

	Attribute (Attribute &&)=delete

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

virtual	~Attribute ()

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	value () const =0

virtual UndoableCommand::Ptr	setCmd (const Value &value)=0

	Attribute (const Attribute &)=delete

Attribute &	operator= (const Attribute &)=delete

	Attribute (Attribute &&)=delete

Attribute &	operator= (Attribute &&)=delete

bool	operator== (const Attribute &rhs) const

bool	operator!= (const Attribute &rhs) const

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	kUInt [] = "UInt"

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	kBoolArray [] = "BoolArray"

static constexpr char	kIntArray [] = "IntArray"

static constexpr char	kUIntArray [] = "UIntArray"

static constexpr char	kFloatArray [] = "FloatArray"

static constexpr char	kDoubleArray [] = "DoubleArray"

static constexpr char	kStringArray [] = "StringArray"

static constexpr char	kInt2Array [] = "Int2Array"

static constexpr char	kFloat2Array [] = "Float2Array"

static constexpr char	kDouble2Array [] = "Double2Array"

static constexpr char	kInt3Array [] = "Int3Array"

static constexpr char	kFloat3Array [] = "Float3Array"

static constexpr char	kDouble3Array [] = "Double3Array"

static constexpr char	kInt4Array [] = "Int4Array"

static constexpr char	kFloat4Array [] = "Float4Array"

static constexpr char	kDouble4Array [] = "Double4Array"

static constexpr char	kColorFloat3Array [] = "ColorFloat3Array"

static constexpr char	kColorFloat4Array [] = "ColorFloat4Array"

static constexpr char	kMatrixDouble3Array [] = "MatrixDouble3Array"

static constexpr char	kMatrixDouble4Array [] = "MatrixDouble4Array"

static constexpr char	kGeneric [] = "Generic"

static constexpr char	kLocked [] = "Locked"

Detailed Description

Attribute which represents a filename.

Definition at line 224 of file attribute.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 228 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 current value.

◆ isDefault()

virtual bool Ufe::AttributeFilename::isDefault ( ) const

pure virtual

Returns true if this attribute value was never set and is still at the default value.

◆ reset()

virtual void Ufe::AttributeFilename::reset ( )

pure virtual

Reset the attribute value to its default setting.

◆ resetCmd()

virtual UndoableCommand::Ptr Ufe::AttributeFilename::resetCmd ( )

virtual

Return a command for undo / redo that resets the attribute value. The returned command is not executed; it is up to the caller to call execute(). The default implementation stores undo/redo data in an AttributeInfo that allows reconstructing a stale Attribute. Executing the command will throw if reconstruction fails or leads to an incorrectly typed attribute.

◆ set()

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

pure virtual

Set the attribute value.

◆ setCmd() [1/2]

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

virtual

Return a command for undo / redo that sets the attribute value. The returned command is not executed; it is up to the caller to call execute(). The default implementation stores undo/redo data in an AttributeInfo that allows reconstructing a stale Attribute. Executing the command will throw if reconstruction fails or leads to an incorrectly typed attribute.

◆ setCmd() [2/2]

UndoableCommand::Ptr Ufe::AttributeFilename::setCmd ( const Value & value )

overridevirtual

Return a command for undo / redo that sets the attribute value. If the specified value is not of the correct type, a null pointer is returned. The returned command is not executed; it is up to the caller to call execute(). The default implementation stores undo/redo data in an AttributeInfo that allows reconstructing a stale Attribute. Executing the command will throw if reconstruction fails or leads to an incorrectly typed attribute.

Implements Ufe::Attribute.

◆ type()

Type Ufe::AttributeFilename::type ( ) const

finalvirtual

Returns: The attributes type.

Implements Ufe::Attribute.

◆ value()

Value Ufe::AttributeFilename::value ( ) const

overridevirtual

Returns: The attribute value wrapped in a Value variant for generic access.

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

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Function Documentation

◆ Attribute() [1/3]

◆ Attribute() [2/3]

◆ Attribute() [3/3]

◆ get()

◆ isDefault()

◆ reset()

◆ resetCmd()

◆ set()

◆ setCmd() [1/2]

◆ setCmd() [2/2]

◆ type()

◆ value()