HPS::StandAloneWindowEvent Class Reference

#include <hps.h>

Inheritance diagram for HPS::StandAloneWindowEvent:
HPS::Event

Public Types

enum  Action : uint32_t { Action::Unknown, Action::Close, FocusIn, FocusOut }
 
- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
 

Public Member Functions

EventClone () const
 
virtual bool Equals (StandAloneWindowEvent const &in_that) const
 
virtual bool operator!= (StandAloneWindowEvent const &in_that) const
 
virtual bool operator== (StandAloneWindowEvent const &in_that) const
 
 StandAloneWindowEvent ()
 
 StandAloneWindowEvent (Action in_action)
 
 StandAloneWindowEvent (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

Action action
 The action for this StandAloneWindowEvent.
 

Additional Inherited Members

- 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 StandAloneWindowEvent class is the event that is generated by a Standalone window.

Member Enumeration Documentation

◆ Action

enum HPS::StandAloneWindowEvent::Action : uint32_t
strong

Enumeration of various actions StandAloneWindowEvent.

Enumerator
Unknown 

The StandAloneWindow has recieved a unknown message.

Close 

The StandAloneWindow has recieved a close.

Constructor & Destructor Documentation

◆ StandAloneWindowEvent() [1/3]

HPS::StandAloneWindowEvent::StandAloneWindowEvent ( )
inline

The default constructor creates an StandAloneWindowEvent object with an empty message and code of 0.

◆ StandAloneWindowEvent() [2/3]

HPS::StandAloneWindowEvent::StandAloneWindowEvent ( Action  in_action)
inline

This constructor creates a StandAloneWindowEvent object for a given action.

Parameters
in_actionAction of this StandAloneWindowEvent.

◆ StandAloneWindowEvent() [3/3]

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

This constructor converts an Event Object to a StandAloneWindowEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

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

Allocates and returns a copy of this ErrorEvent.

Returns
A copy of this ErrorEvent.

Implements HPS::Event.

◆ Equals()

virtual bool HPS::StandAloneWindowEvent::Equals ( StandAloneWindowEvent 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::StandAloneWindowEvent::operator!= ( StandAloneWindowEvent 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::StandAloneWindowEvent::operator== ( StandAloneWindowEvent 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: