FFrontendFilter_ArticyObject Class Reference

#include <ArticyFilterHelpers.h>

Inheritance diagram for FFrontendFilter_ArticyObject:

Public Member Functions
	FFrontendFilter_ArticyObject ()
	~FFrontendFilter_ArticyObject ()
virtual FString	GetName () const
virtual FText	GetDisplayName () const
virtual FText	GetToolTipText () const
virtual bool	PassesFilter (FArticyObjectFilterType InItem) const override
	DECLARE_DERIVED_EVENT (FFrontendFilter_ArticyObject, IFilter< FArticyObjectFilterType >::FChangedEvent, FChangedEvent)
virtual FChangedEvent &	OnChanged () override
FText	GetRawFilterText () const
void	SetRawFilterText (const FText &InFilterText)
FText	GetFilterErrorText () const
void	SetIncludeClassName (const bool InIncludeClassName)

Public Attributes
FChangedEvent	ChangedEvent

Protected Member Functions
void	BroadcastChangedEvent () const

Detailed Description

A filter for testing Articy objects for various traits such as display name, speaker name, text, etc.

Constructor & Destructor Documentation

FFrontendFilter_ArticyObject()

FFrontendFilter_ArticyObject::FFrontendFilter_ArticyObject

(

)

Constructor for FFrontendFilter_ArticyObject.

~FFrontendFilter_ArticyObject()

FFrontendFilter_ArticyObject::~FFrontendFilter_ArticyObject

(

)

Destructor for FFrontendFilter_ArticyObject.

Member Function Documentation

BroadcastChangedEvent()

void FFrontendFilter_ArticyObject::BroadcastChangedEvent ( ) const

inlineprotected

Broadcasts the changed event to notify listeners.

GetDisplayName()

virtual FText FFrontendFilter_ArticyObject::GetDisplayName ( ) const

inlinevirtual

Gets the display name of the filter.

Returns

The display name of the filter as FText.

GetFilterErrorText()

FText FFrontendFilter_ArticyObject::GetFilterErrorText

(

)

const

Get the last error returned from lexing or compiling the current filter text.

Returns

The filter error text.

Retrieves any error text from the filter.

Returns

The filter error text.

GetName()

virtual FString FFrontendFilter_ArticyObject::GetName ( ) const

inlinevirtual

Gets the name of the filter.

Returns

The name of the filter as a string.

GetRawFilterText()

FText FFrontendFilter_ArticyObject::GetRawFilterText

(

)

const

Returns the unsanitized and unsplit filter terms.

Returns

The raw filter text.

Retrieves the raw filter text.

Returns

The raw filter text.

GetToolTipText()

virtual FText FFrontendFilter_ArticyObject::GetToolTipText ( ) const

inlinevirtual

Gets the tooltip text for the filter.

Returns

The tooltip text of the filter as FText.

PassesFilter()

bool FFrontendFilter_ArticyObject::PassesFilter ( FArticyObjectFilterType InItem ) const

overridevirtual

Determines if the given item passes the filter.

Parameters

InItem

The item to test against the filter.

Returns

True if the item passes the filter, false otherwise.

SetIncludeClassName()

void FFrontendFilter_ArticyObject::SetIncludeClassName

(

const bool

InIncludeClassName

)

If bIncludeClassName is true, the text filter will include an asset's class name in the search.

Parameters

InIncludeClassName

Boolean value indicating inclusion of class name.

Sets whether the class name should be included in the filter.

Parameters

InIncludeClassName

Boolean value indicating inclusion of class name.

SetRawFilterText()

void FFrontendFilter_ArticyObject::SetRawFilterText

(

const FText &

InFilterText

)

Set the Text to be used as the Filter's restrictions.

Parameters

InFilterText

The filter text to set.

Sets the raw filter text.

Parameters

InFilterText

The filter text to set.

---

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

• Source/ArticyEditor/Public/Slate/ArticyFilterHelpers.h
• Source/ArticyEditor/Private/Slate/ArticyFilterHelpers.cpp