className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
SDockTab::GetTabLabelSuffix
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Get Label Suffix
Slate
[FText](API\Runtime\Core\Internationalization\FText) GetTabLabelSuffix() const
[]
SDockTab::GetTabManagerPtr
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Get the tab manager currently managing this tab. Note that a user move the tab between Tab Managers, so this return value may change.
Slate
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTabManager](API\Runtime\Slate\Framework\Docking\FTabManager) > GetTabManagerPtr() const
[]
SDockTab::GetTabPadding
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
the padding for the tab widget
Slate
[FMargin](API\Runtime\SlateCore\Layout\FMargin) GetTabPadding() const
[]
SDockTab::GetTabRole
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Is this an MajorTab? A tool panel tab?
Slate
ETabRole GetTabRole() const
[]
SDockTab::GetTabWellBrush
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Depending on the tabs we put into the tab well, we want a different background brush.
Slate
const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetTabWellBrush() const
[]
SDockTab::GetTitleBarRightContent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetTitleBarRightContent()
[]
SDockTab::GetVisualTabRole
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Similar toGetTabRole()but returns the correct role for UI style and user input purposes
Slate
ETabRole GetVisualTabRole() const
[]
SDockTab::HandleIsCloseButtonVisible
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
if the close button should be visible.
Slate
[EVisibility](API\Runtime\SlateCore\Layout\EVisibility) HandleIsCloseButtonVisible() const
[]
SDockTab::IsActive
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
True if this tab is currently focused
Slate
bool IsActive() const
[]
SDockTab::HasSiblingTab
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Check to see whether this tab has a sibling tab with the given tab ID
Slate
bool HasSiblingTab ( const [FTabId](API\Runtime\Slate\Framework\Docking\FTabId) & SiblingTabId, const bool TreatIndexNoneAsWildcard ) const
[]
SDockTab::IsForeground
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
True if this tab appears active; False otherwise
Slate
bool IsForeground() const
[]
SDockTab::OnDragDetected
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called when Slate detects that a widget started to be dragged. Usage: A widget can ask Slate to detect a drag. OnMouseDown() reply withFReply::Handled().DetectDrag( SharedThis(this) ). Slate will either send anOnDragDetected()event or do nothing. If the user releases a mouse button or leaves the widget before a drag is triggered (maybe user started at the very edge) then no event will be sent.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SDockTab::OnCloseButtonClicked
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called when the close button is clicked on the tab.
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) OnCloseButtonClicked()
[]
SDockTab::OnDragEnter
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
The concession is to return a can_handled/cannot_handle boolean rather than a fullFReply. A reply that indicated whether the contents of the DragDropEvent can potentially be processed by this widget.
Slate
virtual void OnDragEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )
[]
SDockTab::OnDragLeave
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called during drag and drop when the drag leaves a widget.
Slate
virtual void OnDragLeave ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )
[]
SDockTab::OnDrop
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called when the user is dropping something onto a widget; terminates drag and drop. A reply that indicated whether this event was handled.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )
[]
SDockTab::OnMouseButtonDoubleClick
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called when a mouse button is double clicked. Override this in derived classes. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )
[]
SDockTab::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SDockTab::OnMouseButtonUp
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SDockTab::OnTouchEnded
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called when a touchpad touch is ended (finger lifted)
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchEnded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )
[]
SDockTab::OnTouchStarted
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Called when a touchpad touch is started (finger down)
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchStarted ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )
[]
SDockTab::PersistVisualState
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
A chance for the tab's content to save any internal layout info
Slate
void PersistVisualState()
[]
SDockTab::PlaySpawnAnim
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Play an animation showing this tab as opening
Slate
void PlaySpawnAnim()
[]
SDockTab::ProvideDefaultIcon
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Provide a default tab icon.
Slate
void ProvideDefaultIcon ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * InDefaultIcon )
[]
SDockTab::ProvideDefaultLabel
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Provide a default tab label in case the spawner did not set one.
Slate
void ProvideDefaultLabel ( const [FText](API\Runtime\Core\Internationalization\FText) & InDefaultLabel )
[]
SDockTab::RemoveTabFromParent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Pulls this tab out of it's parent tab stack and destroys it Note: This does not check if its safe to remove the tab. Use RequestCloseTab to do this safely.
Slate
void RemoveTabFromParent()
[]
SDockTab::RequestCloseTab
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Requests that the tab be closed. Tabs may prevent closing depending on their state
Slate
bool RequestCloseTab()
[]
SDockTab::SetCanCloseTab
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler to be invoked when the user requests that this tab be closed.
Slate
void SetCanCloseTab ( const [FCanCloseTab](API\Runtime\Slate\Widgets\Docking\SDockTab\FCanCloseTab) & InOnTabClosing )
[]
SDockTab::SetContent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Sets the content for this border
Slate
virtual void SetContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )
[]
SDockTab::SetDraggedOverDockArea
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Used by the drag/drop operation to signal to this tab what it is dragging over.
Slate
void SetDraggedOverDockArea ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SDockingArea > & Area )
[]
SDockTab::SetLabel
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
The label that appears on the tab.
Slate
void SetLabel ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InTabLabel )
[]
SDockTab::SetLayoutIdentifier
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Specify the TabId that was used to spawn this tab.
Slate
void SetLayoutIdentifier ( const [FTabId](API\Runtime\Slate\Framework\Docking\FTabId) & TabId )
[]
SDockTab::SetLeftContent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Content that appears in the TabWell to the left of the tabs
Slate
void SetLeftContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )
[]
SDockTab::SetOnExtendContextMenu
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler for extending the tab context menu
Slate
void SetOnExtendContextMenu ( const [FExtendContextMenu](API\Runtime\Slate\Widgets\Docking\SDockTab\FExtendContextMenu) & Handler )
[]
SDockTab::SetOnPersistVisualState
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the custom code to execute for saving visual state in this tab. e.g. ContentBrowser saves the visible filters.OnExtendContextMenu
Slate
void SetOnPersistVisualState ( const [FOnPersistVisualState](API\Runtime\Slate\Widgets\Docking\SDockTab\FOnPersistVisualState) & Handler )
[]
SDockTab::SetOnTabActivated
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is activated
Slate
void SetOnTabActivated ( const [FOnTabActivatedCallback](API\Runtime\Slate\Widgets\Docking\SDockTab\FOnTabActivatedCallback) & InDelegate )
[]
SDockTab::SetOnTabClosed
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is closed
Slate
void SetOnTabClosed ( const [FOnTabClosedCallback](API\Runtime\Slate\Widgets\Docking\SDockTab\FOnTabClosedCallback) & InDelegate )
[]
SDockTab::SetOnTabDraggedOverDockArea
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is dragged over dock area
Slate
void SetOnTabDraggedOverDockArea ( const FSimpleDelegate InDelegate )
[]
SDockTab::SetOnTabDrawerClosed
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is closed from a drawer
Slate
void SetOnTabDrawerClosed ( const FSimpleDelegate InDelegate )
[]
SDockTab::SetOnTabDrawerOpened
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is opened from a drawer
Slate
void SetOnTabDrawerOpened ( const FSimpleDelegate InDelegate )
[]
SDockTab::SetOnTabRelocated
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is relocated to a new tab well
Slate
void SetOnTabRelocated ( const FSimpleDelegate InDelegate )
[]
SDockTab::SetOnTabRenamed
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the handler that will be invoked when the tab is renamed
Slate
void SetOnTabRenamed ( const [FOnTabRenamed](API\Runtime\Slate\Widgets\Docking\SDockTab\FOnTabRenamed) & InDelegate )
[]
SDockTab::SetParent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Sets the tab's tab well parent, or resets it if nothing is passed in
Slate
void SetParent ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SDockingTabWell > Parent )
[]
SDockTab::SetRightContent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Content that appears in the TabWell to the right of the tabs
Slate
void SetRightContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )
[]
SDockTab::SetShouldAutosize
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set whether this tab should be sized based on its content.
Slate
void SetShouldAutosize ( const bool bNewShouldAutosize )
[]
SDockTab::SetTabIcon
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Sets the tab icon
Slate
void SetTabIcon ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > InTabIcon )
[]
SDockTab::SetTabLabelSuffix
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set Label Suffix. A second text field at the end of the Label that takes precedence and isn't lost when space is restricted
Slate
void SetTabLabelSuffix ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InTabLabelSuffix )
[]
SDockTab::SetTabManager
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Set the tab manager that is controlling this tab
Slate
void SetTabManager ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTabManager](API\Runtime\Slate\Framework\Docking\FTabManager) > & InTabManager )
[]
SDockTab::SetTabToolTipWidget
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
The tooltip text that appears on the tab.
Slate
void SetTabToolTipWidget ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SToolTip](API\Runtime\Slate\Widgets\SToolTip) > InTabToolTipWidget )
[]
SDockTab::SetTitleBarRightContent
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Content that appears on the right side of the title bar in the window this stack is in
Slate
void SetTitleBarRightContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )
[]
SDockTab::ShouldAutosize
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Should this tab be sized based on its content.
Slate
bool ShouldAutosize() const
[]
SDockTab::UpdateActivationTime
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Updates the 'last activated' time to the current time
Slate
void UpdateActivationTime()
[]
SDockTab::SDockTab
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Protected constructor; Widgets may only be constructed via aFArguments(i.e.: SNew(SDockTab) )
Slate
SDockTab()
[]
SDockTab
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
A tab widget that also holds on to some content that should be shown when this tab is selected. Intended to be used in conjunction with SDockingTabStack.
Slate
class SDockTab : public [SBorder](API\Runtime\Slate\Widgets\Layout\SBorder)
[ { "type": "bool", "name": "bCanEverClose", "description": "Determines whether the close button for the tab is shown." }, { "type": "bool", "name": "bShouldAutosize", "description": "Should this tab be auto-sized based on its content?" }, { "type": "TSharedRef<SWi...", "name": "Content", "description": "The stuff to show when this tab is selected" }, { "type": "TAttribute<FMa...", "name": "ContentAreaPadding", "description": "" }, { "type": "TSharedPtr< SDo...", "name": "DraggedOverDockingArea", "description": "The dock area this tab is currently being dragged over. Used in nomad tabs to change style" }, { "type": "FCurveSequence", "name": "FlashTabCurve", "description": "Animation that causes the tab to flash" }, { "type": "constFDockTabS...", "name": "GenericTabStyle", "description": "" }, { "type": "TAttribute<FLi...", "name": "IconColor", "description": "Color of this tab's icon" }, { "type": "TSharedPtr<SIm...", "name": "IconWidget", "description": "Widget used to show the icon on the tab" }, { "type": "TSharedPtr<STe...", "name": "LabelSuffix", "description": "" }, { "type": "TSharedPtr<STe...", "name": "LabelWidget", "description": "Widget used to show the label on the tab" }, { "type": "double", "name": "LastActivationTime", "description": "Time this tab was last activated" }, { "type": "FTabId", "name": "LayoutIdentifier", "description": "The tab's layout identifier" }, { "type": "constFDockTabS...", "name": "MajorTabStyle", "description": "The styles used to draw the tab in its various states" }, { "type": "TWeakPtr<FTabM...", "name": "MyTabManager", "description": "The tab manager that created this tab." }, { "type": "FCanCloseTab", "name": "OnCanCloseTab", "description": "Delegate to execute to determine if we can close this tab" }, { "type": "FExtendContextM...", "name": "OnExtendContextMenu", "description": "" }, { "type": "FOnPersistVisua...", "name": "OnPersistVisualState", "description": "Invoked during the Save Visual State pass; gives this tab a chance to save misc info about visual state." }, { "type": "FOnTabActivated...", "name": "OnTabActivated", "description": "Callback to call when this tab is activated" }, { "type": "FOnTabClosedCal...", "name": "OnTabClosed", "description": "Callback to call when this tab is destroyed" }, { "type": "FSimpleDelegate", "name": "OnTabDraggedOverDockArea", "description": "" }, { "type": "FSimpleDelegate", "name": "OnTabDrawerClosedEvent", "description": "" }, { "type": "FSimpleDelegate", "name": "OnTabDrawerOpenedEvent", "description": "" }, { "type": "FSimpleDelegate", "name": "OnTabRelocated", "description": "" }, { "type": "FOnTabRenamed", "name": "OnTabRenamed", "description": "Invoked when the tab is renamed" }, { "type": "TWeakPtr< SDock...", "name": "ParentPtr", "description": "The tab's parent tab well. Null if it is a floating tab." }, { "type": "FCurveSequence", "name": "SpawnAnimCurve", "description": "Animation that shows the tab opening up" }, { "type": "TAttribute<FLi...", "name": "TabColorScale", "description": "Color of this tab" }, { "type": "TAttribute< con...", "name": "TabIcon", "description": "The icon on the tab" }, { "type": "TAttribute<FTe...", "name": "TabLabel", "description": "The label on the tab" }, { "type": "TAttribute<FTe...", "name": "TabLabelSuffix", "description": "A second text field at the end of the Label that takes precedence and isn't lost when space is restricted" }, { "type": "ETabRole", "name": "TabRole", "description": "Is this an MajorTab? A tool panel tab?" }, { "type": "TSharedRef<SWi...", "name": "TabWellContentLeft", "description": "" }, { "type": "TSharedRef<SWi...", "name": "TabWellContentRight", "description": "" }, { "type": "TSharedRef<SWi...", "name": "TitleBarContentRight", "description": "" } ]
SDockTab::SetParentDockTabStackTabWellHidden
/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Slate
void SetParentDockTabStackTabWellHidden ( bool bIsTabWellHidden )
[]
SCircularThrobber::ComputeVolatility
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.
Slate
virtual bool ComputeVolatility() const
[]
SCircularThrobber::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.
Slate
virtual FVector2D ComputeDesiredSize ( float ) const
[]
SCircularThrobber::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Constructs the widget
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Images\SCircularThrobber\FArguments) & InArgs )
[]
SCircularThrobber::FArguments::NumPieces
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
How many pieces there are
Slate
WidgetArgsType & NumPieces &40; int32 InArg &41;
[]
SCircularThrobber::FArguments::ColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Throbber color and opacity
Slate
WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SCircularThrobber::FArguments::Period
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
The amount of time in seconds for a full circle
Slate
WidgetArgsType & Period &40; float InArg &41;
[]
SCircularThrobber::FArguments::PieceImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
What each segment of the throbber looks like
Slate
WidgetArgsType & PieceImage &40; const FSlateBrush &42; InArg &41;
[]
SCircularThrobber::FArguments::Radius
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
The radius of the circle
Slate
WidgetArgsType & Radius &40; float InArg &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
typedef FArguments WidgetArgsType
[]
SCircularThrobber::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
FArguments&40;&41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SCircularThrobber >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
SCircularThrobber::GetWidgetClass
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
virtual const [FSlateWidgetClassData](API\Runtime\SlateCore\Widgets\FSlateWidgetClassData) & GetWidgetClass() const
[]
SCircularThrobber::InvalidatePieceImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Invalidate theSCircularThrobberwith the correct reason. You should invalidate when you are changing a property of SlateBrush after the SlateBrush was set to theSCircularThrobber.
Slate
void InvalidatePieceImage()
[]
MinimumPeriodValue
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
static const float MinimumPeriodValue = (1.e-8f);
[]
SCircularThrobber::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
PrivateParentType
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
typedef [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget) PrivateParentType
[]
PrivateThisType
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
typedef [SCircularThrobber](API\Runtime\Slate\Widgets\Images\SCircularThrobber) PrivateThisType
[]
SCircularThrobber::SetNumPieces
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets how many pieces there are
Slate
void SetNumPieces ( int32 InNumPieces )
[]
SCircularThrobber::SetPieceImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets what each segment of the throbber looks like
Slate
void SetPieceImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * InPieceImage )
[]
SCircularThrobber::SetPeriod
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets the amount of time in seconds for a full circle
Slate
void SetPeriod ( float InPeriod )
[]
SCircularThrobber::SetRadius
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets the radius of the circle
Slate
void SetRadius ( float InRadius )
[]
SCircularThrobber::StaticWidgetClass
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
static const [FSlateWidgetClassData](API\Runtime\SlateCore\Widgets\FSlateWidgetClassData) & StaticWidgetClass()
[]
Super
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
typedef [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget) Super
[]
ThisClass
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
typedef [SCircularThrobber](API\Runtime\Slate\Widgets\Images\SCircularThrobber) ThisClass
[]
SCircularThrobber::SCircularThrobber
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
SCircularThrobber()
[]
SCircularThrobber
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
A throbber widget that orients images in a spinning circle.
Slate
class SCircularThrobber : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget)
[]
SSpinningImage::ComputeVolatility
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.
Slate
virtual bool ComputeVolatility() const
[]
SSpinningImage::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Construct this widget
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Images\SSpinningImage\FArguments) & InArgs )
[]
SSpinningImage::FArguments::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Invoked when the mouse is pressed in the widget.
Slate
WidgetArgsType & OnMouseButtonDown &40; const FPointerEventHandler & InDelegate &41;
[]
SSpinningImage::FArguments::Image
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Image resource
Slate
WidgetArgsType & Image &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
[]
SSpinningImage::FArguments::ColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Color and opacity
Slate
WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SSpinningImage::FArguments::Period
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
The amount of time in seconds for a full rotation
Slate
WidgetArgsType & Period &40; float InArg &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Slate
typedef FArguments WidgetArgsType
[]
SSpinningImage::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Slate
FArguments&40;&41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SSpinningImage >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
SSpinningImage::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SSpinningImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SSpinningImage.h
A widget that displays a spinning image.
Slate
class SSpinningImage : public [SImage](API\Runtime\SlateCore\Widgets\Images\SImage)
[]
SThrobber::ComputeVolatility
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.
Slate
virtual bool ComputeVolatility() const
[]
SThrobber::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Images\SThrobber\FArguments) & InArgs )
[]
DefaultNumPieces
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
static const int32 DefaultNumPieces = 3;
[]
EAnimation
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
enum EAnimation { Vertical = 0x1 << 0, Horizontal = 0x1 << 1, Opacity = 0x1 << 2, VerticalAndOpacity = Vertical | Opacity, All = Vertical | Horizontal | Opacity, None = 0x0, }
[]
SThrobber::FArguments::NumPieces
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
How many pieces there are
Slate
WidgetArgsType & NumPieces &40; int32 InArg &41;
[]
SThrobber::FArguments::PieceImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
What each segment of the throbber looks like
Slate
WidgetArgsType & PieceImage &40; const FSlateBrush &42; InArg &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
typedef FArguments WidgetArgsType
[]
SThrobber::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
FArguments&40;&41;
[]