Navigation
API > API/Plugins > API/Plugins/CommonUI
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UUserWidget
- UCommonUserWidget
- UCommonActivatableWidget
- UXRCreativePaletteTab
- UXRCreativePaletteToolTab
- UCommonButtonBase
- UCommonBoundActionButton
- UCommonRotator
- UCommonTabListWidgetBase
- UXRCreativePalette
References
| Module | CommonUI |
| Header | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonUserWidget.h |
| Include | #include "CommonUserWidget.h" |
Syntax
UCLASS&40;ClassGroup&61;UI, Meta&61;&40;Category&61;"Common UI", DisableNativeTick&41;&41;
class UCommonUserWidget : public UUserWidget
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bDisplayInActionBar | True to generally display this widget's actions in the action bar, assuming it has actions. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UCommonUserWidget
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddActionBinding
(
FUIActionBindingHandle ActionBinding |
||
| const TArray< FUIActionBindingHandle > & | |||
| GameInstanceT & | |||
| UCommonInputSubsystem * | |||
| TSharedPtr< FSlateUser > | |||
| PlayerControllerT & | |||
| const TArray< TWeakObjectPtr< const UWidget > > | |||
| UCommonUISubsystemBase * | |||
| void | RegisterScrollRecipient
(
const UWidget& AnalogScrollRecipient |
||
| FUIActionBindingHandle | RegisterUIActionBinding
(
const FBindUIActionArgs& BindActionArgs |
Convenience methods for menu action registrations (any UWidget can register via FCommonUIActionRouter directly, though generally that shouldn't be needed). | |
| void | RemoveActionBinding
(
FUIActionBindingHandle ActionBinding |
||
| void | SetConsumePointerInput
(
bool bInConsumePointerInput |
Sets whether or not this widget will consume ALL pointer input that reaches it | |
| void | UnregisterScrollRecipient
(
const UWidget& AnalogScrollRecipient |
Overridden from UUserWidget
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| FReply | NativeOnMouseButtonDoubleClick
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnMouseButtonDown
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnMouseButtonUp
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnMouseWheel
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnTouchEnded
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnTouchGesture
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnTouchMoved
(
const FGeometry& InGeometry, |
||
| FReply | NativeOnTouchStarted
(
const FGeometry& InGeometry, |
Overridden from UWidget
| Type | Name | Description | |
|---|---|---|---|
| void | Function called after the underlying SWidget is constructed. |