className: ColorThemes

description: A static holder of the color themes for the entire program

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FColorTheme](API\Runtime\AppFramework\Widgets\Colors\FColorTheme) > > ColorThemes;


className: bSRGBEnabled

description: Whether to use display sRGB color

module: AppFramework

code: static bool bSRGBEnabled = true;


className: CurrentlySelectedThemePtr

description: A static pointer to the color theme that is currently selected for the entire program

code: static [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FColorTheme](API\Runtime\AppFramework\Widgets\Colors\FColorTheme) > CurrentlySelectedThemePtr;


code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Colors\SColorThemesViewer\FArguments) & InArgs )


description: Whether the ability to pick the alpha value is enabled

code: WidgetArgsType & UseAlpha &40; const TAttribute< bool > & InAttribute &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SColorThemesViewer >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FCurrentThemeChangedEvent

description: Callbacks to execute whenever we change the global current theme

code: class FCurrentThemeChangedEvent : public TBaseMulticastDelegate_NoParams< void >


description: Gets the current color theme

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FColorTheme](API\Runtime\AppFramework\Widgets\Colors\FColorTheme) > GetCurrentColorTheme() const


description: Load the color theme settings from the config

code: static void LoadColorThemesFromIni()


code: void MenuToStandardNoReturn()


description: Save the color theme settings to the config

code: static void SaveColorThemesToIni()


description: Sets the UseAlpha attribute

code: void SetUseAlpha ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InUseAlpha )


className: SColorThemesViewer

description: There should only ever be a singleSColorThemesViewer. It is the widget which manages all color themes and displays in a nice list format.

code: class SColorThemesViewer : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Colors\SColorTrash\FArguments) & InArgs )


code: WidgetArgsType & UsesSmallIcon &40; const TAttribute< bool > & InAttribute &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SColorTrash >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetBorderStyle() const


description:
Called during drag and drop when the drag enters a widget.
A reply that indicated whether this event was handled.

code: virtual void OnDragEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description:
Called during drag and drop when the drag leaves a widget.
A reply that indicated whether this event was handled.

code: virtual void OnDragLeave ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description:
Called when the user is dropping something onto a widget; terminates drag and drop.
A reply that indicated whether this event was handled.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


className: SColorTrash

description: TheSColorTrashis a multipurpose widget which allows FColorDragDrops to be dropped on to to be

code: class SColorTrash : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: A pointer to the color this block uses

code: WidgetArgsType & Color &40; const TAttribute< TSharedPtr< FLinearColor > > & InAttribute &41;


description: Construct the widget

code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Colors\SThemeColorBlock\FArguments) & InArgs )


description: The info for the color this block uses

code: WidgetArgsType & ColorInfo &40; const TAttribute< TSharedPtr< FColorInfo > > & InAttribute &41;


description: Callback to pass down to theFColorDragDropfor it to hide the trash

code: WidgetArgsType & HideTrashCallback &40; const FSimpleDelegate & InDelegate &41;


description: Event called when this block is clicked

code: WidgetArgsType & OnSelectColor &40; const FOnLinearColorValueChanged & InDelegate &41;


description: A pointer to the theme color blocks bar that is this block's origin

code: WidgetArgsType & Parent &40; const TAttribute< TSharedPtr< SThemeColorBlocksBar > > & InAttribute &41;


description: Callback to pass down to theFColorDragDropfor it to show the trash

code: WidgetArgsType & ShowTrashCallback &40; const FSimpleDelegate & InDelegate &41;


code: WidgetArgsType & UseAlpha &40; const TAttribute< bool > & InAttribute &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SThemeColorBlock >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: typedef FArguments WidgetArgsType


className: SThemeColorBlock

description: SThemeColorBlocks are Color Blocks which point to a Color in a ColorTheme. They can be dragged and dropped, and clicking on one in the Color Picker will give the color that they point to.

code: class SThemeColorBlock : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Adds a new color block to the Bar

code: void AddNewColorBlock ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) Color, int32 InsertPosition )


description: Whether to display sRGB color

code: WidgetArgsType & UseSRGB &40; const TAttribute< bool > & InAttribute &41;


description: Adds a callback to the Color Theme that this bar has a pointer to.

code: void AddRefreshCallback()


description:
A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user. See StackPanel for an example.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


description: Most panels do not create widgets as part of their implementation, so they do not need to implement aConstruct()

code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Colors\SThemeColorBlocksBar\FArguments) & InArgs )


description: A pointer to the color theme that this bar should display

code: WidgetArgsType & ColorTheme &40; const TAttribute< TSharedPtr< FColorTheme > > & InAttribute &41;


description: Specify what the bar should display when no colors are present

code: WidgetArgsType & EmptyText &40; FText InArg &41;


description: Event called when a color block is clicked


code: struct FArguments : public [TSlateBaseNamedArgs< SThemeColorBlocksBar >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: All widgets must provide a way to access their children in a layout-agnostic way. Panels store their children in Slots, which creates a dilemma. Most panels can store their children in a TPanelChildren, where the Slot class provides layout information about the child it stores. In that case GetChildren should simply return the TPanelChildren.

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()


code: virtual void OnDragEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description: Panels arrange their children in a space described by the AllottedGeometry parameter. The results of the arrangement should be returned by appending aFArrangedWidgetpair for every child widget.

code: virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


code: virtual void OnDragLeave ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description:
Called during drag and drop when the the mouse is being dragged over a widget.
A reply that indicated whether this event was handled.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragOver ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description: Rebuilds the entire bar, regenerating all the constituent color blocks

code: void Refresh()


description: The index of the removed color block, INDEX_NONE if it can't be found

code: int32 RemoveColorBlock ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > ColorToRemove )


description: Refresh Callbacks are used by Color Themes to notify widgets to refresh This removes a callback from the Color Theme that this bar has a pointer to

code: void RemoveRefreshCallback()


code: void SetPlaceholderGrabOffset ( FVector2D GrabOffset )


className: SThemeColorBlocksBar

description: SThemeColorBlocksBars are panels for dragging and dropping SColorThemeBlocks onto and off of.

code: class SThemeColorBlocksBar : public [SPanel](API\Runtime\SlateCore\Widgets\SPanel)


code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Views\SMultipleOptionTable\FArguments) & InArgs, const [TArray](API\Runtime\Core\Containers\TArray)< OptionType > *const InOptions )


code: WidgetArgsType & IsOptionSelected &40; const FIsOptionSelected & InDelegate &41;


code: WidgetArgsType & ListHeight &40; const TAttribute< FOptionalSize > & InAttribute &41;


code: WidgetArgsType & OnGenerateOptionWidget &40; const FOnGenerateOptionWidget & InDelegate &41;


code: WidgetArgsType & OnPostBatchSelect &40; const FOnPostBatchSelect & InDelegate &41;


code: WidgetArgsType & OnOptionSelectionChanged &40; const FOnOptionSelectionChanged & InDelegate &41;


code: WidgetArgsType & OnPreBatchSelect &40; const FOnPreBatchSelect & InDelegate &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SMultipleOptionTable< OptionType > >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FIsOptionSelected

code: typedef TBaseDelegate_OneParam< bool, OptionType > FIsOptionSelected


className: FOnGenerateOptionWidget

code: typedef TSlateDelegates< OptionType >::FOnGenerateWidget FOnGenerateOptionWidget


className: FOnOptionSelectionChanged

code: typedef TBaseDelegate_TwoParams< void, bool, OptionType > FOnOptionSelectionChanged


className: FOnPostBatchSelect

description: This callback will be used after selecting or deselecting all of the options. May be of use for optimization.

code: typedef TBaseDelegate_NoParams< void > FOnPostBatchSelect


className: FOnPreBatchSelect

description: This callback will be used before selecting or deselecting all of the options. May be of use for optimization.

code: typedef TBaseDelegate_NoParams< void > FOnPreBatchSelect


description: Refreshes the list view. Useful if the options array is modified.

code: void RequestTableRefresh()


className: SMultipleOptionTable

code: template<typename OptionType> class SMultipleOptionTable : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Constructs the widget.

code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Views\SOptionTableRow\FArguments) & InArgs )


code: WidgetArgsType & IsChecked &40; const TAttribute< ECheckBoxState > & InAttribute &41;


code: WidgetArgsType & OnCheckStateChanged &40; const FOnCheckStateChanged & InDelegate &41;


code: WidgetArgsType & OnGenerateWidget &40; const FOnGenerateWidget & InDelegate &41;


code: WidgetArgsType & OwnerTableView &40; TSharedPtr< STableViewBase > InArg &41;


code: WidgetArgsType & Option &40; OptionType InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SOptionTableRow >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnGenerateWidget

code: typedef TSlateDelegates< OptionType >::[FOnGenerateWidget](API\Runtime\AppFramework\Widgets\Views\SOptionTableRow\FOnGenerateWidget) FOnGenerateWidget


className: FOptionTableRowArgs

code: typedef [STableRow](API\Runtime\Slate\Widgets\Views\STableRow)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< OptionType > >::[FArguments](API\Runtime\AppFramework\Widgets\Views\SOptionTableRow\FArguments) FOptionTableRowArgs


className: SOptionTableRow

