1. Epic GamesDeveloper
  3. UCanvasPanelSlot

UCanvasPanelSlot

API > API/Runtime > API/Runtime/UMG

   
Name UCanvasPanelSlot
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/CanvasPanelSlot.h
Include Path #include "Components/CanvasPanelSlot.h"

Syntax

UCLASS (MinimalAPI)  
class UCanvasPanelSlot : public UPanelSlot

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCanvasPanelSlot ( const FObjectInitializer& ObjectInitializer
)

   Components/CanvasPanelSlot.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAutoSize bool When AutoSize is true we use the widget's desired size Components/CanvasPanelSlot.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetAutoSize"
  • Setter="SetAutoSize"
  • BlueprintGetter="GetAutoSize"
  • BlueprintSetter="SetAutoSize"
  • Category="Layout|Canvas Slot"
  • AdvancedDisplay
  • Meta=(DisplayName="Size To Content")
LayoutData FAnchorData The anchoring information for the slot Components/CanvasPanelSlot.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetLayout"
  • Setter="SetLayout"
  • BlueprintGetter="GetLayout"
  • BlueprintSetter="SetLayout"
  • Category="Layout|Canvas Slot"
ZOrder int32 The order priority this widget is rendered in. Components/CanvasPanelSlot.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintGetter="GetZOrder"
  • BlueprintSetter="SetZOrder"
  • Category="Layout|Canvas Slot"

Protected

Name Type Remarks Include Path Unreal Specifiers
DesiredPosition TOptional< FVector2D >   Components/CanvasPanelSlot.h  
PreEditGeometry FGeometry   Components/CanvasPanelSlot.h  
PreEditLayoutData FAnchorData   Components/CanvasPanelSlot.h  
Slot SConstraintCanvas::FSlot *   Components/CanvasPanelSlot.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BuildSlot ( TSharedRef< SConstraintCanvas > Canvas
)

   Components/CanvasPanelSlot.h  

FVector2D GetAlignment()

 Gets the alignment on the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

FAnchors GetAnchors()

 Gets the anchors on the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

bool GetAutoSize()

 Gets if the slot to be auto-sized Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

FAnchorData GetLayout()

 Gets the layout data of the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

FMargin GetOffsets()

 Gets the offset data of the slot, which could be position and size, or margins depending on the anchor points Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

FVector2D GetPosition()

 Gets the position of the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

FVector2D GetSize()

 Gets the size of the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

int32 GetZOrder()

 Gets the z-order on the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void RebaseLayout ( bool PreserveSize
)

 Compares the saved base layout against the current state. Components/CanvasPanelSlot.h  

void SaveBaseLayout()

 Stores the current layout information about the slot and parent canvas. Components/CanvasPanelSlot.h  

void SetAlignment ( FVector2D InAlignment
)

 Sets the alignment on the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetAnchors ( FAnchors InAnchors
)

 Sets the anchors on the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetAutoSize ( bool InbAutoSize
)

 Sets if the slot to be auto-sized Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetDesiredPosition ( FVector2D InPosition
)

   Components/CanvasPanelSlot.h  

void SetLayout ( const FAnchorData& InLayoutData
)

 Sets the layout data of the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetMaximum ( FVector2D InMaximumAnchors
)

 Sets the anchors on the slot Components/CanvasPanelSlot.h  

void SetMinimum ( FVector2D InMinimumAnchors
)

 Sets the anchors on the slot Components/CanvasPanelSlot.h  

void SetOffsets ( FMargin InOffset
)

 Sets the offset data of the slot, which could be position and size, or margins depending on the anchor points Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetPosition ( FVector2D InPosition
)

 Sets the position of the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetSize ( FVector2D InSize
)

 Sets the size of the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

void SetZOrder ( int32 InZOrder
)

 Sets the z-order on the slot Components/CanvasPanelSlot.h
  • BlueprintCallable
  • Category="Layout|Canvas Slot"

Overridden from UPanelSlot

Name Remarks Include Path Unreal Specifiers

virtual bool DragDropPreviewByDesigner ( const FVector2D& LocalCursorPosition,
const TOptional< int32 >& XGridSnapSize,
const TOptional< int32 >& YGridSnapSize
)

 Called by the designer when a design-time widget is dragged. Components/CanvasPanelSlot.h  

virtual bool NudgeByDesigner ( const FVector2D& NudgeDirection,
const TOptional< int32 >& GridSnapSize
)

 Called by the designer to "nudge" a widget in a direction. Components/CanvasPanelSlot.h  

virtual void SynchronizeFromTemplate ( const UPanelSlot*const TemplateSlot
)

 Called by the designer when a design-time widget needs to have changes to its associated template synchronized. Components/CanvasPanelSlot.h  

virtual void SynchronizeProperties()

 Applies all properties to the live slot if possible. Components/CanvasPanelSlot.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/CanvasPanelSlot.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   Components/CanvasPanelSlot.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   Components/CanvasPanelSlot.h  

virtual void PreEditChange ( FEditPropertyChain& PropertyAboutToChange
)

   Components/CanvasPanelSlot.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page