SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType > Struct Template Reference

Inheritance diagram for SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >:

Public Types
using	SlateAttributeType = AttributeMemberType
using	ObjectType = typename AttributeMemberType::ObjectType
using	AttributeType = TAttribute< ObjectType >

Public Member Functions
template<typename WidgetType , typename V = typename std::enable_if<std::is_base_of<SWidget, WidgetType>::value>::type>
	TSlateMemberAttributeRef (const TSharedRef< WidgetType > &InOwner, const AttributeMemberType &InAttribute)
	TSlateMemberAttributeRef (ESlateMemberAttributeRefNoCheckParam, const TSharedRef< SWidget > &InOwner, const AttributeMemberType &InAttribute)
bool	IsValid () const
const ObjectType &	Get () const
const ObjectType &	Get (const ObjectType &DefaultValue) const
void	UpdateValue ()
const ObjectType &	UpdateAndGet ()
const ObjectType &	UpdateAndGet (const ObjectType &DefaultValue)
TAttribute< ObjectType >	ToAttribute () const
bool	IsBound () const
bool	IdenticalTo (const TSlateMemberAttributeRef &Other) const
bool	IdenticalTo (const TAttribute< ObjectType > &Other) const

Member Typedef Documentation

AttributeType

template<typename AttributeMemberType >

using SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::AttributeType = TAttribute<ObjectType>

ObjectType

template<typename AttributeMemberType >

using SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::ObjectType = typename AttributeMemberType::ObjectType

SlateAttributeType

template<typename AttributeMemberType >

using SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::SlateAttributeType = AttributeMemberType

Constructor & Destructor Documentation

TSlateMemberAttributeRef() [1/2]

template<typename AttributeMemberType >

template<typename WidgetType , typename V = typename std::enable_if<std::is_base_of<SWidget, WidgetType>::value>::type>

SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::TSlateMemberAttributeRef ( const TSharedRef< WidgetType > &  InOwner, const AttributeMemberType &  InAttribute  )

inlineexplicit

Constructor

TSlateMemberAttributeRef() [2/2]

template<typename AttributeMemberType >

SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::TSlateMemberAttributeRef ( ESlateMemberAttributeRefNoCheckParam  , const TSharedRef< SWidget > &  InOwner, const AttributeMemberType &  InAttribute  )

inlineexplicit

Constructor

Member Function Documentation

Get() [1/2]

template<typename AttributeMemberType >

const ObjectType & SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::Get ( ) const

inline

Returns

the SlateAttribute cached value; undefined when IsValid() returns false.

Get() [2/2]

template<typename AttributeMemberType >

const ObjectType & SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::Get ( const ObjectType &  DefaultValue ) const

inline

Returns

the SlateAttribute cached value or the DefaultValue if the reference is invalid.

IdenticalTo() [1/2]

template<typename AttributeMemberType >

bool SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::IdenticalTo ( const TAttribute< ObjectType > &  Other ) const

inline

Returns

True if they have the same Getter or, if the Attribute is set, the same value.

IdenticalTo() [2/2]

template<typename AttributeMemberType >

bool SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::IdenticalTo ( const TSlateMemberAttributeRef< AttributeMemberType > &  Other ) const

inline

Returns

True if they have the same Getter or the same value.

IsBound()

template<typename AttributeMemberType >

bool SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::IsBound ( ) const

inline

Returns

True if the SlateAttribute is bound to a getter function.

IsValid()

template<typename AttributeMemberType >

bool SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::IsValid ( ) const

inline

Returns

if the reference is valid. A reference can be invalid if the SWidget is destroyed.

ToAttribute()

template<typename AttributeMemberType >

TAttribute< ObjectType > SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::ToAttribute ( ) const

inline

Build a Attribute from this SlateAttribute.

UpdateAndGet() [1/2]

template<typename AttributeMemberType >

const ObjectType & SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::UpdateAndGet ( )

inline

Assumes the reference is valid. Shorthand for the boilerplace code: MyAttribute.UpdateValueNow(); MyAttribute.Get();

UpdateAndGet() [2/2]

template<typename AttributeMemberType >

const ObjectType & SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::UpdateAndGet ( const ObjectType &  DefaultValue )

inline

Shorthand for the boilerplace code: MyAttribute.UpdateValueNow(); MyAttribute.Get(DefaultValue);

Returns

the SlateAttribute cached value or the DefaultValue if the reference is invalid.

UpdateValue()

template<typename AttributeMemberType >

void SlateAttributePrivate::TSlateMemberAttributeRef< AttributeMemberType >::UpdateValue ( )

inline

Update the cached value and invalidate the widget if needed.

---

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

• Engine/Source/Runtime/SlateCore/Public/Types/Attributes/SlateAttributeDefinition.inl
• Engine/Source/Runtime/SlateCore/Public/Types/Attributes/SlateAttributeMember.inl