description: Implements a row widget for an option list.

code: template<typename OptionType> class SOptionTableRow : public [SMultiColumnTableRow< TSharedPtr< OptionType > >](API\Runtime\Slate\Widgets\Views\SMultiColumnTableRow)

CheckBox

type: TSharedPtr<SCh...


description:
Generates the widget for the specified column.
The widget.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidgetForColumn ( const [FName](API\Runtime\Core\UObject\FName) & ColumnName )


description: Shows the page with the specified index, but preserves page history.

code: void AdvanceToPage ( int32 PageIndex )


description:
Checks whether the page with the specified index can be shown.
true if the page can be shown, false otherwise.

code: bool CanShowPage ( int32 PageIndex ) const


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


description: Construct this widget.

code: void Construct ( const [FArguments](API\Runtime\AppFramework\Widgets\Workflow\SWizard\FArguments) & InArgs )


description: The button style to use for each breadcrumb if ShowBreadcrumbs is set to true.

code: WidgetArgsType & BreadcrumbButtonStyle &40; const FButtonStyle &42; InArg &41;


description: The text style to use for breadcrumbs if ShowBreadcrumbs is set to true.

code: WidgetArgsType & BreadcrumbTextStyle &40; const FTextBlockStyle &42; InArg &41;


description: The text style used by the buttons.

code: WidgetArgsType & ButtonTextStyle &40; const FTextBlockStyle &42; InArg &41;


description: The button style used by next and back.

code: WidgetArgsType & ButtonStyle &40; const FButtonStyle &42; InArg &41;


description: The button style used by the cancel button.

code: WidgetArgsType & CancelButtonStyle &40; const FButtonStyle &42; InArg &41;


description: Holds a flag indicating whether the 'Finish' button is enabled.

code: WidgetArgsType & CanFinish &40; const TAttribute< bool > & InAttribute &41;


description: Holds the desired size.

code: WidgetArgsType & DesiredSize &40; const TAttribute< FVector2D > & InAttribute &41;


description: The button style used by the finish button.

code: WidgetArgsType & FinishButtonStyle &40; const FButtonStyle &42; InArg &41;


description: Holds the label text of the wizard's 'Finish' button.

code: WidgetArgsType & FinishButtonText &40; const TAttribute< FText > & InAttribute &41;


description: Holds the tool tip text of the wizard's 'Finish' button.

code: WidgetArgsType & FinishButtonToolTip &40; const TAttribute< FText > & InAttribute &41;


description: Holds the index of the initial page to be displayed (0 = default).

code: WidgetArgsType & InitialPageIndex &40; const TAttribute< int32 > & InAttribute &41;


description: Exposes a delegate to be invoked when the wizard is canceled.

code: WidgetArgsType & OnCanceled &40; const FSimpleDelegate & InDelegate &41;


description: Exposes a delegate to be invoked when the wizard is finished.

code: WidgetArgsType & OnFinished &40; const FSimpleDelegate & InDelegate &41;


description: Exposes a delegate to be invoked when the wizard's 'Back' button is clicked. This button is only visible if this delegate is set and only on the first page.

code: WidgetArgsType & OnFirstPageBackClicked &40; const FOnClicked & InDelegate &41;


description: Exposes a delegate to be invoked when the wizard's 'Next' button is clicked. Passes in the current page index and expects the next page index to be returned.

code: WidgetArgsType & OnGetNextPageIndex &40; const FOnGetPageIndex & InDelegate &41;


code: WidgetArgsType & operator&43; &40; FWizardPage::FArguments & ArgumentsForNewSlot &41;


description: Holds an optional widget containing the contents to place above the buttons for all wizard pages

code: NamedSlotProperty< FArguments > PageFooter&40;&41;


description: The text style to use for showing the page title if ShowPageTitle is set to true.

code: WidgetArgsType & PageTitleTextStyle &40; const FTextBlockStyle &42; InArg &41;


description: Holds a flag indicating whether the cancel button should be shown (default = true).

code: WidgetArgsType & ShowCancelButton &40; bool InArg &41;


description: Holds a flag indicating whether a breadcrumb trail should be shown (default = false)

code: WidgetArgsType & ShowBreadcrumbs &40; bool InArg &41;


description: Holds a flag indicating whether the page list should be shown (default = true).

code: WidgetArgsType & ShowPageList &40; bool InArg &41;


description: Holds a flag indicating whether a page title should be shown for each page (default = false)

code: WidgetArgsType & ShowPageTitle &40; bool InArg &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SWizard >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description:
Checks whether the page can be shown.
true if the page can be shown, false otherwise.

code: bool CanShow&40;&41; const


description: Holds the content of the button to be shown in the wizard's page selector.

code: NamedSlotProperty< FArguments > ButtonContent&40;&41;


description: Holds a flag indicating whether this page can be activated (default = true).

code: WidgetArgsType & CanShow &40; const TAttribute< bool > & InAttribute &41;


description: Holds the name of the page to be displayed in the breadcrumb trail.

code: WidgetArgsType & Name &40; const TAttribute< FText > & InAttribute &41;


description: Exposes a delegate to be invoked when this page is being activated.

code: WidgetArgsType & OnEnter &40; const FSimpleDelegate & InDelegate &41;


description: Exposes a delegate to be invoked when this page is being deactivated.

code: WidgetArgsType & OnLeave &40; const FSimpleDelegate & InDelegate &41;


code: FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;


description: Holds the page content.

code: NamedSlotProperty< FArguments > PageContent&40;&41;


code: struct FArguments : public [TSlateBaseNamedArgs< FWizardPage >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description:
Gets the button content.
The button content widget.

code: const TSharedRef< SWidget > & GetButtonContent&40;&41; const


description: Gets the display name of the page.

code: FText GetName&40;&41; const


description:
Gets the page content.
The page contents.

code: const TSharedRef< SWidget > & GetPageContent&40;&41; const


description:
Gets a delegate to be invoked when this page is being entered.
The delegate.

code: FSimpleDelegate & OnEnter&40;&41;


description:
Gets a delegate to be invoked when this page is being left.
The delegate.

code: FSimpleDelegate & OnLeave&40;&41;


description:
Get the index of the current page.
The index of the current page.

code: int32 GetCurrentPageIndex() const


description: Creates and initializes a new instance.

code: FWizardPage &40; const FArguments & InArgs &41;


className: FWizardPage

description: Implements a wizard page.

code: class FWizardPage


description:
Gets the number of pages that this wizard contains.
The number of pages.

code: int32 GetNumPages() const


description:
Gets the index of the specified wizard page widget.
The index of the page, or INDEX_NONE if not found.

code: int32 GetPageIndex ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & PageWidget ) const


description:
Returns a new slot for a page.
A new slot.


description: Attempts to show the page with the specified index.

code: void ShowPage ( int32 PageIndex )


className: SWizard

description: Implements a wizard widget.

code: class SWizard : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


module: ApplicationCore

code: FAccessibleEventArgs ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > InWidget, EAccessibleEvent InEvent, [FVariant](API\Runtime\Core\Misc\FVariant) InOldValue, [FVariant](API\Runtime\Core\Misc\FVariant) InNewValue, FAccessibleUserIndex InUserIndex )


description:
Subclasses should return true to indicate that they support accessibility.
true if the application intends to return valid accessible widgets when queried.

code: bool ApplicationIsAccessible() const


className: FAccessibleEvent

description: A delegate accessible event handlers such as platform accessibility APIs can listen for accessibility events raised by widgets. .

code: typedef TBaseDelegate_OneParam< void, const [FAccessibleEventArgs](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FAccessibleEventArgs) & > FAccessibleEvent


description: Retrieves the accessible user registry. This is the means of retrieving, registering and interacting with accessible useres in the rest of the application.


code: const [FGenericAccessibleUserRegistry](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessib-_1) & GetAccessibleUserRegistry() const


description:
Retrieves an accessible widget that matches the given identifier.
The widget that matches this identifier, or nullptr if the widget does not exist.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetAccessibleWidgetFromId ( AccessibleWidgetId Id ) const


description:
Creates or retrieves an accessible object for a native OS window. todo: Behavior for non-native windows (virtual or others) is currently undefined.
The accessible object corresponding to the supplied native window

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetAccessibleWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & InWindow ) const


description:
Checks if accessibility is enabled in the application. Usually this happens when screen-reading software is turned on. Note: On some platforms, there is no way to deactivate this after enabling it.
The last valueSetActive()was called with.

code: bool IsActive() const


className: FAccessibleEventArgs

description: FGenericAccessibleMessageHandler::RaiseEvent

code: struct FAccessibleEventArgs

Event

type: EAccessibleEven...

description: The type of event generated

NewValue

type: FVariant

description: If this was a property changed event, the 'after' value.

OldValue

description: If this was a property changed event, the 'before' value

UserIndex

type: FAccessibleUser...

description: The Id of the user this event is intended for.

Widget

type: TSharedRef<IAc...

description: The accessible widget that generated the event


description: Request a string to be announced to the user. Note: Currently only supported on Win10, Mac, iOS. If requests are made too close together, earlier announcement requests will get stomped by later announcements on certain platforms.

code: virtual void MakeAccessibleAnnouncement ( const [FString](API\Runtime\Core\Containers\FString) & AnnouncementString )


