A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
SFindInDialogues Class Reference

#include <SFindInDialogues.h>

Inheritance diagram for SFindInDialogues:
[legend]

Public Member Functions

 ~SFindInDialogues ()
 
void CloseHostTab ()
 
void Construct (const FArguments &InArgs, const TSharedPtr< FDialogueEditor > &InDialogueEditor=nullptr)
 
void FocusForUse (bool bSetFindWithinDialogue, const FDialogueSearchFilter &SearchFilter=FDialogueSearchFilter(), bool bSelectFirstResult=false)
 
FName GetHostTabId () const
 
void MakeSearchQuery (const FDialogueSearchFilter &SearchFilter, bool bInIsFindWithinDialogue)
 
 SLATE_BEGIN_ARGS (Self)
 

Private Types

typedef SFindInDialogues Self
 

Private Member Functions

TSharedRef< SWidget > FillFilterEntries ()
 
TSharedPtr< SWidget > HandleContextMenuOpening ()
 
void HandleFindModeChanged (ECheckBoxState CheckState)
 
TSharedRef< ITableRow > HandleGenerateRow (TSharedPtr< FDialogueSearchResult > InItem, const TSharedRef< STableViewBase > &OwnerTable)
 
void HandleGetChildren (TSharedPtr< FDialogueSearchResult > InItem, TArray< TSharedPtr< FDialogueSearchResult > > &OutChildren)
 
ECheckBoxState HandleGetFindModeChecked () const
 
void HandleHostTabClosed (TSharedRef< SDockTab > DockTab)
 
FReply HandleOpenGlobalFindResults ()
 
void HandleSearchTextChanged (const FText &Text)
 
void HandleSearchTextCommitted (const FText &Text, ETextCommit::Type CommitType)
 
void HandleTreeSelectionDoubleClicked (TSharedPtr< FDialogueSearchResult > Item)
 

Private Attributes

bool bIsInFindWithinDialogueMode
 
TSharedPtr< FUICommandList > CommandList
 
FDialogueSearchFilter CurrentFilter
 
TWeakPtr< FDialogueEditor > DialogueEditorPtr
 
FText HighlightText
 
TWeakPtr< SDockTab > HostTab
 
TArray< TSharedPtr< FDialogueSearchResult > > ItemsFound
 
TWeakPtr< SVerticalBox > MainVerticalBoxWidget
 
TSharedPtr< FDialogueSearchResult > RootSearchResult
 
TSharedPtr< SSearchBox > SearchTextBoxWidget
 
TSharedPtr< STreeView< TSharedPtr< FDialogueSearchResult > > > TreeView
 

Detailed Description

Widget for searching across all dialogues or just a single dialogue

Definition at line 16 of file SFindInDialogues.h.

Member Typedef Documentation

◆ Self

typedef SFindInDialogues SFindInDialogues::Self
private

Definition at line 19 of file SFindInDialogues.h.

Constructor & Destructor Documentation

◆ ~SFindInDialogues()

SFindInDialogues::~SFindInDialogues ( )

Definition at line 152 of file SFindInDialogues.cpp.

Member Function Documentation

◆ CloseHostTab()

void SFindInDialogues::CloseHostTab ( )

If this is a global find results widget, ask the host tab to close

Definition at line 266 of file SFindInDialogues.cpp.

◆ Construct()

void SFindInDialogues::Construct ( const FArguments & InArgs,
const TSharedPtr< FDialogueEditor > & InDialogueEditor = nullptr )

Definition at line 23 of file SFindInDialogues.cpp.

Here is the call graph for this function:

◆ FillFilterEntries()

TSharedRef< SWidget > SFindInDialogues::FillFilterEntries ( )
private

Fills in the filter menu.

Definition at line 426 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FocusForUse()

void SFindInDialogues::FocusForUse ( bool bSetFindWithinDialogue,
const FDialogueSearchFilter & SearchFilter = FDialogueSearchFilter(),
bool bSelectFirstResult = false )

Focuses this widget's search box, and changes the mode as well, and optionally the search terms

Definition at line 157 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetHostTabId()

FName SFindInDialogues::GetHostTabId ( ) const

If this is a global find results widget, returns the host tab's unique ID. Otherwise, returns NAME_None.

Definition at line 255 of file SFindInDialogues.cpp.

◆ HandleContextMenuOpening()

TSharedPtr< SWidget > SFindInDialogues::HandleContextMenuOpening ( )
private

Callback to build the context menu when right clicking in the tree

Definition at line 412 of file SFindInDialogues.cpp.

Here is the caller graph for this function:

◆ HandleFindModeChanged()

void SFindInDialogues::HandleFindModeChanged ( ECheckBoxState CheckState)
inlineprivate

Called when the find mode checkbox is hit

Definition at line 66 of file SFindInDialogues.h.

Here is the caller graph for this function:

