FBindingContext Class Reference

#include <UICommandInfo.h>

Inheritance diagram for FBindingContext:

Public Member Functions
	FBindingContext (const FName InContextName, const FText &InContextDesc, const FName InContextParent, const FName InStyleSetName)
	FBindingContext (const FBindingContext &)=default
	FBindingContext (FBindingContext &&)=default
FBindingContext &	operator= (const FBindingContext &)=default
FBindingContext &	operator= (FBindingContext &&)=default
SLATE_API FUICommandInfoDecl	NewCommand (const FName InCommandName, const FText &InCommandLabel, const FText &InCommandDesc)
FName	GetContextName () const
FName	GetContextParent () const
FName	GetStyleSetName () const
const FText &	GetContextDesc () const
SLATE_API void	AddBundle (const FName Name, const FText &Desc)
SLATE_API const FText &	GetBundleLabel (const FName Name)
bool	operator== (const FBindingContext &Other) const
Public Member Functions inherited from TSharedFromThis< FBindingContext >
TSharedRef< FBindingContext, Mode >	AsShared ()
TSharedRef< FBindingContext const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FBindingContext, Mode >	AsWeak ()
TWeakPtr< FBindingContext const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Attributes
static SLATE_API FOnBindingContextChanged	CommandsChanged

Friends
uint32	GetTypeHash (const FBindingContext &Context)

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FBindingContext >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FBindingContext >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Represents a context in which input bindings are valid

Constructor & Destructor Documentation

FBindingContext() [1/3]

FBindingContext::FBindingContext ( const FName  InContextName, const FText &  InContextDesc, const FName  InContextParent, const FName  InStyleSetName  )

inline

Constructor

Parameters

InContextName	The name of the context
InContextDesc	The localized description of the context
InContextParent	Optional parent context. Bindings are not allowed to be the same between parent and child contexts
InStyleSetName	The style set to find the icons in, eg) FCoreStyle::Get().GetStyleSetName()

FBindingContext() [2/3]

FBindingContext::FBindingContext ( const FBindingContext &  )

default

FBindingContext() [3/3]

FBindingContext::FBindingContext ( FBindingContext &&  )

default

Member Function Documentation

AddBundle()

void FBindingContext::AddBundle	(	const FName	Name,
		const FText &	Desc
	)

Adds a new command bundle to this context that can be referenced by name from commands within the context.

Parameters

Name	A unique identifier for the bundle in this context
Desc	A localized description of the bundle

GetBundleLabel()

const FText & FBindingContext::GetBundleLabel

(

const FName

Name

)

Gets a localized label of a command bundle

Parameters

Name	The name of the bundle to get a label for

Returns

The localized label of the bundle

GetContextDesc()

const FText & FBindingContext::GetContextDesc ( ) const

inline

Returns

The localized description of this context

GetContextName()

FName FBindingContext::GetContextName ( ) const

inline

Returns

The name of the context

GetContextParent()

FName FBindingContext::GetContextParent ( ) const

inline

Returns

The name of the parent context (or NAME_None if there isnt one)

GetStyleSetName()

FName FBindingContext::GetStyleSetName ( ) const

inline

Returns

The name of the style set to find the icons in

NewCommand()

FUICommandInfoDecl FBindingContext::NewCommand	(	const FName	InCommandName,
		const FText &	InCommandLabel,
		const FText &	InCommandDesc
	)

Creates a new command declaration used to populate commands with data

operator=() [1/2]

FBindingContext & FBindingContext::operator= ( const FBindingContext &  )

default

operator=() [2/2]

FBindingContext & FBindingContext::operator= ( FBindingContext &&  )

default

operator==()

bool FBindingContext::operator== ( const FBindingContext &  Other ) const

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FBindingContext &  Context )

friend

Member Data Documentation

CommandsChanged

FOnBindingContextChanged FBindingContext::CommandsChanged

static

A delegate that is called when commands are registered or unregistered with a binding context

---

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

• Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandInfo.h
• Engine/Source/Runtime/Slate/Private/Framework/Commands/UICommandInfo.cpp