description: Triggered when bIsActive changes from false to true.

code: virtual void OnActivate()


description:
Creates or retrieves the identifier for an accessible object for a native OS window. todo: Behavior for non-native windows (virtual or others) is currently undefined.
The identifier for the accessible window created

code: virtual AccessibleWidgetId GetAccessibleWindowId ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & InWindow ) const


description: Triggered when bIsActive changes from true to false.

code: virtual void OnDeactivate()


description: Request a function to be run in a particular thread. Primarily used to service accessibility requests from the OS thread about accessible Slate widget data in the game thread.

code: virtual void RunInThread ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> & Function, bool bWaitForCompletion, [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) Thread )


description: FAccessibleEventArgs

code: void RaiseEvent ( const [FAccessibleEventArgs](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FAccessibleEventArgs) & Args )


description: Assign a function to be called whenever an accessible event is raised.

code: void SetAccessibleEventDelegate ( const [FAccessibleEvent](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessib-\FAccessibleEvent) & Delegate )


description: Sets a new accessible user registry for the application. Note: As of now, none of the registered users will carry over to the new accessible user manager. It is up to the caller to unregister all currently registered users and register them with the new accessible user registry. .

code: void SetAccessibleUserRegistry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericAccessibleUserRegistry](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessib-_1) > & InAccessibleUserRegistry )


description: Notify the application to start or stop processing accessible messages from the platform layer.

code: void SetActive ( bool bActive )


description: Unbinds the delegate called during accessible events if it is bound.

code: void UnbindAccessibleEventDelegate()


code: FGenericAccessibleMessageHandler()


className: FGenericAccessibleMessageHandler

description: Callers should also useGetAccessibleUserRegistry()to register and interact with accessible users. Accessible users must be registered with the set accessible user registry for the rest of the application to be able to retrieve and interact with the accessible users.

code: class FGenericAccessibleMessageHandler

bApplicationIsAccessible

type: bool

description: Subclasses should override this to indicate that they support accessibility.


description: Returns an array of all accessible users that are currently registered with the accessible registry.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericAccessibleUser](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessibleUser) > > GetAllUsers() const


description: Returns the number of accessible users registered with the accessible user registry.

code: int32 GetNumberofUsers() const


description: Returns the index of the primary accessible user. The primary accessible user should correspond to the default input source that every application should have. This user should also be the primary cursor user. E.g On desktop platforms, that would correspond to the keyboard user.


description: Returns the accessible user associated with the passed in user index. If the passed in user index is not associated with any accessible user, nullptr is returned.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericAccessibleUser](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessibleUser) > GetUser ( const FAccessibleUserIndex UserIndex ) const


description: Returns true if the passed in user index is associated with a registered accessible user. Else, returns false.

code: bool IsUserRegistered ( const FAccessibleUserIndex UserIndex ) const


description:
Registers an accessible user with the accessible registry. It is up to the caller to ensure that the passed in user has the correct user index. The passed in user will not be registered if another user with the same user index has already been registered. This function callsFGenericAccessibleUser::OnRegisteredif the passed in user is successfully registered. Once an accessible user has been successfully registered, it can be retrieved and interacted with by the rest of the application.
True if the passed in user was successfully registered. Else, returns false.

code: bool RegisterUser ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericAccessibleUser](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessibleUser) > & User )


description: Unregisters all accessible users from the accessible registry. This function callsFGenericAccessibleUser::OnUnregisteredwhen each registered user is successfully unregistered.

code: void UnregisterAllUsers()


description:
Unregisters an accessible user from the accessible registry. If the passed in user index is not associated with a registered accessible user, nothing will happen. This function callsFGenericAccessibleUser::OnUnregisteredif the passed in user is successfully unregistered. Once an accessible user has been unregistered, the rest of the application should have no way of retrieving or interacting with the accessible user.
True if the accessible user with the associated user index is successfully unregistered. Else, returns false.

code: bool UnregisterUser ( const FAccessibleUserIndex UserIndex )


className: FGenericAccessibleUserRegistry

description: FGenericAccessibleMessageHandler

code: class FGenericAccessibleUserRegistry

UsersMap

type: TMap< FAccessib...

description: A map of accessible user indices to their associated accessible users.


description: Clear the accessible focused widget.

code: void ClearFocusedAccessibleWidget()


description: IAccessibleWidget


description: Returns the unique index that identifies this accessible user.

code: FAccessibleUserIndex GetIndex() const


description: FGenericAccessibleUserRegistry

code: virtual void OnRegistered()


description: FGenericAccessibleUserRegistry

code: virtual void OnUnregistered()


description:
Note: This function is meant to directly set the widget an accessible user is focused on, bypassing all of the focus change accessible events. This should only be used byFGenericAccessibleMessageHandlerand its subclasses to update the the accessible focus for an accessible user. Most of the time, you want to useIAccessibleWidget::SetUserFocusto request an accessible widget be focused on by a user. It raises the appropriate accessible events so listeners for accessible events can do the appropriate event handling for the focus change event.
True if the passed in widget was successfully set. Else returns false.

code: bool SetFocusedAccessibleWidget ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & InWidget )


code: FGenericAccessibleUser ( const FAccessibleUserIndex InUserIndex )


code: virtual ~FGenericAccessibleUser()


description: Trigger the widget

code: void Activate()


className: FGenericAccessibleUser

description: FGenericAccessibleUserRegistry

code: class FGenericAccessibleUser


description:
IfIsCheckable()is true, this gets the current state that the widget is in. //todo: return ECheckState
true if the current state is considered "on" or "checked"

code: virtual bool GetCheckedState() const


description:
Check whether this widget can be toggled between various check states
true if this widget supports being in different states

code: virtual bool IsCheckable() const


className: IAccessibleActivatable

description: A widget that can be triggered to fire an event, such as buttons or checkboxes.

code: class IAccessibleActivatable


description:
The maximum allowed value for this property. This should only be used if GetStepSize is not 0.
The maximum value that this property can be assigned when using step sizes.

code: virtual float GetMaximum() const


description:
The minimum allowed value for this property. This should only be used if GetStepSize is not 0.
The minimum value that this property can be assigned when using step sizes.

code: virtual float GetMinimum() const


description:
How much the value should increase/decrease when the user attempts to modify the value using UI controls. Note: This should always return a positive value. The caller is responsible for negating it when attempting to decrease.
A number suggesting how much to modifyGetValue()by when the user wants to increase/decrease the value.

code: virtual float GetStepSize() const


description:
The current value stored by the widget as aFVariant. Used on platforms where the type of the value is important for accessibility methods such as on Mac. .
AnFVariantthat holds the widget's current value and type of value.

code: virtual [FVariant](API\Runtime\Core\Misc\FVariant) GetValueAsVariant() const


description:
The current value stored by the widget. Even if the underlying value is not a String, it should be serialized to one in order to match the return type.
A string representing the serialized value stored in the widget.


description:
Check if this text is storing password data, indicating that it may need special handling to presenting itself to the user.
true if the text is storing a password or otherwise senstive data that should be hidden.

code: virtual bool IsPassword() const


description:
Whether the widget is in read-only mode, which could be different than IsEnabled().
true if the widget is in read-only mode.

code: virtual bool IsReadOnly() const


description: Set the value stored by the widget. While this function accepts a String, there is no way to know what the underlying data is stored as. The platform layer must retain some additional information about what kind of widget this is, and ensure it's being called with valid arguments.

code: virtual void SetValue ( const [FString](API\Runtime\Core\Containers\FString) & Value )


className: IAccessibleProperty

description: An accessible widget that stores an arbitrary value of any type capable of being serialized into a string. Optional overrides add support for slider-like functionality.

code: class IAccessibleProperty


description:
Check if the table can select more than one element at a time.
True if the table can support selection for more than one element at a time. Else false.

code: virtual bool CanSupportMultiSelection() const


description:
Get all of the elements that are selected in the table.
All the items selected in this table. Returns an empty array if nothing is selected.

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > > GetSelectedItems() const


description:
Checks if the table must have an element selected at all times.
True if an element of the table must be selected at all times, else false

code: virtual bool IsSelectionRequired() const


className: IAccessibleTable

description: A widget that represents a table such as list views, tile views or tree views Data about the items that are selected in the table or if selection is supported can be queried.

code: class IAccessibleTable


description: Adds this table row to the list of selected items in the owning table

code: virtual void AddToSelection()


description:
Get the accessible table that owns this accessible table row. NOTE: This should always return a valid pointer in concrete classes. An accessible table row must ALWAYS have an accessible table as an owner.
The owning table

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetOwningTable() const


description: Removes this table row from the list of selected items in the owning table

code: virtual void RemoveFromSelection()


description:
Checks if this table row is currently selected in the owning table.
True if this table row is currently selected in the owning table. Else false

code: virtual bool IsSelected() const


description: Selects this table row in the owning table.

code: virtual void Select()


className: IAccessibleTableRow

description: A widget that is an element in an accessible table. These widgets can be interacted with by selecting them or querying them for the owning table. NOTE: All accessible table rows must have an accessible table as an owner

code: class IAccessibleTableRow


