UCommonTileView Class Reference

TileView specialized to navigate on focus for consoles & enable scrolling when not focused for touch. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UTileView
static UClass	StaticClass ()
Static Public Member Functions inherited from UListView
static UClass	StaticClass ()
Static Public Member Functions inherited from UListViewBase
static UClass	StaticClass ()
Static Public Member Functions inherited from UWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Additional Inherited Members
Public Member Functions inherited from UTileView
float32	GetEntryWidth () const
	Gets the width of tile entries.
void	SetEntryHeight (float32 NewHeight)
	Sets the height of every tile entry.
void	SetEntryWidth (float32 NewWidth)
	Sets the width of every tile entry.
float32	GetEntryHeight () const
	Gets the height of tile entries.
Public Member Functions inherited from UListView
const ESelectionMode &	GetSelectionMode () const
void	SetHorizontalEntrySpacing (const float32 &Value)
void	SetVerticalEntrySpacing (const float32 &Value)
float32	GetEntrySpacing () const
	This deprecated property was originally BlueprintReadOnly. To satisfy the compiler requirment to have a BlueprintGetter for this property, it relies on the newly added UFunction GetHorizontalEntrySpacing() to act as its BlueprintGetter.
UObject	GetItemAt (int Index) const
	Returns the item at the given index.
void	CancelScrollIntoView ()
	Cancels a previous request to scroll and item into view.
void	ClearSelection ()
	Clear selection.
int	GetNumItemsSelected () const
	Gets the number of items currently selected in the list.
UObject	GetSelectedItem () const
	Gets the first selected item, if any; recommended that you only use this for single selection lists.
bool	GetSelectedItems (TArray< UObject > &Items) const
	Gets a list of all the currently selected items.
bool	IsItemVisible (UObject Item) const
	Gets whether the entry for the given object is currently visible in the list.
void	NavigateToItem (UObject Item)
	Requests that the given item is navigated to, scrolling it into view if needed.
void	ScrollItemIntoView (UObject Item)
	Requests that the given item is scrolled into view.
void	SetItemSelection (UObject Item, bool bSelected)
	Sets whether the given item is selected.
void	SetListItems (TArray< UObject > InListItems)
	Sets the array of objects to display rows for in the list.
void	SetSelectedItem (UObject Item)
	Sets the given item as the sole selected item.
void	ClearListItems ()
	Removes all items from the list.
float32	GetHorizontalEntrySpacing () const
	Get the horizontal spacing between entries.
int	GetIndexForItem (const UObject Item) const
	Returns the index that the specified item is at. Will return the first found, or -1 for not found.
void	AddItem (UObject Item)
	Adds an the item to the list.
const TArray< UObject > &	GetListItems () const
	Gets the list of all items in the list. Note that each of these items only has a corresponding entry widget when visible. Use GetDisplayedEntryWidgets to get the currently displayed widgets.
int	GetNumItems () const
	Returns the total number of items.
float32	GetVerticalEntrySpacing () const
	Get the vertical spacing between entries.
bool	IsRefreshPending () const
	Returns true if a refresh is pending and the list will be rebuilt on the next tick.
void	NavigateToIndex (int Index)
	Requests that the item at the given index navigated to, scrolling it into view if needed.
void	RemoveItem (UObject Item)
	Removes an the item from the list.
void	ScrollIndexIntoView (int Index)
	Requests that the item at the given index is scrolled into view.
void	SetSelectedIndex (int Index)
	Sets the item at the given index as the sole selected item.
void	SetSelectionMode (ESelectionMode SelectionMode)
	Sets the new selection mode, preserving the current selection where possible.
Public Member Functions inherited from UListViewBase
void	SetScrollOffset (float32 InScrollOffset)
	Set the scroll offset of this view (in items).
const float32 &	GetWheelScrollMultiplier () const
	The multiplier to apply when wheel scrolling.
void	RegenerateAllEntries ()
	Full regeneration of all entries in the list. Note that the entry UWidget instances will not be destroyed, but they will be released and re-generated. In other words, entry widgets will not receive Destruct/Construct events. They will receive OnEntryReleased and IUserObjectListEntry implementations will receive OnListItemObjectSet.
void	RequestRefresh ()
	Sets the list to refresh on the next tick.
void	ScrollToBottom ()
	Scroll the entire list down to the bottom-most item.
void	ScrollToTop ()
	Scroll the entire list up to the first item.
const TArray< UUserWidget > &	GetDisplayedEntryWidgets () const
	Gets all of the list entry widgets currently being displayed by the list.
void	SetScrollbarVisibility (ESlateVisibility InVisibility)
float32	GetScrollOffset () const
	Get the scroll offset of this view (in items).
void	SetIsPointerScrollingEnabled (bool bInIsPointerScrollingEnabled)
	Enable/Disable the ability of the list to scroll. This should be use as a temporary disable.
