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

#include <DlgDataDisplayTreeNode.h>

Inheritance diagram for FDlgDataDisplayTreeNode:
[legend]

Public Member Functions

 FDlgDataDisplayTreeNode (const FText &InDisplayText, const TSharedPtr< Self > &InParent)
 
virtual void AddChild (const TSharedPtr< FDlgDataDisplayTreeNode > &ChildNode)
 
virtual void ClearChildren ()
 
void ClearParent ()
 
bool DoesDisplayTextContains (const FString &InSearch, ESearchCase::Type SearchCase=ESearchCase::IgnoreCase)
 
void ExpandAllChildren (const TSharedPtr< STreeView< TSharedPtr< FDlgDataDisplayTreeNode > > > &TreeView, bool bRecursive=true)
 
virtual void FilterPathsToNodesThatContainText (const FString &InSearch, TArray< TArray< TSharedPtr< FDlgDataDisplayTreeNode > > > &OutNodes)
 
void GetAllNodes (TArray< TSharedPtr< FDlgDataDisplayTreeNode > > &OutNodeArray) const
 
EDlgDataDisplayCategoryTreeNodeType GetCategoryType () const
 
const TArray< TSharedPtr< FDlgDataDisplayTreeNode > > & GetChildren () const
 
FText GetDisplayText () const
 
FName GetDisplayTextAsFName () const
 
TWeakPtr< FDlgDataDisplayTreeNode > GetParent () const
 
virtual TWeakObjectPtr< AActor > GetParentActor () const
 
EDlgDataDisplayTextTreeNodeType GetTextType () const
 
void GetVisibleChildren (TArray< TSharedPtr< FDlgDataDisplayTreeNode > > &OutChildren)
 
bool HasChildren () const
 
bool HasParent () const
 
virtual bool IsCategory () const
 
virtual bool IsEqual (const Self &Other)
 
bool IsLeaf () const
 
bool IsRoot () const
 
virtual bool IsSeparator () const
 
virtual bool IsText () const
 
bool IsVisible () const
 
virtual FReply OnClick ()
 
bool operator== (const Self &Other)
 
virtual void SetChildren (const TArray< TSharedPtr< FDlgDataDisplayTreeNode > > &InChildren)
 
void SetDisplayText (const FText &InText)
 
void SetIsVisible (bool InIsVisible)
 
void SetParent (TWeakPtr< FDlgDataDisplayTreeNode > InParentNode)
 

Protected Member Functions

bool FilterDoesChildContainText (const TSharedPtr< Self > &Child, const FString &InSearch) override
 
bool FilterIsChildVisible (const TSharedPtr< Self > &GrandChild) override
 
virtual void GetPathToChildThatContainsText (const TSharedPtr< FDlgDataDisplayTreeNode > &Child, const FString &InSearch, TArray< TArray< TSharedPtr< FDlgDataDisplayTreeNode > > > &OutNodes)
 
void PostBuildPathToTopMostParent (const TSharedPtr< Self > &CurrentParentNode) override
 
void PostFilterPathsToNodes (const TSharedPtr< Self > &Child) override
 

Protected Attributes

bool bIsVisible
 
EDlgDataDisplayCategoryTreeNodeType CategoryType
 
TArray< TSharedPtr< FDlgDataDisplayTreeNode > > Children
 
FText DisplayText
 
TWeakPtr< FDlgDataDisplayTreeNode > Parent
 
EDlgDataDisplayTextTreeNodeType TextType
 

Private Types

typedef FDlgDataDisplayTreeNode Self
 
typedef FDlgTreeViewNode Super
 

Detailed Description

Definition at line 51 of file DlgDataDisplayTreeNode.h.

Member Typedef Documentation

◆ Self

typedef FDlgDataDisplayTreeNode FDlgDataDisplayTreeNode::Self
private

Definition at line 53 of file DlgDataDisplayTreeNode.h.

◆ Super

typedef FDlgTreeViewNode FDlgDataDisplayTreeNode::Super
private

Definition at line 54 of file DlgDataDisplayTreeNode.h.

Constructor & Destructor Documentation

◆ FDlgDataDisplayTreeNode()

FDlgDataDisplayTreeNode::FDlgDataDisplayTreeNode ( const FText & InDisplayText,
const TSharedPtr< Self > & InParent )

Definition at line 8 of file DlgDataDisplayTreeNode.cpp.

Member Function Documentation

◆ AddChild()

virtual void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::AddChild ( const TSharedPtr< FDlgDataDisplayTreeNode > & ChildNode)
inlinevirtualinherited

Definition at line 57 of file DlgTreeViewNode.h.

◆ ClearChildren()

virtual void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::ClearChildren ( )
inlinevirtualinherited

Definition at line 72 of file DlgTreeViewNode.h.

◆ ClearParent()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::ClearParent ( )
inlineinherited

Definition at line 42 of file DlgTreeViewNode.h.

