Add some documentation to the filechooser schema

This commit is contained in:
Matthias Clasen 2014-05-13 12:37:39 -04:00
parent 128748c5cd
commit 514efb51b0

View File

@ -49,38 +49,42 @@
</key> </key>
<key name='location-mode' enum='org.gtk.Settings.FileChooser.LocationMode'> <key name='location-mode' enum='org.gtk.Settings.FileChooser.LocationMode'>
<default>'path-bar'</default> <default>'path-bar'</default>
<summary>Location mode</summary>
<description> <description>
Controls whether the file chooser Controls whether the file chooser shows just a path bar, or a visible entry
shows just a path bar, or a visible entry for the filename as well, for the for the filename as well, for the benefit of typing-oriented users. The
benefit of typing-oriented users. The possible values for these modes possible values for these modes are "path-bar" and "filename-entry".
are "path-bar" and "filename-entry".
</description> </description>
</key> </key>
<key name='show-hidden' type='b'> <key name='show-hidden' type='b'>
<default>false</default> <default>false</default>
<summary>Whether to show hidden files</summary> <summary>Show hidden files</summary>
<description> <description>
Controls whether the file chooser shows hidden files or not. Controls whether the file chooser shows hidden files or not.
</description> </description>
</key> </key>
<key type="b" name="sort-directories-first"> <key type="b" name="sort-directories-first">
<default>false</default> <default>false</default>
<summary>Whether to show folders first</summary> <summary>Show folders first</summary>
<description>If set to true, then folders are shown prior to showing files in the icon and list views.</description> <description>
If set to true, then folders are shown before files in the list.
</description>
</key> </key>
<key name='expand-folders' type='b'> <key name='expand-folders' type='b'>
<default>false</default> <default>false</default>
<summary>Expand folders</summary>
<description>This key is deprecated; do not use it.</description> <description>This key is deprecated; do not use it.</description>
</key> </key>
<key name='show-size-column' type='b'> <key name='show-size-column' type='b'>
<default>true</default> <default>true</default>
<summary>Show file sizes</summary>
<description> <description>
Controls whether the file chooser shows a column with file Controls whether the file chooser shows a column with file sizes.
sizes.
</description> </description>
</key> </key>
<key name='sort-column' enum='org.gtk.Settings.FileChooser.SortColumn'> <key name='sort-column' enum='org.gtk.Settings.FileChooser.SortColumn'>
<default>'name'</default> <default>'name'</default>
<summary>Sort column</summary>
<description> <description>
Can be one of "name", "modified", or "size". It controls Can be one of "name", "modified", or "size". It controls
which of the columns in the file chooser is used for sorting which of the columns in the file chooser is used for sorting
@ -89,24 +93,29 @@
</key> </key>
<key name='sort-order' enum='org.gtk.Settings.FileChooser.SortOrder'> <key name='sort-order' enum='org.gtk.Settings.FileChooser.SortOrder'>
<default>'ascending'</default> <default>'ascending'</default>
<summary>Sort order</summary>
<description> <description>
Can be one of the strings "ascending" or "descending". Can be one of the strings "ascending" or "descending".
</description> </description>
</key> </key>
<key name='window-position' type='(ii)'> <key name='window-position' type='(ii)'>
<default>(-1, -1)</default> <default>(-1, -1)</default>
<summary>Window position</summary>
<description> <description>
Coordinates (x, y) of the upper-left corner of the GtkFileChooserDialog's window. The (x, y) coordinates of the upper-left corner of the GtkFileChooserDialog's
window.
</description> </description>
</key> </key>
<key name='window-size' type='(ii)'> <key name='window-size' type='(ii)'>
<default>(-1, -1)</default> <default>(-1, -1)</default>
<summary>Window size</summary>
<description> <description>
Size in pixels (width, height) of the GtkFileChooserDialog's window. The size (width, height) of the GtkFileChooserDialog's window, in pixels.
</description> </description>
</key> </key>
<key name='startup-mode' enum='org.gtk.Settings.FileChooser.StartupMode'> <key name='startup-mode' enum='org.gtk.Settings.FileChooser.StartupMode'>
<default>'recent'</default> <default>'recent'</default>
<summary>Startup mode</summary>
<description> <description>
Either "recent" or "cwd"; controls whether the file chooser Either "recent" or "cwd"; controls whether the file chooser
starts up showing the list of recently-used files, or the starts up showing the list of recently-used files, or the
@ -115,12 +124,14 @@
</key> </key>
<key name='sidebar-width' type='i'> <key name='sidebar-width' type='i'>
<default>148</default> <default>148</default>
<summary>Sidebar width</summary>
<description> <description>
Width in pixels of the file chooser's places sidebar. Width in pixels of the file chooser's places sidebar.
</description> </description>
</key> </key>
<key name="clock-format" enum="org.gtk.Settings.FileChooser.ClockFormat"> <key name="clock-format" enum="org.gtk.Settings.FileChooser.ClockFormat">
<default>'24h'</default> <default>'24h'</default>
<summary>Time format</summary>
<description> <description>
Whether the time is shown in 24h or 12h format. Whether the time is shown in 24h or 12h format.
</description> </description>