FTaskbarList Class Reference

#include <WindowsApplication.h>

Public Member Functions
APPLICATIONCORE_API void	SetOverlayIcon (HWND WindowHandle, HICON Icon, FText Description)
APPLICATIONCORE_API void	SetProgressState (HWND WindowHandle, ETaskbarProgressState::Type State)
APPLICATIONCORE_API void	SetProgressValue (HWND WindowHandle, uint64 Current, uint64 Total)
APPLICATIONCORE_API	~FTaskbarList ()

Static Public Member Functions
static APPLICATIONCORE_API TSharedRef< FTaskbarList >	Create ()

Detailed Description

Allows access to task bar lists.

This class can be used to change the appearance of a window's entry in the windows task bar, such as setting an overlay icon or showing a progress indicator.

Constructor & Destructor Documentation

~FTaskbarList()

FTaskbarList::~FTaskbarList

(

)

Destructor.

Member Function Documentation

Create()

TSharedRef< FTaskbarList > FTaskbarList::Create ( )

static

Create and initialize a new task bar list.

Returns

The new task bar list.

SetOverlayIcon()

void FTaskbarList::SetOverlayIcon	(	HWND	WindowHandle,
		HICON	Icon,
		FText	Description
	)

Sets the overlay icon of a task bar entry.

Parameters

WindowHandle	The window handle to change the overlay icon for.
Icon	The overlay icon to set.
Description	The overlay icon's description text.

SetProgressState()

void FTaskbarList::SetProgressState	(	HWND	WindowHandle,
		ETaskbarProgressState::Type	State
	)

Sets the progress state of a task bar entry.

Parameters

WindowHandle	The window handle to change the progress state for.
State	The new progress state.

SetProgressValue()

void FTaskbarList::SetProgressValue	(	HWND	WindowHandle,
		uint64	Current,
		uint64	Total
	)

Sets the progress value of a task bar entry.

Parameters

WindowHandle	The window handle to change the progress value for.
Current	The current progress value.
Total	The total progress value.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/ApplicationCore/Public/Windows/WindowsApplication.h
• Engine/Source/Runtime/ApplicationCore/Private/Windows/WindowsApplication.cpp