doc/xml/gnome-vfs-mime-database.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-mime-database">
   2 <refmeta>
   3 <refentrytitle>File Types</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>File Types</refname><refpurpose>
  10 functions for getting information about files based on their MIME type</refpurpose>
  11 </refnamediv>
  12
  13 <refsynopsisdiv><title>Synopsis</title>
  14
  15 <synopsis>
  16
  17
  18
  19 #define     <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN-CAPS">GNOME_VFS_MIME_TYPE_UNKNOWN</link>
  20 const <link linkend="char">char</link>* <link linkend="gnome-vfs-get-mime-type-for-data">gnome_vfs_get_mime_type_for_data</link>
  21                                             (<link linkend="gconstpointer">gconstpointer</link> data,
  22                                              <link linkend="int">int</link> data_size);
  23 <link linkend="char">char</link>*       <link linkend="gnome-vfs-get-mime-type">gnome_vfs_get_mime_type</link>         (const <link linkend="char">char</link> *text_uri);
  24 enum        <link linkend="GnomeVFSMimeActionType">GnomeVFSMimeActionType</link>;
  25 enum        <link linkend="GnomeVFSMimeApplicationArgumentType">GnomeVFSMimeApplicationArgumentType</link>;
  26 typedef     <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>;
  27 <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* <link linkend="gnome-vfs-mime-application-copy">gnome_vfs_mime_application_copy</link>
  28                                             (<link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);
  29 <link linkend="GnomeVFSMimeActionType">GnomeVFSMimeActionType</link> <link linkend="gnome-vfs-mime-get-default-action-type">gnome_vfs_mime_get_default_action_type</link>
  30                                             (const <link linkend="char">char</link> *mime_type);
  31 <link linkend="GnomeVFSMimeAction">GnomeVFSMimeAction</link>* <link linkend="gnome-vfs-mime-get-default-action">gnome_vfs_mime_get_default_action</link>
  32                                             (const <link linkend="char">char</link> *mime_type);
  33 <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* <link linkend="gnome-vfs-mime-get-default-application">gnome_vfs_mime_get_default_application</link>
  34                                             (const <link linkend="char">char</link> *mime_type);
  35 <link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link>* <link linkend="gnome-vfs-mime-get-default-component">gnome_vfs_mime_get_default_component</link>
  36                                             (const <link linkend="char">char</link> *mime_type);
  37 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-get-short-list-applications">gnome_vfs_mime_get_short_list_applications</link>
  38                                             (const <link linkend="char">char</link> *mime_type);
  39 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-get-short-list-components">gnome_vfs_mime_get_short_list_components</link>
  40                                             (const <link linkend="char">char</link> *mime_type);
  41 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-get-all-applications">gnome_vfs_mime_get_all_applications</link>
  42                                             (const <link linkend="char">char</link> *mime_type);
  43 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-get-all-components">gnome_vfs_mime_get_all_components</link>
  44                                             (const <link linkend="char">char</link> *mime_type);
  45 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-default-action-type">gnome_vfs_mime_set_default_action_type</link>
  46                                             (const <link linkend="char">char</link> *mime_type,
  47                                              <link linkend="GnomeVFSMimeActionType">GnomeVFSMimeActionType</link> action_type);
  48 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-default-application">gnome_vfs_mime_set_default_application</link>
  49                                             (const <link linkend="char">char</link> *mime_type,
  50                                              const <link linkend="char">char</link> *application_id);
  51 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-default-component">gnome_vfs_mime_set_default_component</link>
  52                                             (const <link linkend="char">char</link> *mime_type,
  53                                              const <link linkend="char">char</link> *component_iid);
  54 const <link linkend="char">char</link>* <link linkend="gnome-vfs-mime-get-icon">gnome_vfs_mime_get_icon</link>         (const <link linkend="char">char</link> *mime_type);
  55 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-icon">gnome_vfs_mime_set_icon</link>      (const <link linkend="char">char</link> *mime_type,
  56                                              const <link linkend="char">char</link> *filename);
  57 const <link linkend="char">char</link>* <link linkend="gnome-vfs-mime-get-description">gnome_vfs_mime_get_description</link>  (const <link linkend="char">char</link> *mime_type);
  58 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-description">gnome_vfs_mime_set_description</link>
  59                                             (const <link linkend="char">char</link> *mime_type,
  60                                              const <link linkend="char">char</link> *description);
  61 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-mime-can-be-executable">gnome_vfs_mime_can_be_executable</link>
  62                                             (const <link linkend="char">char</link> *mime_type);
  63 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-can-be-executable">gnome_vfs_mime_set_can_be_executable</link>
  64                                             (const <link linkend="char">char</link> *mime_type,
  65                                              <link linkend="gboolean">gboolean</link> new_value);
  66 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-short-list-applications">gnome_vfs_mime_set_short_list_applications</link>
  67                                             (const <link linkend="char">char</link> *mime_type,
  68                                              <link linkend="GList">GList</link> *application_ids);
  69 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-short-list-components">gnome_vfs_mime_set_short_list_components</link>
  70                                             (const <link linkend="char">char</link> *mime_type,
  71                                              <link linkend="GList">GList</link> *component_iids);
  72 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-add-application-to-short-list">gnome_vfs_mime_add_application_to_short_list</link>
  73                                             (const <link linkend="char">char</link> *mime_type,
  74                                              const <link linkend="char">char</link> *application_id);
  75 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-remove-application-from-short-list">gnome_vfs_mime_remove_application_from_short_list</link>
  76                                             (const <link linkend="char">char</link> *mime_type,
  77                                              const <link linkend="char">char</link> *application_id);
  78 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-add-component-to-short-list">gnome_vfs_mime_add_component_to_short_list</link>
  79                                             (const <link linkend="char">char</link> *mime_type,
  80                                              const <link linkend="char">char</link> *iid);
  81 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-remove-component-from-short-list">gnome_vfs_mime_remove_component_from_short_list</link>
  82                                             (const <link linkend="char">char</link> *mime_type,
  83                                              const <link linkend="char">char</link> *iid);
  84 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-add-extension">gnome_vfs_mime_add_extension</link> (const <link linkend="char">char</link> *mime_type,
  85                                              const <link linkend="char">char</link> *extension);
  86 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-remove-extension">gnome_vfs_mime_remove_extension</link>
  87                                             (const <link linkend="char">char</link> *mime_type,
  88                                              const <link linkend="char">char</link> *extension);
  89 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-extend-all-applications">gnome_vfs_mime_extend_all_applications</link>
  90                                             (const <link linkend="char">char</link> *mime_type,
  91                                              <link linkend="GList">GList</link> *application_ids);
  92 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-remove-from-all-applications">gnome_vfs_mime_remove_from_all_applications</link>
  93                                             (const <link linkend="char">char</link> *mime_type,
  94                                              <link linkend="GList">GList</link> *application_ids);
  95 <link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* <link linkend="gnome-vfs-mime-application-new-from-id">gnome_vfs_mime_application_new_from_id</link>
  96                                             (const <link linkend="char">char</link> *id);
  97 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-application-free">gnome_vfs_mime_application_free</link> (<link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);
  98 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-action-free">gnome_vfs_mime_action_free</link>      (<link linkend="GnomeVFSMimeAction">GnomeVFSMimeAction</link> *action);
  99 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-application-list-free">gnome_vfs_mime_application_list_free</link>
 100                                             (<link linkend="GList">GList</link> *list);
 101 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-component-list-free">gnome_vfs_mime_component_list_free</link>
 102                                             (<link linkend="GList">GList</link> *list);
 103 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-mime-id-in-application-list">gnome_vfs_mime_id_in_application_list</link>
 104                                             (const <link linkend="char">char</link> *id,
 105                                              <link linkend="GList">GList</link> *applications);
 106 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-mime-id-in-component-list">gnome_vfs_mime_id_in_component_list</link>
 107                                             (const <link linkend="char">char</link> *iid,
 108                                              <link linkend="GList">GList</link> *components);
 109 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-remove-application-from-list">gnome_vfs_mime_remove_application_from_list</link>
 110                                             (<link linkend="GList">GList</link> *applications,
 111                                              const <link linkend="char">char</link> *application_id,
 112                                              <link linkend="gboolean">gboolean</link> *did_remove);
 113 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-remove-component-from-list">gnome_vfs_mime_remove_component_from_list</link>
 114                                             (<link linkend="GList">GList</link> *components,
 115                                              const <link linkend="char">char</link> *iid,
 116                                              <link linkend="gboolean">gboolean</link> *did_remove);
 117 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-id-list-from-component-list">gnome_vfs_mime_id_list_from_component_list</link>
 118                                             (<link linkend="GList">GList</link> *components);
 119 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-id-list-from-application-list">gnome_vfs_mime_id_list_from_application_list</link>
 120                                             (<link linkend="GList">GList</link> *applications);
 121 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-freeze">gnome_vfs_mime_freeze</link>           (void);
 122 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-thaw">gnome_vfs_mime_thaw</link>             (void);
 123 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-info-reload">gnome_vfs_mime_info_reload</link>      (void);
 124 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-mime-type-is-known">gnome_vfs_mime_type_is_known</link>    (const <link linkend="char">char</link> *mime_type);
 125 const <link linkend="char">char</link>* <link linkend="gnome-vfs-mime-get-value">gnome_vfs_mime_get_value</link>        (const <link linkend="char">char</link> *mime_type,
 126                                              const <link linkend="char">char</link> *key);
 127 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-value">gnome_vfs_mime_set_value</link>     (const <link linkend="char">char</link> *mime_type,
 128                                              const <link linkend="char">char</link> *key,
 129                                              const <link linkend="char">char</link> *value);
 130 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-get-key-list">gnome_vfs_mime_get_key_list</link>     (const <link linkend="char">char</link> *mime_type);
 131 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-keys-list-free">gnome_vfs_mime_keys_list_free</link>   (<link linkend="GList">GList</link> *mime_type_list);
 132 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-mime-get-extensions-list">gnome_vfs_mime_get_extensions_list</link>
 133                                             (const <link linkend="char">char</link> *mime_type);
 134 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-extensions-list-free">gnome_vfs_mime_extensions_list_free</link>
 135                                             (<link linkend="GList">GList</link> *list);
 136 <link linkend="char">char</link>*       <link linkend="gnome-vfs-mime-get-extensions-string">gnome_vfs_mime_get_extensions_string</link>
 137                                             (const <link linkend="char">char</link> *mime_type);
 138 <link linkend="char">char</link>*       <link linkend="gnome-vfs-mime-get-extensions-pretty-string">gnome_vfs_mime_get_extensions_pretty_string</link>
 139                                             (const <link linkend="char">char</link> *mime_type);
 140 <link linkend="GList">GList</link>*      <link linkend="gnome-vfs-get-registered-mime-types">gnome_vfs_get_registered_mime_types</link>
 141                                             (void);
 142 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-registered-mime-type-list-free">gnome_vfs_mime_registered_mime_type_list_free</link>
 143                                             (<link linkend="GList">GList</link> *list);
 144 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-registered-type-key">gnome_vfs_mime_set_registered_type_key</link>
 145                                             (const <link linkend="char">char</link> *mime_type,
 146                                              const <link linkend="char">char</link> *key,
 147                                              const <link linkend="char">char</link> *data);
 148 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-mime-set-extensions-list">gnome_vfs_mime_set_extensions_list</link>
 149                                             (const <link linkend="char">char</link> *mime_type,
 150                                              const <link linkend="char">char</link> *extensions_list);
 151 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-registered-mime-type-delete">gnome_vfs_mime_registered_mime_type_delete</link>
 152                                             (const <link linkend="char">char</link> *mime_type);
 153 <link linkend="void">void</link>        <link linkend="gnome-vfs-mime-reset">gnome_vfs_mime_reset</link>            (void);
 154 </synopsis>
 155 </refsynopsisdiv>
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165 <refsect1>
 166 <title>Description</title>
 167 <para>
 168
 169 </para>
 170 </refsect1>
 171
 172 <refsect1>
 173 <title>Details</title>
 174 <refsect2>
 175 <title><anchor id="GNOME-VFS-MIME-TYPE-UNKNOWN-CAPS"/>GNOME_VFS_MIME_TYPE_UNKNOWN</title>
 176 <indexterm><primary>GNOME_VFS_MIME_TYPE_UNKNOWN</primary></indexterm><programlisting>#define GNOME_VFS_MIME_TYPE_UNKNOWN "application/octet-stream"
 177 </programlisting>
 178 <para>
 179 The value returned for the MIME type when a file did
 180 not match any entries in the MIME database. May be
 181 treated as a file of an unknown type.</para>
 182 <para>
 183
 184 </para></refsect2>
 185 <refsect2>
 186 <title><anchor id="gnome-vfs-get-mime-type-for-data"/>gnome_vfs_get_mime_type_for_data ()</title>
 187 <indexterm><primary>gnome_vfs_get_mime_type_for_data</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_get_mime_type_for_data
 188                                             (<link linkend="gconstpointer">gconstpointer</link> data,
 189                                              <link linkend="int">int</link> data_size);</programlisting>
 190 <para>
 191 Tries to guess the mime type of the data in <parameter>data</parameter>
 192 using the magic patterns.</para>
 193 <para>
 194
 195 </para><variablelist role="params">
 196 <varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 197 <listitem><simpara> A pointer to data in memory.
 198 </simpara></listitem></varlistentry>
 199 <varlistentry><term><parameter>data_size</parameter>&nbsp;:</term>
 200 <listitem><simpara> Size of the data.
 201 </simpara></listitem></varlistentry>
 202 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the mime-type for this filename.
 203 </simpara></listitem></varlistentry>
 204 </variablelist></refsect2>
 205 <refsect2>
 206 <title><anchor id="gnome-vfs-get-mime-type"/>gnome_vfs_get_mime_type ()</title>
 207 <indexterm><primary>gnome_vfs_get_mime_type</primary></indexterm><programlisting><link linkend="char">char</link>*       gnome_vfs_get_mime_type         (const <link linkend="char">char</link> *text_uri);</programlisting>
 208 <para>
 209 Determine the mime type of <parameter>text_uri</parameter>. The mime type is determined
 210 in the same way as by <link linkend="gnome-vfs-get-file-info"><function>gnome_vfs_get_file_info()</function></link>. This is meant as
 211 a convenience function for times when you only want the mime type.</para>
 212 <para>
 213
 214 </para><variablelist role="params">
 215 <varlistentry><term><parameter>text_uri</parameter>&nbsp;:</term>
 216 <listitem><simpara> URI of the file for which to get the mime type
 217 </simpara></listitem></varlistentry>
 218 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The mime type, or NULL if there is an error reading
 219 the file.
 220 </simpara></listitem></varlistentry>
 221 </variablelist></refsect2>
 222 <refsect2>
 223 <title><anchor id="GnomeVFSMimeActionType"/>enum GnomeVFSMimeActionType</title>
 224 <indexterm><primary>GnomeVFSMimeActionType</primary></indexterm><programlisting>typedef enum {
 225         GNOME_VFS_MIME_ACTION_TYPE_NONE,
 226         GNOME_VFS_MIME_ACTION_TYPE_APPLICATION,
 227         GNOME_VFS_MIME_ACTION_TYPE_COMPONENT
 228 } GnomeVFSMimeActionType;
 229 </programlisting>
 230 <para>
 231
 232 </para></refsect2>
 233 <refsect2>
 234 <title><anchor id="GnomeVFSMimeApplicationArgumentType"/>enum GnomeVFSMimeApplicationArgumentType</title>
 235 <indexterm><primary>GnomeVFSMimeApplicationArgumentType</primary></indexterm><programlisting>typedef enum {
 236         GNOME_VFS_MIME_APPLICATION_ARGUMENT_TYPE_URIS,
 237         GNOME_VFS_MIME_APPLICATION_ARGUMENT_TYPE_PATHS,
 238         GNOME_VFS_MIME_APPLICATION_ARGUMENT_TYPE_URIS_FOR_NON_FILES
 239 } GnomeVFSMimeApplicationArgumentType;
 240 </programlisting>
 241 <para>
 242
 243 </para></refsect2>
 244 <refsect2>
 245 <title><anchor id="GnomeVFSMimeApplication"/>GnomeVFSMimeApplication</title>
 246 <indexterm><primary>GnomeVFSMimeApplication</primary></indexterm><programlisting>typedef struct {
 247         char *id;
 248         char *name;
 249         char *command;
 250         gboolean can_open_multiple_files;
 251         GnomeVFSMimeApplicationArgumentType expects_uris;
 252         GList *supported_uri_schemes;
 253         gboolean requires_terminal;
 254
 255         /* Padded to avoid future breaks in ABI compatibility */
 256         void *reserved1;
 257         void *reserved2;
 258
 259 } GnomeVFSMimeApplication;
 260 </programlisting>
 261 <para>
 262
 263 </para></refsect2>
 264 <refsect2>
 265 <title><anchor id="gnome-vfs-mime-application-copy"/>gnome_vfs_mime_application_copy ()</title>
 266 <indexterm><primary>gnome_vfs_mime_application_copy</primary></indexterm><programlisting><link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* gnome_vfs_mime_application_copy
 267                                             (<link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);</programlisting>
 268 <para>
 269 Creates a newly referenced copy of a GnomeVFSMimeApplication object.</para>
 270 <para>
 271
 272 </para><variablelist role="params">
 273 <varlistentry><term><parameter>application</parameter>&nbsp;:</term>
 274 <listitem><simpara> The GnomeVFSMimeApplication to be duplicated.
 275 </simpara></listitem></varlistentry>
 276 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A copy of <parameter>application</parameter>
 277 </simpara></listitem></varlistentry>
 278 </variablelist></refsect2>
 279 <refsect2>
 280 <title><anchor id="gnome-vfs-mime-get-default-action-type"/>gnome_vfs_mime_get_default_action_type ()</title>
 281 <indexterm><primary>gnome_vfs_mime_get_default_action_type</primary></indexterm><programlisting><link linkend="GnomeVFSMimeActionType">GnomeVFSMimeActionType</link> gnome_vfs_mime_get_default_action_type
 282                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 283 <para>
 284 Query the MIME database for the type of action to be performed on a particular MIME type by default.</para>
 285 <para>
 286
 287 </para><variablelist role="params">
 288 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 289 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 290 </simpara></listitem></varlistentry>
 291 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The type of action to be performed on a file of
 292 MIME type, <parameter>mime_type</parameter> by default.
 293 </simpara></listitem></varlistentry>
 294 </variablelist></refsect2>
 295 <refsect2>
 296 <title><anchor id="gnome-vfs-mime-get-default-action"/>gnome_vfs_mime_get_default_action ()</title>
 297 <indexterm><primary>gnome_vfs_mime_get_default_action</primary></indexterm><programlisting><link linkend="GnomeVFSMimeAction">GnomeVFSMimeAction</link>* gnome_vfs_mime_get_default_action
 298                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 299 <para>
 300 Query the MIME database for default action associated with a particular MIME type <parameter>mime_type</parameter>.</para>
 301 <para>
 302
 303 </para><variablelist role="params">
 304 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 305 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 306 </simpara></listitem></varlistentry>
 307 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSMimeAction representing the default action to perform upon
 308 file of type <parameter>mime_type</parameter>.
 309 </simpara></listitem></varlistentry>
 310 </variablelist></refsect2>
 311 <refsect2>
 312 <title><anchor id="gnome-vfs-mime-get-default-application"/>gnome_vfs_mime_get_default_application ()</title>
 313 <indexterm><primary>gnome_vfs_mime_get_default_application</primary></indexterm><programlisting><link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* gnome_vfs_mime_get_default_application
 314                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 315 <para>
 316 Query the MIME database for the application to be executed on files of MIME type
 317 <parameter>mime_type</parameter> by default.</para>
 318 <para>
 319
 320 </para><variablelist role="params">
 321 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 322 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 323 </simpara></listitem></varlistentry>
 324 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSMimeApplication representing the default handler of <parameter>mime_type</parameter>
 325 </simpara></listitem></varlistentry>
 326 </variablelist></refsect2>
 327 <refsect2>
 328 <title><anchor id="gnome-vfs-mime-get-default-component"/>gnome_vfs_mime_get_default_component ()</title>
 329 <indexterm><primary>gnome_vfs_mime_get_default_component</primary></indexterm><programlisting><link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link>* gnome_vfs_mime_get_default_component
 330                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 331 <para>
 332 Query the MIME database for the default Bonobo component to be activated to
 333 view files of MIME type <parameter>mime_type</parameter>.</para>
 334 <para>
 335
 336 </para><variablelist role="params">
 337 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 338 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 339 </simpara></listitem></varlistentry>
 340 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An Bonobo_ServerInfo * representing the OAF server to be activated
 341 to get a reference to the proper component.
 342 </simpara></listitem></varlistentry>
 343 </variablelist></refsect2>
 344 <refsect2>
 345 <title><anchor id="gnome-vfs-mime-get-short-list-applications"/>gnome_vfs_mime_get_short_list_applications ()</title>
 346 <indexterm><primary>gnome_vfs_mime_get_short_list_applications</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_get_short_list_applications
 347                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 348 <para>
 349 Return an alphabetically sorted list of GnomeVFSMimeApplication
 350 data structures for the requested mime type.    The short list contains
 351 "select" applications recommended for handling this MIME type, appropriate for
 352 display to the user.</para>
 353 <para>
 354
 355 </para><variablelist role="params">
 356 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 357 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 358 </simpara></listitem></varlistentry>
 359 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GList * where the elements are GnomeVFSMimeApplication *
 360 representing various applications to display in the short list for <parameter>mime_type</parameter>.
 361 </simpara></listitem></varlistentry>
 362 </variablelist></refsect2>
 363 <refsect2>
 364 <title><anchor id="gnome-vfs-mime-get-short-list-components"/>gnome_vfs_mime_get_short_list_components ()</title>
 365 <indexterm><primary>gnome_vfs_mime_get_short_list_components</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_get_short_list_components
 366                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 367 <para>
 368 Return an unsorted sorted list of Bonobo_ServerInfo *
 369 data structures for the requested mime type.    The short list contains
 370 "select" components recommended for handling this MIME type, appropriate for
 371 display to the user.</para>
 372 <para>
 373
 374 </para><variablelist role="params">
 375 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 376 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 377 </simpara></listitem></varlistentry>
 378 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GList * where the elements are Bonobo_ServerInfo *
 379 representing various components to display in the short list for <parameter>mime_type</parameter>.
 380 </simpara></listitem></varlistentry>
 381 </variablelist></refsect2>
 382 <refsect2>
 383 <title><anchor id="gnome-vfs-mime-get-all-applications"/>gnome_vfs_mime_get_all_applications ()</title>
 384 <indexterm><primary>gnome_vfs_mime_get_all_applications</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_get_all_applications
 385                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 386 <para>
 387 Return an alphabetically sorted list of GnomeVFSMimeApplication
 388 data structures representing all applications in the MIME database registered
 389 to handle files of MIME type <parameter>mime_type</parameter> (and supertypes).</para>
 390 <para>
 391
 392 </para><variablelist role="params">
 393 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 394 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 395 </simpara></listitem></varlistentry>
 396 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GList * where the elements are GnomeVFSMimeApplication *
 397 representing applications that handle MIME type <parameter>mime_type</parameter>.
 398 </simpara></listitem></varlistentry>
 399 </variablelist></refsect2>
 400 <refsect2>
 401 <title><anchor id="gnome-vfs-mime-get-all-components"/>gnome_vfs_mime_get_all_components ()</title>
 402 <indexterm><primary>gnome_vfs_mime_get_all_components</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_get_all_components
 403                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 404 <para>
 405 Return an alphabetically sorted list of Bonobo_ServerInfo
 406 data structures representing all Bonobo components registered
 407 to handle files of MIME type <parameter>mime_type</parameter> (and supertypes).</para>
 408 <para>
 409
 410 </para><variablelist role="params">
 411 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 412 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 413 </simpara></listitem></varlistentry>
 414 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GList * where the elements are Bonobo_ServerInfo *
 415 representing components that can handle MIME type <parameter>mime_type</parameter>.
 416 </simpara></listitem></varlistentry>
 417 </variablelist></refsect2>
 418 <refsect2>
 419 <title><anchor id="gnome-vfs-mime-set-default-action-type"/>gnome_vfs_mime_set_default_action_type ()</title>
 420 <indexterm><primary>gnome_vfs_mime_set_default_action_type</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_default_action_type
 421                                             (const <link linkend="char">char</link> *mime_type,
 422                                              <link linkend="GnomeVFSMimeActionType">GnomeVFSMimeActionType</link> action_type);</programlisting>
 423 <para>
 424 Sets the default action type to be performed on files of MIME type <parameter>mime_type</parameter>.</para>
 425 <para>
 426
 427 </para><variablelist role="params">
 428 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 429 <listitem><simpara> A const char * containing a mime type, e.g. "image/png"
 430 </simpara></listitem></varlistentry>
 431 <varlistentry><term><parameter>action_type</parameter>&nbsp;:</term>
 432 <listitem><simpara> A GnomeVFSMimeActionType containing the action to perform by default
 433 </simpara></listitem></varlistentry>
 434 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 435 any errors encountered.
 436 </simpara></listitem></varlistentry>
 437 </variablelist></refsect2>
 438 <refsect2>
 439 <title><anchor id="gnome-vfs-mime-set-default-application"/>gnome_vfs_mime_set_default_application ()</title>
 440 <indexterm><primary>gnome_vfs_mime_set_default_application</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_default_application
 441                                             (const <link linkend="char">char</link> *mime_type,
 442                                              const <link linkend="char">char</link> *application_id);</programlisting>
 443 <para>
 444 Sets the default application to be run on files of MIME type <parameter>mime_type</parameter>.</para>
 445 <para>
 446
 447 </para><variablelist role="params">
 448 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 449 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 450 </simpara></listitem></varlistentry>
 451 <varlistentry><term><parameter>application_id</parameter>&nbsp;:</term>
 452 <listitem><simpara> A key representing an application in the MIME database
 453 (GnomeVFSMimeApplication-&gt;id, for example)
 454 </simpara></listitem></varlistentry>
 455 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 456 any errors encountered.
 457 </simpara></listitem></varlistentry>
 458 </variablelist></refsect2>
 459 <refsect2>
 460 <title><anchor id="gnome-vfs-mime-set-default-component"/>gnome_vfs_mime_set_default_component ()</title>
 461 <indexterm><primary>gnome_vfs_mime_set_default_component</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_default_component
 462                                             (const <link linkend="char">char</link> *mime_type,
 463                                              const <link linkend="char">char</link> *component_iid);</programlisting>
 464 <para>
 465 Sets the default component to be activated for files of MIME type <parameter>mime_type</parameter>.</para>
 466 <para>
 467
 468 </para><variablelist role="params">
 469 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 470 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 471 </simpara></listitem></varlistentry>
 472 <varlistentry><term><parameter>component_iid</parameter>&nbsp;:</term>
 473 <listitem><simpara> The OAFIID of a component
 474 </simpara></listitem></varlistentry>
 475 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 476 any errors encountered.
 477 </simpara></listitem></varlistentry>
 478 </variablelist></refsect2>
 479 <refsect2>
 480 <title><anchor id="gnome-vfs-mime-get-icon"/>gnome_vfs_mime_get_icon ()</title>
 481 <indexterm><primary>gnome_vfs_mime_get_icon</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_mime_get_icon         (const <link linkend="char">char</link> *mime_type);</programlisting>
 482 <para>
 483 Query the MIME database for an icon representing the specified MIME type.</para>
 484 <para>
 485
 486 </para><variablelist role="params">
 487 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 488 <listitem><simpara> A const char * containing a  MIME type
 489 </simpara></listitem></varlistentry>
 490 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The filename of the icon as listed in the MIME database. This is
 491 usually a filename without path information, e.g. "i-chardev.png", and sometimes
 492 does not have an extension, e.g. "i-regular" if the icon is supposed to be image
 493 type agnostic between icon themes. Icons are generic, and not theme specific. These
 494 will not necessarily match with the icons a user sees in Nautilus, you have been warned.
 495 </simpara></listitem></varlistentry>
 496 </variablelist></refsect2>
 497 <refsect2>
 498 <title><anchor id="gnome-vfs-mime-set-icon"/>gnome_vfs_mime_set_icon ()</title>
 499 <indexterm><primary>gnome_vfs_mime_set_icon</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_icon      (const <link linkend="char">char</link> *mime_type,
 500                                              const <link linkend="char">char</link> *filename);</programlisting>
 501 <para>
 502 Set the icon entry for a particular MIME type in the MIME database. Note that
 503 icon entries need not necessarily contain the full path, and do not necessarily need to
 504 specify an extension. So "i-regular", "my-special-icon.png", and "some-icon"
 505 are all valid icon filenames.</para>
 506 <para>
 507
 508 </para><variablelist role="params">
 509 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 510 <listitem><simpara> A const char * containing a  MIME type
 511 </simpara></listitem></varlistentry>
 512 <varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
 513 <listitem><simpara> a const char * containing an image filename
 514 </simpara></listitem></varlistentry>
 515 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation
 516 or any errors that may have occurred.
 517 </simpara></listitem></varlistentry>
 518 </variablelist></refsect2>
 519 <refsect2>
 520 <title><anchor id="gnome-vfs-mime-get-description"/>gnome_vfs_mime_get_description ()</title>
 521 <indexterm><primary>gnome_vfs_mime_get_description</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_mime_get_description  (const <link linkend="char">char</link> *mime_type);</programlisting>
 522 <para>
 523 Query the MIME database for a description of the specified MIME type.</para>
 524 <para>
 525
 526 </para><variablelist role="params">
 527 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 528 <listitem><simpara> the mime type
 529 </simpara></listitem></varlistentry>
 530 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A description of MIME type <parameter>mime_type</parameter>
 531 </simpara></listitem></varlistentry>
 532 </variablelist></refsect2>
 533 <refsect2>
 534 <title><anchor id="gnome-vfs-mime-set-description"/>gnome_vfs_mime_set_description ()</title>
 535 <indexterm><primary>gnome_vfs_mime_set_description</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_description
 536                                             (const <link linkend="char">char</link> *mime_type,
 537                                              const <link linkend="char">char</link> *description);</programlisting>
 538 <para>
 539 Set the description of this MIME type in the MIME database. The description
 540 should be something like "Gnumeric spreadsheet".</para>
 541 <para>
 542
 543 </para><variablelist role="params">
 544 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 545 <listitem><simpara> A const char * containing a mime type
 546 </simpara></listitem></varlistentry>
 547 <varlistentry><term><parameter>description</parameter>&nbsp;:</term>
 548 <listitem><simpara> A description of this MIME type
 549 </simpara></listitem></varlistentry>
 550 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation or any
 551 errors that may have occurred.
 552 </simpara></listitem></varlistentry>
 553 </variablelist></refsect2>
 554 <refsect2>
 555 <title><anchor id="gnome-vfs-mime-can-be-executable"/>gnome_vfs_mime_can_be_executable ()</title>
 556 <indexterm><primary>gnome_vfs_mime_can_be_executable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_mime_can_be_executable
 557                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
 558 <para>
 559 Check whether files of this MIME type might conceivably be executable.
 560 Default for known types if FALSE. Default for unknown types is TRUE.</para>
 561 <para>
 562
 563 </para><variablelist role="params">
 564 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 565 <listitem><simpara> A const char * containing a mime type
 566 </simpara></listitem></varlistentry>
 567 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> gboolean containing TRUE if some files of this MIME type
 568 are registered as being executable, and false otherwise.
 569 </simpara></listitem></varlistentry>
 570 </variablelist></refsect2>
 571 <refsect2>
 572 <title><anchor id="gnome-vfs-mime-set-can-be-executable"/>gnome_vfs_mime_set_can_be_executable ()</title>
 573 <indexterm><primary>gnome_vfs_mime_set_can_be_executable</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_can_be_executable
 574                                             (const <link linkend="char">char</link> *mime_type,
 575                                              <link linkend="gboolean">gboolean</link> new_value);</programlisting>
 576 <para>
 577 Set whether files of this MIME type might conceivably be executable.</para>
 578 <para>
 579
 580 </para><variablelist role="params">
 581 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 582 <listitem><simpara> A const char * containing a mime type
 583 </simpara></listitem></varlistentry>
 584 <varlistentry><term><parameter>new_value</parameter>&nbsp;:</term>
 585 <listitem><simpara> A boolean value indicating whether <parameter>mime_type</parameter> could be executable.
 586 </simpara></listitem></varlistentry>
 587 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation or any
 588 errors that may have occurred.
 589 </simpara></listitem></varlistentry>
 590 </variablelist></refsect2>
 591 <refsect2>
 592 <title><anchor id="gnome-vfs-mime-set-short-list-applications"/>gnome_vfs_mime_set_short_list_applications ()</title>
 593 <indexterm><primary>gnome_vfs_mime_set_short_list_applications</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_short_list_applications
 594                                             (const <link linkend="char">char</link> *mime_type,
 595                                              <link linkend="GList">GList</link> *application_ids);</programlisting>
 596 <para>
 597 Set the short list of applications for the specified MIME type. The short list
 598 contains applications recommended for possible selection by the user.</para>
 599 <para>
 600
 601 </para><variablelist role="params">
 602 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 603 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 604 </simpara></listitem></varlistentry>
 605 <varlistentry><term><parameter>application_ids</parameter>&nbsp;:</term>
 606 <listitem><simpara> GList of const char * application ids
 607 </simpara></listitem></varlistentry>
 608 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 609 any errors encountered.
 610 </simpara></listitem></varlistentry>
 611 </variablelist></refsect2>
 612 <refsect2>
 613 <title><anchor id="gnome-vfs-mime-set-short-list-components"/>gnome_vfs_mime_set_short_list_components ()</title>
 614 <indexterm><primary>gnome_vfs_mime_set_short_list_components</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_short_list_components
 615                                             (const <link linkend="char">char</link> *mime_type,
 616                                              <link linkend="GList">GList</link> *component_iids);</programlisting>
 617 <para>
 618 Set the short list of components for the specified MIME type. The short list
 619 contains companents recommended for possible selection by the user. *</para>
 620 <para>
 621
 622 </para><variablelist role="params">
 623 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 624 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 625 </simpara></listitem></varlistentry>
 626 <varlistentry><term><parameter>component_iids</parameter>&nbsp;:</term>
 627 <listitem><simpara> GList of const char * OAF IIDs
 628 </simpara></listitem></varlistentry>
 629 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 630 any errors encountered.
 631 </simpara></listitem></varlistentry>
 632 </variablelist></refsect2>
 633 <refsect2>
 634 <title><anchor id="gnome-vfs-mime-add-application-to-short-list"/>gnome_vfs_mime_add_application_to_short_list ()</title>
 635 <indexterm><primary>gnome_vfs_mime_add_application_to_short_list</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_add_application_to_short_list
 636                                             (const <link linkend="char">char</link> *mime_type,
 637                                              const <link linkend="char">char</link> *application_id);</programlisting>
 638 <para>
 639 Add an application to the short list for MIME type <parameter>mime_type</parameter>. The short list contains
 640 applications recommended for display as choices to the user for a particular MIME type.</para>
 641 <para>
 642
 643 </para><variablelist role="params">
 644 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 645 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 646 </simpara></listitem></varlistentry>
 647 <varlistentry><term><parameter>application_id</parameter>&nbsp;:</term>
 648 <listitem><simpara> const char * containing the application's id in the MIME database
 649 </simpara></listitem></varlistentry>
 650 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 651 any errors encountered.
 652 </simpara></listitem></varlistentry>
 653 </variablelist></refsect2>
 654 <refsect2>
 655 <title><anchor id="gnome-vfs-mime-remove-application-from-short-list"/>gnome_vfs_mime_remove_application_from_short_list ()</title>
 656 <indexterm><primary>gnome_vfs_mime_remove_application_from_short_list</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_remove_application_from_short_list
 657                                             (const <link linkend="char">char</link> *mime_type,
 658                                              const <link linkend="char">char</link> *application_id);</programlisting>
 659 <para>
 660 Remove an application from the short list for MIME type <parameter>mime_type</parameter>. The short list contains
 661 applications recommended for display as choices to the user for a particular MIME type.</para>
 662 <para>
 663
 664 </para><variablelist role="params">
 665 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 666 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 667 </simpara></listitem></varlistentry>
 668 <varlistentry><term><parameter>application_id</parameter>&nbsp;:</term>
 669 <listitem><simpara> const char * containing the application's id in the MIME database
 670 </simpara></listitem></varlistentry>
 671 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 672 any errors encountered.
 673 </simpara></listitem></varlistentry>
 674 </variablelist></refsect2>
 675 <refsect2>
 676 <title><anchor id="gnome-vfs-mime-add-component-to-short-list"/>gnome_vfs_mime_add_component_to_short_list ()</title>
 677 <indexterm><primary>gnome_vfs_mime_add_component_to_short_list</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_add_component_to_short_list
 678                                             (const <link linkend="char">char</link> *mime_type,
 679                                              const <link linkend="char">char</link> *iid);</programlisting>
 680 <para>
 681 Add a component to the short list for MIME type <parameter>mime_type</parameter>. The short list contains
 682 components recommended for display as choices to the user for a particular MIME type.</para>
 683 <para>
 684
 685 </para><variablelist role="params">
 686 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 687 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 688 </simpara></listitem></varlistentry>
 689 <varlistentry><term><parameter>iid</parameter>&nbsp;:</term>
 690 <listitem><simpara> const char * containing the component's OAF IID
 691 </simpara></listitem></varlistentry>
 692 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 693 any errors encountered.
 694 </simpara></listitem></varlistentry>
 695 </variablelist></refsect2>
 696 <refsect2>
 697 <title><anchor id="gnome-vfs-mime-remove-component-from-short-list"/>gnome_vfs_mime_remove_component_from_short_list ()</title>
 698 <indexterm><primary>gnome_vfs_mime_remove_component_from_short_list</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_remove_component_from_short_list
 699                                             (const <link linkend="char">char</link> *mime_type,
 700                                              const <link linkend="char">char</link> *iid);</programlisting>
 701 <para>
 702 Remove a component from the short list for MIME type <parameter>mime_type</parameter>. The short list contains
 703 components recommended for display as choices to the user for a particular MIME type.</para>
 704 <para>
 705
 706 </para><variablelist role="params">
 707 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 708 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 709 </simpara></listitem></varlistentry>
 710 <varlistentry><term><parameter>iid</parameter>&nbsp;:</term>
 711 <listitem><simpara> const char * containing the component's OAF IID
 712 </simpara></listitem></varlistentry>
 713 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 714 any errors encountered.
 715 </simpara></listitem></varlistentry>
 716 </variablelist></refsect2>
 717 <refsect2>
 718 <title><anchor id="gnome-vfs-mime-add-extension"/>gnome_vfs_mime_add_extension ()</title>
 719 <indexterm><primary>gnome_vfs_mime_add_extension</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_add_extension (const <link linkend="char">char</link> *mime_type,
 720                                              const <link linkend="char">char</link> *extension);</programlisting>
 721 <para>
 722 Add a file extension to the specificed MIME type in the MIME database.</para>
 723 <para>
 724
 725 </para><variablelist role="params">
 726 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 727 <listitem><simpara> The mime type to add the mapping to.
 728 </simpara></listitem></varlistentry>
 729 <varlistentry><term><parameter>extension</parameter>&nbsp;:</term>
 730 <listitem><simpara> The extension to add (e.g. "txt")
 731 </simpara></listitem></varlistentry>
 732 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation or any
 733 errors that may have occurred.
 734 </simpara></listitem></varlistentry>
 735 </variablelist></refsect2>
 736 <refsect2>
 737 <title><anchor id="gnome-vfs-mime-remove-extension"/>gnome_vfs_mime_remove_extension ()</title>
 738 <indexterm><primary>gnome_vfs_mime_remove_extension</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_remove_extension
 739                                             (const <link linkend="char">char</link> *mime_type,
 740                                              const <link linkend="char">char</link> *extension);</programlisting>
 741 <para>
 742 Removes a file extension from the specificed MIME type in the MIME database.</para>
 743 <para>
 744
 745 </para><variablelist role="params">
 746 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 747 <listitem><simpara> The mime type to remove the extension from
 748 </simpara></listitem></varlistentry>
 749 <varlistentry><term><parameter>extension</parameter>&nbsp;:</term>
 750 <listitem><simpara> The extension to remove
 751 </simpara></listitem></varlistentry>
 752 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation or any
 753 errors that may have occurred.
 754 </simpara></listitem></varlistentry>
 755 </variablelist></refsect2>
 756 <refsect2>
 757 <title><anchor id="gnome-vfs-mime-extend-all-applications"/>gnome_vfs_mime_extend_all_applications ()</title>
 758 <indexterm><primary>gnome_vfs_mime_extend_all_applications</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_extend_all_applications
 759                                             (const <link linkend="char">char</link> *mime_type,
 760                                              <link linkend="GList">GList</link> *application_ids);</programlisting>
 761 <para>
 762 Register <parameter>mime_type</parameter> as being handled by all applications list in <parameter>application_ids</parameter>.</para>
 763 <para>
 764
 765 </para><variablelist role="params">
 766 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 767 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 768 </simpara></listitem></varlistentry>
 769 <varlistentry><term><parameter>application_ids</parameter>&nbsp;:</term>
 770 <listitem><simpara> a GList of const char * containing application ids
 771 </simpara></listitem></varlistentry>
 772 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 773 any errors encountered.
 774 </simpara></listitem></varlistentry>
 775 </variablelist></refsect2>
 776 <refsect2>
 777 <title><anchor id="gnome-vfs-mime-remove-from-all-applications"/>gnome_vfs_mime_remove_from_all_applications ()</title>
 778 <indexterm><primary>gnome_vfs_mime_remove_from_all_applications</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_remove_from_all_applications
 779                                             (const <link linkend="char">char</link> *mime_type,
 780                                              <link linkend="GList">GList</link> *application_ids);</programlisting>
 781 <para>
 782 Remove <parameter>mime_type</parameter> as a handled type from every application in <parameter>application_ids</parameter></para>
 783 <para>
 784
 785 </para><variablelist role="params">
 786 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
 787 <listitem><simpara> A const char * containing a mime type, e.g. "application/x-php"
 788 </simpara></listitem></varlistentry>
 789 <varlistentry><term><parameter>application_ids</parameter>&nbsp;:</term>
 790 <listitem><simpara> a GList of const char * containing application ids
 791 </simpara></listitem></varlistentry>
 792 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GnomeVFSResult indicating the success of the operation or reporting
 793 any errors encountered.
 794 </simpara></listitem></varlistentry>
 795 </variablelist></refsect2>
 796 <refsect2>
 797 <title><anchor id="gnome-vfs-mime-application-new-from-id"/>gnome_vfs_mime_application_new_from_id ()</title>
 798 <indexterm><primary>gnome_vfs_mime_application_new_from_id</primary></indexterm><programlisting><link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link>* gnome_vfs_mime_application_new_from_id
 799                                             (const <link linkend="char">char</link> *id);</programlisting>
 800 <para>
 801 Fetches the GnomeVFSMimeApplication associated with the specified
 802 application ID from the MIME database.</para>
 803 <para>
 804
 805 </para><variablelist role="params">
 806 <varlistentry><term><parameter>id</parameter>&nbsp;:</term>
 807 <listitem><simpara> A const char * containing an application id
 808 </simpara></listitem></varlistentry>
 809 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSMimeApplication * corresponding to <parameter>id</parameter>
 810 </simpara></listitem></varlistentry>
 811 </variablelist></refsect2>
 812 <refsect2>
 813 <title><anchor id="gnome-vfs-mime-application-free"/>gnome_vfs_mime_application_free ()</title>
 814 <indexterm><primary>gnome_vfs_mime_application_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_application_free (<link linkend="GnomeVFSMimeApplication">GnomeVFSMimeApplication</link> *application);</programlisting>
 815 <para>
 816 Frees a GnomeVFSMimeApplication *.</para>
 817 <para>
 818
 819 </para><variablelist role="params">
 820 <varlistentry><term><parameter>application</parameter>&nbsp;:</term>
 821 <listitem><simpara> The GnomeVFSMimeApplication to be freed
 822 </simpara></listitem></varlistentry>
 823 </variablelist></refsect2>
 824 <refsect2>
 825 <title><anchor id="gnome-vfs-mime-action-free"/>gnome_vfs_mime_action_free ()</title>
 826 <indexterm><primary>gnome_vfs_mime_action_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_action_free      (<link linkend="GnomeVFSMimeAction">GnomeVFSMimeAction</link> *action);</programlisting>
 827 <para>
 828 Frees a GnomeVFSMimeAction *.</para>
 829 <para>
 830
 831 </para><variablelist role="params">
 832 <varlistentry><term><parameter>action</parameter>&nbsp;:</term>
 833 <listitem><simpara> The GnomeVFSMimeAction to be freed
 834 </simpara></listitem></varlistentry>
 835 </variablelist></refsect2>
 836 <refsect2>
 837 <title><anchor id="gnome-vfs-mime-application-list-free"/>gnome_vfs_mime_application_list_free ()</title>
 838 <indexterm><primary>gnome_vfs_mime_application_list_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_application_list_free
 839                                             (<link linkend="GList">GList</link> *list);</programlisting>
 840 <para>
 841 Frees lists of GnomeVFSApplications, as returned from functions such
 842 as <link linkend="gnome-vfs-get-all-applications"><function>gnome_vfs_get_all_applications()</function></link>.</para>
 843 <para>
 844
 845 </para><variablelist role="params">
 846 <varlistentry><term><parameter>list</parameter>&nbsp;:</term>
 847 <listitem><simpara> a GList of GnomeVFSApplication * to be freed
 848 </simpara></listitem></varlistentry>
 849 </variablelist></refsect2>
 850 <refsect2>
 851 <title><anchor id="gnome-vfs-mime-component-list-free"/>gnome_vfs_mime_component_list_free ()</title>
 852 <indexterm><primary>gnome_vfs_mime_component_list_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_component_list_free
 853                                             (<link linkend="GList">GList</link> *list);</programlisting>
 854 <para>
 855 Frees lists of Bonobo_ServerInfo * (as returned from functions such
 856 as <parameter>gnome_vfs_get_all_components</parameter>)</para>
 857 <para>
 858
 859 </para><variablelist role="params">
 860 <varlistentry><term><parameter>list</parameter>&nbsp;:</term>
 861 <listitem><simpara> a GList of Bonobo_ServerInfo * to be freed
 862 </simpara></listitem></varlistentry>
 863 </variablelist></refsect2>
 864 <refsect2>
 865 <title><anchor id="gnome-vfs-mime-id-in-application-list"/>gnome_vfs_mime_id_in_application_list ()</title>
 866 <indexterm><primary>gnome_vfs_mime_id_in_application_list</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_mime_id_in_application_list
 867                                             (const <link linkend="char">char</link> *id,
 868                                              <link linkend="GList">GList</link> *applications);</programlisting>
 869 <para>
 870 Check whether an application id is in a list of GnomeVFSMimeApplications.</para>
 871 <para>
 872
 873 </para><variablelist role="params">
 874 <varlistentry><term><parameter>id</parameter>&nbsp;:</term>
 875 <listitem><simpara> An application id.
 876 </simpara></listitem></varlistentry>
 877 <varlistentry><term><parameter>applications</parameter>&nbsp;:</term>
 878 <listitem><simpara> A GList * whose nodes are GnomeVFSMimeApplications, such as the
 879 result of <link linkend="gnome-vfs-mime-get-short-list-applications"><function>gnome_vfs_mime_get_short_list_applications()</function></link>.
 880 </simpara></listitem></varlistentry>
 881 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if an application whose id matches <parameter>id</parameter> is in <parameter>applications</parameter>.
 882 </simpara></listitem></varlistentry>
 883 </variablelist></refsect2>
 884 <refsect2>
 885 <title><anchor id="gnome-vfs-mime-id-in-component-list"/>gnome_vfs_mime_id_in_component_list ()</title>
 886 <indexterm><primary>gnome_vfs_mime_id_in_component_list</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_mime_id_in_component_list
 887                                             (const <link linkend="char">char</link> *iid,
 888                                              <link linkend="GList">GList</link> *components);</programlisting>
 889 <para>
 890 Check whether a component iid is in a list of Bonobo_ServerInfos.</para>
 891 <para>
 892
 893 </para><variablelist role="params">
 894 <varlistentry><term><parameter>iid</parameter>&nbsp;:</term>
 895 <listitem><simpara> A component iid.
 896 </simpara></listitem></varlistentry>
 897 <varlistentry><term><parameter>components</parameter>&nbsp;:</term>
 898 <listitem><simpara> A GList * whose nodes are Bonobo_ServerInfos, such as the
 899 result of <link linkend="gnome-vfs-mime-get-short-list-components"><function>gnome_vfs_mime_get_short_list_components()</function></link>.
 900 </simpara></listitem></varlistentry>
 901 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a component whose iid matches <parameter>iid</parameter> is in <parameter>components</parameter>.
 902 </simpara></listitem></varlistentry>
 903 </variablelist></refsect2>
 904 <refsect2>
 905 <title><anchor id="gnome-vfs-mime-remove-application-from-list"/>gnome_vfs_mime_remove_application_from_list ()</title>
 906 <indexterm><primary>gnome_vfs_mime_remove_application_from_list</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_remove_application_from_list
 907                                             (<link linkend="GList">GList</link> *applications,
 908                                              const <link linkend="char">char</link> *application_id,
 909                                              <link linkend="gboolean">gboolean</link> *did_remove);</programlisting>
 910 <para>
 911 Remove an application specified by id from a list of GnomeVFSMimeApplications.</para>
 912 <para>
 913
 914 </para><variablelist role="params">
 915 <varlistentry><term><parameter>applications</parameter>&nbsp;:</term>
 916 <listitem><simpara> A GList * whose nodes are GnomeVFSMimeApplications, such as the
 917 result of <link linkend="gnome-vfs-mime-get-short-list-applications"><function>gnome_vfs_mime_get_short_list_applications()</function></link>.
 918 </simpara></listitem></varlistentry>
 919 <varlistentry><term><parameter>application_id</parameter>&nbsp;:</term>
 920 <listitem><simpara> The id of an application to remove from <parameter>applications</parameter>.
 921 </simpara></listitem></varlistentry>
 922 <varlistentry><term><parameter>did_remove</parameter>&nbsp;:</term>
 923 <listitem><simpara> If non-NULL, this is filled in with TRUE if the application
 924 was found in the list, FALSE otherwise.
 925 </simpara></listitem></varlistentry>
 926 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The modified list. If the application is not found, the list will
 927 be unchanged.
 928 </simpara></listitem></varlistentry>
 929 </variablelist></refsect2>
 930 <refsect2>
 931 <title><anchor id="gnome-vfs-mime-remove-component-from-list"/>gnome_vfs_mime_remove_component_from_list ()</title>
 932 <indexterm><primary>gnome_vfs_mime_remove_component_from_list</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_remove_component_from_list
 933                                             (<link linkend="GList">GList</link> *components,
 934                                              const <link linkend="char">char</link> *iid,
 935                                              <link linkend="gboolean">gboolean</link> *did_remove);</programlisting>
 936 <para>
 937 Remove a component specified by iid from a list of Bonobo_ServerInfos.</para>
 938 <para>
 939
 940 </para><variablelist role="params">
 941 <varlistentry><term><parameter>components</parameter>&nbsp;:</term>
 942 <listitem><simpara> A GList * whose nodes are Bonobo_ServerInfos, such as the
 943 result of <link linkend="gnome-vfs-mime-get-short-list-components"><function>gnome_vfs_mime_get_short_list_components()</function></link>.
 944 </simpara></listitem></varlistentry>
 945 <varlistentry><term><parameter>iid</parameter>&nbsp;:</term>
 946 <listitem><simpara> The iid of a component to remove from <parameter>components</parameter>.
 947 </simpara></listitem></varlistentry>
 948 <varlistentry><term><parameter>did_remove</parameter>&nbsp;:</term>
 949 <listitem><simpara> If non-NULL, this is filled in with TRUE if the component
 950 was found in the list, FALSE otherwise.
 951 </simpara></listitem></varlistentry>
 952 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The modified list. If the component is not found, the list will
 953 be unchanged.
 954 </simpara></listitem></varlistentry>
 955 </variablelist></refsect2>
 956 <refsect2>
 957 <title><anchor id="gnome-vfs-mime-id-list-from-component-list"/>gnome_vfs_mime_id_list_from_component_list ()</title>
 958 <indexterm><primary>gnome_vfs_mime_id_list_from_component_list</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_id_list_from_component_list
 959                                             (<link linkend="GList">GList</link> *components);</programlisting>
 960 <para>
 961 Create a list of component iids from a list of Bonobo_ServerInfos.</para>
 962 <para>
 963
 964 </para><variablelist role="params">
 965 <varlistentry><term><parameter>components</parameter>&nbsp;:</term>
 966 <listitem><simpara> A GList * whose nodes are Bonobo_ServerInfos, such as the
 967 result of <link linkend="gnome-vfs-mime-get-short-list-components"><function>gnome_vfs_mime_get_short_list_components()</function></link>.
 968 </simpara></listitem></varlistentry>
 969 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new list where each Bonobo_ServerInfo in the original
 970 list is replaced by a char * with the component's iid. The original list is
 971 not modified.
 972 </simpara></listitem></varlistentry>
 973 </variablelist></refsect2>
 974 <refsect2>
 975 <title><anchor id="gnome-vfs-mime-id-list-from-application-list"/>gnome_vfs_mime_id_list_from_application_list ()</title>
 976 <indexterm><primary>gnome_vfs_mime_id_list_from_application_list</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_id_list_from_application_list
 977                                             (<link linkend="GList">GList</link> *applications);</programlisting>
 978 <para>
 979 Create a list of application ids from a list of GnomeVFSMimeApplications.</para>
 980 <para>
 981
 982 </para><variablelist role="params">
 983 <varlistentry><term><parameter>applications</parameter>&nbsp;:</term>
 984 <listitem><simpara> A GList * whose nodes are GnomeVFSMimeApplications, such as the
 985 result of <link linkend="gnome-vfs-mime-get-short-list-applications"><function>gnome_vfs_mime_get_short_list_applications()</function></link>.
 986 </simpara></listitem></varlistentry>
 987 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new list where each GnomeVFSMimeApplication in the original
 988 list is replaced by a char * with the application's id. The original list is
 989 not modified.
 990 </simpara></listitem></varlistentry>
 991 </variablelist></refsect2>
 992 <refsect2>
 993 <title><anchor id="gnome-vfs-mime-freeze"/>gnome_vfs_mime_freeze ()</title>
 994 <indexterm><primary>gnome_vfs_mime_freeze</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_freeze           (void);</programlisting>
 995 <para>
 996 Freezes the mime data so that you can do multiple
 997 updates to the dat in one batch without needing
 998 to back the files to disk or readind them</para>
 999 <para>
