HPS::TextInputEvent Class Reference

#include <hps.h>

Inheritance diagram for HPS::TextInputEvent:
HPS::Event

Public Member Functions

EventClone () const
 
virtual bool Equals (TextInputEvent const &in_that) const
 
virtual bool operator!= (ErrorEvent const &in_that) const
 
virtual bool operator== (TextInputEvent const &in_that) const
 
 TextInputEvent ()
 
 TextInputEvent (char const *in_text)
 
 TextInputEvent (Event const &in_event)
 
- Public Member Functions inherited from HPS::Event
virtual bool Drop (Event const *in_that_event) const
 
 Event (intptr_t in_channel=0)
 
virtual intptr_t Freshen () const
 
intptr_t GetChannel () const
 
intptr_t GetClassID () const
 
Time GetTimeStamp () const
 
bool IsConsumable () const
 

Public Attributes

HPS::UTF8 text
 The text for this TextInputEvent.
 

Additional Inherited Members

- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
 
- Static Public Member Functions inherited from HPS::Event
static void operator delete (void *in_ptr, size_t in_size) throw ()
 
static void * operator new (size_t in_size)
 
- Protected Attributes inherited from HPS::Event
intptr_t channel
 
bool consumable
 

Detailed Description

The TextInputEvent class is the event that is generated when an application receives text input

Constructor & Destructor Documentation

◆ TextInputEvent() [1/3]

HPS::TextInputEvent::TextInputEvent ( )
inline

The default constructor creates a TextInputEvent.

◆ TextInputEvent() [2/3]

HPS::TextInputEvent::TextInputEvent ( char const *  in_text)
inline

This constructor creates a TextInputEvent object for a given text string.

Parameters
in_textText associated to this TextInputEvent.

◆ TextInputEvent() [3/3]

HPS::TextInputEvent::TextInputEvent ( Event const &  in_event)
inline

This constructor converts an Event Object to a TextInputEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

Event* HPS::TextInputEvent::Clone ( ) const
inlinevirtual

Allocates and returns a copy of this TextInputEvent.

Returns
A copy of this TextInputEvent.

Implements HPS::Event.

◆ Equals()

virtual bool HPS::TextInputEvent::Equals ( TextInputEvent const &  in_that) const
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_eventThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ operator!=()

virtual bool HPS::TextInputEvent::operator!= ( ErrorEvent const &  in_that) const
inlinevirtual

Check if the source object is not equivalent to this object.

Parameters
in_eventThe source object to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator==()

virtual bool HPS::TextInputEvent::operator== ( TextInputEvent const &  in_that) const
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_eventThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

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