1. Epic GamesDeveloper
  3. SImageCatalog

SImageCatalog

Generic catalog widget for listing and interacting with 2D image-like content.

API > API/Plugins > API/Plugins/ImageWidgets

Generic catalog widget for listing and interacting with 2D image-like content. Each catalog item is represented by its own widget based on its

   
Name SImageCatalog
Type class
Header File /Engine/Plugins/Experimental/ImageWidgets/Source/ImageWidgets/Public/SImageCatalog.h
Include Path #include "SImageCatalog.h"

Syntax

class SImageCatalog : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FOnGetGroupContextMenu TBaseDelegate_OneParam< TSharedPtr< SWidget >, FName > Delegate that gets called for creating a context menu for a group. Return SImageCatalog.h
FOnGetItemsContextMenu TBaseDelegate_OneParam< TSharedPtr< SWidget >, const TArray< FGuid > & > Delegate that gets called for creating a context menu for a set of selected items. Return SImageCatalog.h
FOnItemSelected TBaseDelegate_OneParam< void, const FGuid & > Delegate that gets called when an item is selected in the catalog. The given SImageCatalog.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Impl TPimplPtr< class FImpl >   SImageCatalog.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddGroup ( FName Name,
const FText& Heading
)

 Add a custom group to the catalog. SImageCatalog.h  

bool AddGroup ( FName Name,
const FText& Heading,
FName BeforeGroupWithThisName
)

 Add a custom group to the catalog before an already existing group. SImageCatalog.h  

bool AddItem ( const TSharedPtr< FImageCatalogItemData >& Item,
FName Group,
const FGuid& BeforeItemWithThisGuid
)

 Add an item to an existing group right before an existing item. SImageCatalog.h  

bool AddItem ( const TSharedPtr< FImageCatalogItemData >& Item,
FName Group
)

 Add an item to an existing group. SImageCatalog.h  

bool AddItem ( const TSharedPtr< FImageCatalogItemData >& Item,
const FGuid& BeforeItemWithThisGuid
)

 Add an item to the default group right before an existing item. SImageCatalog.h  

bool AddItem ( const TSharedPtr< FImageCatalogItemData >& Item
)

 Add an item to the default group. SImageCatalog.h  

bool ClearSelection ( FName Group
)

 Clear the selection for a given group; selections in other groups will be unchanged. SImageCatalog.h  

void ClearSelection ()

 Clear any selection in the catalog, i.e. across all groups. SImageCatalog.h  

void Construct ( const FArguments& Args
)

 Function used by Slate to construct the image catalog widget with the given arguments. SImageCatalog.h  

bool DeselectItem ( const FGuid& Guid
)

 Deselect an existing item. SImageCatalog.h  

FName GetDefaultGroupName()

   SImageCatalog.h  

TOptional< FName > GetGroupNameAt ( int32 Index
) const

 Return the name of the group at a given position. SImageCatalog.h  

TSharedPtr< const FImageCatalogItemData > GetItem ( const FGuid& Guid
) const

 Retrieve the existing item for a given unique identifier. SImageCatalog.h  

TSharedPtr< const FImageCatalogItemData > GetItemAt ( int32 Index,
FName Group
) const

 Retrieve the existing item within a given group for a given index. SImageCatalog.h  

TSharedPtr< const FImageCatalogItemData > GetItemAt ( int32 Index
) const

 Retrieve the existing item for a given index within the default group. SImageCatalog.h  

TOptional< FName > GetItemGroupName ( const FGuid& Guid
) const

 Return the group an existing item belongs to. SImageCatalog.h  

TOptional< TTuple< FName, int32 > > GetItemGroupNameAndIndex ( const FGuid& Guid
) const

 Return an existing item's group and the index within that group. SImageCatalog.h  

TOptional< FGuid > GetItemGuidAt ( int32 Index,
FName Group
) const

 Retrieve the unique identifier of an existing item at the given index within the given group. SImageCatalog.h  

TOptional< FGuid > GetItemGuidAt ( int32 Index
) const

 Retrieve the unique identifier of an existing item at the given index within the default group. SImageCatalog.h  

TOptional< int32 > GetItemIndex ( const FGuid& Guid
) const

 Return the index of an existing item within the group it belongs to. SImageCatalog.h  

bool MoveItem ( const FGuid& Guid,
const FGuid& BeforeItemWithThisGuid
)

 Move an already existing item before another item within the same group. SImageCatalog.h  

bool MoveItem ( const FGuid& Guid,
FName Group,
const FGuid& BeforeItemWithThisGuid
)

 Move an already existing item to another group, before another item within that group. SImageCatalog.h  

bool MoveItem ( const FGuid& Guid,
FName Group
)

 Move an already existing item to another group. SImageCatalog.h  

int32 NumGroups()

 Return the number of groups in the catalog including the default group. SImageCatalog.h  

int32 NumItems ()

 Return the total number of items in the catalog. SImageCatalog.h  

int32 NumItems ( FName Group
) const

 Return the number of items in a group. SImageCatalog.h  

TOptional< TArray< FGuid > > RemoveGroup ( FName Name,
FName GroupToMoveItemsInto
)

 Remove an existing group, and moves any items in the group into another group. SImageCatalog.h  
Remove an existing group and any items in the group. SImageCatalog.h  

bool RemoveItem ( const FGuid& Guid
)

 Remove an existing item. SImageCatalog.h  

bool SelectItem ( const FGuid& Guid
)

 Select an existing item. SImageCatalog.h  

bool SetGroupHeading ( FName Name,
const FText& Heading
)

 Set the header text for an existing group. SImageCatalog.h  

bool UpdateItem ( const FImageCatalogItemData& Item
)

 Update an existing item's data. The item data needs to contain the item's unique identifier. SImageCatalog.h  

bool UpdateItemInfo ( const FGuid& Guid,
const FText& Info
)

 Update the info text of an existing item. SImageCatalog.h  

bool UpdateItemName ( const FGuid& Guid,
const FText& Name
)

 Update the info text of an existing item. SImageCatalog.h  

bool UpdateItemThumbnail ( const FGuid& Guid,
const FSlateBrush& Thumbnail
)

 Update the thumbnail of an existing item. SImageCatalog.h  

bool UpdateItemToolTip ( const FGuid& Guid,
const FText& ToolTip
)

 Update the tooltip text of an existing item. SImageCatalog.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page