1. Epic GamesDeveloper
  3. SFindInBlueprints

SFindInBlueprints

Widget for searching for (functions/events) across all blueprints or just a single blueprint

API > API/Editor > API/Editor/Kismet

Widget for searching for (functions/events) across all blueprints or just a single blueprint

   
Name SFindInBlueprints
Type class
Header File /Engine/Source/Editor/Kismet/Public/FindInBlueprints.h
Include Path #include "FindInBlueprints.h"

Syntax

class SFindInBlueprints : public SCompoundWidget

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

~SFindInBlueprints()

   FindInBlueprints.h  

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHideProgressBars bool True if progress bar widgets should be hidden FindInBlueprints.h  
bIsInFindWithinBlueprintMode bool Should we search within the current blueprint only (rather than all blueprints) FindInBlueprints.h  
bIsLocked bool True if current search should not be changed by an external source FindInBlueprints.h  
bKeepCacheBarProgressVisible bool True if cache bar should remain visible after a caching operation has ended FindInBlueprints.h  
BlueprintEditorPtr TWeakPtr< class FBlueprintEditor > Pointer back to the blueprint editor that owns us FindInBlueprints.h  
bShowCacheBarCancelButton bool True if users should be allowed to cancel the active caching operation FindInBlueprints.h  
bShowCacheBarCloseButton bool True if users should be allowed to close the cache bar while caching FindInBlueprints.h  
bShowCacheBarUnresponsiveEditorWarningText bool True if the unresponsive warning text should be visible in the cache bar FindInBlueprints.h  
CacheBarSlot TWeakPtr< SWidget > Weak pointer to the cache bar slot, so it can be removed FindInBlueprints.h  
CommandList TSharedPtr< FUICommandList > Commands handled by this widget FindInBlueprints.h  
HighlightText FText The string to highlight in the results FindInBlueprints.h  
HostTab TWeakPtr< SDockTab > Tab hosting this widget. May be invalid. FindInBlueprints.h  
ItemsFound TArray< FSearchResult > This buffer stores the currently displayed results FindInBlueprints.h  
LastCachedAssetPath FSoftObjectPath Last cached asset path (used during continuous cache operations). FindInBlueprints.h  
LastSearchedFiBVersion EFiBVersion Cached version that was last searched FindInBlueprints.h  
MainVerticalBox TWeakPtr< SVerticalBox > Vertical box, used to add and remove widgets dynamically FindInBlueprints.h  
OnSearchComplete FOnSearchComplete Callback when search is complete FindInBlueprints.h  
OutOfDateWithLastSearchBPCount int32 Cached count of out of date Blueprints from last search. FindInBlueprints.h  
RootSearchResult FSearchResult In Find Within Blueprint mode, we need to keep a handle on the root result, because it won't show up in the tree FindInBlueprints.h  
SearchTextField TSharedPtr< class SSearchBox > The search text box FindInBlueprints.h  
SearchValue FString The string to search for FindInBlueprints.h  
StreamSearch TSharedPtr< class FStreamSearch > Thread object that searches through Blueprint data on a separate thread FindInBlueprints.h  
TreeView TSharedPtr< STreeViewType > The tree view displays the results FindInBlueprints.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CacheAllBlueprints ( const FFindInBlueprintCachingOptions& InOptions
)

 Asynchronously caches all Blueprints below a specified version. FindInBlueprints.h  

void ClearResults()

 Clears the currently visible results FindInBlueprints.h  

void CloseHostTab()

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

void Construct ( const FArguments& InArgs,
TSharedPtr< class FBlueprintEditor > InBlueprintEditor
)

   FindInBlueprints.h  

void FocusForUse ( bool bSetFindWithinBlueprint,
FString NewSearchTerms,
bool bSelectFirstResult
)

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

FName GetHostTabId ()

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

bool IsLocked()

 Determines if this context does not accept syncing from an external source FindInBlueprints.h  

bool IsSearchInProgress()

 Determines whether a search query is actively in progress FindInBlueprints.h  

void MakeSearchQuery ( FString InSearchString,
bool bInIsFindWithinBlueprint,
const FStreamSearchOptions& InSearchOptions,
FOnSearchComplete InOnSearchComplete
)

 Submits a search query FindInBlueprints.h  

void OnCacheComplete ( EFiBCacheOpType InOpType,
EFiBCacheOpFlags InOpFlags
)

 Called when caching Blueprints is complete FindInBlueprints.h  

void OnCacheStarted ( EFiBCacheOpType InOpType,
EFiBCacheOpFlags InOpFlags
)

 Called when caching Blueprints is started FindInBlueprints.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 SWidget overrides FindInBlueprints.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page