Navigation
API > API/Plugins > API/Plugins/SlateIMBlueprint
| Name | USlateIMBlueprintFunctionLibrary |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SlateIM/Source/SlateIMBlueprint/Public/SlateIMBlueprintFunctionLibrary.h |
| Include Path | #include "SlateIMBlueprintFunctionLibrary.h" |
Syntax
UCLASS (BlueprintType, ClassGroup="SlateIM", DisplayName="SlateIM")
class USlateIMBlueprintFunctionLibrary : public UBlueprintFunctionLibrary
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → USlateIMBlueprintFunctionLibrary
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ActivateTab
(
const FName& TabId |
Causes a one-time activation of a tab in its parent tab well. | SlateIMBlueprintFunctionLibrary.h |
|
static void AddMenuBarEntry
(
const FString& InMenuName |
Adds a menu to the menu entry with the given name. | SlateIMBlueprintFunctionLibrary.h |
|
static bool AddMenuButton
(
const FString& RowText, |
Add a menu item button to the current context menu | SlateIMBlueprintFunctionLibrary.h |
|
static bool AddMenuCheckButton
(
const FString& RowText, |
Display a menu item button with a checkmark | SlateIMBlueprintFunctionLibrary.h |
|
static void AddMenuSection
(
const FString& SectionText |
Add a new section to the current context menu | SlateIMBlueprintFunctionLibrary.h |
|
static void AddMenuSeparator() |
Add a separator to the current context menu | SlateIMBlueprintFunctionLibrary.h |
|
static bool AddMenuToggleButton
(
const FString& RowText, |
Display a menu item button with a checkbox | SlateIMBlueprintFunctionLibrary.h |
|
static void AddTableColumn
(
const FName& ColumnID, |
Adds a column and immediately ends it with the given label as its body. | SlateIMBlueprintFunctionLibrary.h |
|
static void AutoSize() |
Set the next slot to AutoSize to its content | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginBorder
(
FName BorderStyleName, |
Begin a container with a background image. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginCanvas
(
int32 Width, |
Begin queueing commands to draw to a canvas render target. | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginContextMenuAnchor() |
Begin an area where a menu appears with a right click | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginDisabledState () |
Disables all widgets until EndDisabledState is called. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginGraph() |
Begin a graph widget, call graphing functions between this and EndGraph to include multiple graphs in a single chart | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginHorizontalStack
(
bool bMaximizeContent |
Begins a horizontally stacked container. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginHorizontalWrap
(
bool bMaximizeContent |
Begins a horizontally wrapped container. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginMenuBar () |
Begin a menu bar, similar to those shown at the top of windows. Can be placed anywhere. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginPopUp
(
const FName BorderStyleName, |
Begin a container with a background image. | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginScrollBox
(
const FSlateIMScrollBoxParams& Params |
Begins a container that will allow the user to scroll when its content is larger than the allotted space. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginSubMenu
(
const FString& SubMenuText |
Add a submenu item to the current menu | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginTab
(
const FName& TabId, |
Begins a Tab to contain any other content | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginTabGroup
(
FName TabGroupId |
Begin a tab group, can contain TabStacks and TabSplitters | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginTable
(
const FSlateIMTableParams& Params |
Begin a Table container. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginTableBody() |
Starts a table body. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginTableHeader() |
Starts the header. Call this before adding any content to the table. | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginTableRowChildren
(
const FSlateIMTableRowChildrenParams& Params |
Begin adding content as a child to the current table row. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginTabSplitter
(
TEnumAsByte< EOrientation > Orientation |
Begin a tab splitter, displays child TabSplitters and TabStacks side-by-side | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginTabStack() |
Begin a tab stack, can only contain Tabs | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginVerticalStack
(
bool bMaximizeContent |
Begins a vertically stacked container. | SlateIMBlueprintFunctionLibrary.h |
|
static void BeginVerticalWrap
(
bool bMaximizeContent |
Begins a vertically wrapped container. | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginViewportClientRoot
(
FName UniqueName, |
Begins a new root in the game viewport | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginViewportPlayerRoot
(
FName UniqueName, |
Begins a new root in the provided player's viewport | SlateIMBlueprintFunctionLibrary.h |
|
static bool BeginWindowRoot
(
FName UniqueName, |
Begins a new floating window root | SlateIMBlueprintFunctionLibrary.h |
|
static bool Button
(
const FString& InText, |
Display a button with text | SlateIMBlueprintFunctionLibrary.h |
|
static bool CanUpdateSlateIM() |
SlateIM updates are disabled in specific scenarios (like when a SlateIM::ModalDialog is open), use this function to react accordingly | SlateIMBlueprintFunctionLibrary.h |
|
static bool CheckBox
(
bool& InOutCurrentState, |
Display a two-state checkbox | SlateIMBlueprintFunctionLibrary.h |
|
static bool ComboBox
(
const TArray< FString >& ComboItems, |
Display a dropdown of text options | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawBorder
(
UTexture* BorderTexture, |
Queue drawing a border to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawBox
(
const FVector2D& CanvasPosition, |
Queue drawing an unfilled box to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawIcon
(
const FCanvasIcon& Icon, |
Queue drawing a canvas icon (texture) to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawLine
(
const FVector2D& CanvasPositionA, |
Queue drawing a line to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawMaterial
(
UMaterialInterface* RenderMaterial, |
Queue drawing a material to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawPolygon
(
UTexture* RenderTexture, |
Queue drawing a filled polygon to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawText
(
UFont* RenderFont, |
Queue drawing text to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawTextRenderInfo
(
UFont* RenderFont, |
Queue drawing text to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawTexture
(
UTexture* RenderTexture, |
Queue drawing a texture to the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void DrawWrappedText
(
const UFont* RenderFont, |
Queue drawing wrapped text to canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static bool EditableText
(
FString& InOutText, |
Create a text input field | SlateIMBlueprintFunctionLibrary.h |
|
static void EndBorder() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndCanvas() |
Ends the currently drawn canvas and executes all queued commands. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndContextMenuAnchor() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndDisabledState() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndGraph() |
Call when finished calling graphing functions for the widget | SlateIMBlueprintFunctionLibrary.h |
|
static void EndHorizontalStack() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndHorizontalWrap() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndMenuBar() |
End the menu bar. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndMenuBarEntry() |
Ends a menu bar entry | SlateIMBlueprintFunctionLibrary.h |
|
static void EndPopUp() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndRoot() |
Ends any Root type, must always be called regardless of the result of the Begin function | SlateIMBlueprintFunctionLibrary.h |
|
static void EndScrollBox() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndSubMenu() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndTab() |
Ends the current Tab. This must be called even when BeginTab returns false. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTabGroup() |
Ends the current Tab Group | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTable() |
End the current Table container. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTableBody() |
Ends a table body. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTableHeader() |
Ends the table header. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTableRowChildren () |
Stop adding child content to the parent row. | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTabSplitter() |
Ends the current Tab Splitter | SlateIMBlueprintFunctionLibrary.h |
|
static void EndTabStack() |
Ends the current Tab Stack | SlateIMBlueprintFunctionLibrary.h |
|
static void EndVerticalStack() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void EndVerticalWrap() |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void Fill () |
Sets the next slot to Fill the remaining space in its container | SlateIMBlueprintFunctionLibrary.h |
|
static void FixedTableColumnWidth
(
float Width |
Set the column to a fixed width, not resizable by users. Call this before calling AddTableColumn(). | SlateIMBlueprintFunctionLibrary.h |
|
static float GetKeyAnalogValue
(
const FKey& InKey |
Retrieve the analog value for a key | SlateIMBlueprintFunctionLibrary.h |
|
static void GraphLinePoints
(
const TArray< FVector2D >& Points, |
Add a line graph of 2D vectors to the graph widget | SlateIMBlueprintFunctionLibrary.h |
|
static void GraphLineValues
(
const TArray< double >& Values, |
Add a line graph of values to the graph widget. | SlateIMBlueprintFunctionLibrary.h |
|
static void HAlign
(
EHorizontalAlignment NextAlignment |
Sets the horizontal alignment for the next widget | SlateIMBlueprintFunctionLibrary.h |
|
static void Image
(
UTexture2D* ImageTexture, |
Display a texture | SlateIMBlueprintFunctionLibrary.h |
|
static void ImageBlock
(
const FSlateIMImageParams& Params |
Display a colored box | SlateIMBlueprintFunctionLibrary.h |
|
static void ImageMaterial
(
UMaterialInterface* ImageMaterial, |
Display a material | SlateIMBlueprintFunctionLibrary.h |
|
static void ImageName
(
const FName ImageStyleName, |
Display a slate style brush | SlateIMBlueprintFunctionLibrary.h |
|
static void ImageTexture
(
UTextureRenderTarget2D* ImageRenderTarget, |
Display a render target texture | SlateIMBlueprintFunctionLibrary.h |
|
static void InitialTableColumnWidth
(
float Width |
Set the column to an initial width, which can then be resized by users. | SlateIMBlueprintFunctionLibrary.h |
|
static void Invalidate() |
Invalidate the current canvas, forcing a redraw if its UpdateType is set to Invalidation. | SlateIMBlueprintFunctionLibrary.h |
|
static bool IsFocused
(
ESlateIMFocusDepth Depth |
Query whether the previous widget is focused | SlateIMBlueprintFunctionLibrary.h |
|
static bool IsHovered() |
Query whether the last widget is hovered or not | SlateIMBlueprintFunctionLibrary.h |
|
| Query whether a key is being held this frame. | SlateIMBlueprintFunctionLibrary.h |
|
|
static bool IsKeyPressed
(
const FKey& InKey |
Query whether a key was pressed this frame. | SlateIMBlueprintFunctionLibrary.h |
|
static bool IsKeyReleased
(
const FKey& InKey |
Query whether a key was released this frame. | SlateIMBlueprintFunctionLibrary.h |
|
static void MaxHeight
(
float MaxHeight |
Set the maximum height the next slot can have. | SlateIMBlueprintFunctionLibrary.h |
|
static void Maximize() |
Set the alignments to Fill and removes autosize. | SlateIMBlueprintFunctionLibrary.h |
|
static void MaxWidth
(
float MaxWidth |
Set the maximum width the next slot can have. | SlateIMBlueprintFunctionLibrary.h |
|
static void MinHeight
(
float MinHeight |
Set the minimum height the next slot can have. | SlateIMBlueprintFunctionLibrary.h |
|
static void MinWidth
(
float MinWidth |
Set the minimum width the next slot can have. | SlateIMBlueprintFunctionLibrary.h |
|
static EAppReturnType::Type ModalDialog
(
EAppMsgType::Type MessageType, |
Opens a modal dialog of the specified type. | SlateIMBlueprintFunctionLibrary.h |
|
static bool NextTableCell
(
bool& bOutRowSelected |
Begin the content for the next table cell. | SlateIMBlueprintFunctionLibrary.h |
|
static void NextTableColumn
(
const FName& ColumnID |
Moves to the next column. | SlateIMBlueprintFunctionLibrary.h |
|
static void Padding
(
const FMargin NextPadding |
Sets the padding for the next widget | SlateIMBlueprintFunctionLibrary.h |
|
static void ProgressBar
(
TOptional< float > Percent, |
Display a progress bar | SlateIMBlueprintFunctionLibrary.h |
|
static bool SelectionList
(
const TArray< FString >& ListItems, |
Display a list of text options | SlateIMBlueprintFunctionLibrary.h |
|
static void SetClip
(
const FVector2f& ClipPosition |
Sets the position of the lower-right corner of the clipping region of the canvas | SlateIMBlueprintFunctionLibrary.h |
|
static void SetDrawColor
(
const FColor& Color |
SlateIMBlueprintFunctionLibrary.h |
|
|
static void SetLinearDrawColor
(
const FLinearColor& Color |
Sets the draw color of the canvas. | SlateIMBlueprintFunctionLibrary.h |
|
static void SetToolTip
(
const FString& NextToolTip |
Sets the tooltip to be used for the next widget created. Resets after tooltip is used | SlateIMBlueprintFunctionLibrary.h |
|
static bool Slider
(
float& InOutValue, |
Display a float-based slider | SlateIMBlueprintFunctionLibrary.h |
|
static void Spacer
(
const FVector2D& Size |
Create a block of empty space | SlateIMBlueprintFunctionLibrary.h |
|
static bool SpinBoxDouble
(
double& InOutValue, |
Display a double-based spin box | SlateIMBlueprintFunctionLibrary.h |
|
static bool SpinBoxFloat
(
float& InOutValue, |
Display a float-based spin box | SlateIMBlueprintFunctionLibrary.h |
|
static bool SpinBoxInt32
(
int32& InOutValue, |
Display an int32-based spin box | SlateIMBlueprintFunctionLibrary.h |
|
static void TabSplitterSizeCoefficient
(
float SizeCoefficient |
Assigns the Size Coefficient for the next child of a TabSplitter | SlateIMBlueprintFunctionLibrary.h |
|
static void Text
(
const FString& InText, |
Display a string of text | SlateIMBlueprintFunctionLibrary.h |
|
static void VAlign
(
EVerticalAlignment NextAlignment |
Sets the vertical alignment for the next widget | SlateIMBlueprintFunctionLibrary.h |
|