Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::OrientationChangedEvent Class Reference

Specialized event that reports the orientation change of a window. More...

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

Inheritance diagram for kanzi::OrientationChangedEvent:
[legend]

Public Member Functions

WindowOrientation getOrientation () const
 Returns the orientation held by the event. More...
 
 OrientationChangedEvent (NativeWindowHandle target, WindowOrientation orientation)
 Constructs the orientation change event reported on the given window. More...
 
- Public Member Functions inherited from kanzi::WindowEvent
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

WindowOrientation m_orientation
 Holds the orientation reported for the window. More...
 
- Protected Attributes inherited from kanzi::WindowEvent
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, WindowClosed,
  ApplicationPaused, ApplicationSleep, ApplicationWakeup, DebugToggleHud,
  DebugSetHud, UserEvent
}
 InputEvent type enumeration. More...
 

Detailed Description

Specialized event that reports the orientation change of a window.

The type of the event is InputEvent::WindowOrientationChanged.

Constructor & Destructor Documentation

◆ OrientationChangedEvent()

kanzi::OrientationChangedEvent::OrientationChangedEvent ( NativeWindowHandle  target,
WindowOrientation  orientation 
)
explicit

Constructs the orientation change event reported on the given window.

Parameters
targetThe target window that got its orientation changed.
orientationThe orientation of the window.

Member Function Documentation

◆ getOrientation()

WindowOrientation kanzi::OrientationChangedEvent::getOrientation ( ) const
inline

Returns the orientation held by the event.

Member Data Documentation

◆ m_orientation

WindowOrientation kanzi::OrientationChangedEvent::m_orientation
protected

Holds the orientation reported for the window.


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