ui.h File Reference

#include <wx/cursor.h>

Go to the source code of this file.

Namespaces
namespace	KIPLATFORM
namespace	KIPLATFORM::UI

Enumerations
enum	KIPLATFORM::UI::NATIVE_DISPLAY_TYPE {   KIPLATFORM::UI::DISPLAY_UNKNOWN = 0 , KIPLATFORM::UI::DISPLAY_X11 = 1 , KIPLATFORM::UI::DISPLAY_WAYLAND = 2 , KIPLATFORM::UI::DISPLAY_WIN32 = 3 ,   KIPLATFORM::UI::DISPLAY_COCOA = 4 }
	Display server types reported by GetNativeWindowHandles(). More...

Functions
bool	KIPLATFORM::UI::IsDarkTheme ()
	Determine if the desktop interface is currently using a dark theme or a light theme.
wxColour	KIPLATFORM::UI::GetDialogBGColour ()
void	KIPLATFORM::UI::ForceFocus (wxWindow *aWindow)
	Pass the current focus to the window.
bool	KIPLATFORM::UI::IsWindowActive (wxWindow *aWindow)
	Check to see if the given window is the currently active window (e.g.
void	KIPLATFORM::UI::ReparentModal (wxNonOwnedWindow *aWindow)
	Move a window's parent to be the top-level window and force the window to be on top.
void	KIPLATFORM::UI::ReparentWindow (wxNonOwnedWindow *aWindow, wxTopLevelWindow *aParent)
void	KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision (wxWindow *aWindow)
bool	KIPLATFORM::UI::IsStockCursorOk (wxStockCursor aCursor)
	Checks if we designated a stock cursor for this OS as "OK" or else we may need to load a custom one.
void	KIPLATFORM::UI::LargeChoiceBoxHack (wxChoice *aChoice)
	Configure a wxChoice control to support a lot of entries by disabling functionality that makes adding new items become very expensive.
void	KIPLATFORM::UI::EllipsizeChoiceBox (wxChoice *aChoice)
	Configure a wxChoice control to ellipsize the shown text in the button with the ellipses placed at the end of the string.
double	KIPLATFORM::UI::GetPixelScaleFactor (const wxWindow *aWindow)
	Tries to determine the pixel scaling factor currently in use for the window.
double	KIPLATFORM::UI::GetContentScaleFactor (const wxWindow *aWindow)
	Tries to determine the content scaling factor currently in use for the window.
double	KIPLATFORM::UI::GetDisplayRefreshRate (const wxWindow *aWindow)
	Return the refresh rate in Hz of the display showing most of the window, or 0 if unknown.
void	KIPLATFORM::UI::GetInfoBarColours (wxColour &aFGColour, wxColour &aBGColour)
	Return the background and foreground colors for info bars in the current scheme.
wxWindow *	KIPLATFORM::UI::CreateCanvasOverlay (wxWindow *aCanvas)
	Create a window for widgets that are shown over a canvas without taking space from it.
wxSize	KIPLATFORM::UI::GetUnobscuredSize (const wxWindow *aWindow)
	Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl, wxGrid) that won't be obscured by scrollbars.
void	KIPLATFORM::UI::SetOverlayScrolling (const wxWindow *aWindow, bool overlay)
	Used to set overlay/non-overlay scrolling mode in a window.
bool	KIPLATFORM::UI::AllowIconsInMenus ()
	If the user has disabled icons system-wide, we check that here.
bool	KIPLATFORM::UI::SupportsKeyState ()
	Return whether wxGetKeyState() can query ordinary keys, beyond modifiers and lock keys.
wxPoint	KIPLATFORM::UI::GetMousePosition ()
	Returns the mouse position in screen coordinates.
bool	KIPLATFORM::UI::WarpPointer (wxWindow *aWindow, int aX, int aY)
	Move the mouse cursor to a specific position relative to the window.
void	KIPLATFORM::UI::ImmControl (wxWindow *aWindow, bool aEnable)
	Configures the IME mode of a given control handle.
void	KIPLATFORM::UI::ImeNotifyCancelComposition (wxWindow *aWindow)
	Asks the IME to cancel.
bool	KIPLATFORM::UI::InfiniteDragPrepareWindow (wxWindow *aWindow)
	On Wayland, restricts the pointer movement to a rectangle slightly bigger than the given wxWindow.
void	KIPLATFORM::UI::InfiniteDragReleaseWindow ()
	On Wayland, allows the cursor to freely move again after a drag (see InfiniteDragPrepareWindow).
void	KIPLATFORM::UI::EnsureVisible (wxWindow *aWindow)
	Ensure that a window is visible on the screen.
void	KIPLATFORM::UI::StabilizeWindowPosition (wxWindow *aWindow)
	Prepare a top-level window for reliable position round-tripping.
void	KIPLATFORM::UI::SetFloatLevel (wxWindow *aWindow)
	Intended to set the floating window level in macOS on a window.
void	KIPLATFORM::UI::ReleaseChildWindow (wxNonOwnedWindow *aWindow)
	Release a modal window's parent-child relationship with its parent window.
void	KIPLATFORM::UI::AllowNetworkFileSystems (wxDialog *aDialog)
	Configure a file dialog to show network and virtual file systems.
void	KIPLATFORM::UI::CancelPendingScroll (wxDataViewCtrl *aCtrl)
	Cancel any pending scroll-to-item request on aCtrl.
void	KIPLATFORM::UI::SetWMClass (wxWindow *aWindow, const wxString &aClass)
	Tag a top-level window with the freedesktop application id of its installed launcher, setting the X11 WM_CLASS and, on Wayland, the surface application id.
void	KIPLATFORM::UI::GetNativeWindowHandles (wxWindow *aWindow, void **aHandle, void **aDisplay, int *aDisplayType=nullptr)
	Get the native handles needed to create a GPU surface for aWindow.
void	KIPLATFORM::UI::PrepareForExternalRendering (wxWindow *aWindow)
	Prepare a realized widget for Vulkan or Metal rendering, before its first present.
void	KIPLATFORM::UI::KeepAboveExternalRendering (wxWindow *aChild)
	Keep a child visible on top of a parent prepared with PrepareForExternalRendering().