IUserListEntry Class Reference

#include <IUserListEntry.h>

Inheritance diagram for IUserListEntry:

Public Member Functions
UMG_API bool	IsListItemSelected () const
UMG_API bool	IsListItemExpanded () const
UMG_API UListViewBase *	GetOwningListView () const
virtual bool	IsListItemSelectable () const

Static Public Member Functions
static UMG_API void	ReleaseEntry (UUserWidget &ListEntryWidget)
static UMG_API void	UpdateItemSelection (UUserWidget &ListEntryWidget, bool bIsSelected)
static UMG_API void	UpdateItemExpansion (UUserWidget &ListEntryWidget, bool bIsExpanded)
static UMG_API void	UpdateEntryDropIndicator (UUserWidget &ListEntryWidget, TOptional< EItemDropZone > DropZone)
static UMG_API void	UpdateEntryDragOverState (UUserWidget &ListEntryWidget, bool bIsDraggingOver)
static UMG_API void	EndEntryDropOperation (UUserWidget &ListEntryWidget, bool bSuccess)
static UMG_API void	HandleEntryDropped (UUserWidget &ListEntryWidget, UDragDropOperation *Operation)
static UMG_API void	HandleEntryDragged (UUserWidget &ListEntryWidget, UDragDropOperation *Operation)

Protected Member Functions
virtual UMG_API void	NativeOnItemSelectionChanged (bool bIsSelected)
virtual UMG_API void	NativeOnItemExpansionChanged (bool bIsExpanded)
virtual UMG_API void	NativeOnEntryReleased ()
UMG_API void	BP_OnItemSelectionChanged (bool bIsSelected)
UMG_API void	BP_OnItemExpansionChanged (bool bIsExpanded)
UMG_API void	BP_OnEntryReleased ()
UMG_API void	BP_OnUpdateEntryDropIndicator (EUMGItemDropZone DropZone)
UMG_API void	BP_OnEntryDragOverChanged (bool bIsDraggingOver)
UMG_API void	BP_OnEndEntryDropOperation (bool bSuccess)
UMG_API void	BP_OnEntryDropped (UDragDropOperation *Operation)
UMG_API void	BP_OnEntryDragged (UDragDropOperation *Operation)

Member Function Documentation

BP_OnEndEntryDropOperation()

UMG_API void IUserListEntry::BP_OnEndEntryDropOperation ( bool  bSuccess )

protected

Called when this entry accepts a drag and drop operation

BP_OnEntryDragged()

UMG_API void IUserListEntry::BP_OnEntryDragged ( UDragDropOperation *  Operation )

protected

Called when this entry is dragged

BP_OnEntryDragOverChanged()

UMG_API void IUserListEntry::BP_OnEntryDragOverChanged ( bool  bIsDraggingOver )

protected

Called when the the entry is dragged over

BP_OnEntryDropped()

UMG_API void IUserListEntry::BP_OnEntryDropped ( UDragDropOperation *  Operation )

protected

Called when this entry is dropped

BP_OnEntryReleased()

UMG_API void IUserListEntry::BP_OnEntryReleased ( )

protected

Called when this entry is released from the owning table and no longer represents any list item

BP_OnItemExpansionChanged()

UMG_API void IUserListEntry::BP_OnItemExpansionChanged ( bool  bIsExpanded )

protected

Called when the expansion state of the item represented by this entry changes. Tree view entries only.

BP_OnItemSelectionChanged()

UMG_API void IUserListEntry::BP_OnItemSelectionChanged ( bool  bIsSelected )

protected

Called when the selection state of the item represented by this entry changes.

BP_OnUpdateEntryDropIndicator()

UMG_API void IUserListEntry::BP_OnUpdateEntryDropIndicator ( EUMGItemDropZone  DropZone )

protected

Called when the drop zone indicator is changed for this entry

EndEntryDropOperation()

UMG_API void IUserListEntry::EndEntryDropOperation ( UUserWidget &  ListEntryWidget, bool  bSuccess  )

static

GetOwningListView()

UListViewBase * IUserListEntry::GetOwningListView

(

)

const

Returns the list view that contains this entry.

HandleEntryDragged()

UMG_API void IUserListEntry::HandleEntryDragged ( UUserWidget &  ListEntryWidget, UDragDropOperation *  Operation  )

static

HandleEntryDropped()

UMG_API void IUserListEntry::HandleEntryDropped ( UUserWidget &  ListEntryWidget, UDragDropOperation *  Operation  )

static

IsListItemExpanded()

bool IUserListEntry::IsListItemExpanded

(

)

const

Returns true if the item represented by this entry is currently expanded and showing its children. Tree view entries only.

IsListItemSelectable()

virtual bool IUserListEntry::IsListItemSelectable ( ) const

inlinevirtual

Advanced native-only option for specific rows to preclude themselves from any kind of selection. Intended primarily for category separators and the like. Note that this is only relevant when the row is in a list that allows selection in the first place.

IsListItemSelected()

bool IUserListEntry::IsListItemSelected

(

)

const

Returns true if the item represented by this entry is currently selected in the owning list view.

NativeOnEntryReleased()

void IUserListEntry::NativeOnEntryReleased ( )

protectedvirtual

NativeOnItemExpansionChanged()

void IUserListEntry::NativeOnItemExpansionChanged ( bool  bIsExpanded )

protectedvirtual

NativeOnItemSelectionChanged()

void IUserListEntry::NativeOnItemSelectionChanged ( bool  bIsSelected )

protectedvirtual

These follow the same pattern as the NativeOn[X] methods in UUserWidget - super calls are expected in order to route the event to BP. See the BP events below for descriptions.

ReleaseEntry()

void IUserListEntry::ReleaseEntry ( UUserWidget &  ListEntryWidget )

static

Functionality largely for "internal" use/plumbing - see SObjectTableRow's usage. You shouldn't have any cause to call these directly.

UpdateEntryDragOverState()

UMG_API void IUserListEntry::UpdateEntryDragOverState ( UUserWidget &  ListEntryWidget, bool  bIsDraggingOver  )

static

UpdateEntryDropIndicator()

UMG_API void IUserListEntry::UpdateEntryDropIndicator ( UUserWidget &  ListEntryWidget, TOptional< EItemDropZone >  DropZone  )

static

UpdateItemExpansion()

void IUserListEntry::UpdateItemExpansion ( UUserWidget &  ListEntryWidget, bool  bIsExpanded  )

static

UpdateItemSelection()

void IUserListEntry::UpdateItemSelection ( UUserWidget &  ListEntryWidget, bool  bIsSelected  )

static

---

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

• Engine/Source/Runtime/UMG/Public/Blueprint/IUserListEntry.h
• Engine/Source/Runtime/UMG/Private/Blueprint/IUserListEntry.cpp