API reference

platform.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/platform/platform.h
Platform::browserCompatUserAgentCSS
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static const String& browserCompatUserAgentCSS();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:117

Report an issue with this entry →
Platform::clearTimer
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void clearTimer(u32 timerId);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:55

Report an issue with this entry →
Platform::clipboardText
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static String clipboardText();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:75

Report an issue with this entry →
Platform::defaultUserAgentCSS
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static const String& defaultUserAgentCSS();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:114

Report an issue with this entry →
Platform::deprecated
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
[[deprecated("No-op — DevTools auto-starts per-window in processFrame")]] static void devToolsAttachIfNeeded(Document* doc);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:158

Report an issue with this entry →
Platform::deprecated
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
[[deprecated("No-op — DevTools polls per-window in processFrame")]] static void devToolsPoll();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:162

Report an issue with this entry →
Platform::deprecated
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
[[deprecated("Use Window::devToolsServer() — DevTools is now per-window")]] static DevToolsServer* devToolsServer();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:154

Report an issue with this entry →
Platform::deprecated
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
[[deprecated("Use Window::devToolsUrl() — DevTools is now per-window")]] static String devToolsUrl();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:148

Report an issue with this entry →
Platform::devToolsEnabled
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static bool devToolsEnabled();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:143

Report an issue with this entry →
Platform::devToolsPort
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static u16 devToolsPort();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:146

Report an issue with this entry →
Platform::enableDevTools
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void enableDevTools(u16 port = 9229);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:147

Report an issue with this entry →
Platform::FileDialogOptions::FileDialogOptions
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
FileDialogOptions(String titleIn = String(), String defaultPathIn = String(), std::vector<String> filtersIn = std::vector<String>(), bool allowMultipleIn = false) : title(std::move(titleIn)), defaultPath(std::move(defaultPathIn)), filters(std::move(filtersIn)), allowMultiple(allowMultipleIn)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:132

Report an issue with this entry →
Platform::hasClipboardText
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static bool hasClipboardText();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:78

Report an issue with this entry →
Platform::init
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static bool init();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:26

Report an issue with this entry →
Platform::isF12DevToolsEnabled
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static bool isF12DevToolsEnabled();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:170

Report an issue with this entry →
Platform::messageBox
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static MsgBoxResult messageBox(const String& title, const String& message, MsgBoxType type = MsgBoxType::Info, MsgBoxButtons buttons = MsgBoxButtons::OK);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:96

Report an issue with this entry →
Platform::monitorFromPoint
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static MonitorInfo monitorFromPoint(f32 x, f32 y);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:111

Report an issue with this entry →
Platform::monitorFromWindow
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static MonitorInfo monitorFromWindow(void* nativeHandle);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:112

Report an issue with this entry →
Platform::monitors
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static std::vector<MonitorInfo> monitors();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:109

Report an issue with this entry →
Platform::now
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static f64 now();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:122

Report an issue with this entry →
Platform::openFileDialog
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static Optional<String> openFileDialog(const FileDialogOptions& opts = {});

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:139

Report an issue with this entry →
Platform::openUrl
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void openUrl(const String& url);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:172

Report an issue with this entry →
Platform::osName
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static String osName();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:80

Report an issue with this entry →
Platform::osVersion
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static String osVersion();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:82

Report an issue with this entry →
Platform::pollEvents
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void pollEvents();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:41

Report an issue with this entry →
Platform::postToMainThread
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void postToMainThread(Callback<void()> callback);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:62

Report an issue with this entry →
Platform::primaryMonitor
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static MonitorInfo primaryMonitor();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:110

Report an issue with this entry →
Platform::primaryMonitorPhysicalSize
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static Size primaryMonitorPhysicalSize();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:73

Report an issue with this entry →
Platform::primaryMonitorScale
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static f32 primaryMonitorScale();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:70

Report an issue with this entry →
Platform::primaryMonitorSize
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static Size primaryMonitorSize();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:72

Report an issue with this entry →
Platform::quit
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void quit(int exitCode = 0);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:38

Report an issue with this entry →
Platform::requestIdle
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void requestIdle(Callback<void()> callback);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:58

Report an issue with this entry →
Platform::run
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static int run();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:33

Report an issue with this entry →
Platform::saveFileDialog
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static Optional<String> saveFileDialog(const FileDialogOptions& opts = {});

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:140

Report an issue with this entry →
Platform::selectFolderDialog
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static Optional<String> selectFolderDialog(const String& title = "");

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:141

Report an issue with this entry →
Platform::setClipboardText
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void setClipboardText(const String& text);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:77

Report an issue with this entry →
Platform::setF12DevToolsEnabled
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void setF12DevToolsEnabled(bool enable);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:166

Report an issue with this entry →
Platform::setInterval
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static u32 setInterval(Callback<void()> callback, u32 intervalMs);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:52

Report an issue with this entry →
Platform::setTimeout
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static u32 setTimeout(Callback<void()> callback, u32 delayMs);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:48

Report an issue with this entry →
Platform::shutdown
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void shutdown();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:30

Report an issue with this entry →
Platform::toLowerUnicode
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static String toLowerUnicode(const String& utf8Text);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:89

Report an issue with this entry →
Platform::toUpperUnicode
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static String toUpperUnicode(const String& utf8Text);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:84

Report an issue with this entry →
Platform::waitEvents
Needs verification3.61.7C++

Installed header declaration in the platform module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

platform.h
static void waitEvents(f64 timeoutSeconds = -1);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/platform/platform.h:45

Report an issue with this entry →
Browse this reference type →