description:
Get the full text contained in this widget, even if some if it is clipped.
All the text held by this widget.

code: const [FString](API\Runtime\Core\Containers\FString) & GetText() const


className: IAccessibleText

description: A widget that contains text, with the potential ability to select sections, read specific words/paragraphs, etc. Note: This class is currently incomplete.

code: class IAccessibleText


description: Attempt to cast this to anIAccessibleActivatable'this' as anIAccessibleActivatableif possible, otherwise nullptr


description: Attempt to cast this to anIAccessibleProperty'this' as anIAccessiblePropertyif possible, otherwise nullptr


description: Attempt to cast this to anIAccessibleTable'this' as anIAccessibleTableif possible, otherwise nullptr

code: virtual [IAccessibleTable](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleTable) * AsTable()


description: Attempt to cast this to anIAccessibleTableRow'this' as anIAccessibleTableRowif possible, otherwise nullptr


description: Attempt to cast this to anIAccessibleText'this' as anIAccessibleTextif possible, otherwise nullptr

code: virtual [IAccessibleText](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleText) * AsText()


description: Attempt to cast this to anIAccessibleWindow'this' as anIAccessibleWindowif possible, otherwise nullptr

code: virtual [IAccessibleWindow](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWindow) * AsWindow()


description:
Whether the widget can currently support accessible focus.
true if the widget can currently receive accessible focus. Else, returns false.


description:
Retrieving the bounding rect in absolute coordinates for this widget. On some platforms this may be used for hit testing.
The bounds of the widget.

code: FBox2D GetBounds() const


description:
Retrieves the accessible child widget at a certain index. This should return nullptr ifIndex< 0 orIndex>=GetNumberOfChildren().
The accessible child widget at the specified index.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetChildAt ( int32 Index )


description:
The name of the underlying class that this accessible widget represents.
The class name of the underlying widget.


description:
Additional information a user may need in order to effectively interact or use the widget, such as a tooltip.
A more-detailed description of what the widget is or how its used.


description:
Get an application-unique identifier for this widget. If the widget is destroyed, a different widget is allowed to re-use that ID.
A unique ID that specifically refers to this widget.

code: AccessibleWidgetId GetId() const


description:
Retrieves the widget after this one in the parent's list of children. This should return nullptr for the last widget.
The next widget on the same level of the UI hierarchy.


description:
If the current widget has no next sibling, search for the first ancestor from the current widget with a next sibling. Return that ancestor's next sibling.
The logical next widget in the accessible widget hierarchy.


description:
How many accessible children this widget has.
The number of accessible children that exist for this widget.

code: int32 GetNumberOfChildren()


description:
Get the accessible parent of this widget. This may be nullptr if this widget is a window, or if the widget is currently disconnected from the UI tree.
The accessible parent widget of this widget.


description:
Retrieves the widget before this one in the parent's list of children. This should return nullptr for the first widget.
The previous widget on the same level of the UI hierarchy.


description:
If the current widget has no previous sibling, we return the parent of the current widget.
The logical previous widget in the accessible widget hierarchy.


description:
The name of the widget to report to the platform layer. For screen readers, this is often the text that will be spoken.
Ideally, a human-readable name that represents what the widget does.


description:
What type of accessible widget the underlying widget should be treated as. A widget may be capable of presenting itself as multiple different types of widgets, but only one can be reported back to the platform.
Which type of widget the platform layer should treat this as.


description:
Returns the window at the top of this widget's hierarchy. This function may return itself for accessible windows, and could return nullptr in cases where the widget is not currently part of a hierarchy.
The root window in this widget's widget tree, or nullptr if there is no window.


description:
Whether the widget has accessible focus or not by a particular user .
true if the widget currently has accessible focus by the user. Else, returns false.

code: bool HasUserFocus ( const FAccessibleUserIndex UserIndex ) const


className: InvalidAccessibleWidgetId

code: static const AccessibleWidgetId InvalidAccessibleWidgetId = -1;


description:
Whether the widget is enabled and can be interacted with.
true if the widget is enabled.

code: bool IsEnabled() const


description:
Whether the widget is being rendered on screen or not.
true if the widget is hidden off screen, collapsed, or something similar.

code: bool IsHidden() const


description:
Whether or not the underlying widget backing this interface still exists
true if functions can be called on this interface and should return valid results

code: bool IsValid() const


description:
Returns the first instance of an ancestor from a source widget that satisfies a search criteria. If the passed in source widget does not have any ancestors or if there are no ancestors that satisfy the search criteria, nullptr is returned. The search criteria can be either a functor or lambda that acts as a predicate. It must return a bool and take in a constTSharedRef& as an argument.
The first instance of an ancestor from the source widget that satisfies the search criteria.

code: template<typename PredicateType> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > SearchForAncestorFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source, PredicateType Predicate )


description:
Returns the first instance of a child from a source widget that satisfies a search criteria. If the passed in source widget does not have any children or if there are no children that satisfy the search criteria, nullptr is returned. The search criteria can be either a functor or lambda that acts as a predicate. It must return a bool and take in a constTSharedRef& as an argument.
The first child from the source widget that satisfies the search criteria.

code: template<typename PredicateType> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > SearchForFirstChildFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source, PredicateType Predicate )


description:
Returns the first instance of a next sibling from a source widget that satisfies a search criteria. If the passed in source widget does not have any next siblings or if there are no next siblings that satisfy the search criteria, nullptr is returned. The search criteria can be either a functor or lambda that acts as a predicate. It must return a bool and take in a constTSharedRef& as an argument.
The first instance of a next sibling from the source widget that satisfies the search criteria.

code: template<typename PredicateType> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > SearchForNextSiblingFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source, PredicateType Predicate )


description:
Returns the first instance of a next widget in the accessible hierarchy from a source widget that satisfies a search criteria. If the passed in source widget does not have any next widgets or if there are no next widgets that satisfy the search criteria, nullptr is returned. The search criteria can be either a functor or lambda that acts as a predicate. It must return a bool and take in a constTSharedRef& as an argument.
The first instance of a next widget from the source widget that satisfies the search criteria.

code: template<typename PredicateType> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > SearchForNextWidgetInHierarchyFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source, PredicateType Predicate )


description:
Returns the first instance of a previous sibling from a source widget that satisfies a search criteria. If the passed in source widget does not have any previous siblings or if there are no previous siblings that satisfy the search criteria, nullptr is returned. The search criteria can be either a functor or lambda that acts as a predicate. It must return a bool and take in a constTSharedRef& as an argument.
The first instance of a previous sibling from the source widget that satisfies the search criteria.

code: template<typename PredicateType> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > SearchForPreviousSiblingFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source, PredicateType Predicate )


description:
Returns the first instance of a previous widget in the accessible hierarchy from a source widget that satisfies a search criteria. If the passed in source widget does not have any previous widgets or if there are no previous widgets that satisfy the search criteria, nullptr is returned. The search criteria can be either a functor or lambda that acts as a predicate. It must return a bool and take in a constTSharedRef& as an argument.
The first instance of a previous widget from the source widget that satisfies the search criteria.

code: template<typename PredicateType> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > SearchForPreviousWidgetInHierarchyFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source, PredicateType Predicate )


description:
Assign accessible focus to the widget. Also sets keyboard/gamepad focus if the widget supports it.
True if focus was successfully set to this widget for the requested user. Else false.

code: bool SetUserFocus ( const FAccessibleUserIndex UserIndex )


description:
Whether the widget can ever support accessible focus.
true if the widget can ever receive accessible focus. Else, returns false.

code: bool SupportsAccessibleFocus() const


description:
Whether the widget can ever support keyboard/gamepad focus.
true if the widget can ever receive keyboard/gamepad focus. Else, returns false.

code: bool SupportsFocus() const


description: Returns a string representation of this widget. Primarily used for debugging.

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


code: virtual ~IAccessibleWidget()


description: Request that the window closes itself. This may not happen immediately.

code: void Close()


className: IAccessibleWidget

description: Provides the core set of accessible data that is necessary in order for widget traversal and TTS to be implemented. In order to support functionality beyond this, subclasses must implement the other accessible interfaces and then override the As*() functions.

code: class IAccessibleWidget : public [TSharedFromThis< IAccessibleWidget >](API\Runtime\Core\Templates\TSharedFromThis)


description:
Finds the deepest accessible widget in the hierarchy at the specified coordinates. The window may return a pointer to itself in the case where there are no accessible children at the position. This could return nullptr in the case where the coordinates are outside the window bounds.
The deepest widget in the UI heirarchy at X,Y

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetChildAtPosition ( int32 X, int32 Y )


className: EWindowDisplayState

description: The different states a window can be in to describe its screen anchors

code: enum EWindowDisplayState { Normal, Minimize, Maximize, }


description:
Gets the current state minimize/maximize state of the window.
The display state corresponding to how the window is displayed.


description:
Retrieve the native OS window backing this accessible window. This can be safely casted if you know what OS you're in (ie FWindowsWindows on Windows platform).
The native window causing this accessible window to exist

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > GetNativeWindow() const


