← Back to branch summary

~maxolasersquad/ubuntu/precise/epiphany-browser/add_quicklist

« back to all changes in this revision

Viewing changes to doc/reference/xml/ephy-file-helpers.xml

  • Committer: Bazaar Package Importer
  • Author(s): Artur Rona
  • Date: 2010-10-14 12:45:29 UTC
  • mfrom: (98.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20101014124529-57hi6lecoo68e3sq
Tags: 2.30.6-1ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Update the search URL:
    + add debian/patches/80_ubuntu_search_url.patch
    + update debian/epiphany-browser-data.gconf-defaults
  - Set branding to Ubuntu.
  - debian/patches/81_ubuntu_force_update_bookmarks_menu.patch:
    + Update the bookmarks menu every time the internal structure
      is changed (needed for the UNE application menu to work correctly).
  - Support appindicator.
  - debian/control.in:
    + Temporary bump for gir dependencies to ensure we rebuild against
      the correct version.
  - debian/patches/13_clearing_temp.patch:
    + Fix crashing epiphany-browser while clearing temp files.
      This patch can be dropped with new upstream 2.32 release.
* debian/control.in:
  - Bump Build-Depends on network-manager-dev to avoid FTBFS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/ephy-file-helpers.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="epiphany-Epiphany-File-Helpers">
 
5
<refmeta>
 
6
<refentrytitle role="top_of_page" id="epiphany-Epiphany-File-Helpers.top_of_page">Epiphany File Helpers</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>
 
9
  EPIPHANY Library
 
10
</refmiscinfo>
 
11
</refmeta>
 
12
<refnamediv>
 
13
<refname>Epiphany File Helpers</refname>
 
14
<refpurpose>miscellaneous file related utility functions</refpurpose>
 
15
</refnamediv>
 
16
 
 
17
<refsynopsisdiv id="epiphany-Epiphany-File-Helpers.synopsis" role="synopsis">
 
18
<title role="synopsis.title">Synopsis</title>
 
19
 
 
20
<synopsis>enum                <link linkend="EphyMimePermission">EphyMimePermission</link>;
 
21
const <link linkend="char"><returnvalue>char</returnvalue></link> *        <link linkend="ephy-file">ephy_file</link>                           (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>);
 
22
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-file-add-recent-item">ephy_file_add_recent_item</link>           (<parameter>const <link linkend="char"><type>char</type></link> *uri</parameter>,
 
23
                                                         <parameter>const <link linkend="char"><type>char</type></link> *mime_type</parameter>);
 
24
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="ephy-file-browse-to">ephy_file_browse_to</link>                 (<parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>,
 
25
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>);
 
26
<link linkend="EphyMimePermission"><returnvalue>EphyMimePermission</returnvalue></link>  <link linkend="ephy-file-check-mime">ephy_file_check_mime</link>                (<parameter>const <link linkend="char"><type>char</type></link> *mime_type</parameter>);
 
27
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-file-delete-directory">ephy_file_delete_directory</link>          (<parameter>const <link linkend="char"><type>char</type></link> *path</parameter>);
 
28
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-file-delete-on-exit">ephy_file_delete_on_exit</link>            (<parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>);
 
29
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-file-delete-uri">ephy_file_delete_uri</link>                (<parameter>const <link linkend="char"><type>char</type></link> *uri</parameter>);
 
30
<link linkend="char"><returnvalue>char</returnvalue></link> *              <link linkend="ephy-file-desktop-dir">ephy_file_desktop_dir</link>               (<parameter><type>void</type></parameter>);
 
31
<link linkend="char"><returnvalue>char</returnvalue></link> *              <link linkend="ephy-file-downloads-dir">ephy_file_downloads_dir</link>             (<parameter><type>void</type></parameter>);
 
32
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="ephy-file-find">ephy_file_find</link>                      (<parameter>const <link linkend="char"><type>char</type></link> *path</parameter>,
 
33
                                                         <parameter>const <link linkend="char"><type>char</type></link> *fname</parameter>,
 
34
                                                         <parameter><link linkend="gint"><type>gint</type></link> maxdepth</parameter>);
 
35
<link linkend="char"><returnvalue>char</returnvalue></link> *              <link linkend="ephy-file-get-downloads-dir">ephy_file_get_downloads_dir</link>         (<parameter><type>void</type></parameter>);
 
36
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="ephy-file-helpers-init">ephy_file_helpers_init</link>              (<parameter>const <link linkend="char"><type>char</type></link> *profile_dir</parameter>,
 
37
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> private_profile</parameter>,
 
38
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> keep_temp_dir</parameter>,
 
39
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
40
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-file-helpers-shutdown">ephy_file_helpers_shutdown</link>          (<parameter><type>void</type></parameter>);
 
41
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="ephy-file-launch-application">ephy_file_launch_application</link>        (<parameter><link linkend="GAppInfo"><type>GAppInfo</type></link> *app</parameter>,
 
42
                                                         <parameter><link linkend="GList"><type>GList</type></link> *files</parameter>,
 
43
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>,
 
44
                                                         <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);
 
45
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="ephy-file-launch-desktop-file">ephy_file_launch_desktop_file</link>       (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>,
 
46
                                                         <parameter>const <link linkend="char"><type>char</type></link> *parameter</parameter>,
 
47
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>,
 
48
                                                         <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);
 
49
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="ephy-file-launch-handler">ephy_file_launch_handler</link>            (<parameter>const <link linkend="char"><type>char</type></link> *mime_type</parameter>,
 
50
                                                         <parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>,
 
51
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>);
 
52
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="ephy-file-switch-temp-file">ephy_file_switch_temp_file</link>          (<parameter><link linkend="GFile"><type>GFile</type></link> *file_dest</parameter>,
 
53
                                                         <parameter><link linkend="GFile"><type>GFile</type></link> *file_temp</parameter>);
 
54
const <link linkend="char"><returnvalue>char</returnvalue></link> *        <link linkend="ephy-file-tmp-dir">ephy_file_tmp_dir</link>                   (<parameter><type>void</type></parameter>);
 
55
<link linkend="char"><returnvalue>char</returnvalue></link> *              <link linkend="ephy-file-tmp-filename">ephy_file_tmp_filename</link>              (<parameter>const <link linkend="char"><type>char</type></link> *base</parameter>,
 
56
                                                         <parameter>const <link linkend="char"><type>char</type></link> *extension</parameter>);
 
57
</synopsis>
 
58
</refsynopsisdiv>
 
59
 
 
60
<refsect1 id="epiphany-Epiphany-File-Helpers.description" role="desc">
 
61
<title role="desc.title">Description</title>
 
62
<para>
 
63
File related functions, including functions to launch, browse or move files
 
64
atomically.
 
65
</para>
 
66
</refsect1>
 
67
<refsect1 id="epiphany-Epiphany-File-Helpers.details" role="details">
 
68
<title role="details.title">Details</title>
 
69
<refsect2 id="EphyMimePermission" role="enum">
 
70
<title>enum EphyMimePermission</title>
 
71
<indexterm zone="EphyMimePermission"><primary>EphyMimePermission</primary></indexterm>
 
72
<programlisting>typedef enum
 
73
{
 
74
        EPHY_MIME_PERMISSION_SAFE&#160;= 1,
 
75
        EPHY_MIME_PERMISSION_UNSAFE&#160;= 2,
 
76
        EPHY_MIME_PERMISSION_UNKNOWN&#160;= 3
 
77
} EphyMimePermission;
 
78
</programlisting>
 
79
<para>
 
80
</para></refsect2>
 
81
<refsect2 id="ephy-file" role="function">
 
82
<title>ephy_file ()</title>
 
83
<indexterm zone="ephy-file"><primary>ephy_file</primary></indexterm>
 
84
<programlisting>const <link linkend="char"><returnvalue>char</returnvalue></link> *        ephy_file                           (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>);</programlisting>
 
85
<para>
 
86
Looks for <parameter>filename</parameter> in Epiphany's directories and relevant paths.
 
87
</para><variablelist role="params">
 
88
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
 
89
<listitem><simpara>the name of the Epiphany file requested
 
90
</simpara></listitem></varlistentry>
 
91
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the full path to the requested file
 
92
</simpara></listitem></varlistentry>
 
93
</variablelist></refsect2>
 
94
<refsect2 id="ephy-file-add-recent-item" role="function">
 
95
<title>ephy_file_add_recent_item ()</title>
 
96
<indexterm zone="ephy-file-add-recent-item"><primary>ephy_file_add_recent_item</primary></indexterm>
 
97
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_file_add_recent_item           (<parameter>const <link linkend="char"><type>char</type></link> *uri</parameter>,
 
98
                                                         <parameter>const <link linkend="char"><type>char</type></link> *mime_type</parameter>);</programlisting>
 
99
<para>
 
100
Adds <parameter>uri</parameter> to the default <link linkend="GtkRecentManager"><type>GtkRecentManager</type></link>, with <parameter>mime_type</parameter> as its type.
 
101
</para><variablelist role="params">
 
102
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
103
<listitem><simpara>an URI
 
104
</simpara></listitem></varlistentry>
 
105
<varlistentry><term><parameter>mime_type</parameter>&#160;:</term>
 
106
<listitem><simpara>the mime type corresponding to <parameter>uri</parameter>
 
107
</simpara></listitem></varlistentry>
 
108
</variablelist></refsect2>
 
109
<refsect2 id="ephy-file-browse-to" role="function">
 
110
<title>ephy_file_browse_to ()</title>
 
111
<indexterm zone="ephy-file-browse-to"><primary>ephy_file_browse_to</primary></indexterm>
 
112
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            ephy_file_browse_to                 (<parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>,
 
113
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>);</programlisting>
 
114
<para>
 
115
Launches the default application for browsing directories, with <parameter>file</parameter>'s
 
116
parent directory as its target. Passes <parameter>user_time</parameter> to
 
117
<link linkend="ephy-file-launch-handler"><function>ephy_file_launch_handler()</function></link> to prevent focus stealing.
 
118
</para><variablelist role="params">
 
119
<varlistentry><term><parameter>file</parameter>&#160;:</term>
 
120
<listitem><simpara>a <link linkend="GFile"><type>GFile</type></link>
 
121
</simpara></listitem></varlistentry>
 
122
<varlistentry><term><parameter>user_time</parameter>&#160;:</term>
 
123
<listitem><simpara>user_time to prevent focus stealing
 
124
</simpara></listitem></varlistentry>
 
125
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the launch succeeded
 
126
</simpara></listitem></varlistentry>
 
127
</variablelist></refsect2>
 
128
<refsect2 id="ephy-file-check-mime" role="function">
 
129
<title>ephy_file_check_mime ()</title>
 
130
<indexterm zone="ephy-file-check-mime"><primary>ephy_file_check_mime</primary></indexterm>
 
131
<programlisting><link linkend="EphyMimePermission"><returnvalue>EphyMimePermission</returnvalue></link>  ephy_file_check_mime                (<parameter>const <link linkend="char"><type>char</type></link> *mime_type</parameter>);</programlisting>
 
132
<para>
 
133
Checks <parameter>mime_type</parameter> against our safe/unsafe database of types, returns an
 
134
<link linkend="EphyMimePermission"><type>EphyMimePermission</type></link>.
 
135
</para><variablelist role="params">
 
136
<varlistentry><term><parameter>mime_type</parameter>&#160;:</term>
 
137
<listitem><simpara>a mime type
 
138
</simpara></listitem></varlistentry>
 
139
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="EphyMimePermission"><type>EphyMimePermission</type></link>
 
140
</simpara></listitem></varlistentry>
 
141
</variablelist></refsect2>
 
142
<refsect2 id="ephy-file-delete-directory" role="function">
 
143
<title>ephy_file_delete_directory ()</title>
 
144
<indexterm zone="ephy-file-delete-directory"><primary>ephy_file_delete_directory</primary></indexterm>
 
145
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_file_delete_directory          (<parameter>const <link linkend="char"><type>char</type></link> *path</parameter>);</programlisting>
 
146
<para>
 
147
Remove <parameter>path</parameter> and its contents. Like calling rm -rf <parameter>path</parameter>.
 
148
</para><variablelist role="params">
 
149
<varlistentry><term><parameter>path</parameter>&#160;:</term>
 
150
<listitem><simpara>the path to remove
 
151
</simpara></listitem></varlistentry>
 
152
</variablelist></refsect2>
 
153
<refsect2 id="ephy-file-delete-on-exit" role="function">
 
154
<title>ephy_file_delete_on_exit ()</title>
 
155
<indexterm zone="ephy-file-delete-on-exit"><primary>ephy_file_delete_on_exit</primary></indexterm>
 
156
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_file_delete_on_exit            (<parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>);</programlisting>
 
157
<para>
 
158
Schedules <parameter>file</parameter> to be deleted when Epiphany exits. This function currently
 
159
does nothing.
 
160
</para><variablelist role="params">
 
161
<varlistentry><term><parameter>file</parameter>&#160;:</term>
 
162
<listitem><simpara>a <link linkend="GFile"><type>GFile</type></link>
 
163
</simpara></listitem></varlistentry>
 
164
</variablelist></refsect2>
 
165
<refsect2 id="ephy-file-delete-uri" role="function">
 
166
<title>ephy_file_delete_uri ()</title>
 
167
<indexterm zone="ephy-file-delete-uri"><primary>ephy_file_delete_uri</primary></indexterm>
 
168
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_file_delete_uri                (<parameter>const <link linkend="char"><type>char</type></link> *uri</parameter>);</programlisting>
 
169
<para>
 
170
Remove the given URI.
 
171
</para><variablelist role="params">
 
172
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
173
<listitem><simpara>URI of the file to be deleted
 
174
</simpara></listitem></varlistentry>
 
175
</variablelist></refsect2>
 
176
<refsect2 id="ephy-file-desktop-dir" role="function">
 
177
<title>ephy_file_desktop_dir ()</title>
 
178
<indexterm zone="ephy-file-desktop-dir"><primary>ephy_file_desktop_dir</primary></indexterm>
 
179
<programlisting><link linkend="char"><returnvalue>char</returnvalue></link> *              ephy_file_desktop_dir               (<parameter><type>void</type></parameter>);</programlisting>
 
180
<para>
 
181
Gets the XDG desktop dir path or a default homedir/Desktop alternative.
 
182
</para><variablelist role="params">
 
183
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated string containing the desktop dir path.
 
184
</simpara></listitem></varlistentry>
 
185
</variablelist></refsect2>
 
186
<refsect2 id="ephy-file-downloads-dir" role="function">
 
187
<title>ephy_file_downloads_dir ()</title>
 
188
<indexterm zone="ephy-file-downloads-dir"><primary>ephy_file_downloads_dir</primary></indexterm>
 
189
<programlisting><link linkend="char"><returnvalue>char</returnvalue></link> *              ephy_file_downloads_dir             (<parameter><type>void</type></parameter>);</programlisting>
 
190
<para>
 
191
Gets the basename for Epiphany's Downloads dir. This depends on the current
 
192
locale. For the full path to the downloads directory see
 
193
<link linkend="ephy-file-get-downloads-dir"><function>ephy_file_get_downloads_dir()</function></link>.
 
194
</para><variablelist role="params">
 
195
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated string containing the downloads dir basename.
 
196
</simpara></listitem></varlistentry>
 
197
</variablelist></refsect2>
 
198
<refsect2 id="ephy-file-find" role="function">
 
199
<title>ephy_file_find ()</title>
 
200
<indexterm zone="ephy-file-find"><primary>ephy_file_find</primary></indexterm>
 
201
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            ephy_file_find                      (<parameter>const <link linkend="char"><type>char</type></link> *path</parameter>,
 
202
                                                         <parameter>const <link linkend="char"><type>char</type></link> *fname</parameter>,
 
203
                                                         <parameter><link linkend="gint"><type>gint</type></link> maxdepth</parameter>);</programlisting>
 
204
<para>
 
205
Searchs for <parameter>fname</parameter> in <parameter>path</parameter> with a maximum depth of <parameter>maxdepth</parameter>.
 
206
</para><variablelist role="params">
 
207
<varlistentry><term><parameter>path</parameter>&#160;:</term>
 
208
<listitem><simpara>path to search for <parameter>fname</parameter>
 
209
</simpara></listitem></varlistentry>
 
210
<varlistentry><term><parameter>fname</parameter>&#160;:</term>
 
211
<listitem><simpara>filename to search for
 
212
</simpara></listitem></varlistentry>
 
213
<varlistentry><term><parameter>maxdepth</parameter>&#160;:</term>
 
214
<listitem><simpara>maximum directory depth when searching <parameter>path</parameter>
 
215
</simpara></listitem></varlistentry>
 
216
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a GSList of matches
 
217
</simpara></listitem></varlistentry>
 
218
</variablelist></refsect2>
 
219
<refsect2 id="ephy-file-get-downloads-dir" role="function">
 
220
<title>ephy_file_get_downloads_dir ()</title>
 
221
<indexterm zone="ephy-file-get-downloads-dir"><primary>ephy_file_get_downloads_dir</primary></indexterm>
 
222
<programlisting><link linkend="char"><returnvalue>char</returnvalue></link> *              ephy_file_get_downloads_dir         (<parameter><type>void</type></parameter>);</programlisting>
 
223
<para>
 
224
Gets the full path to the downloads dir. This uses <link linkend="ephy-file-downloads-dir"><function>ephy_file_downloads_dir()</function></link>
 
225
internally and hence is locale dependant. Note that this can return <link linkend="NULL:CAPS"><literal>NULL</literal></link> if
 
226
not even the user homedir path can be found.
 
227
</para><variablelist role="params">
 
228
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated string containing the path to the downloads dir.
 
229
</simpara></listitem></varlistentry>
 
230
</variablelist></refsect2>
 
231
<refsect2 id="ephy-file-helpers-init" role="function">
 
232
<title>ephy_file_helpers_init ()</title>
 
233
<indexterm zone="ephy-file-helpers-init"><primary>ephy_file_helpers_init</primary></indexterm>
 
234
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            ephy_file_helpers_init              (<parameter>const <link linkend="char"><type>char</type></link> *profile_dir</parameter>,
 
235
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> private_profile</parameter>,
 
236
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> keep_temp_dir</parameter>,
 
237
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
 
238
<para>
 
239
Initializes Epiphany file helper functions, sets <parameter>profile_dir</parameter> as Epiphany's
 
240
profile dir and whether the running session will be private.
 
241
</para><variablelist role="params">
 
242
<varlistentry><term><parameter>profile_dir</parameter>&#160;:</term>
 
243
<listitem><simpara>directory to use as Epiphany's profile
 
244
</simpara></listitem></varlistentry>
 
245
<varlistentry><term><parameter>private_profile</parameter>&#160;:</term>
 
246
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we should use a private profile
 
247
</simpara></listitem></varlistentry>
 
248
<varlistentry><term><parameter>keep_temp_dir</parameter>&#160;:</term>
 
249
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to omit deleting the temp dir on exit
 
250
</simpara></listitem></varlistentry>
 
251
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
252
<listitem><simpara>an optional <link linkend="GError"><type>GError</type></link>
 
253
</simpara></listitem></varlistentry>
 
254
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if the profile dir couldn't be created or accesed
 
255
</simpara></listitem></varlistentry>
 
256
</variablelist></refsect2>
 
257
<refsect2 id="ephy-file-helpers-shutdown" role="function">
 
258
<title>ephy_file_helpers_shutdown ()</title>
 
259
<indexterm zone="ephy-file-helpers-shutdown"><primary>ephy_file_helpers_shutdown</primary></indexterm>
 
260
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_file_helpers_shutdown          (<parameter><type>void</type></parameter>);</programlisting>
 
261
<para>
 
262
Cleans file helpers information, corresponds to <link linkend="ephy-file-helpers-init"><function>ephy_file_helpers_init()</function></link>.
 
263
</para></refsect2>
 
264
<refsect2 id="ephy-file-launch-application" role="function">
 
265
<title>ephy_file_launch_application ()</title>
 
266
<indexterm zone="ephy-file-launch-application"><primary>ephy_file_launch_application</primary></indexterm>
 
267
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            ephy_file_launch_application        (<parameter><link linkend="GAppInfo"><type>GAppInfo</type></link> *app</parameter>,
 
268
                                                         <parameter><link linkend="GList"><type>GList</type></link> *files</parameter>,
 
269
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>,
 
270
                                                         <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);</programlisting>
 
271
<para>
 
272
Launches <parameter>app</parameter> to open <parameter>files</parameter>. If <parameter>widget</parameter> is set the screen and display from
 
273
it will be used to launch the application, otherwise the defaults will be
 
274
used.
 
275
</para><variablelist role="params">
 
276
<varlistentry><term><parameter>app</parameter>&#160;:</term>
 
277
<listitem><simpara>the application to launch
 
278
</simpara></listitem></varlistentry>
 
279
<varlistentry><term><parameter>files</parameter>&#160;:</term>
 
280
<listitem><simpara>files to pass to <parameter>app</parameter>
 
281
</simpara></listitem></varlistentry>
 
282
<varlistentry><term><parameter>user_time</parameter>&#160;:</term>
 
283
<listitem><simpara>user time to prevent focus stealing
 
284
</simpara></listitem></varlistentry>
 
285
<varlistentry><term><parameter>widget</parameter>&#160;:</term>
 
286
<listitem><simpara>a relevant widget from where to get the <link linkend="GdkScreen"><type>GdkScreen</type></link> and <link linkend="GdkDisplay"><type>GdkDisplay</type></link>
 
287
</simpara></listitem></varlistentry>
 
288
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <link linkend="g-app-info-launch"><function>g_app_info_launch()</function></link> succeeded
 
289
</simpara></listitem></varlistentry>
 
290
</variablelist></refsect2>
 
291
<refsect2 id="ephy-file-launch-desktop-file" role="function">
 
292
<title>ephy_file_launch_desktop_file ()</title>
 
293
<indexterm zone="ephy-file-launch-desktop-file"><primary>ephy_file_launch_desktop_file</primary></indexterm>
 
294
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            ephy_file_launch_desktop_file       (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>,
 
295
                                                         <parameter>const <link linkend="char"><type>char</type></link> *parameter</parameter>,
 
296
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>,
 
297
                                                         <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);</programlisting>
 
298
<para>
 
299
Calls <link linkend="ephy-file-launch-application"><function>ephy_file_launch_application()</function></link> for the application described by the
 
300
.desktop file <parameter>filename</parameter>. Can pass <parameter>parameter</parameter> as optional file arguments.
 
301
</para><variablelist role="params">
 
302
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
 
303
<listitem><simpara>the path to the .desktop file
 
304
</simpara></listitem></varlistentry>
 
305
<varlistentry><term><parameter>parameter</parameter>&#160;:</term>
 
306
<listitem><simpara>path to a parameter file to pass to the application
 
307
</simpara></listitem></varlistentry>
 
308
<varlistentry><term><parameter>user_time</parameter>&#160;:</term>
 
309
<listitem><simpara>user time to prevent focus stealing
 
310
</simpara></listitem></varlistentry>
 
311
<varlistentry><term><parameter>widget</parameter>&#160;:</term>
 
312
<listitem><simpara>an optional widget for <link linkend="ephy-file-launch-application"><function>ephy_file_launch_application()</function></link>
 
313
</simpara></listitem></varlistentry>
 
314
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the application launch was successful
 
315
</simpara></listitem></varlistentry>
 
316
</variablelist></refsect2>
 
317
<refsect2 id="ephy-file-launch-handler" role="function">
 
318
<title>ephy_file_launch_handler ()</title>
 
319
<indexterm zone="ephy-file-launch-handler"><primary>ephy_file_launch_handler</primary></indexterm>
 
320
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            ephy_file_launch_handler            (<parameter>const <link linkend="char"><type>char</type></link> *mime_type</parameter>,
 
321
                                                         <parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>,
 
322
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> user_time</parameter>);</programlisting>
 
323
<para>
 
324
Launches <parameter>file</parameter> with its default handler application, if <parameter>mime_type</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
325
then <parameter>file</parameter> will be queried for its type.
 
326
</para><variablelist role="params">
 
327
<varlistentry><term><parameter>mime_type</parameter>&#160;:</term>
 
328
<listitem><simpara>the mime type of <parameter>file</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
329
</simpara></listitem></varlistentry>
 
330
<varlistentry><term><parameter>file</parameter>&#160;:</term>
 
331
<listitem><simpara>a <link linkend="GFile"><type>GFile</type></link> to pass as argument
 
332
</simpara></listitem></varlistentry>
 
333
<varlistentry><term><parameter>user_time</parameter>&#160;:</term>
 
334
<listitem><simpara>user time to prevent focus stealing
 
335
</simpara></listitem></varlistentry>
 
336
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success
 
337
</simpara></listitem></varlistentry>
 
338
</variablelist></refsect2>
 
339
<refsect2 id="ephy-file-switch-temp-file" role="function">
 
340
<title>ephy_file_switch_temp_file ()</title>
 
341
<indexterm zone="ephy-file-switch-temp-file"><primary>ephy_file_switch_temp_file</primary></indexterm>
 
342
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            ephy_file_switch_temp_file          (<parameter><link linkend="GFile"><type>GFile</type></link> *file_dest</parameter>,
 
343
                                                         <parameter><link linkend="GFile"><type>GFile</type></link> *file_temp</parameter>);</programlisting>
 
344
<para>
 
345
Moves <parameter>file_temp</parameter> to <parameter>file_dest</parameter> atomically, doing a backup and restoring it if
 
346
something fails.
 
347
</para><variablelist role="params">
 
348
<varlistentry><term><parameter>file_dest</parameter>&#160;:</term>
 
349
<listitem><simpara>destination file
 
350
</simpara></listitem></varlistentry>
 
351
<varlistentry><term><parameter>file_temp</parameter>&#160;:</term>
 
352
<listitem><simpara>file to move to <parameter>file</parameter>
 
353
</simpara></listitem></varlistentry>
 
354
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the switch was successful
 
355
</simpara></listitem></varlistentry>
 
356
</variablelist></refsect2>
 
357
<refsect2 id="ephy-file-tmp-dir" role="function">
 
358
<title>ephy_file_tmp_dir ()</title>
 
359
<indexterm zone="ephy-file-tmp-dir"><primary>ephy_file_tmp_dir</primary></indexterm>
 
360
<programlisting>const <link linkend="char"><returnvalue>char</returnvalue></link> *        ephy_file_tmp_dir                   (<parameter><type>void</type></parameter>);</programlisting>
 
361
<para>
 
362
Returns the name of the temp dir for the running Epiphany instance.
 
363
</para><variablelist role="params">
 
364
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the name of the temp dir, this string belongs to Epiphany.
 
365
</simpara></listitem></varlistentry>
 
366
</variablelist></refsect2>
 
367
<refsect2 id="ephy-file-tmp-filename" role="function">
 
368
<title>ephy_file_tmp_filename ()</title>
 
369
<indexterm zone="ephy-file-tmp-filename"><primary>ephy_file_tmp_filename</primary></indexterm>
 
370
<programlisting><link linkend="char"><returnvalue>char</returnvalue></link> *              ephy_file_tmp_filename              (<parameter>const <link linkend="char"><type>char</type></link> *base</parameter>,
 
371
                                                         <parameter>const <link linkend="char"><type>char</type></link> *extension</parameter>);</programlisting>
 
372
<para>
 
373
Creates a temp file with <link linkend="mkstemp"><function>mkstemp()</function></link> using <parameter>base</parameter> as the name with an optional
 
374
<parameter>extension</parameter>.
 
375
</para><variablelist role="params">
 
376
<varlistentry><term><parameter>base</parameter>&#160;:</term>
 
377
<listitem><simpara>the base name of the temp file to create
 
378
</simpara></listitem></varlistentry>
 
379
<varlistentry><term><parameter>extension</parameter>&#160;:</term>
 
380
<listitem><simpara>an optional extension for <parameter>base</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
381
</simpara></listitem></varlistentry>
 
382
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated string containing the name of the created temp
 
383
file or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
384
</simpara></listitem></varlistentry>
 
385
</variablelist></refsect2>
 
386
 
 
387
</refsect1>
 
388
 
 
389
</refentry>