1000
1001 </para></refsect2>
1002 <refsect2>
1003 <title><anchor id="gnome-vfs-mime-thaw"/>gnome_vfs_mime_thaw ()</title>
1004 <indexterm><primary>gnome_vfs_mime_thaw</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_thaw             (void);</programlisting>
1005 <para>
1006 UnFreezes the mime data so that you can do multiple
1007 updates to the dat in one batch without needing
1008 to back the files to disk or readind them</para>
1009 <para>
1010
1011 </para></refsect2>
1012 <refsect2>
1013 <title><anchor id="gnome-vfs-mime-info-reload"/>gnome_vfs_mime_info_reload ()</title>
1014 <indexterm><primary>gnome_vfs_mime_info_reload</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_info_reload      (void);</programlisting>
1015 <para>
1016 Reload the MIME database from disk and notify any listeners
1017 holding active <link linkend="GnomeVFSMIMEMonitor"><type>GnomeVFSMIMEMonitor</type></link> objects.</para>
1018 <para>
1019
1020 </para></refsect2>
1021 <refsect2>
1022 <title><anchor id="gnome-vfs-mime-type-is-known"/>gnome_vfs_mime_type_is_known ()</title>
1023 <indexterm><primary>gnome_vfs_mime_type_is_known</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_mime_type_is_known    (const <link linkend="char">char</link> *mime_type);</programlisting>
1024 <para>
1025 This function returns TRUE if <parameter>mime_type</parameter> is in the MIME database at all.</para>
1026 <para>
1027
1028 </para><variablelist role="params">
1029 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1030 <listitem><simpara> a mime type.
1031 </simpara></listitem></varlistentry>
1032 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if anything is known about <parameter>mime_type</parameter>, otherwise FALSE
1033 </simpara></listitem></varlistentry>
1034 </variablelist></refsect2>
1035 <refsect2>
1036 <title><anchor id="gnome-vfs-mime-get-value"/>gnome_vfs_mime_get_value ()</title>
1037 <indexterm><primary>gnome_vfs_mime_get_value</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_mime_get_value        (const <link linkend="char">char</link> *mime_type,
1038                                              const <link linkend="char">char</link> *key);</programlisting>
1039 <para>
1040 This function retrieves the value associated with <parameter>key</parameter> in
1041 the given GnomeMimeContext.  The string is private, you
1042 should not free the result.</para>
1043 <para>
1044
1045 </para><variablelist role="params">
1046 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1047 <listitem><simpara> a mime type.
1048 </simpara></listitem></varlistentry>
1049 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
1050 <listitem><simpara> A key to lookup for the given mime-type
1051 </simpara></listitem></varlistentry>
1052 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GNOME_VFS_OK if the operation succeeded, otherwise an error code
1053 </simpara></listitem></varlistentry>
1054 </variablelist></refsect2>
1055 <refsect2>
1056 <title><anchor id="gnome-vfs-mime-set-value"/>gnome_vfs_mime_set_value ()</title>
1057 <indexterm><primary>gnome_vfs_mime_set_value</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_value     (const <link linkend="char">char</link> *mime_type,
1058                                              const <link linkend="char">char</link> *key,
1059                                              const <link linkend="char">char</link> *value);</programlisting>
1060 <para>
1061 This function is going to set the value
1062 associated to the key and it will save it
1063 to the user' file if necessary.
1064 You should not free the key/values passed to
1065 this function. They are used internally.</para>
1066 <para>
1067
1068 </para><variablelist role="params">
1069 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1070 <listitem><simpara> a mime type.
1071 </simpara></listitem></varlistentry>
1072 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
1073 <listitem><simpara> a key to store the value in.
1074 </simpara></listitem></varlistentry>
1075 <varlistentry><term><parameter>value</parameter>&nbsp;:</term>
1076 <listitem><simpara> the value to store in the key.
1077 </simpara></listitem></varlistentry>
1078 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GNOME_VFS_OK if the operation succeeded, otherwise an error code
1079
1080 </simpara></listitem></varlistentry>
1081 </variablelist></refsect2>
1082 <refsect2>
1083 <title><anchor id="gnome-vfs-mime-get-key-list"/>gnome_vfs_mime_get_key_list ()</title>
1084 <indexterm><primary>gnome_vfs_mime_get_key_list</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_get_key_list     (const <link linkend="char">char</link> *mime_type);</programlisting>
1085 <para>
1086 Gets a list of all keys associated with <parameter>mime_type</parameter>.</para>
1087 <para>
1088
1089 </para><variablelist role="params">
1090 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1091 <listitem><simpara> the MIME type to lookup
1092 </simpara></listitem></varlistentry>
1093 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GList of const char * representing keys associated
1094 with <parameter>mime_type</parameter>
1095 </simpara></listitem></varlistentry>
1096 </variablelist></refsect2>
1097 <refsect2>
1098 <title><anchor id="gnome-vfs-mime-keys-list-free"/>gnome_vfs_mime_keys_list_free ()</title>
1099 <indexterm><primary>gnome_vfs_mime_keys_list_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_keys_list_free   (<link linkend="GList">GList</link> *mime_type_list);</programlisting>
1100 <para>
1101 Frees the mime type list.</para>
1102 <para>
1103
1104 </para><variablelist role="params">
1105 <varlistentry><term><parameter>mime_type_list</parameter>&nbsp;:</term>
1106 <listitem><simpara> A mime type list to free.
1107 </simpara></listitem></varlistentry>
1108 </variablelist></refsect2>
1109 <refsect2>
1110 <title><anchor id="gnome-vfs-mime-get-extensions-list"/>gnome_vfs_mime_get_extensions_list ()</title>
1111 <indexterm><primary>gnome_vfs_mime_get_extensions_list</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_mime_get_extensions_list
1112                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
1113 <para>
1114 Get the file extensions associated with mime type <parameter>mime_type</parameter>.</para>
1115 <para>
1116
1117 </para><variablelist role="params">
1118 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1119 <listitem><simpara> type to get the extensions of
1120 </simpara></listitem></varlistentry>
1121 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GList of char *s
1122 </simpara></listitem></varlistentry>
1123 </variablelist></refsect2>
1124 <refsect2>
1125 <title><anchor id="gnome-vfs-mime-extensions-list-free"/>gnome_vfs_mime_extensions_list_free ()</title>
1126 <indexterm><primary>gnome_vfs_mime_extensions_list_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_extensions_list_free
1127                                             (<link linkend="GList">GList</link> *list);</programlisting>
1128 <para>
1129 Call this function on the list returned by gnome_vfs_mime_extensions
1130 to free the list and all of its elements.</para>
1131 <para>
1132
1133 </para><variablelist role="params">
1134 <varlistentry><term><parameter>list</parameter>&nbsp;:</term>
1135 <listitem><simpara> the extensions list
1136 </simpara></listitem></varlistentry>
1137 </variablelist></refsect2>
1138 <refsect2>
1139 <title><anchor id="gnome-vfs-mime-get-extensions-string"/>gnome_vfs_mime_get_extensions_string ()</title>
1140 <indexterm><primary>gnome_vfs_mime_get_extensions_string</primary></indexterm><programlisting><link linkend="char">char</link>*       gnome_vfs_mime_get_extensions_string
1141                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
1142 <para>
1143 Retrieves the extensions associated with <parameter>mime_type</parameter> as a single
1144 space seperated string.</para>
1145 <para>
1146
1147 </para><variablelist role="params">
1148 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1149 <listitem><simpara> the mime type
1150 </simpara></listitem></varlistentry>
1151 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string containing space seperated extensions for <parameter>mime_type</parameter>
1152 </simpara></listitem></varlistentry>
1153 </variablelist></refsect2>
1154 <refsect2>
1155 <title><anchor id="gnome-vfs-mime-get-extensions-pretty-string"/>gnome_vfs_mime_get_extensions_pretty_string ()</title>
1156 <indexterm><primary>gnome_vfs_mime_get_extensions_pretty_string</primary></indexterm><programlisting><link linkend="char">char</link>*       gnome_vfs_mime_get_extensions_pretty_string
1157                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
1158 <para>
1159 Returns the supported extensions for <parameter>mime_type</parameter> as a comma-seperated list.</para>
1160 <para>
1161
1162 </para><variablelist role="params">
1163 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1164 <listitem><simpara> the mime type
1165 </simpara></listitem></varlistentry>
1166 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string containing comma seperated extensions for this mime-type
1167 </simpara></listitem></varlistentry>
1168 </variablelist></refsect2>
1169 <refsect2>
1170 <title><anchor id="gnome-vfs-get-registered-mime-types"/>gnome_vfs_get_registered_mime_types ()</title>
1171 <indexterm><primary>gnome_vfs_get_registered_mime_types</primary></indexterm><programlisting><link linkend="GList">GList</link>*      gnome_vfs_get_registered_mime_types
1172                                             (void);</programlisting>
1173 <para>
1174
1175 </para><variablelist role="params">
1176 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
1177
1178
1179 </simpara></listitem></varlistentry>
1180 </variablelist></refsect2>
1181 <refsect2>
1182 <title><anchor id="gnome-vfs-mime-registered-mime-type-list-free"/>gnome_vfs_mime_registered_mime_type_list_free ()</title>
1183 <indexterm><primary>gnome_vfs_mime_registered_mime_type_list_free</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_registered_mime_type_list_free
1184                                             (<link linkend="GList">GList</link> *list);</programlisting>
1185 <para>
1186 Call this function on the list returned by gnome_vfs_get_registered_mime_types
1187 to free the list and all of its elements.</para>
1188 <para>
1189
1190 </para><variablelist role="params">
1191 <varlistentry><term><parameter>list</parameter>&nbsp;:</term>
1192 <listitem><simpara> the extensions list
1193 </simpara></listitem></varlistentry>
1194 </variablelist></refsect2>
1195 <refsect2>
1196 <title><anchor id="gnome-vfs-mime-set-registered-type-key"/>gnome_vfs_mime_set_registered_type_key ()</title>
1197 <indexterm><primary>gnome_vfs_mime_set_registered_type_key</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_registered_type_key
1198                                             (const <link linkend="char">char</link> *mime_type,
1199                                              const <link linkend="char">char</link> *key,
1200                                              const <link linkend="char">char</link> *data);</programlisting>
1201 <para>
1202 This function sets the key data for the registered mime
1203 type's hash table.</para>
1204 <para>
1205
1206 </para><variablelist role="params">
1207 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1208 <listitem><simpara>     Mime type to set key for
1209 </simpara></listitem></varlistentry>
1210 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
1211 <listitem><simpara>     The key to set
1212 </simpara></listitem></varlistentry>
1213 <varlistentry><term><parameter>data</parameter>&nbsp;:</term>
1214 <listitem><simpara>     The data to set for the key
1215 </simpara></listitem></varlistentry>
1216 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GNOME_VFS_OK if the operation succeeded, otherwise an error code
1217 </simpara></listitem></varlistentry>
1218 </variablelist></refsect2>
1219 <refsect2>
1220 <title><anchor id="gnome-vfs-mime-set-extensions-list"/>gnome_vfs_mime_set_extensions_list ()</title>
1221 <indexterm><primary>gnome_vfs_mime_set_extensions_list</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_mime_set_extensions_list
1222                                             (const <link linkend="char">char</link> *mime_type,
1223                                              const <link linkend="char">char</link> *extensions_list);</programlisting>
1224 <para>
1225 Sets the extensions for a given mime type. Overrides
1226 the previously set extensions.</para>
1227 <para>
1228
1229 </para><variablelist role="params">
1230 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1231 <listitem><simpara> the mime type.
1232 </simpara></listitem></varlistentry>
1233 <varlistentry><term><parameter>extensions_list</parameter>&nbsp;:</term>
1234 <listitem><simpara> a whitespace-separated list of the
1235                   extensions to set for this mime type.
1236 </simpara></listitem></varlistentry>
1237 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GNOME_VFS_OK if the operation succeeded, otherwise an error code.
1238 </simpara></listitem></varlistentry>
1239 </variablelist></refsect2>
1240 <refsect2>
1241 <title><anchor id="gnome-vfs-mime-registered-mime-type-delete"/>gnome_vfs_mime_registered_mime_type_delete ()</title>
1242 <indexterm><primary>gnome_vfs_mime_registered_mime_type_delete</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_registered_mime_type_delete
1243                                             (const <link linkend="char">char</link> *mime_type);</programlisting>
1244 <para>
1245 Delete a mime type for the user which runs this command.
1246 You can undo this only by calling gnome_vfs_mime_reset</para>
1247 <para>
1248
1249 </para><variablelist role="params">
1250 <varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
1251 <listitem><simpara> string representing the existing type to delete
1252 </simpara></listitem></varlistentry>
1253 </variablelist></refsect2>
1254 <refsect2>
1255 <title><anchor id="gnome-vfs-mime-reset"/>gnome_vfs_mime_reset ()</title>
1256 <indexterm><primary>gnome_vfs_mime_reset</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_mime_reset            (void);</programlisting>
1257 <para>
1258 resets the user's mime database to the system defaults.</para>
1259 <para>
1260
1261 </para></refsect2>
1262
1263 </refsect1>
1264
1265
1266
1267
1268 </refentry>