description:
Retrieves the focused accessible widget for a user. If the passed in user index is not registered with an accessible user registry, nullptr will be returned.
The accessible widget that is focused by the accessible user. Returns nullptr if the accessible user index does not correspond to a registered accessible user.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetUserFocusedWidget ( const FAccessibleUserIndex UserIndex ) const


description:
Whether or not the window is modal.
true if the window is modal, otherwise false.

code: bool IsModal() const


description: Sets a window to be minimized, maximized, or restored to normal.

code: void SetDisplayState ( [EWindowDisplayState](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWindow\EWindowDisplaySt-) State )


description:
Check if the window can be minimized or maximized.
True if the display state can be switched to, otherwise false.

code: bool SupportsDisplayState ( [EWindowDisplayState](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWindow\EWindowDisplaySt-) State ) const


className: IAccessibleWindow

description: An accessible window corresponds to a native OS window. Fake windows that are embedded within other widgets that simply look and feel like windows are not IAccessibleWindows.

code: class IAccessibleWindow


code: namespace EDropEffect { enum Type { None = 0, Copy = 1, Move = 2, Link = 3, } }


code: namespace EModifierKey { [EModifierKey::Type](API\Runtime\ApplicationCore\GenericPlatform\Type) EModifierKey::FromBools ( const bool bControl, const bool bAlt, const bool bShift, const bool bCommand ) }


code: namespace EMouseButtons { enum Type { Left = 0, Middle, Right, Thumb01, Thumb02, Invalid, } }


description: Mouse cursor types

code: namespace EMouseCursor { enum Type { None, Default, TextEditBeam, ResizeLeftRight, ResizeUpDown, ResizeSouthEast, ResizeSouthWest, CardinalCross, Crosshairs, Hand, GrabHand, GrabHandClosed, SlashedCircle, EyeDropper, Custom, TotalCursorCount, } }


code: namespace EPopUpOrientation { enum Type { Horizontal, Vertical, } }


code: namespace EWindowAction { enum Type { ClickedNonClientArea = 1, Maximize = 2, Restore = 3, WindowMenu = 4, } }


code: namespace EWindowMode { static [Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowMode__Type) EWindowMode::ConvertIntToWindowMode ( int32 InWindowMode ) }


description: Modes that anFGenericWindowcan be in

code: namespace EWindowMode { enum Type { Fullscreen, WindowedFullscreen, Windowed, NumWindowModes, } }


description: Enumerates available horizontal alignments for window title bars.

code: namespace EWindowTitleAlignment { enum Type { Left, Center, Right, } }


description: The Window Zone is the window area we are currently over to send back to the operating system for operating system compliance.

code: namespace EWindowZone { enum Type { NotInWindow = 0, TopLeftBorder = 1, TopBorder = 2, TopRightBorder = 3, LeftBorder = 4, ClientArea = 5, RightBorder = 6, BottomLeftBorder = 7, BottomBorder = 8, BottomRightBorder = 9, TitleBar = 10, MinimizeButton = 11, MaximizeButton = 12, CloseButton = 13, SysMenu = 14, Unspecified = 0, } }


description: Apply the debug/default safe zones.

code: void ApplyDefaultSafeZones()


description: The action safe zone ratio that will be returned byFDisplayMetrics::GetDisplayMetricson platforms that don't have a defined safe zone.


description: The title safe zone ratio that will be returned byFDisplayMetrics::GetDisplayMetricson platforms that don't have a defined safe zone.


description: Deprecated* Please use RebuildDisplayMetrics - it is functionally the same but is clearer about the function cost

code: static void GetDisplayMetrics ( struct [FDisplayMetrics](API\Runtime\ApplicationCore\GenericPlatform\FDisplayMetrics) & OutDisplayMetrics )


description: Gets the monitor work area from a position in the global display rect

code: [FPlatformRect](API\Runtime\ApplicationCore\GenericPlatform\FPlatformRect) GetMonitorWorkAreaFromPoint ( const FVector2D & Point ) const


description: Logs out display metrics

code: void PrintToLog() const


code: static void RebuildDisplayMetrics ( struct [FDisplayMetrics](API\Runtime\ApplicationCore\GenericPlatform\FDisplayMetrics) & OutDisplayMetrics )


className: FDisplayMetrics

description: Contains metrics information for the desktop area

code: struct FDisplayMetrics

ActionSafePaddingSize

description: The safe area for less important spill over on TVs (see TitleSafePaddingSize)

MonitorInfo

type: TArray<FMonito...

description: Info on connected physical monitors.

PrimaryDisplayHeight

description: Height of the primary display in pixels

PrimaryDisplayWidth

description: Width of the primary display in pixels

PrimaryDisplayWorkAreaRect

type: FPlatformRect

description: Area of the primary display not covered by task bars or other docked widgets

TitleSafePaddingSize

description: The safe area for all content on TVs (seehttp://en.wikipedia.org/wiki/Safe_area_%28television%29) - content will be inset Left - X Top - Y Right - Z Bottom - W

VirtualDisplayRect

description: Virtual display coordinate range (includes all active displays)


className: DPadDown

code: static const [FName](API\Runtime\Core\UObject\FName) DPadDown;


className: FForceFeedbackValues

code: struct FForceFeedbackValues

LeftLarge

type: float


className: DPadLeft

code: static const [FName](API\Runtime\Core\UObject\FName) DPadLeft;


className: DPadUp

code: static const [FName](API\Runtime\Core\UObject\FName) DPadUp;


className: DPadRight

code: static const [FName](API\Runtime\Core\UObject\FName) DPadRight;


className: FaceButtonBottom

code: static const [FName](API\Runtime\Core\UObject\FName) FaceButtonBottom;


className: FaceButtonLeft

code: static const [FName](API\Runtime\Core\UObject\FName) FaceButtonLeft;


className: FaceButtonRight

code: static const [FName](API\Runtime\Core\UObject\FName) FaceButtonRight;


className: FaceButtonTop

code: static const [FName](API\Runtime\Core\UObject\FName) FaceButtonTop;


className: Invalid

code: static const [FName](API\Runtime\Core\UObject\FName) Invalid;


className: LeftAnalogY

code: static const [FName](API\Runtime\Core\UObject\FName) LeftAnalogY;


className: LeftAnalogX

code: static const [FName](API\Runtime\Core\UObject\FName) LeftAnalogX;


className: LeftShoulder

code: static const [FName](API\Runtime\Core\UObject\FName) LeftShoulder;


className: LeftStickDown

code: static const [FName](API\Runtime\Core\UObject\FName) LeftStickDown;


className: LeftStickRight

code: static const [FName](API\Runtime\Core\UObject\FName) LeftStickRight;


className: LeftStickLeft

code: static const [FName](API\Runtime\Core\UObject\FName) LeftStickLeft;


className: LeftStickUp

code: static const [FName](API\Runtime\Core\UObject\FName) LeftStickUp;


className: LeftThumb

code: static const [FName](API\Runtime\Core\UObject\FName) LeftThumb;


className: LeftTriggerAnalog

code: static const [FName](API\Runtime\Core\UObject\FName) LeftTriggerAnalog;


className: LeftTriggerThreshold

code: static const [FName](API\Runtime\Core\UObject\FName) LeftTriggerThreshold;


className: RightAnalogX

code: static const [FName](API\Runtime\Core\UObject\FName) RightAnalogX;


className: RightAnalogY

code: static const [FName](API\Runtime\Core\UObject\FName) RightAnalogY;


className: RightStickDown

code: static const [FName](API\Runtime\Core\UObject\FName) RightStickDown;


className: RightShoulder

code: static const [FName](API\Runtime\Core\UObject\FName) RightShoulder;


className: RightStickLeft

code: static const [FName](API\Runtime\Core\UObject\FName) RightStickLeft;


className: RightStickRight

code: static const [FName](API\Runtime\Core\UObject\FName) RightStickRight;


className: RightStickUp

code: static const [FName](API\Runtime\Core\UObject\FName) RightStickUp;


className: RightThumb

code: static const [FName](API\Runtime\Core\UObject\FName) RightThumb;


className: RightTriggerAnalog

code: static const [FName](API\Runtime\Core\UObject\FName) RightTriggerAnalog;


className: RightTriggerThreshold

code: static const [FName](API\Runtime\Core\UObject\FName) RightTriggerThreshold;


className: SpecialLeft

code: static const [FName](API\Runtime\Core\UObject\FName) SpecialLeft;


code: static const [FName](API\Runtime\Core\UObject\FName) SpecialLeft_X;


code: static const [FName](API\Runtime\Core\UObject\FName) SpecialLeft_Y;


className: SpecialRight

code: static const [FName](API\Runtime\Core\UObject\FName) SpecialRight;


className: FGamepadKeyNames

code: struct FGamepadKeyNames


code: virtual bool BeginReshapingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void FinishedReshapingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual [FWindowSizeLimits](API\Runtime\ApplicationCore\GenericPlatform\FWindowSizeLimits) GetSizeLimitsForWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window ) const


code: virtual [EWindowZone::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowZone__Type) GetWindowZoneForPoint ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const int32 X, const int32 Y )


code: virtual bool OnApplicationActivationChanged ( const bool IsActive )


code: virtual void HandleDPIScaleChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void OnBeginGesture()


description: Deprecate these when engine code has been converted to handle platform user id