◆ HandleGenerateRow()

TSharedRef< ITableRow > SFindInDialogues::HandleGenerateRow ( TSharedPtr< FDialogueSearchResult > InItem,
const TSharedRef< STableViewBase > & OwnerTable )
private

Definition at line 318 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HandleGetChildren()

void SFindInDialogues::HandleGetChildren ( TSharedPtr< FDialogueSearchResult > InItem,
TArray< TSharedPtr< FDialogueSearchResult > > & OutChildren )
private

Definition at line 305 of file SFindInDialogues.cpp.

Here is the caller graph for this function:

◆ HandleGetFindModeChecked()

ECheckBoxState SFindInDialogues::HandleGetFindModeChecked ( ) const
inlineprivate

Called to check what the find mode is for the checkbox

Definition at line 72 of file SFindInDialogues.h.

Here is the caller graph for this function:

◆ HandleHostTabClosed()

void SFindInDialogues::HandleHostTabClosed ( TSharedRef< SDockTab > DockTab)
private

Called when the host tab is closed (if valid)

Definition at line 275 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HandleOpenGlobalFindResults()

FReply SFindInDialogues::HandleOpenGlobalFindResults ( )
private

Called when the user clicks the global find results button

Definition at line 294 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HandleSearchTextChanged()

void SFindInDialogues::HandleSearchTextChanged ( const FText & Text)
private

Called when user changes the text they are searching for

Definition at line 280 of file SFindInDialogues.cpp.

Here is the caller graph for this function:

◆ HandleSearchTextCommitted()

void SFindInDialogues::HandleSearchTextCommitted ( const FText & Text,
ETextCommit::Type CommitType )
private

Called when user changes commits text to the search box

Definition at line 285 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HandleTreeSelectionDoubleClicked()

void SFindInDialogues::HandleTreeSelectionDoubleClicked ( TSharedPtr< FDialogueSearchResult > Item)
private

Definition at line 310 of file SFindInDialogues.cpp.

Here is the caller graph for this function:

◆ MakeSearchQuery()

void SFindInDialogues::MakeSearchQuery ( const FDialogueSearchFilter & SearchFilter,
bool bInIsFindWithinDialogue )

Submits a search query

Parameters
SearchFilterFilter for search
bInIsFindWithinDialogueTRUE if searching within the current Dialogue only

Definition at line 191 of file SFindInDialogues.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SLATE_BEGIN_ARGS()

SFindInDialogues::SLATE_BEGIN_ARGS ( Self )
inline

Definition at line 22 of file SFindInDialogues.h.

Member Data Documentation

◆ bIsInFindWithinDialogueMode

bool SFindInDialogues::bIsInFindWithinDialogueMode
private

Should we search within the current Dialogue only (rather than all Dialogues)

Definition at line 118 of file SFindInDialogues.h.

◆ CommandList

TSharedPtr<FUICommandList> SFindInDialogues::CommandList
private

Commands handled by this widget

Definition at line 124 of file SFindInDialogues.h.

◆ CurrentFilter

FDialogueSearchFilter SFindInDialogues::CurrentFilter
private

The current searach filter

Definition at line 115 of file SFindInDialogues.h.

◆ DialogueEditorPtr

TWeakPtr<FDialogueEditor> SFindInDialogues::DialogueEditorPtr
private

Pointer back to the Dialogue editor that owns us

Definition at line 94 of file SFindInDialogues.h.

◆ HighlightText

FText SFindInDialogues::HighlightText
private

Definition at line 112 of file SFindInDialogues.h.

◆ HostTab

TWeakPtr<SDockTab> SFindInDialogues::HostTab
private

Tab hosting this widget. May be invalid.

Definition at line 121 of file SFindInDialogues.h.

◆ ItemsFound

TArray<TSharedPtr<FDialogueSearchResult> > SFindInDialogues::ItemsFound
private

Definition at line 109 of file SFindInDialogues.h.

◆ MainVerticalBoxWidget

TWeakPtr<SVerticalBox> SFindInDialogues::MainVerticalBoxWidget
private

Vertical box, used to add and remove widgets dynamically

Definition at line 103 of file SFindInDialogues.h.

◆ RootSearchResult

TSharedPtr<FDialogueSearchResult> SFindInDialogues::RootSearchResult
private

In Find Within Dialogue mode, we need to keep a handle on the root result, because it won't show up in the tree.

Definition at line 106 of file SFindInDialogues.h.

◆ SearchTextBoxWidget

TSharedPtr<SSearchBox> SFindInDialogues::SearchTextBoxWidget
private

The search text box

Definition at line 100 of file SFindInDialogues.h.

◆ TreeView

TSharedPtr<STreeView<TSharedPtr<FDialogueSearchResult> > > SFindInDialogues::TreeView
private

Definition at line 97 of file SFindInDialogues.h.

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