◆ DoesDisplayTextContains()

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::DoesDisplayTextContains ( const FString & InSearch,
ESearchCase::Type SearchCase = ESearchCase::IgnoreCase )
inlineinherited

Definition at line 33 of file DlgTreeViewNode.h.

◆ ExpandAllChildren()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::ExpandAllChildren ( const TSharedPtr< STreeView< TSharedPtr< FDlgDataDisplayTreeNode > > > & TreeView,
bool bRecursive = true )
inlineinherited

Takes the tree view and expands its elements for each child.

Parameters
TreeViewThe tree responsible for visualizing this node hierarchy.
bRecursiveDetermines if you want children/descendants to expand their children as well.

Definition at line 93 of file DlgTreeViewNode.h.

◆ FilterDoesChildContainText()

bool FDlgDataDisplayTreeNode::FilterDoesChildContainText ( const TSharedPtr< Self > & Child,
const FString & InSearch )
inlineoverrideprotectedvirtual

Called inside GetPathToChildThatContainsText to determine if the child has the text

Reimplemented from FDlgTreeViewNode< FDlgDataDisplayTreeNode >.

Definition at line 104 of file DlgDataDisplayTreeNode.h.

◆ FilterIsChildVisible()

bool FDlgDataDisplayTreeNode::FilterIsChildVisible ( const TSharedPtr< Self > & GrandChild)
inlineoverrideprotectedvirtual

Called inside GetPathToChildThatContainsText after we got the path of the GrandChild

Reimplemented from FDlgTreeViewNode< FDlgDataDisplayTreeNode >.

Definition at line 100 of file DlgDataDisplayTreeNode.h.

◆ FilterPathsToNodesThatContainText()

virtual void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::FilterPathsToNodesThatContainText ( const FString & InSearch,
TArray< TArray< TSharedPtr< FDlgDataDisplayTreeNode > > > & OutNodes )
inlinevirtualinherited

Searches the node so that the OutNodes will only contains paths to nodes that contains the specified string.

Parameters
InSearchThe string to search by
OutNodesArray of arrays, each array inside represents a node path that points to the Node that contains the InSearch

Definition at line 136 of file DlgTreeViewNode.h.

◆ GetAllNodes()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetAllNodes ( TArray< TSharedPtr< FDlgDataDisplayTreeNode > > & OutNodeArray) const
inlineinherited

Recursively collects all child/grandchild/descendant nodes. Aka Flattened tree.

Parameters
OutNodeArrayThe array to fill out with descendant nodes.

Definition at line 122 of file DlgTreeViewNode.h.

◆ GetCategoryType()

EDlgDataDisplayCategoryTreeNodeType FDlgDataDisplayTreeNode::GetCategoryType ( ) const
inline

Definition at line 60 of file DlgDataDisplayTreeNode.h.

◆ GetChildren()

const TArray< TSharedPtr< FDlgDataDisplayTreeNode > > & FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetChildren ( ) const
inlineinherited

Definition at line 46 of file DlgTreeViewNode.h.

◆ GetDisplayText()

FText FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetDisplayText ( ) const
inlineinherited

Definition at line 30 of file DlgTreeViewNode.h.

◆ GetDisplayTextAsFName()

FName FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetDisplayTextAsFName ( ) const
inlineinherited

Definition at line 31 of file DlgTreeViewNode.h.

◆ GetParent()

TWeakPtr< FDlgDataDisplayTreeNode > FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetParent ( ) const
inlineinherited

Definition at line 40 of file DlgTreeViewNode.h.

◆ GetParentActor()

TWeakObjectPtr< AActor > FDlgDataDisplayTreeNode::GetParentActor ( ) const
virtual

Gets the Actor that has this Node belongs to.

Reimplemented in FDlgDataDisplayTreeActorNode.

Definition at line 13 of file DlgDataDisplayTreeNode.cpp.

Here is the caller graph for this function:

◆ GetPathToChildThatContainsText()

virtual void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetPathToChildThatContainsText ( const TSharedPtr< FDlgDataDisplayTreeNode > & Child,
const FString & InSearch,
TArray< TArray< TSharedPtr< FDlgDataDisplayTreeNode > > > & OutNodes )
inlineprotectedvirtualinherited

Definition at line 168 of file DlgTreeViewNode.h.

◆ GetTextType()

EDlgDataDisplayTextTreeNodeType FDlgDataDisplayTreeNode::GetTextType ( ) const
inline

Definition at line 59 of file DlgDataDisplayTreeNode.h.

◆ GetVisibleChildren()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::GetVisibleChildren ( TArray< TSharedPtr< FDlgDataDisplayTreeNode > > & OutChildren)
inlineinherited

Definition at line 47 of file DlgTreeViewNode.h.

◆ HasChildren()

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::HasChildren ( ) const
inlineinherited

Definition at line 45 of file DlgTreeViewNode.h.

◆ HasParent()

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::HasParent ( ) const
inlineinherited

Definition at line 39 of file DlgTreeViewNode.h.

◆ IsCategory()

virtual bool FDlgDataDisplayTreeNode::IsCategory ( ) const
inlinevirtual

