Kanzi  3.9.7
Kanzi Engine API
kanzi::WindowEvent Class Reference

The WindowEvent class holds window specific events. More...

#include <kanzi/core.ui/platform/input/common/events.hpp>

Inheritance diagram for kanzi::WindowEvent:
[legend]

Public Member Functions

NativeWindowHandle getWindow () const
 Returns the window instance to which the event refers. More...
 
 WindowEvent (Type type, NativeWindowHandle window)
 Constructs a window event with a given type for a given window. More...
 
- Public Member Functions inherited from kanzi::InputEvent
Type getType () const
 Returns the type of the event. More...
 
 InputEvent (Type type)
 Constructs an event with a given type. More...
 
bool isHandled () const
 Returns true if the event is handled, false if not. More...
 
void markHandled ()
 Marks the event as handled. More...
 
virtual ~InputEvent ()
 Destructor. More...
 

Protected Attributes

NativeWindowHandle m_window
 The window instance to which the event refers. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::InputEvent
enum  Type {
  Key, Pointer, Touch, WindowResized,
  WindowResizeRequest, WindowFocusLost, WindowFocusGained, WindowHidden,
  WindowResourcesLost, WindowOrientationChanged, WindowRedrawRequest, WindowPlacement,
  WindowClosed, ApplicationPaused, ApplicationSleep, ApplicationWakeup,
  DebugToggleHud, DebugSetHud, UserEvent
}
 InputEvent type enumeration. More...
 

Detailed Description

The WindowEvent class holds window specific events.

It serves as base class for window specific events that hold additional arguments aside of the target window. The standalone events which have no additional arguments are: -* InputEvent::WindowFocusLost -* InputEvent::WindowFocusGained -* InputEvent::WindowHidden -* InputEvent::WindowResourcesLost -* InputEvent::WindowClosed

Constructor & Destructor Documentation

kanzi::WindowEvent::WindowEvent ( Type  type,
NativeWindowHandle  window 
)
explicit

Constructs a window event with a given type for a given window.

The constructor asserts if the given type is not about a window event.

Parameters
typeThe event type.
windowThe window to which the event refers.

Member Function Documentation

NativeWindowHandle kanzi::WindowEvent::getWindow ( ) const
inline

Returns the window instance to which the event refers.

Member Data Documentation

NativeWindowHandle kanzi::WindowEvent::m_window
protected

The window instance to which the event refers.


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