void	SetWheelScrollMultiplier (float32 NewWheelScrollMultiplier)
Public Member Functions inherited from UWidget
bool	IsInViewport () const
void	RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void	AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	SetbOverride_Cursor (bool Value)
void	SetToolTipWidget (UWidget Widget)
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	GetbIsEnabled () const
	Sets whether this widget can be modified interactively by the user.
void	SetbIsEnabled (bool bInIsEnabled)
	Sets whether this widget can be modified interactively by the user.
const FWidgetTransform &	GetRenderTransform ()
const FText &	GetToolTipText () const
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	GetToolTipWidget () const
	Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D &	GetRenderTransformPivot () const
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
void	GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void	SetbOverrideAccessibleDefaults (bool Value)
	Override all of the default accessibility behavior and text for this widget.
void	SetbCanChildrenBeAccessible (bool Value)
	Whether or not children of this widget can appear as distinct accessible widgets.
void	SetAccessibleText (FText Value)
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void	SetAccessibleSummaryText (FText Value)
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool	GetbIsVolatile () const
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
void	SetbIsVolatile (bool Value)
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
const EMouseCursor &	GetCursor () const
	The cursor to show when the mouse is over the widget.
const FGeometry &	GetCachedGeometry () const
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
EWidgetClipping	GetClipping () const
	Gets the clipping state of this widget.
FVector2D	GetDesiredSize () const
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
FText	GetAccessibleText () const
	Gets the accessible text from the underlying Slate accessible widget.
FText	GetAccessibleSummaryText () const
	Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance	GetGameInstance () const
	Gets the game instance associated with this UI.
ULocalPlayer	GetOwningLocalPlayer () const
	Gets the local player associated with this UI.
APlayerController	GetOwningPlayer () const
	Gets the player controller associated with this UI.
const FGeometry &	GetPaintSpaceGeometry () const
UPanelWidget	GetParent () const
	Gets the parent widget.
float32	GetRenderOpacity () const
	Gets the current visibility of the widget.
bool	GetIsEnabled () const
	Gets the current enabled status of the widget.
void	ForceVolatile (bool bForce)
	Sets the forced volatility of the widget.
ESlateVisibility	GetVisibility () const
	Gets the current visibility of the widget.
bool	HasAnyUserFocus () const
	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants () const
	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus () const
	Checks to see if this widget currently has the keyboard focus.
bool	HasMouseCapture () const
	Checks to see if this widget is the current mouse captor.
bool	HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
	Checks to see if this widget is the current mouse captor.
bool	HasUserFocus (APlayerController PlayerController) const
	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants (APlayerController PlayerController) const
	Returns true if any descendant widget is focused by a specific user.
void	InvalidateLayoutAndVolatility ()
	Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.
bool	IsHovered () const
	Returns true if the widget is currently being hovered by a pointer device.
void	ForceLayoutPrepass ()
	Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.
bool	IsRendered () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry &	GetTickSpaceGeometry () const
void	SetClipping (EWidgetClipping InClipping)
	Sets the clipping state of this widget.
void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.
void	RemoveFromParent ()
	Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.
void	ResetCursor ()
	Resets the cursor to use on the widget, removing any customization for it.
void	SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
	Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.
void	SetVisibility (ESlateVisibility InVisibility)
	Sets the visibility of the widget.
void	SetCursor (EMouseCursor InCursor)
	Sets the cursor to show over the widget.
void	SetFocus ()
	Sets the focus to this widget for the owning user.
void	SetIsEnabled (bool bInIsEnabled)
	Sets the current enabled status of the widget.
void	SetKeyboardFocus ()
	Sets the focus to this widget.
void	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void	SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.
void	SetUserFocus (APlayerController PlayerController)
	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.
void	SetNavigationRuleExplicit (EUINavigation Direction, UWidget InWidget)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.
void	SetRenderOpacity (float32 InOpacity)
	Sets the visibility of the widget.
void	SetToolTip (UWidget Widget)
	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText (FText InToolTipText)
	Sets the tooltip text for the widget.
void	SetRenderTransformAngle (float32 Angle)
void	SetRenderTransformPivot (FVector2D Pivot)
float32	GetRenderTransformAngle () const
void	SetRenderTransform (FWidgetTransform InTransform)
void	SetRenderShear (FVector2D Shear)
void	SetRenderScale (FVector2D Scale)
void	SetRenderTranslation (FVector2D Translation)
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const
Public Attributes inherited from UTileView
float32	EntryWidth
	The width of each tile.
float32	EntryHeight
	The height of each tile.
bool	bEntrySizeIncludesEntrySpacing
	True if entry dimensions should be the sum of the entry widget dimensions and the spacing. This means the size of the entry widget will be adjusted so that the summation of the widget size and entry spacing always equals entry size.
EListItemAlignment	TileAlignment
	The method by which to align the tile entries in the available space for the tile view.
ESlateVisibility	ScrollbarDisabledVisibility
	Set the visibility of the Scrollbar when it's not needed.
bool	bWrapHorizontalNavigation
	True to allow left/right navigation to wrap back to the tile on the opposite edge.
Public Attributes inherited from UListView
FOnListItemSelectionChangedDynamic	BP_OnItemSelectionChanged
FOnListEntryInitializedDynamic	BP_OnEntryInitialized
	Called when a row widget is generated for a list item.
FOnListViewScrolledDynamic	BP_OnListViewScrolled
FSimpleListItemEventDynamic	BP_OnItemClicked
FOnItemIsHoveredChangedDynamic	BP_OnItemIsHoveredChanged
FOnListItemScrolledIntoViewDynamic	BP_OnItemScrolledIntoView
FSimpleListItemEventDynamic	BP_OnItemDoubleClicked
TArray< UObject >	ListItems
UObject	SelectedItem
const int	NumItemsSelected
EOrientation	Orientation
	The scroll & layout orientation of the list. ListView and TileView only. Vertical will scroll vertically and arrange tiles into rows. Horizontal will scroll horizontally and arrange tiles into columns.
bool	bClearSelectionOnClick
bool	bIsFocusable
FScrollBarStyle	ScrollBarStyle
bool	bReturnFocusToSelection
EConsumeMouseWheel	ConsumeMouseWheel
FTableViewStyle	WidgetStyle
const float32	EntrySpacing
	This deprecated property was originally BlueprintReadOnly. To satisfy the compiler requirment to have a BlueprintGetter for this property, it relies on the newly added UFunction GetHorizontalEntrySpacing() to act as its BlueprintGetter.
float32	HorizontalEntrySpacing
float32	VerticalEntrySpacing
const int	NumItems
	Returns the total number of items.
ESelectionMode	SelectionMode
Public Attributes inherited from UListViewBase
FOnListEntryReleasedDynamic	BP_OnEntryReleased
	Called when a row widget is released by the list (i.e. when it no longer represents a list item).
FOnListEntryGeneratedDynamic	BP_OnEntryGenerated
	Called when a row widget is generated for a list item.
bool	bAllowDragging
	True to allow dragging of row widgets in the list.
TSubclassOf< UUserWidget >	EntryWidgetClass
	The type of widget to create for each entry displayed in the list.
int	NumDesignerPreviewEntries
	The number of dummy item entry widgets to preview in the widget designer.
bool	AllowOverscroll
	Disable to stop scrollbars from activating inertial overscrolling.
float32	FixedLineScrollOffset
	Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list. If provided, all non-inertial means of scrolling will settle with exactly this offset of the topmost entry. Ex: A value of 0.25 would cause the topmost full entry to be offset down by a quarter length of the preceeding entry.
bool	bInEnableTouchAnimatedScrolling
	True to enable lerped animation when scrolling through the list with touch.
bool	bEnableScrollAnimation
	True to enable lerped animation when scrolling through the list.
bool	bEnableRightClickScrolling
	True to allow right click drag scrolling.
bool	bEnableTouchScrolling
	True to allow scrolling using touch input.
bool	bIsPointerScrollingEnabled
	Enable/Disable scrolling using Touch or Mouse.
bool	bEnableFixedLineOffset
float32	WheelScrollMultiplier
	The multiplier to apply when wheel scrolling.
const TArray< UUserWidget >	DisplayedEntryWidgets
	Gets all of the list entry widgets currently being displayed by the list.
float32	ScrollOffset
	Get the scroll offset of this view (in items).
Public Attributes inherited from UWidget
FText	AccessibleSummaryText
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText	AccessibleText
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior	AccessibleBehavior
	Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior	AccessibleSummaryBehavior
	How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
EMouseCursor	Cursor
	The cursor to show when the mouse is over the widget.
FText	ToolTipText
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	ToolTipWidget
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	bIsEnabled
	Sets whether this widget can be modified interactively by the user.
ESlateVisibility	Visibility
	The visibility of the widget.
UPanelSlot	Slot
	The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
EFlowDirectionPreference	FlowDirectionPreference
	Allows you to set a new flow direction.
UWidgetNavigation	Navigation
	The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
bool	bIsVolatile
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
FVector2D	RenderTransformPivot
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
FWidgetTransform	RenderTransform
	The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
EWidgetPixelSnapping	PixelSnapping
	If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping	Clipping
	Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
float32	RenderOpacity
	The opacity of the widget.
const FGeometry	CachedGeometry
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
const FGeometry	PaintSpaceGeometry
const UGameInstance	GameInstance
	Gets the game instance associated with this UI.
const UPanelWidget	Parent
	Gets the parent widget.
const FVector2D	DesiredSize
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
const FGeometry	TickSpaceGeometry
bool	IsEnabled
	Gets the current enabled status of the widget.
const ULocalPlayer	OwningLocalPlayer
	Gets the local player associated with this UI.
const APlayerController	OwningPlayer
	Gets the player controller associated with this UI.
float32	RenderTransformAngle
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

TileView specialized to navigate on focus for consoles & enable scrolling when not focused for touch.

Member Function Documentation

StaticClass()

UClass StaticClass ( )

static