Spec: Clarify types of hints

Most type names were clear, but 'int' could map to different
dbus types. Use conventional D-Bus type names througout.
This commit is contained in:
Matthias Clasen 2011-09-05 08:31:58 -04:00
parent f6638ebfb7
commit 3a60c433fd
1 changed files with 13 additions and 13 deletions

View File

@ -663,7 +663,7 @@
<tbody valign="top"> <tbody valign="top">
<row> <row>
<entry><literal>"action-icons"</literal></entry> <entry><literal>"action-icons"</literal></entry>
<entry>boolean</entry> <entry>BOOLEAN</entry>
<entry> <entry>
When set, a server that has the "action-icons" capability will When set, a server that has the "action-icons" capability will
attempt to interpret any action identifier as a named icon. attempt to interpret any action identifier as a named icon.
@ -675,7 +675,7 @@
</row> </row>
<row> <row>
<entry><literal>"category"</literal></entry> <entry><literal>"category"</literal></entry>
<entry>string</entry> <entry>STRING</entry>
<entry> <entry>
The type of notification this is. The type of notification this is.
</entry> </entry>
@ -683,7 +683,7 @@
</row> </row>
<row> <row>
<entry><literal>"desktop-entry"</literal></entry> <entry><literal>"desktop-entry"</literal></entry>
<entry>string</entry> <entry>STRING</entry>
<entry> <entry>
This specifies the name of the desktop filename representing the This specifies the name of the desktop filename representing the
calling program. This should be the same as the prefix used for the calling program. This should be the same as the prefix used for the
@ -713,7 +713,7 @@
</row> </row>
<row> <row>
<entry><literal>"image-path"</literal></entry> <entry><literal>"image-path"</literal></entry>
<entry>string</entry> <entry>STRING</entry>
<entry> <entry>
Alternative way to define the notification image. See <xref linkend="icons-and-images"/>. Alternative way to define the notification image. See <xref linkend="icons-and-images"/>.
</entry> </entry>
@ -721,7 +721,7 @@
</row> </row>
<row> <row>
<entry><literal>"image_path"</literal></entry> <entry><literal>"image_path"</literal></entry>
<entry>string</entry> <entry>STRING</entry>
<entry> <entry>
<emphasis>Deprecated</emphasis>. Use image-path instead. <emphasis>Deprecated</emphasis>. Use image-path instead.
</entry> </entry>
@ -737,7 +737,7 @@
</row> </row>
<row> <row>
<entry><literal>"resident"</literal></entry> <entry><literal>"resident"</literal></entry>
<entry>boolean</entry> <entry>BOOLEAN</entry>
<entry> <entry>
When set the server will not automatically remove the When set the server will not automatically remove the
notification when an action has been invoked. The notification notification when an action has been invoked. The notification
@ -749,7 +749,7 @@
</row> </row>
<row> <row>
<entry><literal>"sound-file"</literal></entry> <entry><literal>"sound-file"</literal></entry>
<entry>string</entry> <entry>STRING</entry>
<entry> <entry>
The path to a sound file to play when the notification pops up. The path to a sound file to play when the notification pops up.
</entry> </entry>
@ -757,7 +757,7 @@
</row> </row>
<row> <row>
<entry><literal>"sound-name"</literal></entry> <entry><literal>"sound-name"</literal></entry>
<entry>string</entry> <entry>STRING</entry>
<entry> <entry>
A themeable named sound from the freedesktop.org A themeable named sound from the freedesktop.org
<ulink url="http://0pointer.de/public/sound-naming-spec.html">sound naming specification</ulink> <ulink url="http://0pointer.de/public/sound-naming-spec.html">sound naming specification</ulink>
@ -768,7 +768,7 @@
</row> </row>
<row> <row>
<entry><literal>"suppress-sound"</literal></entry> <entry><literal>"suppress-sound"</literal></entry>
<entry>boolean</entry> <entry>BOOLEAN</entry>
<entry> <entry>
Causes the server to suppress playing any sounds, if it has that Causes the server to suppress playing any sounds, if it has that
ability. This is usually set when the client itself is going to ability. This is usually set when the client itself is going to
@ -778,7 +778,7 @@
</row> </row>
<row> <row>
<entry><literal>"transient"</literal></entry> <entry><literal>"transient"</literal></entry>
<entry>boolean</entry> <entry>BOOLEAN</entry>
<entry> <entry>
When set the server will treat the notification as transient When set the server will treat the notification as transient
and by-pass the server's persistence capability, if it should and by-pass the server's persistence capability, if it should
@ -788,7 +788,7 @@
</row> </row>
<row> <row>
<entry><literal>"x"</literal></entry> <entry><literal>"x"</literal></entry>
<entry>int</entry> <entry>INT32</entry>
<entry> <entry>
Specifies the X location on the screen that the notification should Specifies the X location on the screen that the notification should
point to. The <literal>"y"</literal> hint must also be specified. point to. The <literal>"y"</literal> hint must also be specified.
@ -797,7 +797,7 @@
</row> </row>
<row> <row>
<entry><literal>"y"</literal></entry> <entry><literal>"y"</literal></entry>
<entry>int</entry> <entry>INT32</entry>
<entry> <entry>
Specifies the Y location on the screen that the notification should Specifies the Y location on the screen that the notification should
point to. The <literal>"x"</literal> hint must also be specified. point to. The <literal>"x"</literal> hint must also be specified.
@ -806,7 +806,7 @@
</row> </row>
<row> <row>
<entry><literal>"urgency"</literal></entry> <entry><literal>"urgency"</literal></entry>
<entry>byte</entry> <entry>BYTE</entry>
<entry> <entry>
The urgency level. The urgency level.
</entry> </entry>