Navigation
API > API/Plugins > API/Plugins/SlateIM
A utility base class for creating SlateIM-based tools. Handles setting up a tick for drawing the tool.
Note: this class is not required for using SlateIM but provides common functionality for SlateIM tools
The test widgets (FSlateIMTestViewportWidget/FSlateIMTestWindowWidget in SlateIMManager) are examples of using this class.
| Name | FSlateIMWidgetBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SlateIM/Source/SlateIM/Public/SlateIMWidgetBase.h |
| Include Path | #include "SlateIMWidgetBase.h" |
Syntax
class FSlateIMWidgetBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateIMWidgetBase
(
const FStringView& Name |
SlateIMWidgetBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSlateIMWidgetBase() |
SlateIMWidgetBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| TickHandle | FDelegateHandle | SlateIMWidgetBase.h | ||
| WidgetName | FName | SlateIMWidgetBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DisableWidget() |
SlateIMWidgetBase.h | ||
void EnableWidget() |
SlateIMWidgetBase.h | ||
const FName & GetWidgetName() |
SlateIMWidgetBase.h | ||
bool IsWidgetEnabled() |
SlateIMWidgetBase.h | ||
void ToggleWidget() |
SlateIMWidgetBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DrawWidget
(
float DeltaTime |
SlateIMWidgetBase.h |