1. Epic GamesDeveloper
  3. SAssetViewItem

SAssetViewItem

A base class for all asset view items

API > API/Editor > API/Editor/ContentBrowser

Inheritance Hierarchy

References

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

Syntax

class SAssetViewItem : public SCompoundWidget

Remarks

A base class for all asset view items

Variables

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

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Protected function Const void

AddToToolTipInfoBox ( const TSharedRef< SVerticalBox >& InfoBox,
const FText& Key,
const FText& Value,
bool bImportant
)

 Helper function for CreateToolTipWidget. Adds a key value pair to the info box of the tooltip
Protected function void Cache the display tags for this item
Public function void

Construct ( const FArguments& InArgs
)

 Performs common initialization logic for all asset view items
Protected function Const TSharedRef< SWidget > Creates a tooltip widget for this item
Protected function Virtual void Notification for when the dirty flag changes
Protected function Const TSharedRef< SWidget >

GenerateExtraStateIconWidget ( TAttribute< float > InMaxExtraStateIconWidth
)

 Generate a widget to inject extra external state indicator on the asset.
Protected function Const TSharedRef< SWidget > Generate a widget to inject extra external state indicator on the asset tooltip.
Protected function TSharedRef< SWidget > Generates the source control icon widget
Protected function Const FText Gets the name of the class of this asset
Public function Virtual Const FSlateColor Returns the color this item should be tinted with
Protected function Const FText Helper function for CreateToolTipWidget. Gets the user description for the asset, if it exists.
Public function Virtual Const const FSlateBrush * Get the border image to display
Protected function Const const FSlateBrush * Gets the brush for the dirty indicator image
Public function Const FText Get the name text to be displayed for this item
Protected function Virtual Const float Returns the width at which the name label will wrap the name
Protected function Const FText Gets the text for the source control text block in the tooltip
Protected function Const EVisibility Gets the visibility of the source control text block in the tooltip
Protected function Const EVisibility Gets the visibility for the thumbnail edit mode UI
Protected function Virtual void

HandleBeginNameChange ( const FText& OriginalText
)

 Handles starting a name change
Protected function Virtual void

HandleNameCommitted ( const FText& NewText,
ETextCommit::Type CommitInfo
)

 Handles committing a name change
Protected function void Delegate handler for when the source control provider changes
Protected function void Delegate handler for when source control state changes
Protected function Virtual bool

HandleVerifyNameChanged ( const FText& NewText,
FText& OutErrorMessage
)

 Handles verifying a name change
Protected function Const bool

IsDirty ()

 Returns true if the item is dirty.
Protected function Const bool Whether this item is a folder
Protected function Const bool Check to see if the name should be read-only
Protected function Virtual void Handles committing a name change
Public function Virtual FReply

OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent,
const TSharedRef< SWidget >& InParentWidget
)

  
Protected function void Updates the bPackageDirty flag
Protected function void

UpdateSourceControlState ( float InDeltaTime
)

 Update the source control state of this item if required

Overridden from SWidget

  Type Name Description
Public function Virtual TSharedPtr< IToolTip >  
Public function Virtual void

OnDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
Public function Virtual void

OnDragLeave ( const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the drag leaves a widget.
Public function Virtual FReply

OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the the mouse is being dragged over a widget.
Public function Virtual FReply

OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual void Called when a tooltip displayed from this widget is being closed
Public function Virtual bool

OnVisualizeTooltip ( const TSharedPtr< SWidget >& TooltipContent
)

 Called when Slate wants to visualize tooltip.
Public function Virtual 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

On this page