Reimplemented in FDlgDataDisplayTreeCategoryNode.

Definition at line 66 of file DlgDataDisplayTreeNode.h.

◆ IsEqual()

virtual bool FDlgDataDisplayTreeNode::IsEqual ( const Self & Other)
inlinevirtual

Is this equal with Other?

Reimplemented in FDlgDataDisplayTreeVariableNode.

Definition at line 70 of file DlgDataDisplayTreeNode.h.

◆ IsLeaf()

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::IsLeaf ( ) const
inlineinherited

Is this the leaf node? Aka no children.

Definition at line 85 of file DlgTreeViewNode.h.

◆ IsRoot()

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::IsRoot ( ) const
inlineinherited

Is this the root node? Aka no parent.

Definition at line 82 of file DlgTreeViewNode.h.

◆ IsSeparator()

virtual bool FDlgDataDisplayTreeNode::IsSeparator ( ) const
inlinevirtual

Definition at line 67 of file DlgDataDisplayTreeNode.h.

◆ IsText()

virtual bool FDlgDataDisplayTreeNode::IsText ( ) const
inlinevirtual

Reimplemented in FDlgDataDisplayTreeCategoryNode.

Definition at line 65 of file DlgDataDisplayTreeNode.h.

◆ IsVisible()

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::IsVisible ( ) const
inlineinherited

Definition at line 78 of file DlgTreeViewNode.h.

◆ OnClick()

virtual FReply FDlgTreeViewNode< FDlgDataDisplayTreeNode >::OnClick ( )
inlinevirtualinherited

Definition at line 18 of file DlgTreeViewNode.h.

◆ operator==()

bool FDlgDataDisplayTreeNode::operator== ( const Self & Other)
inline

Definition at line 78 of file DlgDataDisplayTreeNode.h.

◆ PostBuildPathToTopMostParent()

void FDlgDataDisplayTreeNode::PostBuildPathToTopMostParent ( const TSharedPtr< Self > & CurrentParentNode)
inlineoverrideprotectedvirtual

Called inside GetPathToChildThatContainsText after we advanced one parent in the path

Reimplemented from FDlgTreeViewNode< FDlgDataDisplayTreeNode >.

Definition at line 95 of file DlgDataDisplayTreeNode.h.

◆ PostFilterPathsToNodes()

void FDlgDataDisplayTreeNode::PostFilterPathsToNodes ( const TSharedPtr< Self > & Child)
inlineoverrideprotectedvirtual

Called inside FilterPathsToNodesThatContainText after we got the path for the current Child.

Reimplemented from FDlgTreeViewNode< FDlgDataDisplayTreeNode >.

Definition at line 85 of file DlgDataDisplayTreeNode.h.

◆ SetChildren()

virtual void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::SetChildren ( const TArray< TSharedPtr< FDlgDataDisplayTreeNode > > & InChildren)
inlinevirtualinherited

Definition at line 63 of file DlgTreeViewNode.h.

◆ SetDisplayText()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::SetDisplayText ( const FText & InText)
inlineinherited

Definition at line 32 of file DlgTreeViewNode.h.

◆ SetIsVisible()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::SetIsVisible ( bool InIsVisible)
inlineinherited

Definition at line 79 of file DlgTreeViewNode.h.

◆ SetParent()

void FDlgTreeViewNode< FDlgDataDisplayTreeNode >::SetParent ( TWeakPtr< FDlgDataDisplayTreeNode > InParentNode)
inlineinherited

Definition at line 41 of file DlgTreeViewNode.h.

Member Data Documentation

◆ bIsVisible

bool FDlgTreeViewNode< FDlgDataDisplayTreeNode >::bIsVisible
protectedinherited

Is this node displayed?

Definition at line 226 of file DlgTreeViewNode.h.

◆ CategoryType

EDlgDataDisplayCategoryTreeNodeType FDlgDataDisplayTreeNode::CategoryType
protected

Definition at line 111 of file DlgDataDisplayTreeNode.h.

◆ Children

TArray<TSharedPtr<FDlgDataDisplayTreeNode > > FDlgTreeViewNode< FDlgDataDisplayTreeNode >::Children
protectedinherited

Any children listed under this node.

Definition at line 217 of file DlgTreeViewNode.h.

◆ DisplayText

FText FDlgTreeViewNode< FDlgDataDisplayTreeNode >::DisplayText
protectedinherited

The displayed text for this item.

Definition at line 223 of file DlgTreeViewNode.h.

◆ Parent

TWeakPtr<FDlgDataDisplayTreeNode > FDlgTreeViewNode< FDlgDataDisplayTreeNode >::Parent
protectedinherited

The node that this is a direct child of (empty if this is a root node)

Definition at line 220 of file DlgTreeViewNode.h.

◆ TextType

EDlgDataDisplayTextTreeNodeType FDlgDataDisplayTreeNode::TextType
protected

Definition at line 114 of file DlgDataDisplayTreeNode.h.

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