My Project
unity::shell::application::MirSurfaceItemInterface Class Reference

Renders a MirSurface in a QML scene and forwards the input events it receives to it. More...

#include <unity/shell/application/MirSurfaceItemInterface.h>

Inheritance diagram for unity::shell::application::MirSurfaceItemInterface:
Collaboration diagram for unity::shell::application::MirSurfaceItemInterface:

Properties

unity::shell::application::MirSurfaceInterface surface
 The surface to be displayed.
 
Mir::Type type
 Type of the given surface or Mir.UnknownType if no surface is set.
 
Mir::State surfaceState
 State of the given surface or Mir.UnknownState if no surface is set.
 
QString name
 Name of the given surface or an empty string if no surface is set.
 
bool live
 True if the item has a surface and that surface has a mir client bound to it. A "zombie" (live == false) surface never becomes alive again.
 
Mir::OrientationAngle orientationAngle
 Orientation angle of the given surface. More...
 
bool consumesInput
 Whether the item will forward activeFocus, touch events, mouse events and key events to its surface. It's false by default. Only one item should have this property enabled for a given surface.
 
int surfaceWidth
 The desired width for the contained MirSurface. It's ignored if set to zero or a negative number The default value is zero.
 
int surfaceHeight
 The desired height for the contained MirSurface. It's ignored if set to zero or a negative number The default value is zero.
 

Detailed Description

Renders a MirSurface in a QML scene and forwards the input events it receives to it.

You can have multiple MirSurfaceItems displaying the same MirSurface. But care must be taken that only one of them feeds the MirSurface with input events and also only one resizes it.

Property Documentation

Mir::OrientationAngle unity::shell::application::MirSurfaceItemInterface::orientationAngle
readwrite

Orientation angle of the given surface.

How many degrees, clockwise, the UI in the surface has to rotate to match shell's UI orientation


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