1. Epic GamesDeveloper
  3. SColumnToggleWidget

SColumnToggleWidget

Outliner Column Widget for toggling active state with click and drag functionality.

API > API/Editor > API/Editor/SequencerCore

Outliner Column Widget for toggling active state with click and drag functionality. Adjusts image color and transparency based on active state and item hover. Displays an alternate icon when a child is active and the item is not. Column Toggle widgets have 4 States: Active, Inactive, Active Child, and Implicitly Active. Column Toggle widgets will change its brush based on its state.

   
Name SColumnToggleWidget
Type class
Header File /Engine/Source/Editor/SequencerCore/Public/MVVM/Views/OutlinerColumns/SColumnToggleWidget.h
Include Path #include "MVVM/Views/OutlinerColumns/SColumnToggleWidget.h"

Syntax

class SColumnToggleWidget : public SImage

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveBrush const FSlateBrush * Brushes for the various states of active widgets. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
bIsActive uint8 Whether this item is active. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
bIsChildActive uint8 Whether or not a child of this item is active. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
bIsImplicitlyActive uint8 Whether this item is active implicitly (as a result of some item's state, not this item explicitly). MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
bIsMouseOverWidget uint8 Whether or not the mouse is directly over the widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
ChildActiveBrush const FSlateBrush *   MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
InactiveBrush const FSlateBrush *   MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
UndoTransaction TUniquePtr< FScopedTransaction > Scoped undo transaction. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs,
const TWeakPtr< IOutlinerColumn > InOutlinerColumn,
const FCreateOutlinerColumnParams& InParams
)

   MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual FSlateColor GetImageColorAndOpacity()

 Get the color and opacity of the column toggle widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual void OnToggleOperationComplete()

 Called when a drag or click ends and can be used to refresh the SequencerTree if necessary. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

Protected

Name Remarks Include Path Unreal Specifiers

const FSlateBrush * GetActiveBrush()

 Returns the brush to be used to represent a widget is active. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual const FSlateBrush * GetBrush()

 Get the image this widget displays. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual const FSlateBrush * GetInactiveBrush()

 Returns the brush to be used to represent a widget is inactive. If Null, will use the active brush. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

FReply HandleClick()

 Handles left click-type inputs and potentially begins drag and drop operation. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

bool IsActive()

 Returns whether or not the item is directly active or not. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

bool IsChildActive()

 Returns true if a child of this item is active. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual bool IsEnabled()

 Returns whether the widget is enabled or not. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual bool IsImplicitlyActive()

 Returns true if this item is implicitly active, but not directly active MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  
Refreshes the Sequencer Tree. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

void SetIsActive ( const bool bInIsActive
)

 Sets the active state of this item to the input value. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnDragDetected ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Start a new drag/drop operation for this widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

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

 If a matching column drag drop operation has entered this widget, set its item to the specified active state. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual FReply OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when the mouse button is double clicked on this widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Called when the mouse button is pressed down on this widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Process a mouse up message. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual void OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

 Called when this widget had captured the mouse, but that capture has been revoked for some reason. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual void OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Called when mouse enters the column widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

 Called when mouse leaves the column widget. MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 Tick this widget to update its cached state MVVM/Views/OutlinerColumns/SColumnToggleWidget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page