Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::gui::input::TextEvent Class Reference

A class that represents an event that occurrs whenever a user enters text data. More...

#include <omGUIInputTextEvent.h>

Public Member Functions

 TextEvent (const UTF8String &newText)
 Create a new text event for the specified input text string. More...
 
 TextEvent (const UTF8String &newText, const Time &newTime)
 Create a new text event for the specified input text string and event time. More...
 
const UTF8String & getText () const
 Return a string that contains the text that was entered by the user. More...
 
void setText (const UTF8String &newText)
 Set a string that contains the text that was entered by the user. More...
 
const TimegetTime () const
 Return the absolute time since the epoch when the text event occurred. More...
 
void setTime (const Time &newTime)
 Set the absolute time since the epoch when the text event occurred. More...
 
const ModifiersgetModifiers () const
 Return the modifier flags that were set when the event occurred. More...
 
void setModifiers (const Modifiers &newModifiers)
 Set the modifier flags that were set when the event occurred. More...
 
 operator const UTF8String & () const
 Return the string contained in this text event. More...
 

Detailed Description

A class that represents an event that occurrs whenever a user enters text data.

Constructor & Destructor Documentation

om::gui::input::TextEvent::TextEvent ( const UTF8String &  newText)
inline

Create a new text event for the specified input text string.

om::gui::input::TextEvent::TextEvent ( const UTF8String &  newText,
const Time newTime 
)
inline

Create a new text event for the specified input text string and event time.

Member Function Documentation

const UTF8String& om::gui::input::TextEvent::getText ( ) const
inline

Return a string that contains the text that was entered by the user.

void om::gui::input::TextEvent::setText ( const UTF8String &  newText)
inline

Set a string that contains the text that was entered by the user.

const Time& om::gui::input::TextEvent::getTime ( ) const
inline

Return the absolute time since the epoch when the text event occurred.

void om::gui::input::TextEvent::setTime ( const Time newTime)
inline

Set the absolute time since the epoch when the text event occurred.

const Modifiers& om::gui::input::TextEvent::getModifiers ( ) const
inline

Return the modifier flags that were set when the event occurred.

void om::gui::input::TextEvent::setModifiers ( const Modifiers newModifiers)
inline

Set the modifier flags that were set when the event occurred.

om::gui::input::TextEvent::operator const UTF8String & ( ) const
inline

Return the string contained in this text event.


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