Navigation
API > API/Runtime > API/Runtime/SlateCore
A CompoundWidget is the base from which most non-primitive widgets should be built. CompoundWidgets have a protected member named ChildSlot.
| Name | SCompoundWidget |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Widgets/SCompoundWidget.h |
| Include Path | #include "Widgets/SCompoundWidget.h" |
Syntax
class SCompoundWidget : public SWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget
- FSlateControlledConstruction → SWidget → SCompoundWidget
Derived Classes
SCompoundWidget derived class hierarchy
- ICustomDetailsView
- IMediaPlayerSlider
- IMultiReplicationStreamEditor
- IObjectNameEditableTextBox
- IReplicationStreamViewer
- ISocketManager
- ITimeSlider
- ITransportControl
- SAboutScreen
- SActionButton
- SActorEditorContext
- SActorModifierCoreEditorProfiler
- SAdvancedFilter
- SAdvancedRotationInputBox
- SAdvancedTransformInputBox
- SAnimationCompressionSelectionDialog
- SAppIconWidget
- SAssetEditorViewportsOverlay
- SAssetPickerButton
- SAssetSearchBox
- SAssetTagItem
- SAsyncOperationStatus
- SAudioCurveView
- SAudioInputWidget
- SAudioMeterView
- SAudioOscilloscopePanelWidget
- SAudioSpectrogram
- SAudioSpectrumPlot
- SAudioTextBox
- SAudioVectorscopePanelWidget
- SAvaDraggableBoxOverlay
- SAvatar
- SAvaUserInputDialog
- SBackgroundBlur
- SBasicFilterBar
- SBasicFilterBar::SFilter
- SBindingView
- SBoneGroupsListWidget
- SBoneListWidget
- SBoolPropertyValue
- SBorder
- SBreadcrumbTrailBase
- SBuildProgressWidget
- SCheckBox
- SCheckBoxList
- SClassPickerDialog
- SClientName
- SCollectionSpreadSheet
- SCollectionSpreadSheetWidget
- SColorGradingComponentViewer
- SColorGradingDetailView
- SColorGradingPanel
- SColorGradingPicker
- SColorPicker
- SColorThemeBar
- SColorThemesViewer
- SColorTrash
- SComplexGradient
- SComponentClassCombo
- SConcertScrollBox
- SConcertSessionActivities
- SConcertSessionBrowser
- SConcertSessionRecovery
- SContentReference
- SCreateAssetFromObject
- SCreditsScreen
- SCSVImportOptions
- SCurveEditor
- SCurveEditorFilterPanel
- SCurveEditorPanel
- SCurveEditorToolProperties
- SCurveEditorTreeFilterStatusBar
- SCurveEditorTreePin
- SCurveEditorTreeSelect
- SCurveEditorTreeTextFilter
- SCurveEditorView
- SCurveKeyDetailPanel
- SCurvePickerWidget
- SCurveSelectionWidget
- SCustomLaunchBuildTargetCombo
- SCustomLaunchCombo
- SCustomLaunchContentSchemeCombo
- SCustomLaunchDeviceWidgetBase
- SCustomLaunchMapListView
- SCustomLaunchPlatformCombo
- SCustomLaunchProjectCombo
- SCustomTextFilterDialog
- SDatabaseAssetTree
- SDatabaseDataDetails
- SDatabasePreview
- SDataflowMembersWidget
- SDataflowSimulationPanel
- SDatasmithOptionsWindow
- SDefaultPropertyValue
- SDeleteAssetsDialog
- SDesignSurface
- SDirectoryPicker
- SDMXEntityPickerButton
- SDMXPixelMappingCell
- SDMXPixelMappingComponentBox
- SDMXPixelMappingComponentLabel
- SDMXPixelMappingScreenLayout
- SDMXPixelMappingSimpleScreenLayout
- SDMXReadOnlyFixturePatchList
- SDNAAssetImportWindow
- SDraggableBoxOverlay
- SDropTarget
- SDynamicLayoutBox
- SEditableComboBox
- SEditableLabel
- SEditableSessionHistory
- SEditorViewport
- SEditorViewportToolBarButton
- SEditorViewportToolbarMenu
- SEnumPropertyValue
- SErrorHint
- SExpandableArea
- SExpanderArrow
- SExtensionPanel
- SFacesOutliner
- SFieldIcon
- SFieldName
- SFilePathPicker
- SFilterConfigurator
- SFilterSearchBox
- SFindInMetasound
- SFixedSampledSequenceRuler
- SFixedSampledSequenceViewerPanel
- SFrameRateEntryBox
- SFrameRatePicker
- SFxWidget
- SGameLayerManager
- SGameMenuItemWidget
- SGameMenuPageWidget
- SGenericDialogWidget
- SGeometryMaskCanvasPreview
- SGlobalPlayWorldActions
- SGraphEditor
- SGridLineSpacingList
- SHorizontalClientList
- SImageCatalog
- SIndent
- SInlineEditableTextBlock
- SInputChord
- SInputKeySelector
- SInstanceDataObjectFixupTool
- SInstancedStructPicker
- SInteractionAssetPreview
- SInvalidationPanel
- SItemSelector
- SKeyEditInterface
- SKeyNavigationButtons
- SKeySelector
- SLazyToolTip
- SLevelSequenceFavoriteRating
- SListView::SListViewPinnedRowWidget
- SListViewSelectorDropdownMenu
- SLiveLinkBoneSelectionWidget
- SLiveLinkBoneTreeMenu
- SLiveLinkClientPanelToolbar
- SLiveLinkDataView
- SLiveLinkFilterSearchBox
- SLiveLinkMessageBusSourceFactory
- SLiveLinkSubjectRepresentationPicker
- SLoadGuard
- SLocalClientName
- SLogWidget
- SMajorTabWindow
- SMediaImage
- SMediaPermutationsSelector
- SMediaPlayerEditorMediaDetails
- SMediaPlayerEditorViewer
- SMediaPlaylistEditorTracks
- SMenuOwner
- SMetaDataView
- SMetaHumanAudioBaseLiveLinkSubjectMonitorWidget
- SMetaHumanAuthenticationMenuButton
- SMetaHumanCalibrationObjectWidget
- SMetaHumanImageViewerScrubber
- SMetaHumanLocalLiveLinkSubjectMonitorWidget
- SMetaHumanMediaSourceWidget
- SMetaHumanVideoBaseLiveLinkSubjectMonitorWidget
- SMiniCurveEditor
- SMLDeformerInputBonesWidget
- SMLDeformerInputCurvesWidget
- SMLDeformerInputWidget
- SModalEditorDialog
- SModeWidget
- SMotionTrailOptions
- SMovieGraphSimpleList
- SMovieGraphSimplePicker
- SMultiBlockBaseWidget
- SMultipleOptionTable
- SNameListPicker
- SNamingTokensEditableTextBox
- SNegativeActionButton
- SNiagaraActionWidget
- SNiagaraFilterBox
- SNiagaraFunctionSpecifierNDCVariablesSelector
- SNiagaraGraphActionWidget
- SNiagaraHierarchyModule
- SNiagaraHierarchyModuleInput
- SNiagaraLibraryOnlyToggleHeader
- SNiagaraParameterEditor
- SNiagaraParameterMenu
- SNiagaraParameterName
- SNiagaraParameterNamePinLabel
- SNiagaraParameterNameTextBlock
- SNiagaraParameterPanel
- SNiagaraPinTypeSelector
- SNiagaraScriptGraph
- SNiagaraScriptInputPreviewPanel
- SNiagaraSelectedObjectsDetails
- SNiagaraSourceFilterBox
- SNiagaraTemplateTabBox
- SNotificationItem
- SNotificationList
- SNumericDropDown
- SNumericEntryBox
- SNumericPropertyValue
- SNumericRotatorInputBox
- SNumericTextBlockKeyEditor
- SNumericVectorInputBox
- SObjectBindingTag
- SObjectBindingTags
- SObjectWidget
- SOutlinerColumnButton
- SOutlinerItemViewBase
- SOutlinerTrackColorPicker
- SOutputLogDialog
- SOverrideListWidget
- SOverrideStatusWidget
- SPackageDetails
- SPopup
- SPositiveActionButton
- SPreviewSceneProfileSelector
- SPrivateAssetsDialog
- SPropertyMenuTedsRowPicker
- SPropertyViewer
- SReadOnlyHierarchyView
- SReferenceTree
- SRemoteClientName
- SRetainerWidget
- SRigVMBulkEditWidget
- SRigVMChangesTreeView
- SRigVMDetailsInspector
- SRigVMEditorGraphExplorer
- SRigVMEditorSelectedDebugObjectWidget
- SRigVMEnumPicker
- SRigVMExecutionStackView
- SRigVMFindReferences
- SRigVMGraphBreakLinksWidget
- SRigVMGraphChangePinType
- SRigVMGraphFunctionBulkEditWidget
- SRigVMGraphFunctionLocalizationWidget
- SRigVMGraphPinReorderHandle
- SRigVMGraphVariableBinding
- SRigVMNodeLayoutWidget
- SRigVMNodePreviewWidget
- SRigVMSwapAssetReferencesWidget
- SRigVMSwapFunctionsWidget
- SRigVMUserDataPath
- SRigVMVariableMappingWidget
- SScalabilitySettings
- SScaleBox
- SScriptableToolGroupSetCombo
- SScriptableToolGroupSetPicker
- SScriptableToolGroupTagChip
- SScrollBorder
- SScrollBox
- SSearchToggleButton
- SSegmentedControl
- SSegmentedTimelineView
- SSelectionView
- SSelectionViewWidget
- SSequencerFilter
- SSequencerSearchBox
- SSessionBrowser
- SSessionHistory
- SSessionHistoryWrapper
- SSidebar
- SSidebarContainer
- SSimpleGradient
- SSimplePreLoadScreenWidget
- SSimpleTimeSlider
- SSkeletonBoneRemoval
- SSkeletonSelectorWindow
- SSkeletonWidget
- SSourceControlControls
- SSourceControlReview
- SSpinBox
- SStringPropertyValue
- SSubMenuHandler
- SSuggestionTextBox
- STabDrawer
- STableTreeView
- STableTreeViewCell
- STableViewBase
- STaggedAssetBrowser
- STaggedAssetBrowserContent
- STaggedAssetBrowserSection
- STaggedAssetBrowserSections
- STemplateStringEditableTextBox
- STextComboBox
- STextComboPopup
- STextEntryPopup
- STextHighlightOverlay
- STextPropertyEditableStringTableReference
- STextPropertyEditableTextBox
- STextScroller
- STextureGraphInsightActionView
- STextureGraphInsightBatchInspectorView
- STextureGraphInsightBatchJobView
- STextureGraphInsightBlobInspectorView
- STextureGraphInsightDeviceBufferInspectorView
- STextureGraphInsightDeviceListView
- STextureGraphInsightDeviceManagerView
- STextureGraphInsightDeviceView
- STextureGraphInsightInspectorView
- STextureGraphInsightJobInspectorView
- STextureGraphInsightMixListView
- STextureGraphInsightRecordTrailView
- STextureGraphInsightResourceView
- STextureGraphInsightSessionView
- STextureHistogram
- STextureHistogramBars
- STextureHistogramCurve
- STextureHistogramReferenceLines
- SThemeColorBlock
- SThrobber
- STimecodeProvider
- SToolTip
- STrackAreaLaneView
- STrainingDataProcessorMainWidget
- STransformedWaveformViewPanel
- STransformOutliner
- STweenView
- SUsdOptionsWindow
- SUserAssetTag
- SUserAssetTagBrowserSelectedAssetDetails
- SUserAssetTagRow
- SUserAssetTagsEditor
- SUserWidget
- SVerticalResizeBox
- SVerticesOutliner
- SViewport
- SViewportToolBar
- SViewportToolBarComboMenu
- SViewportToolBarIconMenu
- SVolumeControl
- SVPBookmarkListView
- SWaveformEditorMessageDialog
- SWaveformTransformationRenderLayer
- SWaveformTransformationsOverlay
- SWebBrowser
- SWebBrowserView
- SWidgetDrawer
- SWindow
- SWindowTitleBar
- SWizard
- SWorldPartitionBuildNavigationDialog
- SWorldPartitionViewportWidget
- SWorldWidgetScreenLayer
- SZoomPan
- IAnimAssetFindReplace
- IAnimationSequenceBrowser
- IAnimSequenceCurveEditor
- IDetailsView
- IDistributionCurveEditor
- IHierarchyTable
- ILevelEditor
- INavigationEventSimulationView
- IPersonaViewport
- IPinnedCommandList
- IRewindDebuggerView
- ISceneOutliner
- ISinglePropertyView
- ISkeletonTree
- IStatsViewer
- SActionableMessageEntry
- SActionableMessageViewportWidget
- SAdvancedPreviewDetailsTab
- SAnimAttributeView
- SAnimAttributeViewer
- SAssetViewItem
- SAssetMenuIcon
- SAssetView
- SAudioDrivenAnimationMood
- SBarVisualizer
- SBlueprintDiff
- SBlueprintEditorSelectedDebugObjectWidget
- SBlueprintNamespaceEntry
- SBlueprintRevisionMenu
- SBoneMappingBase
- SBoneSelectionWidget
- SBoneTreeMenu
- SCameraFamilyShortcutBar
- SObjectTreeGraphEditor
- SCameraRigAssetEditor
- SCameraRigTransitionEditor
- SCameraVariableCollectionEditor
- SCaptureManagerWidget
- SCaptureSourcesWidget
- SCarouselNavigationBar
- SCarouselNavigationButton
- SChaosVDDetailsView
- SChaosVDEnumFlagsMenu
- SChaosVDMainTab
- SCharacterPartsView
- SClassPropertyEntryBox
- SClassViewer
- SCollectionSelectionButton
- SComboPanel
- SCommandDetailsView
- SCommandPickMenuWidget
- SCommandWidget
- SCommentBubble
- SConsoleVariablesEditorCustomConsoleInputBox
- SContentBundleBrowser
- SConvertInnerPin
- SCreateClothingSettingsPanel
- SCulturePicker
- SCulturePickerCombo
- SCurveTimelineView
- SDefaultGraphActionWidget
- SDeleteCameraObjectDialog
- SDerivedDataCacheStatisticsDialog
- SDerivedDataRemoteStoreDialog
- SDerivedDataResourceUsageDialog
- SDetailsDiff
- SDetailsSplitter
- SDMXPortSelector
- SDocumentationToolTip
- SDraggableBox
- SDynamicNumericEntry
- SEventsTree
- SEventTimelineView
- SEverythingPicker
- SExportTrajectoriesWindow
- SExternalImageReference
- SFilterableObjectList
- SFilterClassMenuItem
- SFindInBlueprints
- SFindInGraph
- SFindInMaterial
- SFindInObjectTreeGraph
- SFixupSelfContextDialog
- SFootageIngestWidget
- SFrameBasedTimeSignatureInput
- SGameplayTagChip
- SGameplayTagCombo
- SGameplayTagContainerCombo
- SGameplayTagPicker
- SGameplayTagQueryEntryBox
- SGameplayTagWidget
- SGraphActionMenu
- SGraphPalette
- SGraphPaletteItem
- SGraphPreviewer
- SHierarchyViewer
- SHyperlinkLaunchURL
- SIKRetargetChainMapList
- SIKRetargetHierarchy
- SIKRetargetPoseEditor
- SIKRigHierarchy
- SIKRigHierarchyItem
- SIKRigRetargetChainList
- SIKRigSolverStack
- SInlinePropertyCellWidget
- SInterchangeBaseConflictWidget
- SKismetDebugTreeView
- SKismetInspector
- SKismetLinearExpression
- SLayerHandle
- SLevelOfDetailBranchNode
- SMaterialSlotWidget
- SMediaViewerTab
- SMeshLayersStack
- SMessageLogListing
- SMetaHumanCameraCombo
- SMetaHumanConfigCombo
- SMetaHumanSpeechToAnimProcessingSettings
- SMyBlueprint
- SNameComboBox
- SNodeTitle
- SObjectPropertyEntryBox
- SObjectReferenceContextView
- SObjectTreeGraphTitleBar
- SObjectTreeGraphToolbox
- SObjectTreeGraphToolboxEntry
- SOperatorStackEditorWidget
- SOperatorTreeWidget
- SOperatorViewerTabWidget
- SOverridePropertiesWidget
- SPersonaToolbox
- SPinComboBox
- SPinTypeSelector
- SPinValueInspector
- SPlatformSetupMessage
- SPListEditorPanel
- SProperty
- SPropertyAccessChainWidget
- SReferenceSectionSelectionWidget
- SResetToDefaultMenu
- SResetToDefaultPropertyEditor
- SRetargetAnimAssetsWindow
- SRetargetOpItem
- SRetargetOpStack
- SRowDetails
- SScrubControlPanel
- SScrubWidget
- SSCSEditor
- SSettingsEditorCheckoutNotice
- SSingleObjectDetailsPanel
- SSkinWeightProfileImportOptions
- SSocketChooserPopup
- SSplineGeneratorPanel
- SStandaloneCustomizedValueWidget
- SStructPropertyEntryBox
- SSubobjectEditor
- STedsAssetPreviewWidget
- STedsSearchBox
- STedsTableViewer
- STedsTileViewer
- STickDelegateWidget
- STimeline
- SToggleTraceButton
- SToolInputAssetComboPanel
- SToolInputAssetPicker
- STransformGizmoNumericalUIOverlay
- STypeListContextView
- SUndoHistoryDetails
- SUserToolBoxTabWidget
- SVector2DSlider
- SVector2DTextBox
- SVector4Slider
- SVector4TextBox
- SVectorSlider
- SVectorTextBox
- SWidgetCarousel
- SWidgetCarouselWithNavigation
- SWorldPartitionEditor
- SWorldPartitionEditorGrid
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SCompoundWidget() |
Disallow public construction | Widgets/SCompoundWidget.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SCompoundWidget() |
Widgets/SCompoundWidget.h |
Structs
| Name | Remarks |
|---|---|
| FCompoundWidgetOneChildSlot |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateParentType | SWidget | Widgets/SCompoundWidget.h | |
| PrivateThisType | SCompoundWidget | Widgets/SCompoundWidget.h | |
| Super | SWidget | Widgets/SCompoundWidget.h | |
| ThisClass | SCompoundWidget | Widgets/SCompoundWidget.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColorAndOpacityAttribute | TSlateAttribute< FLinearColor > | The color and opacity to apply to this widget and all its descendants. | Widgets/SCompoundWidget.h | |
| ContentScaleAttribute | TSlateAttribute< FVector2D > | The layout scale to apply to this widget's contents; useful for animation. | Widgets/SCompoundWidget.h | |
| ForegroundColorAttribute | TSlateAttribute< FSlateColor > | Optional foreground color that will be inherited by all of this widget's contents | Widgets/SCompoundWidget.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLinearColor GetColorAndOpacity() |
Gets the widget's color. | Widgets/SCompoundWidget.h | |
const FVector2D GetContentScale() |
Returns the size scaling factor for this widget. | Widgets/SCompoundWidget.h | |
void SetColorAndOpacity
(
TAttribute< FLinearColor > InColorAndOpacity |
Sets the widget's color. | Widgets/SCompoundWidget.h | |
void SetContentScale
(
TAttribute< FVector2D > InContentScale |
Sets the content scale for this widget. | Widgets/SCompoundWidget.h | |
void SetForegroundColor
(
TAttribute< FSlateColor > InForegroundColor |
Sets the widget's foreground color. | Widgets/SCompoundWidget.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FChildren * GetChildren () |
Returns the useful children (if any) of this widget. | Widgets/SCompoundWidget.h | |
virtual FSlateColor GetForegroundColor() |
Widgets/SCompoundWidget.h | ||
virtual void OnArrangeChildren
(
const FGeometry& AllottedGeometry, |
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. | Widgets/SCompoundWidget.h | |
virtual int32 OnPaint
(
const FPaintArgs& Args, |
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. | Widgets/SCompoundWidget.h | |
virtual void SetVisibility
(
TAttribute< EVisibility > InVisibility |
Widgets/SCompoundWidget.h |
Overridden from FSlateControlledConstruction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FSlateWidgetClassData & GetWidgetClass() |
Widgets/SCompoundWidget.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSlateAttributeRef< FLinearColor > GetColorAndOpacityAttribute() |
Widgets/SCompoundWidget.h | ||
TSlateAttributeRef< FVector2D > GetContentScaleAttribute() |
Widgets/SCompoundWidget.h | ||
TSlateAttributeRef< FSlateColor > GetForegroundColorAttribute() |
Widgets/SCompoundWidget.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float LayoutScaleMultiplier |
Compute the ideal size necessary to display this widget. | Widgets/SCompoundWidget.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSlateWidgetClassData & GetPrivateWidgetClass() |
Widgets/SCompoundWidget.h | ||
static void PrivateRegisterAttributes
(
FSlateAttributeInitializer& |
Widgets/SCompoundWidget.h | ||
static const FSlateWidgetClassData & StaticWidgetClass() |
Widgets/SCompoundWidget.h |