code: virtual bool OnControllerAnalog ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, int32 ControllerId, float AnalogValue )


code: virtual bool OnControllerAnalog ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId, float AnalogValue )


description: Deprecated* This version of OnControllerButtonPressed has been deprecated, please use the one that takes an FPlatformUser andFInputDeviceIdinstead.

code: virtual bool OnControllerButtonPressed ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, int32 ControllerId, bool IsRepeat )


code: virtual bool OnControllerButtonPressed ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId, bool IsRepeat )


description: Deprecated* This version of OnControllerButtonReleased has been deprecated, please use the one that takes an FPlatformUser andFInputDeviceIdinstead.

code: virtual bool OnControllerButtonReleased ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, int32 ControllerId, bool IsRepeat )


code: virtual bool OnControllerButtonReleased ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId, bool IsRepeat )


code: virtual bool OnCursorSet()


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragDrop ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragEnterExternal ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [FString](API\Runtime\Core\Containers\FString) & Text, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Files )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragEnterFiles ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Files )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragEnterText ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [FString](API\Runtime\Core\Containers\FString) & Text )


code: virtual void OnDragLeave ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragOver ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void OnEndGesture()


code: virtual void OnInputLanguageChanged()


code: virtual bool OnKeyChar ( const TCHAR Character, const bool IsRepeat )


code: virtual bool OnKeyDown ( const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat )


code: virtual bool OnKeyUp ( const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat )


code: virtual bool OnMotionDetected ( const FVector & Tilt, const FVector & RotationRate, const FVector & Gravity, const FVector & Acceleration, int32 ControllerId )


code: virtual bool OnMouseDoubleClick ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button )


code: virtual bool OnMotionDetected ( const FVector & Tilt, const FVector & RotationRate, const FVector & Gravity, const FVector & Acceleration, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId )


code: virtual bool OnMouseDoubleClick ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button, const FVector2D CursorPos )


code: virtual bool OnMouseDown ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button )


code: virtual bool OnMouseDown ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button, const FVector2D CursorPos )


code: virtual bool OnMouseMove()


code: virtual bool OnMouseUp ( const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button )


code: virtual bool OnMouseUp ( const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button, const FVector2D CursorPos )


code: virtual bool OnMouseWheel ( const float Delta )


code: virtual bool OnMouseWheel ( const float Delta, const FVector2D CursorPos )


code: virtual void OnOSPaint ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void OnMovedWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const int32 X, const int32 Y )


code: virtual bool OnRawMouseMove ( const int32 X, const int32 Y )


code: virtual bool OnSizeChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const int32 Width, const int32 Height, bool bWasMinimized )


code: virtual bool OnTouchEnded ( const FVector2D & Location, int32 TouchIndex, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) DeviceID )


code: virtual void OnResizingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual bool OnTouchEnded ( const FVector2D & Location, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchFirstMove ( const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchFirstMove ( const FVector2D & Location, float Force, int32 TouchIndex, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) DeviceID )


code: virtual bool OnTouchForceChanged ( const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchForceChanged ( const FVector2D & Location, float Force, int32 TouchIndex, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) DeviceID )


code: virtual bool OnTouchGesture ( EGestureEvent GestureType, const FVector2D & Delta, float WheelDelta, bool bIsDirectionInvertedFromDevice )


code: virtual bool OnTouchMoved ( const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchMoved ( const FVector2D & Location, float Force, int32 TouchIndex, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) DeviceID )


code: virtual bool OnTouchStarted ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchStarted ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const FVector2D & Location, float Force, int32 TouchIndex, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) DeviceId )


code: virtual bool OnWindowAction ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EWindowAction::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowAction__Type) InActionType )


code: virtual bool OnWindowActivationChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const EWindowActivation ActivationType )


code: virtual void OnWindowClose ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void SetCursorPos ( const FVector2D & MouseCoordinate )


code: virtual bool ShouldProcessUserInputMessages ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & PlatformWindow ) const


code: virtual void ShouldSimulateGesture ( EGestureEvent Gesture, bool bEnable )


code: virtual void SignalSystemDPIChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


description: Return true if this message handler expects FPlatformUserIds. This base class will convert both directions. As part of a larger fixup to allow mapping of multiple input devices to the same player, physical device id will be passed as part of the InputScope above and used to compute a logical input user.

code: virtual bool ShouldUsePlatformUserId() const


className: FGenericApplicationMessageHandler

description: Interface that defines how to handle interaction with a user via hardware input and output

code: class FGenericApplicationMessageHandler


description: UE expects mouse coordinates in screen space. Some platforms provides in client space. Return true to anchor the window at the top/left corner to make sure client space coordinates and screen space coordinates match up.


className: CachedPhysicalScreenData

code: static bool CachedPhysicalScreenData = false;


className: CachedPhysicalScreenAccuracy

code: static EScreenPhysicalAccuracy CachedPhysicalScreenAccuracy = EScreenPhysicalAccuracy::Unknown;


className: CachedPhysicalScreenDensity

code: static int32 CachedPhysicalScreenDensity = 0;


description: Pastes in text from the operating system clipboard.

code: static void ClipboardPaste ( class [FString](API\Runtime\Core\Containers\FString) & Dest )


description: Copies text to the operating system clipboard.

code: static void ClipboardCopy ( const TCHAR * Str )


description: Gets the physical size of the screen if possible. Some platforms lie, some platforms don't know.

code: static EScreenPhysicalAccuracy ComputePhysicalScreenDensity ( int32 & OutScreenDensity )


description:
Disables screensaver (if platform supports such an API)
true if succeeded, false if platform does not have this API andPreventScreenSaver()hack is needed

code: static bool ControlScreensaver ( [EScreenSaverAction](API\Runtime\ApplicationCore\GenericPlatform\FGenericPlatformApplicationMisc\EScreenSaverActi-) Action )


description: If we know or can approximate the pixel density of the screen we will convert the incoming inches to pixels on the device. If the accuracy is unknown OutPixels will be set to 0.

code: template<typename T, typename T2, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsFloatingPoint](API\Runtime\Core\Templates\TIsFloatingPoint)< T >::Value &&[TIsFloatingPoint](API\Runtime\Core\Templates\TIsFloatingPoint)< T2 >::Value, int >::type> static EScreenPhysicalAccuracy ConvertInchesToPixels ( T Inches, T2 & OutPixels )


description: If we know or can approximate the pixel density of the screen we will convert the incoming pixels to inches on the device. If the accuracy is unknown OutInches will be set to 0.

code: template<typename T, typename T2, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsFloatingPoint](API\Runtime\Core\Templates\TIsFloatingPoint)< T >::Value &&[TIsFloatingPoint](API\Runtime\Core\Templates\TIsFloatingPoint)< T2 >::Value, int >::type> static EScreenPhysicalAccuracy ConvertPixelsToInches ( T Pixels, T2 & OutInches )


description: Creates an application instance.

code: static [GenericApplication](API\Runtime\ApplicationCore\GenericPlatform\GenericApplication) * CreateApplication()


description: Creates a console output device for this platform. Should only be called once.

code: static [FOutputDeviceConsole](API\Runtime\Core\Misc\FOutputDeviceConsole) * CreateConsoleOutputDevice()


description: Gets a pointer to the default platform input device manager.


className: CVarEnableHighDPIAwareness


description: Whether to enable controller motion data polling (by default motion data is enabled) Some platforms may want to disable it to reduce battery drain

code: static void EnableMotionData ( bool bEnable )


description:
Returns monitor's DPI scale factor at given screen coordinates (expressed in pixels)
Monitor's DPI scale factor at given point

code: static float GetDPIScaleFactorAtPoint ( float X, float Y )


className: EScreenSaverAction

code: enum EScreenSaverAction { Disable, Enable, }


description: Gets a pointer to the platform error output device singleton.

code: static [FOutputDeviceError](API\Runtime\Core\Misc\FOutputDeviceError) * GetErrorOutputDevice()


description: Gets a pointer to the default platform feedback context implementation.

