Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

river-option: compositor may ignore set requests

Browse Source 
This allows the compositor to restrict options to a certain set of
values, which can be desirable if the options affect compositor
behavior.

This was always the intended behavior of the protocol, but now it is
explicitly stated.
This commit is contained in:
Isaac Freund 2021-01-18 01:34:06 +01:00
parent 8cbccbfb6e
commit 421c403cf5
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
protocol/river-options-unstable-v1.xml
View File

@ -110,27 +110,38 @@
<request name="set_int_value">
<description summary="set the value of the option">
If the option is either unset or set to a value of type int,
this request sets the value of the option as well as the type if
previously unset. Otherwise the request is ignored.
If the option is either unset or set to a value of type int, this
request asks the compositor to set the value of the option as well
as the type if previously unset. The compositor is not required to
honor this request.
If the option is already set and is not of type int, this request does nothing.
</description>
<arg name="value" type="int"/>
</request>
<request name="set_uint_value">
<description summary="set the value of the option">
If the option is either unset or set to a value of type uint,
this request sets the value of the option as well as the type if
previously unset. Otherwise the request is ignored.
If the option is either unset or set to a value of type uint, this
request asks the compositor to set the value of the option as well
as the type if previously unset. The compositor is not required to
honor this request.
If the option is already set and is not of type uint, this request
does nothing.
</description>
<arg name="value" type="uint"/>
</request>
<request name="set_fixed_value">
<description summary="set the value of the option">
If the option is either unset or set to a value of type fixed,
this request sets the value of the option as well as the type if
previously unset. Otherwise the request is ignored.
If the option is either unset or set to a value of type fixed, this
request asks the compositor to set the value of the option as well
as the type if previously unset. The compositor is not required to
honor this request.
If the option is already set and is not of type fixed, this request
does nothing.
</description>
<arg name="value" type="fixed"/>
</request>
@ -138,8 +149,12 @@
<request name="set_string_value">
<description summary="set the value of the option">
If the option is either unset or set to a value of type string,
this request sets the value of the option as well as the type if
previously unset. Otherwise the request is ignored.
this request asks the compositor to set the value of the option as
well as the type if previously unset. The compositor is not required
to honor this request.
If the option is already set and is not of type string, this request
does nothing.
</description>
<arg name="value" type="string" allow-null="true"/>
</request>