diff options
| author | Paul Pogonyshev <pogonyshev@gmx.net> | 2009-04-20 23:19:03 +0300 |
|---|---|---|
| committer | Paul Pogonyshev <pogonyshev@gmx.net> | 2009-04-20 23:19:03 +0300 |
| commit | fbed027845c24eb69a3325d6a5bc3c0aad12c4a8 (patch) | |
| tree | da31a3205516c9d119a7f00d6b0a2937eb816505 /docs/reference/pyglib-constants.xml | |
| parent | 9f5a9318ec769ccb4b9a8c4c7fdbad8f0e31250f (diff) | |
| download | pygobject-fbed027845c24eb69a3325d6a5bc3c0aad12c4a8.tar.gz pygobject-fbed027845c24eb69a3325d6a5bc3c0aad12c4a8.tar.xz pygobject-fbed027845c24eb69a3325d6a5bc3c0aad12c4a8.zip | |
Wrap four g_get_user_*_dir() functions
Wrap g_get_user_cache_dir(), g_get_user_config_dir(),
g_get_user_data_dir(), g_get_user_special_dir() and the constants
required for the latter. Document all new functions and constants.
(Bug #575999).
Diffstat (limited to 'docs/reference/pyglib-constants.xml')
| -rw-r--r-- | docs/reference/pyglib-constants.xml | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/reference/pyglib-constants.xml b/docs/reference/pyglib-constants.xml index a879171..0f1bf8d 100644 --- a/docs/reference/pyglib-constants.xml +++ b/docs/reference/pyglib-constants.xml @@ -15,6 +15,7 @@ <xref linkend="glib-io-condition-constants" endterm="glib-io-condition-constants-title"></xref> <xref linkend="glib-priority-constants" endterm="glib-priority-constants-title"></xref> <xref linkend="glib-spawn-flag-constants" endterm="glib-spawn-flag-constants-title"></xref> +<xref linkend="glib-user-directory-constants" endterm="glib-user-directory-constants-title"></xref> <xref linkend="glib-version-constants" endterm="glib-version-constants-title"></xref> </programlisting> @@ -192,6 +193,65 @@ of <parameter>argv</parameter> to the child.</simpara> </refsect2> + <refsect2 id="glib-user-directory-constants"> + <title id="glib-user-directory-constants-title">Glib User Directory Constants</title> + + <para>The User Directory constants are integer values that are currently used only as arguments to + <link linkend="function-glib--get-user-special-dir"><function>glib.get_user_special_dir</function>()</link> + function. See function documentation for details.</para> + + <variablelist> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_DESKTOP</literal></term> + <listitem> + <simpara>the user's Desktop directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_DOCUMENTS</literal></term> + <listitem> + <simpara>the user's Documents directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_DOWNLOAD</literal></term> + <listitem> + <simpara>the user's Downloads directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_MUSIC</literal></term> + <listitem> + <simpara>the user's Music directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_PICTURES</literal></term> + <listitem> + <simpara>the user's Pictures directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_PUBLIC_SHARE</literal></term> + <listitem> + <simpara>the user's shared directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_TEMPLATES</literal></term> + <listitem> + <simpara>the user's Templates directory</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>glib.USER_DIRECTORY_VIDEOS</literal></term> + <listitem> + <simpara>the user's Movies directory</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + <refsect2 id="glib-version-constants"> <title id="glib-version-constants-title">Glib Version Constants</title> <para>The Version constants specify the version of |