MenuRootSubComponent Interface Reference

Widget component which is linked to menu it's part of. More...

Inheritance diagram for MenuRootSubComponent:

Public Member Functions
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Detailed Description

Widget component which is linked to menu it's part of.

Linking is done through MenuRootComponent.

Member Function Documentation

GetMenu()

MenuRootBase MenuRootSubComponent.GetMenu

(

)

Get menu of which the widget is part of.

Returns

Menu

GetRootComponent()

MenuRootComponent MenuRootSubComponent.GetRootComponent

(

)

Get root component of this subcomponent,.

Returns

Menu

GetWidget()

Widget MenuRootSubComponent.GetWidget

(

)

Get widget to which the component belongs to.

Returns

Widget

HandlerAttached()

override void MenuRootSubComponent.HandlerAttached

(

Widget

w

)

Implemented in SCR_CampaignBuildingServicesEditorUIComponent, SCR_CampaignBuildingSupplyEditorUIComponent, SCR_PlayerHubWarningEditorUIComponent, SCR_PlayersListEntryEditorUIComponent, SCR_BaseToolbarEditorUIComponent, SCR_BasePaginationUIComponent, and SCR_ExternalPaginationUIComponent.

HandlerAttachedScripted()

void MenuRootSubComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implemented in SCR_AttributesButtonEditorUIComponent, SCR_BaseContextMenuEditorUIComponent, SCR_BudgetEditorUIComponent, SCR_ButtonHintEditorUIComponent, SCR_CameraInfoEditorUIComponent, SCR_CommandActionsEditorUIComponent, SCR_ContentBrowserEditorUIComponent, SCR_ContentBrowserFiltersEditorUIComponent, SCR_ContextMenuActionsEditorUIComponent, SCR_CursorEditorUIComponent, SCR_DialogEditorUIComponent, SCR_EditorStateConditionUIComponent, SCR_HideEditorUIComponent, SCR_LayerAutoEnterUIComponent, SCR_LayersEditorUIComponent, SCR_MapEditorUIComponent, SCR_ModesEditorUIComponent, SCR_MouseAreaEditorUIComponent, SCR_PingEditorUIComponent, SCR_PlacingEditorUIComponent, SCR_PlayersListEditorUIComponent, SCR_PreviewEntityEditorUIComponent, SCR_QuickPlacingEditorUIComponent, SCR_SelectionEditorUIComponent, SCR_TransformingEditorUIComponent, SCR_EditableEntityLinkUIComponent, SCR_EditableEntitySlotManagerUIComponent, SCR_EntitiesEditorUIComponent, SCR_WaypointLinesEditorUIComponent, SCR_BaseModeEditorUIComponent, SCR_BudgetUIComponent, SCR_ActionsToolbarEditorUIComponent, SCR_BaseToolbarEditorUIComponent, SCR_CommandToolbarEditorUIComponent, SCR_EntitiesToolbarEditorUIComponent, SCR_FactionsToolbarEditorUIComponent, SCR_PlacingToolbarEditorUIComponent, SCR_TooltipAreaEditorUIComponent, SCR_TooltipManagerEditorUIComponent, SCR_NotificationsLogComponent, SCR_CompassUIComponent, SCR_IngameClockUIComponent, and SCR_SessionDurationUIComponent.

HandlerDeattached()

override void MenuRootSubComponent.HandlerDeattached

(

Widget

w

)

Implemented in SCR_AttributesEditorUIComponent, SCR_BaseContextMenuEditorUIComponent, SCR_BudgetEditorUIComponent, SCR_ButtonHintEditorUIComponent, SCR_CameraInfoEditorUIComponent, SCR_CampaignBuildingServicesEditorUIComponent, SCR_CampaignBuildingSupplyEditorUIComponent, SCR_CommandActionsEditorUIComponent, SCR_ContentBrowserEditorUIComponent, SCR_ContentBrowserFiltersEditorUIComponent, SCR_ContextMenuActionsEditorUIComponent, SCR_CursorEditorUIComponent, SCR_DialogEditorUIComponent, SCR_EditorStateConditionUIComponent, SCR_HideEditorUIComponent, SCR_LayerAutoEnterUIComponent, SCR_LayersEditorUIComponent, SCR_MapEditorUIComponent, SCR_ModesEditorUIComponent, SCR_MouseAreaEditorUIComponent, SCR_PingEditorUIComponent, SCR_PlacingEditorUIComponent, SCR_PlayerHubWarningEditorUIComponent, SCR_PlayersListEditorUIComponent, SCR_PreviewEntityEditorUIComponent, SCR_QuickPlacingEditorUIComponent, SCR_SelectionEditorUIComponent, SCR_TransformingEditorUIComponent, SCR_EditableEntitySlotManagerUIComponent, SCR_EntitiesEditorUIComponent, SCR_WaypointLinesEditorUIComponent, SCR_BudgetUIComponent, SCR_ActionsToolbarEditorUIComponent, SCR_CommandToolbarEditorUIComponent, SCR_EntitiesToolbarEditorUIComponent, SCR_FactionsToolbarEditorUIComponent, SCR_PlacingToolbarEditorUIComponent, SCR_TooltipManagerEditorUIComponent, SCR_BaseTooltipTargetEditorUIComponent, SCR_NotificationsLogComponent, SCR_BasePaginationUIComponent, SCR_CompassUIComponent, SCR_IngameClockUIComponent, and SCR_SessionDurationUIComponent.

IsUnique()

bool MenuRootSubComponent.IsUnique ( )

protected

Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

To be overwritten by inherited classes.

Returns

True if unique

Implemented in SCR_AttributesButtonEditorUIComponent, SCR_ButtonHintEditorUIComponent, SCR_ContentBrowserEditorUIComponent, SCR_EditorStateConditionUIComponent, SCR_LayerAutoEnterUIComponent, SCR_EditableEntityLinkUIComponent, SCR_EditableEntitySlotManagerUIComponent, SCR_BudgetUIComponent, SCR_CommandToolbarEditorUIComponent, SCR_EntitiesToolbarEditorUIComponent, SCR_BaseTooltipTargetEditorUIComponent, SCR_BaseTooltipEditorUIComponent, and SCR_BasePaginationUIComponent.

---

The documentation for this interface was generated from the following file:

• Game/UI/Components/MenuRootSubComponent.c