[v3,1/7] ui: add show-cursor option
diff mbox series

Message ID 20200207101753.25812-2-kraxel@redhat.com
State New
Headers show
Series
  • ui: rework -show-cursor option
Related show

Commit Message

Gerd Hoffmann Feb. 7, 2020, 10:17 a.m. UTC
When enabled, this forces showing the mouse cursor,
i.e. do not hide the pointer on mouse grabs.
Defaults to off.

Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
---
 qapi/ui.json | 3 +++
 1 file changed, 3 insertions(+)

Comments

Markus Armbruster Feb. 7, 2020, 1:56 p.m. UTC | #1
Gerd Hoffmann <kraxel@redhat.com> writes:

> When enabled, this forces showing the mouse cursor,
> i.e. do not hide the pointer on mouse grabs.
> Defaults to off.
>
> Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
> ---
>  qapi/ui.json | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/qapi/ui.json b/qapi/ui.json
> index e04525d8b44b..b9df7fe7b5cb 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -1144,6 +1144,8 @@
>  # @type:          Which DisplayType qemu should use.
>  # @full-screen:   Start user interface in fullscreen mode (default: off).
>  # @window-close:  Allow to quit qemu with window close button (default: on).
> +# @show-cursor:   Force showing the mouse cursor (default: off).
> +#                 Since: 5.0

By convention, we use

   # Since: 5.0

for top-level definitions, and

   #                 (since 5.0)

for members and such.  See docs/devel/qapi-code-gen.txt section
"Definition documentation".

>  # @gl:            Enable OpenGL support (default: off).
>  #
>  # Since: 2.12
> @@ -1153,6 +1155,7 @@
>    'base'    : { 'type'           : 'DisplayType',
>                  '*full-screen'   : 'bool',
>                  '*window-close'  : 'bool',
> +                '*show-cursor'   : 'bool',
>                  '*gl'            : 'DisplayGLMode' },
>    'discriminator' : 'type',
>    'data'    : { 'gtk'            : 'DisplayGTK',

With the doc comment tidied up:
Reviewed-by: Markus Armbruster <armbru@redhat.com>

Patch
diff mbox series

diff --git a/qapi/ui.json b/qapi/ui.json
index e04525d8b44b..b9df7fe7b5cb 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -1144,6 +1144,8 @@ 
 # @type:          Which DisplayType qemu should use.
 # @full-screen:   Start user interface in fullscreen mode (default: off).
 # @window-close:  Allow to quit qemu with window close button (default: on).
+# @show-cursor:   Force showing the mouse cursor (default: off).
+#                 Since: 5.0
 # @gl:            Enable OpenGL support (default: off).
 #
 # Since: 2.12
@@ -1153,6 +1155,7 @@ 
   'base'    : { 'type'           : 'DisplayType',
                 '*full-screen'   : 'bool',
                 '*window-close'  : 'bool',
+                '*show-cursor'   : 'bool',
                 '*gl'            : 'DisplayGLMode' },
   'discriminator' : 'type',
   'data'    : { 'gtk'            : 'DisplayGTK',