code: static [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * GetFeedbackContext()


description: Returns a texture of the glyph representing the specified button on the specified controller, or nullptr if not supported.

code: static [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetGamepadButtonGlyph ( const [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) & ButtonKey, uint32 ControllerIndex )


description: Returns name of gamepad if controller id assigned to a gamepad

code: static [FString](API\Runtime\Core\Containers\FString) GetGamepadControllerName ( int32 ControllerId )


code: static EScreenPhysicalAccuracy GetPhysicalScreenDensity ( int32 & OutScreenDensity )


description:
Sample the displayed pixel color from anywhere on the screen using the OS
The color of the pixel displayed at the chosen location

code: static [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetScreenPixelColor ( const FVector2D & InScreenPos, float InGamma )


description:
Searches for a window that matches the window name or the title starts with a particular text. When found, it returns the title text for that window
whether the window was found and the text copied or not

code: static bool GetWindowTitleMatchingText ( const TCHAR * TitleStartsWith, [FString](API\Runtime\Core\Containers\FString) & OutTitle )


description: Returns true if controller id assigned to a gamepad

code: static bool IsControllerAssignedToGamepad ( int32 ControllerId )


description: true if the application is high dpi aware

code: static bool IsHighDPIAwarenessEnabled()


description: Whether controller motion data polling is enabled (by default motion data is enabled)

code: static bool IsMotionDataEnabled()


description:
Returns state of screensaver (if platform supports it)
true if screensaver enabled (returns false if platform does not support it)

code: static bool IsScreensaverEnabled()


description: Returns true if the specified application has a visible window, and that window is active/has focus/is selected


description: Load the preinit modules required by this platform, typically they are the renderer modules

code: static void LoadPreInitModules()


description: Load the platform-specific startup modules

code: static void LoadStartupModules()


description: Prevents screen-saver from kicking in by moving the mouse by 0 pixels. This works even in the presence of a group policy for password protected screen saver.

code: static void PreventScreenSaver()


description: Request application to minimize (goto background).

code: static void RequestMinimize()


description: Pumps Windows messages.

code: static void PumpMessages ( bool bFromMainLoop )


description: Returns whether the platform wants to use a touch screen for a virtual keyboard.

code: static bool RequiresVirtualKeyboard()


description: Resets the gamepad to player controller id assignments

code: static void ResetGamepadAssignments()


description: Resets the gamepad assignment to player controller id

code: static void ResetGamepadAssignmentToController ( int32 ControllerId )


description: Set whether gamepads are allowed at the platform level.

code: static void SetGamepadsBlockDeviceFeedback ( bool bAllowed )


code: static void SetGamepadsAllowed ( bool bAllowed )


description: Allows the OS to enable high DPI mode

code: static void SetHighDPIMode()


description:
Asyncronously display the platform-specific input device selection UI, if supported.
false if the platform does not support an input device selection API, or it is not currently available (the callback will not be called)

code: static bool ShowInputDeviceSelector ( [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) InitiatingUserId, FShowInputDeviceSelectorComplete OnShowInputDeviceSelectorComplete )


description:
Asyncronously display the platform-specific user selection UI, if supported.
false if the platform does not support a user-selection API, or it is not currently available (the callback will not be called)

code: static bool ShowPlatformUserSelector ( [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InitiatingInputDeviceId, EPlatformUserSelectorFlags Flags, FPlatformUserSelectionComplete OnUserSelectionComplete )


className: FGenericPlatformApplicationMisc

code: struct FGenericPlatformApplicationMisc


description: Returns the next available input device id


description: Allocates a new user id when a user becomes active, will return none if no more can be created


description: Returns the default device id used for things like keyboard/mouse input

code: virtual [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) GetDefaultInputDevice() const


description:
Remap the legacy platform LocalUserIndex (often the same as ControllerId) to aFPlatformUserId. This is useful in cases where the input device id is not needed.
A platform-allocated user id, or PLATFORMUSERID_NONE

code: virtual [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) GetPlatformUserForUserIndex ( int32 LocalUserIndex )


description: Returns the 'Primary' Platform user for this platform. This typically has an internal ID of '0' and is used as the default platform user to map devices such as the keyboard and mouse that don't get assigned unique ID's from their owning platform code.

code: virtual [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) GetPrimaryPlatformUser() const


description: This is unsupported by default and will return PLATFORMUSERID_NONE on the generic platform

code: virtual [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) GetUserForUnpairedInputDevices() const


description:
Remap aFPlatformUserIdto the legacy platform LocalUserIndex (often the same as ControllerId). This is useful in cases where the input device id is not needed.
A valid platform user index, or INDEX_NONE

code: virtual int32 GetUserIndexForPlatformUser ( [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) UserId )


description: If true, this device mapper is operating in a backward compatible mode where there is a 1:1 mapping between controller id and user id

code: virtual bool IsUsingControllerIdAsUserId() const


description: Callback for when FCoreDelegates::OnUserLoginChangedEvent is broadcasted. If the user has logged out, then remap any input devices that the user had to the "Unpaired" user on this platform (if bUnpairInputDevicesWhenLoggingOut is true)

code: virtual void OnUserLoginChangedEvent ( bool bLoggedIn, int32 RawPlatformUserId, int32 UserIndex )


description:
This is useful for functions such asFGenericApplicationMessageHandler::OnControllerAnalogthat used to use the "int32 ControllerId" as a parameter so that you can call the newFGenericApplicationMessageHandlerthat take in a PlatformUserId and an InputDeviceId.
True if this maps to a real user

code: virtual bool RemapControllerIdToPlatformUserAndDevice ( int32 ControllerId, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) & InOutUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) & OutInputDeviceId )


description:
Functions to provide compatibility between the old "int32 ControllerId" and the newFPlatformUserIdandFInputDeviceIdstructs. Remap aFPlatformUserIdto a ControllerId that is needed by legacy code. Use this function to add compatibility to platforms that may not have implemented this device mapper yet.
True if this maps to a real user

code: virtual bool RemapUserAndDeviceToControllerId ( [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) UserId, int32 & OutControllerId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) OptionalDeviceId )


description: If true, than this device mapper will broadcast the older CoreDelegates as well as the new delegates. Set this to true if your platform needs calls from OnControllerConnectionChange or OnControllerPairingChange

code: virtual bool ShouldBroadcastLegacyDelegates() const


code: FGenericPlatformInputDeviceMapper ( const bool InbUsingControllerIdAsUserId, const bool InbShouldBroadcastLegacyDelegates )


className: FGenericPlatformInputDeviceMapper

description: Generic implementation of theIPlatformInputDeviceMapper. This provides the base functionality that can be used on most platforms.

code: class FGenericPlatformInputDeviceMapper : public [IPlatformInputDeviceMapper](API\Runtime\ApplicationCore\GenericPlatform\IPlatformInputDeviceMapper)

bShouldBroadcastLegacyDelegates

type: const bool

bUnpairInputDevicesWhenLoggingOut

description: Additional functionality that specializations can customize

bUsingControllerIdAsUserId

description: Flags for backwards compatibility with the older "int32 ControllerId" implementation


description: The pace we are running at (30 = 30fps, 0 = unpaced) The generic implementation returns a result based on rhi.SyncInterval and FPlatformMisc::GetMaxRefreshRate().

code: static int32 GetFramePace()


description: The generic implementation returns a result based on rhi.SyncInterval and FPlatformMisc::GetMaxRefreshRate().


description:
Sets the pace we would like to running at (30 = 30fps, 0 = unpaced). The generic implementation sets the value for rhi.SyncInterval according to FPlatformMisc::GetMaxRefreshRate().
the pace we will run at.

code: static int32 SetFramePace ( int32 FramePace )


description:
The generic implementation sets rhi.SyncInterval based on FPlatformMisc::GetMaxRefreshRate().
the pace we will run at.

code: static int32 SetFramePaceToSyncInterval ( int32 FramePace )


description: Returns whether the hardware is able to frame pace at the specified frame rate

code: static bool SupportsFramePace ( int32 QueryFramePace )


className: FGenericPlatformRHIFramePacer

description: Generic implementation for most platforms

code: struct FGenericPlatformRHIFramePacer


description: The position of the cursor

code: virtual FVector2D GetPosition() const


description: Gets the size of the cursor

code: virtual void GetSize ( int32 & Width, int32 & Height ) const


description: Gets the current type of the cursor

code: virtual [EMouseCursor::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseCursor__Type) GetType() const


description: Locks the cursor to the passed in bounds

code: virtual void Lock ( const RECT *const Bounds )


description: Sets the cursor

code: virtual void SetType ( const [EMouseCursor::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseCursor__Type) InNewCursor )


description: Sets the position of the cursor

code: virtual void SetPosition ( const int32 X, const int32 Y )


description: Allows overriding the shape of a particular cursor.

code: virtual void SetTypeShape ( [EMouseCursor::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseCursor__Type) InCursorType, void * CursorHandle )


description: Shows or hides the cursor

code: virtual void Show ( bool bShow )


code: FGenericPlatformSoftwareCursor()


className: FGenericPlatformSoftwareCursor

description: Windows has special needs with RECT, and we don't need this class on Windows anyway, so just skip it.

code: class FGenericPlatformSoftwareCursor : public [ICursor](API\Runtime\ApplicationCore\GenericPlatform\ICursor)


description:
Finds a usable splash pathname for the given filename
true if a splash screen was found

code: static *param IconFilename Name of the desired [icon](API\Runtime\ApplicationCore\GenericPlatform\FGenericPlatformSplash\icon)[if](API\Plugins\NetcodeUnitTest\if)[this](API\Plugins\WorldConditions\this) function returns true *param OutIconPath String containing the path to the [if](API\Plugins\NetcodeUnitTest\if)[this](API\Plugins\WorldConditions\this) function returns true **return true[if](API\Plugins\NetcodeUnitTest\if) a splash screen was found *staticbool GetSplashPath ( const TCHAR * SplashFilename, [FString](API\Runtime\Core\Containers\FString) & OutPath, bool & OutIsCustom )


code: static bool GetSplashPath ( const TCHAR * SplashFilename, const TCHAR * IconFilename, [FString](API\Runtime\Core\Containers\FString) & OutPath, [FString](API\Runtime\Core\Containers\FString) & OutIconPath, bool & OutIsCustom )


description: Hide the splash screen.

code: static void Hide()


description: Return whether the splash screen is being shown or not

code: static bool IsShown()


description: Finds a usable splash pathname for the given filename

code: *param IconFilename Name of the desired [icon](API\Runtime\ApplicationCore\GenericPlatform\FGenericPlatformSplash\icon) name ( "Splash" )


description: Sets the progress displayed on the application icon (for startup/loading progress).

code: static void SetProgress ( int ProgressPercent )


description: Sets the text displayed on the splash screen (for startup/loading progress)

code: static void SetSplashText ( const [SplashTextType::Type](API\Runtime\ApplicationCore\GenericPlatform\SplashTextType__Type) InType, const TCHAR * InText )


description: Show the splash screen.

code: static void Show()


className: FGenericPlatformSplash

code: struct FGenericPlatformSplash

icon

type: *param Icon...


description:
Attempt to get hardware survey results now. If they aren't available the survey will be started/ticked until complete.
True if the results were available, false otherwise.

code: static bool GetSurveyResults ( [FHardwareSurveyResults](API\Runtime\ApplicationCore\GenericPlatform\FHardwareSurveyResults) & OutResults, bool bWait )


className: FGenericPlatformSurvey

description: Generic implementation for most platforms, these tend to be unused and unimplemented

code: struct FGenericPlatformSurvey


description: Sets a custom splash image to display

code: static void SetCustomSplashImage ( const TCHAR * SplashFilename )


description: Gives the native window a chance to adjust our stored window size before we cache it off

code: virtual void AdjustCachedSize ( FVector2D & Size ) const


description: Native windows should implement BringToFront by making this window the top-most window (i.e. focused).

code: virtual void BringToFront ( bool bForce )


description: Native windows should implement this function by asking the OS to destroy OS-specific resource associated with the window (e.g. Win32 window handle)

code: virtual void Destroy()


description: Attempts to draw the user's attention to this window in whatever way is appropriate for the platform if this window is not the current active window.

code: virtual void DrawAttention ( const [FWindowDrawAttentionParameters](API\Runtime\ApplicationCore\GenericPlatform\FWindowDrawAttentionParameters) & Parameters )


description: Enables or disables the window. If disabled the window receives no input

code: virtual void Enable ( bool bEnable )


description: The definition describing properties of the window

code: virtual const [FGenericWindowDefinition](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindowDefinition) & GetDefinition() const


description: ratio of pixels to SlateUnits in this window. E.g. DPIScale of 2.0 means there is a 2x2 pixel square for every 1x1 SlateUnit.

code: virtual float GetDPIScaleFactor() const


description: Returns the rectangle of the screen the window is associated with

code: virtual bool GetFullScreenInfo ( int32 & X, int32 & Y, int32 & Width, int32 & Height ) const


description: Gets the OS Window handle in the form of a void pointer for other API's

code: virtual void * GetOSWindowHandle() const


description:
Populates the size and location of the window when it is restored. If the function fails, false is returned and X,Y,Width,Height will be undefined.
true when the size and location and successfully retrieved; false otherwise.

code: virtual bool GetRestoredDimensions ( int32 & X, int32 & Y, int32 & Width, int32 & Height )


description: Gets OS specific window border size. This is necessary because Win32 does not give control over this size.

code: virtual int32 GetWindowBorderSize() const


description: true if the native window is currently in fullscreen mode, false otherwise

code: virtual [EWindowMode::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowMode__Type) GetWindowMode() const


description: Force a window to front even if a different application is in front.

code: virtual void HACK_ForceToFront()


description: Gets OS specific window title bar size

code: virtual int32 GetWindowTitleBarSize() const


description: Native window should hide itself

code: virtual void Hide()


description: Returns true if the window definition is valid

code: virtual bool IsDefinitionValid() const


description: true if the window is in the foreground

code: virtual bool IsForegroundWindow() const


description: true if the window is in the foreground

code: virtual bool IsFullscreenSupported() const


description: Determines whether or not this window does its own DPI management

code: virtual bool IsManualManageDPIChanges() const


description: true if the native window is maximized, false otherwise

code: virtual bool IsMaximized() const


description: true if the native window is minimized, false otherwise

code: virtual bool IsMinimized() const


description: true if the native window is visible, false otherwise

code: virtual bool IsVisible() const


description: true if native window exists underneath the coordinates

code: virtual bool IsPointInWindow ( int32 X, int32 Y ) const


description: Native window should implement this function by performing the equivalent of the Win32 maximize operation

code: virtual void Maximize()


description: Native window should implement this function by performing the equivalent of the Win32 minimize-to-taskbar operation

code: virtual void Minimize()


description: Native windows should implement MoveWindowTo by relocating the platform-specific window to (X,Y).

code: virtual void MoveWindowTo ( int32 X, int32 Y )


description: Native windows should implement ReshapeWindow by changing the platform-specific window to be located at (X,Y) and be the dimensions Width x Height.

code: virtual void ReshapeWindow ( int32 X, int32 Y, int32 Width, int32 Height )


description: Native window should implement this function by performing the equivalent of the Win32 restore operation

code: virtual void Restore()


description: Sets a new DPI scale factor

code: virtual void SetDPIScaleFactor ( const float Factor )


description: Call with a true argument if this window need to do its custom size management in response to DPI variations

code: virtual void SetManualManageDPIChanges ( const bool bAutoHandle )


description: Shows or hides native window buttons on platforms that use them

code: virtual void SetNativeWindowButtonsVisibility ( bool bVisible )


description: Sets the opacity of this window

code: virtual void SetOpacity ( const float InOpacity )


description: Native windows should implement SetWindowFocus to let the OS know that a window has taken focus. Slate handles focus on a per widget basis internally but the OS still needs to know what window has focus for proper message routing

code: virtual void SetWindowFocus()


description: Sets the window text - usually the title but can also be text content for things like controls

code: virtual void SetText ( const TCHAR *const Text )


description: Toggle native window between fullscreen and normal mode

code: virtual void SetWindowMode ( [EWindowMode::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowMode__Type) InNewWindowMode )


description: Native window should make itself visible

code: virtual void Show()


className: FGenericWindow

code: class FGenericWindow

Definition

type: TSharedPtr<FGe...


code: virtual ~FGenericWindow()


className: FGenericWindowDefinition

code: struct FGenericWindowDefinition

AcceptsInput

description: True if the window accepts input; false if the window is non-interactive

ActivationPolicy

type: EWindowActivati...

description: The policy for activating the window upon each show

AppearsInTaskbar

description: Should this window show up in the taskbar

bManualDPI

description: False if the window should respond to system DPI changes, otherwise this will be handled, internally, by the application

CornerRadius

description: The radius of the corner rounding of the window

ExpectedMaxHeight

description: The expected maximum height of the window.

ExpectedMaxWidth

description: The expected maximum width of the window.

FocusWhenFirstShown

description: True if this window will be focused when it is first shown

HasCloseButton

description: True if this window displays an enabled close button on the toolbar area

HasOSWindowBorder

description: True if the window is using the os window border instead of a slate created one

HasSizingFrame

description: True if this is a user-sized window with a thick edge

HeightDesiredOnScreen

description: The initially desired height

IsModalWindow

description: True if the window is modal (prevents interacting with its parent)

IsRegularWindow

description: True if this is a vanilla window, or one being used for some special purpose: e.g. tooltip or menu

IsTopmostWindow

description: True if the window should be on top of all other windows; false otherwise

Opacity

description: Opacity of the window (0-1)

ShouldPreserveAspectRatio

description: True if the window should preserve its aspect ratio when resized by user

SizeLimits

type: FWindowSizeLimi...

SizeWillChangeOften

description: True if we expect the size of this window to change often, such as if its animated, or if it recycled for tool-tips.

SupportsMaximize

description: True if this window displays an enabled maximize button on the toolbar area

SupportsMinimize

description: True if this window displays an enabled minimize button on the toolbar area

Title

type: FString

description: The title of the window

TransparencySupport

type: EWindowTranspar...

description: The level of transparency supported by this window

Type

type: EWindowType

description: Window type

WidthDesiredOnScreen

description: The initially desired width

XDesiredPositionOnScreen

description: The initially desired horizontal screen position

YDesiredPositionOnScreen

description: The initially desired vertical screen position


className: MaxStringLength

code: static const uint32 MaxStringLength = 260;


className: FGPUAdpater

code: struct FGPUAdpater

AdapterDedicatedMemoryMB

type: TCHAR[MaxString...

AdapterDriverDate

description: Extra data when RHI starts up

AdapterUserDriverVersion

description: Extra data when RHI starts up, AMD has the Catalyst Driver version which is more useful for the user, otherwise it's the same as GRHIAdapterInternalDriverVersion


className: FHapticFeedbackBuffer

code: struct FHapticFeedbackBuffer

BufferLength

type: int

RawData

type: const uint8 ...


code: FHapticFeedbackValues ( const float InFrequency, const float InAmplitude )


className: FHapticFeedbackValues

code: struct FHapticFeedbackValues

HapticBuffer

type: FHapticFeedback...


className: FHardwareDisplay

code: struct FHardwareDisplay


className: MaxDisplayCount

code: static const int32 MaxDisplayCount = 8;


code: static const int32 MaxStringLength = 260;