ScreenEdgeHandler QML Type
Qml export for reserving a Screen Edge. More...
| Import Statement: | import org.kde.kwin |
Properties
Signals
Detailed Description
The edge is controlled by the enabled property and the edge property. If the edge is enabled and gets triggered the activated() signal gets emitted.
Example usage:
ScreenEdgeHandler { edge: ScreenEdgeHandler.LeftEdge onActivated: doSomething() }
Property Documentation
edge : enumeration |
Which of the screen edges is to be reserved. Default value is NoEdge.
| Constant | Description |
|---|---|
ScreenEdgeHandler.TopEdge | The top edge of the screen. |
ScreenEdgeHandler.TopRightEdge | The top right corner of the screen. |
ScreenEdgeHandler.RightEdge | The right edge of the screen. |
ScreenEdgeHandler.BottomRightEdge | The bottom right corner of the screen. |
ScreenEdgeHandler.BottomEdge | The bottom edge of the screen. |
ScreenEdgeHandler.BottomLeftEdge | The bottom left corner of the screen. |
ScreenEdgeHandler.LeftEdge | The left edge of the screen. |
ScreenEdgeHandler.TopLeftEdge | The top left corner of the screen. |
ScreenEdgeHandler.NoEdge | No edge. |
enabled : bool |
Whether the edge is currently enabled, that is reserved. Default value is true.
mode : enumeration |
The operation mode for this edge. Default value is Mode::Pointer
| Constant | Description |
|---|---|
ScreenEdgeHandler.Pointer | The screen edge is triggered by a pointer input device. |
ScreenEdgeHandler.Touch | The screen edge is triggered by a touch input device. |
Signal Documentation
activated() |
This signal is emitted when the screen edge is activated by the user.
The way how the screen edge gets activated depends on the mode(). For example, with Mode::Pointer, the screen edge will be activated when the pointer hits the screen edge; with Mode::Touch, the screen edge will be activated when user swipes their fingers from the corresponding screen border towards the center of the screen.
Note: The corresponding handler is onActivated.