summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkmountoperation.xml
blob: dac9305ac00b10f82e4f5501caaf70d8acd4da5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkmountoperation">
    <refnamediv>
        <refname>gtk.MountOperation</refname>
        <refpurpose>Functions for working with GIO (new in PyGTK 2.14)</refpurpose>
    </refnamediv>

    <refsect1>
        <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>gtk.MountOperation</classname></ooclass>
        <ooclass><classname><link linkend="class-giomountoperation">gio.MountOperation</link></classname></ooclass>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkmountoperation--get-parent">get_parent</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkmountoperation--get-screen">get_screen</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkmountoperation--is-showing">is_showing</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkmountoperation--set-parent">set_parent</link></methodname>
        <methodparam><parameter role="keyword">parent</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkmountoperation--set-screen">set_screen</link></methodname>
        <methodparam><parameter role="keyword">screen</parameter></methodparam>
    </methodsynopsis>

    </classsynopsis>

    </refsect1>

    <refsect1>
        <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-giomountoperation">gio.MountOperation</link>
    +-- <link linkend="class-gtkmountoperation">gtk.MountOperation</link>
</synopsis>

    </refsect1>

  <refsect1 id="properties-gtkmountoperation">
    <title>gtk.MountOperation Properties</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="3.5in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"is-showing"</entry>
	      <entry>Read</entry>
	      <entry>Are we showing a dialog. Default value: <literal>False</literal>.</entry>
	  </row>

	    <row valign="top">
	      <entry>"parent"</entry>
	      <entry>Read/Write</entry>
          <entry>The parent window.</entry>
	  </row>

	    <row valign="top">
	      <entry>"screen"</entry>
	      <entry>Read/Write</entry>
          <entry>The screen where this window will be displayed.</entry>
	  </row>

	</tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

    <refsect1>
        <title>Description</title>
            <para>
                The functions and objects described here make working with GTK+ and GIO more convenient.
                <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
                is needed when mounting volumes and
                <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
                is a convenient way to launch applications for URIs. Another object that is worth
                mentioning in this context is 
                <link linkend="class-gdkapplaunchcontext"><classname>gtk.gdk.AppLaunchContext</classname></link>,
                which provides visual feedback when lauching applications.
            </para>
    </refsect1>
    
    <refsect1 id="constructor-gtkmountoperation">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.MountOperation</methodname>
	<methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>

    <variablelist>
      <varlistentry>
	<term><parameter role="keyword">parent</parameter>&nbsp;:</term>
	<listitem><simpara>transient parent of the window, or
        <literal>None</literal>.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new
        <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
        </simpara></listitem>
      </varlistentry>
    </variablelist>

    <note>
        <para>This method is available in PyGTK 2.14 and above.</para>
    </note>

    <para>
        Creates a new <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
    </para>

  </refsect1>

    <refsect1>
        <title>Methods</title>

        <refsect2 id="method-gtkmountoperation--get-parent">
            <title>gtk.MountOperation.get_parent</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_parent</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>a new
                    <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>get_parent</methodname>() method gets the transient
                parent used by the
                <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
            </para>
        </refsect2>

        <refsect2 id="method-gtkmountoperation--get-screen">
            <title>gtk.MountOperation.get_screen</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_screen</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>the screen on which windows of op are shown.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>get_screen</methodname>() method gets the screen
                on which windows of the
                <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
                will be shown.
            </para>
        </refsect2>

        <refsect2 id="method-gtkmountoperation--is-showing">
            <title>gtk.MountOperation.is_showing</title>

            <programlisting><methodsynopsis language="python">
                <methodname>is_showing</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara><literal>True</literal> if op is currently displaying a window.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>is_showing</methodname>() method returns whetherthe
                <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
                is currently displaying a window.
            </para>
        </refsect2>

        <refsect2 id="method-gtkmountoperation--set-parent">
            <title>gtk.MountOperation.set_parent</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_parent</methodname>
                <methodparam><parameter>parent</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
                        <listitem><simpara>transient parent of the window,
                        or <literal>None</literal>.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>set_parent</methodname>() method sets the
                transient parent for windows shown by the
                <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
            </para>
        </refsect2>

        <refsect2 id="method-gtkmountoperation--set-screen">
            <title>gtk.MountOperation.set_screen</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_screen</methodname>
                <methodparam><parameter>screen</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
                        <listitem><simpara>a
                        <link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>.
                        </simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>set_screen</methodname>() method gets the screen
                on which windows of the
                <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
                will be shown.
            </para>
        </refsect2>
    </refsect1>
</refentry>