SAssetViewItem

A base class for all asset view items

Unreal Engine C++ API Reference > Editor > ContentBrowser

Inheritance Hierarchy

References

   
Module ContentBrowser
Header /Engine/Source/Editor/ContentBrowser/Public/AssetViewWidgets.h
Include #include "AssetViewWidgets.h"

Syntax

class SAssetViewItem : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)  

Remarks

A base class for all asset view items

Variables

Type Name Description
const FSlateBru... AssetDirtyBrush Cached brushes for the dirty state
TSharedPtr< FAs... AssetItem The data for this item
bool bDraggedOver True when a drag is over this item with a drag operation that we know how to handle.
bool bHasCCStateBrush Whether the item has a valid scc state brush (not empty)
bool bItemDirty Cached flag describing if the item is dirty
bool bSourceControlStateRequested Flag indicating whether we have requested initial source control state
TArray< FTagDis... CachedDisplayTags The cached display tags for this item
TSharedPtr< STe... ClassTextWidget  
TAttribute< FTe... HighlightText The substring to be highlighted in the name and tooltip path
TSharedPtr< SIn... InlineRenameWidget  
FIsSelected IsSelected Delegate for getting the selection state of this item
FGeometry LastGeometry  
FOnAssetToolTip... OnAssetToolTipClosing Called if bound when a tooltip is closing
FOnGetCustomAss... OnGetCustomAssetToolTip Called if bound to get a custom asset item tooltip
FOnIsAssetValid... OnIsAssetValidForCustomToolTip Called to test if it is valid to make a custom tool tip for that asset
FOnItemDestroye... OnItemDestroyed Called when any asset item is destroyed. Used in thumbnail management
FOnRenameBegin OnRenameBegin Delegate for when an asset name has entered a rename state
FOnRenameCommit OnRenameCommit Delegate for when an asset name has been entered for an item that is in a rename state
FOnVerifyRename... OnVerifyRenameCommit Delegate for when an asset name has been entered for an item to verify the name before commit
FOnVisualizeAss... OnVisualizeAssetToolTip Called if bound when about to show a tooltip
TSharedPtr< SLa... SCCStateWidget Widget for the source control state
TAttribute< boo... ShouldAllowToolTip If false, the tooltip will not be displayed
FDelegateHandle SourceControlStateChangedDelegateHandle Delegate handle for the HandleSourceControlStateChanged function callback
float SourceControlStateDelay Delay timer before we request a source control state update, to prevent spam
TAttribute< boo... ThumbnailEditMode If true, display the thumbnail edit mode UI

Destructors

Type Name Description
  ~SAssetViewItem () Virtual destructor

Functions

Type Name Description
void AddToToolTipInfoBox ( const TSharedRef< SVerticalBox >& ..., const FText& Key, const FText& Value, bool bImportant ) Helper function for CreateToolTipWidget. Adds a key value pair to the info box of the tooltip
void CacheDisplayTags () Cache the display tags for this item
void Construct ( const FArguments& InArgs ) Performs common initialization logic for all asset view items
TSharedRef< ... CreateToolTipWidget () Creates a tooltip widget for this item
void DirtyStateChanged () Notification for when the dirty flag changes
TSharedRef< ... GenerateExtraStateIconWidget ( TAttribute< float > InMaxExtraState... ) Generate a widget to inject extra external state indicator on the asset.
TSharedRef< ... GenerateExtraStateTooltipWidget () Generate a widget to inject extra external state indicator on the asset tooltip.
TSharedRef< ... GenerateSourceControlIconWidget () Generates the source control icon widget
FText GetAssetClassText () Gets the name of the class of this asset
FSlateColor GetAssetColor () Returns the color this item should be tinted with
FText GetAssetUserDescription () Helper function for CreateToolTipWidget. Gets the user description for the asset, if it exists.
const FSlate... GetBorderImage () Get the border image to display
const FSlate... GetDirtyImage () Gets the brush for the dirty indicator image
FText GetNameText () Get the name text to be displayed for this item
float GetNameTextWrapWidth () Returns the width at which the name label will wrap the name
FText GetSourceControlText () Gets the text for the source control text block in the tooltip
EVisibility GetSourceControlTextVisibility () Gets the visibility of the source control text block in the tooltip
EVisibility GetThumbnailEditModeUIVisibility () Gets the visibility for the thumbnail edit mode UI
void HandleBeginNameChange ( const FText& OriginalText ) Handles starting a name change
void HandleNameCommitted ( const FText& NewText, ETextCommit::Type CommitInfo ) Handles committing a name change
void HandleSourceControlProviderChanged ( ISourceControlProvider& OldProvide..., ISourceControlProvider& NewProvide... ) Delegate handler for when the source control provider changes
void HandleSourceControlStateChanged () Delegate handler for when source control state changes
bool HandleVerifyNameChanged ( const FText& NewText, FText& OutErrorMessage ) Handles verifying a name change
bool IsDirty () Returns true if the item is dirty.
bool IsFolder () Whether this item is a folder
bool IsNameReadOnly () Check to see if the name should be read-only
void OnAssetDataChanged () Handles committing a name change
FReply OnDrop ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven..., const TSharedRef< SWidget >& InPar... )  
void UpdateDirtyState () Updates the bPackageDirty flag
void UpdateSourceControlState ( float InDeltaTime ) Update the source control state of this item if required

Overridden from SWidget

Type Name Description
TSharedPtr< ... GetToolTip ()  
void OnDragEnter ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... ) DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
void OnDragLeave ( const FDragDropEvent& DragDropEven... ) Called during drag and drop when the drag leaves a widget.
FReply OnDragOver ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... ) Called during drag and drop when the the mouse is being dragged over a widget.
FReply OnDrop ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... ) Called when the user is dropping something onto a widget; terminates drag and drop.
void OnToolTipClosing () Called when a tooltip displayed from this widget is being closed
bool OnVisualizeTooltip ( const TSharedPtr< SWidget >& Toolt... ) Called when Slate wants to visualize tooltip.
void Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) NOTE: Any functions overridden from the base widget classes must also be overridden by SAssetColumnViewRow and forwarded on to its internal item

Classes

Type Name Description
Public struct FArguments  
Protected struct FTagDisplayItem Data for a cached display tag for this item (used in the tooltip, and also as the display string in column views)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library