unravel::RmlUi_SystemInterface Class Reference

System interface implementation using engine's ospp systems. More...

#include <RmlUi_SystemInterface.h>

Inheritance diagram for unravel::RmlUi_SystemInterface:

Public Member Functions
	RmlUi_SystemInterface ()
	~RmlUi_SystemInterface ()
auto	init (rtti::context &ctx) -> bool
	Initialize the system interface with engine context.
void	shutdown ()
	Cleanup resources.
double	GetElapsedTime () override
	Get elapsed time since application start.
auto	TranslateString (Rml::String &translated, const Rml::String &input) -> int override
	Translate the input string into the translated string.
void	SetMouseCursor (const Rml::String &cursor_name) override
	Set the mouse cursor.
void	SetClipboardText (const Rml::String &text) override
	Set clipboard text.
void	GetClipboardText (Rml::String &text) override
	Get clipboard text.
void	ActivateKeyboard (Rml::Vector2f caret_position, float line_height) override
	Activate virtual keyboard (for mobile/touch devices)
void	DeactivateKeyboard () override
	Deactivate virtual keyboard.
bool	LogMessage (Rml::Log::Type type, const Rml::String &message) override

Detailed Description

System interface implementation using engine's ospp systems.

This class provides RmlUi with access to system-level functionality through the engine's existing ospp windowing and input systems.

Definition at line 33 of file RmlUi_SystemInterface.h.

Constructor & Destructor Documentation

RmlUi_SystemInterface()

unravel::RmlUi_SystemInterface::RmlUi_SystemInterface

(

)

Definition at line 24 of file RmlUi_SystemInterface.cpp.

~RmlUi_SystemInterface()

unravel::RmlUi_SystemInterface::~RmlUi_SystemInterface

(

)

Definition at line 29 of file RmlUi_SystemInterface.cpp.

Member Function Documentation

ActivateKeyboard()

void unravel::RmlUi_SystemInterface::ActivateKeyboard ( Rml::Vector2f caret_position, float line_height )

override

Activate virtual keyboard (for mobile/touch devices)

Parameters

caret_position	Position of text caret
line_height	Height of text line

Definition at line 141 of file RmlUi_SystemInterface.cpp.

DeactivateKeyboard()

void unravel::RmlUi_SystemInterface::DeactivateKeyboard ( )

override

Deactivate virtual keyboard.

Definition at line 154 of file RmlUi_SystemInterface.cpp.

GetClipboardText()

void unravel::RmlUi_SystemInterface::GetClipboardText ( Rml::String & text )

override

Get clipboard text.

Parameters

text	Reference to store clipboard text

Definition at line 136 of file RmlUi_SystemInterface.cpp.

GetElapsedTime()

double unravel::RmlUi_SystemInterface::GetElapsedTime ( )

override

Get elapsed time since application start.

Returns

Time in seconds

Definition at line 52 of file RmlUi_SystemInterface.cpp.

init()

auto unravel::RmlUi_SystemInterface::init

(

rtti::context &

ctx

)

-> bool

Initialize the system interface with engine context.

Parameters

ctx	Engine context for accessing systems

Returns

True if initialization was successful

Definition at line 35 of file RmlUi_SystemInterface.cpp.

LogMessage()

auto unravel::RmlUi_SystemInterface::LogMessage ( Rml::Log::Type type, const Rml::String & message )

override

Log the specified message.

Parameters

[in]	type	Type of log message, ERROR, WARNING, etc.
[in]	message	Message to log.

Returns

True to continue execution, false to break into the debugger.

Definition at line 167 of file RmlUi_SystemInterface.cpp.

SetClipboardText()

void unravel::RmlUi_SystemInterface::SetClipboardText ( const Rml::String & text )

override

Set clipboard text.

Parameters

text	Text to set in clipboard

Definition at line 131 of file RmlUi_SystemInterface.cpp.

SetMouseCursor()

void unravel::RmlUi_SystemInterface::SetMouseCursor ( const Rml::String & cursor_name )

override

Set the mouse cursor.

Parameters

cursor_name

Name of the cursor to set

Definition at line 70 of file RmlUi_SystemInterface.cpp.

shutdown()

void unravel::RmlUi_SystemInterface::shutdown

(

)

Cleanup resources.

Definition at line 44 of file RmlUi_SystemInterface.cpp.

TranslateString()

auto unravel::RmlUi_SystemInterface::TranslateString ( Rml::String & translated, const Rml::String & input ) -> int

override

Translate the input string into the translated string.

Parameters

[out]	translated	Translated string ready for display.
[in]	input	String as received from XML.

Returns

Number of translations that occured.

Definition at line 65 of file RmlUi_SystemInterface.cpp.

---

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

• C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/ui/rmlui/RmlUi_SystemInterface.h
• C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/ui/rmlui/RmlUi_SystemInterface.cpp