You.i Engine
CYIKeyboardInputBridge::Receiver::Description Struct Reference

Detailed Description

Provides details to the system software keyboard.

#include <platform/YiKeyboardInputBridge.h>

Public Member Functions

 Description ()
 

Public Attributes

CYIString currentText
 The existing text maintained by the Receiver. More...
 
CYIString placeholderText
 The placeholder text maintained by the Receiver. More...
 
size_t maximumCharacterCount
 The maxiumum character count. More...
 
YI_RECT_REL screenRect
 The screen space area occupied by the Receiver's visual representation. This is used to position the software keyboard, if applicable. More...
 
size_t currentCursorPosition
 The position of the cursor in Description::defaultText. Must be greater than or equal to 0 and less than the length of Description::defaultText. More...
 

Constructor & Destructor Documentation

◆ Description()

CYIKeyboardInputBridge::Receiver::Description::Description ( )
inline

Member Data Documentation

◆ currentCursorPosition

size_t CYIKeyboardInputBridge::Receiver::Description::currentCursorPosition

The position of the cursor in Description::defaultText. Must be greater than or equal to 0 and less than the length of Description::defaultText.

◆ currentText

CYIString CYIKeyboardInputBridge::Receiver::Description::currentText

The existing text maintained by the Receiver.

◆ maximumCharacterCount

size_t CYIKeyboardInputBridge::Receiver::Description::maximumCharacterCount

The maxiumum character count.

◆ placeholderText

CYIString CYIKeyboardInputBridge::Receiver::Description::placeholderText

The placeholder text maintained by the Receiver.

◆ screenRect

YI_RECT_REL CYIKeyboardInputBridge::Receiver::Description::screenRect

The screen space area occupied by the Receiver's visual representation. This is used to position the software keyboard, if applicable.


The documentation for this struct was generated from the following file: