-
-
Notifications
You must be signed in to change notification settings - Fork 7
Utility interface
Stanislav Vasilev edited this page May 18, 2023
·
8 revisions
The Utility interface provides utility functions. It looks like this:
class UIMGUI_PUBLIC_API Utility
{
public:
static void sanitiseFilepath(FString& str) noexcept;
static void keyToText(FString& text, const uint16_t& key, bool bLong) noexcept;
static FString keyToText(const uint16_t& key, bool bLong) noexcept;
static void keyToText(FString& text, const InputAction& action, bool bLong) noexcept;
static FString keyToText(const InputAction& action, bool bLong) noexcept;
// DO NOT USE THIS, THIS IS ONLY HERE FOR INTERNAL REASONS!!! REALLY KNOW WHAT YOU'RE DOING WHEN USING THIS
static Global& getGlobal() noexcept;
static void removeConsole() noexcept;
static FString toLower(String str) noexcept;
static void toLower(FString& str) noexcept;
static FString toUpper(String str) noexcept;
static void toUpper(FString& str) noexcept;
static void sleep(uint64_t milliseconds) noexcept;
};Reference for the functions:
-
toUpper- Converts a string to all uppercase characters -
toLower- Converts a string to all lowercase characters -
removeConsole- Removes the console window on Windows -
getGlobal- Returns a reference to the internal global class, DO NOT TOUCH!!! -
keyToText- Converts a key code to text in short or long form for usage in UI -
sanitizeFilepath- Sanitizes file paths, such as replacing\with/on Windows -
sleep- Puts the current thread to sleep for X milliseconds
The whole interface is flagged as event safe at Any time.
This project is supported by all the people who joined our discord server and became beta testers. If you want to join the discord you can click here.
- Home
- Beginner content
- Install guide
- Creating and using the UI components
- The Instance
- The Init Info struct
- Building better titlebar menus
- Textures
- Logging
- Unicode support
- Additional features
- Client-side bar
- Custom type definitions
- Memory management
- C API development
- Config files and Folders
- Interfaces
- Internal Event safety
- Customising the build system
- Modules system
- Collaborating with others
- Advanced content
- Loading dynamic libraries at runtime
- Understanding the library layout
- Compilation mode modifiers
- Supporting plugins
- Production export and deployment
- OS integration tips
- Targeting WASM
- Using a custom rendering engine:
- Using a custom windowing backend:
- Developer and contributor resources
- Misc