docs/reference/pygio-mountoperation.xml

   1 <?xml version="1.0" standalone="no"?>
   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
   5 <refentry id="class-giomountoperation">
   6     <refnamediv>
   7         <refname>gio.MountOperation</refname>
   8         <refpurpose>Authentication methods for mountable locations.</refpurpose>
   9     </refnamediv>
  10
  11     <refsect1>
  12         <title>Synopsis</title>
  13
  14     <classsynopsis language="python">
  15         <ooclass><classname>gio.MountOperation</classname></ooclass>
  16         <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
  17
  18     <constructorsynopsis language="python">
  19     <methodname><link linkend="constructor-giomountoperation">gio.MountOperation</link></methodname>
  20     <methodparam></methodparam>
  21     </constructorsynopsis>
  22
  23     <methodsynopsis language="python">
  24         <methodname><link linkend="method-giomountoperation--get-anonymous">get_anonymous</link></methodname>
  25         <methodparam></methodparam>
  26     </methodsynopsis>
  27     <methodsynopsis language="python">
  28         <methodname><link linkend="method-giomountoperation--get-choice">get_choice</link></methodname>
  29         <methodparam></methodparam>
  30     </methodsynopsis>
  31     <methodsynopsis language="python">
  32         <methodname><link linkend="method-giomountoperation--get-domain">get_domain</link></methodname>
  33         <methodparam></methodparam>
  34     </methodsynopsis>
  35     <methodsynopsis language="python">
  36         <methodname><link linkend="method-giomountoperation--get-password">get_password</link></methodname>
  37         <methodparam></methodparam>
  38     </methodsynopsis>
  39     <methodsynopsis language="python">
  40         <methodname><link linkend="method-giomountoperation--get-password-save">get_password_save</link></methodname>
  41         <methodparam></methodparam>
  42     </methodsynopsis>
  43     <methodsynopsis language="python">
  44         <methodname><link linkend="method-giomountoperation--get-username">get_username</link></methodname>
  45         <methodparam></methodparam>
  46     </methodsynopsis>
  47     <methodsynopsis language="python">
  48         <methodname><link linkend="method-giomountoperation--reply">replay</link></methodname>
  49         <methodparam><parameter role="keyword">result</parameter></methodparam>
  50     </methodsynopsis>
  51     <methodsynopsis language="python">
  52         <methodname><link linkend="method-giomountoperation--set-anonymous">set_anonymous</link></methodname>
  53         <methodparam><parameter role="keyword">anonymous</parameter></methodparam>
  54     </methodsynopsis>
  55     <methodsynopsis language="python">
  56         <methodname><link linkend="method-giomountoperation--set-choice">set_choice</link></methodname>
  57         <methodparam><parameter role="keyword">choice</parameter></methodparam>
  58     </methodsynopsis>
  59     <methodsynopsis language="python">
  60         <methodname><link linkend="method-giomountoperation--set-domain">set_domain</link></methodname>
  61         <methodparam><parameter role="keyword">domain</parameter></methodparam>
  62     </methodsynopsis>
  63     <methodsynopsis language="python">
  64         <methodname><link linkend="method-giomountoperation--set-password">set_password</link></methodname>
  65         <methodparam><parameter role="keyword">password</parameter></methodparam>
  66     </methodsynopsis>
  67     <methodsynopsis language="python">
  68         <methodname><link linkend="method-giomountoperation--set-password-save">set_password_save</link></methodname>
  69         <methodparam><parameter role="keyword">save</parameter></methodparam>
  70     </methodsynopsis>
  71     <methodsynopsis language="python">
  72         <methodname><link linkend="method-giomountoperation--set-username">set_username</link></methodname>
  73         <methodparam><parameter role="keyword">username</parameter></methodparam>
  74     </methodsynopsis>
  75
  76     </classsynopsis>
  77     </refsect1>
  78
  79     <refsect1>
  80         <title>Ancestry</title>
  81
  82 <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  83   +-- <link linkend="class-giomountoperation">gio.MountOperation</link>
  84 </synopsis>
  85
  86     </refsect1>
  87
  88     <refsect1 id="properties-giomountoperation">
  89         <title>gio.MountOperation Properties</title>
  90
  91         <blockquote role="properties">
  92             <informaltable pgwide="1" frame="none">
  93                 <tgroup cols="3">
  94                     <colspec column="1" colwidth="1in"/>
  95                     <colspec column="2" colwidth="1in"/>
  96                     <colspec column="3" colwidth="4in"/>
  97                     <tbody>
  98                         <row valign="top">
  99                             <entry>"anonymous"</entry>
 100                             <entry>Read/Write</entry>
 101                             <entry>
 102                                 Whether to use an anonymous user when authenticating.
 103                                 Default value: <literal>False</literal>
 104                             </entry>
 105                         </row>
 106                         <row valign="top">
 107                             <entry>"choice"</entry>
 108                             <entry>Read/Write</entry>
 109                             <entry>
 110                                 The index of the user's choice when a question is asked during
 111                                 the mount operation. See the "ask-question" signal.
 112                                 Allowed values: >= 0 Default value: 0
 113                             </entry>
 114                         </row>
 115                         <row valign="top">
 116                             <entry>"domain"</entry>
 117                             <entry>Read/Write</entry>
 118                             <entry>
 119                                 The domain to use for the mount operation. Default value: <literal>None</literal>
 120                             </entry>
 121                         </row>
 122                         <row valign="top">
 123                             <entry>"password"</entry>
 124                             <entry>Read/Write</entry>
 125                             <entry>
 126                                 The password that is used for authentication when carrying out the
 127                                 mount operation. Default value: <literal>None</literal>
 128                             </entry>
 129                         </row>
 130                         <row valign="top">
 131                             <entry>"password-save"</entry>
 132                             <entry>Read/Write</entry>
 133                             <entry>
 134                                 Determines if and how the password information should be saved.
 135                                 Default value: gio.PASSWORD_SAVE_NEVER
 136                             </entry>
 137                         </row>
 138                         <row valign="top">
 139                             <entry>"username"</entry>
 140                             <entry>Read/Write</entry>
 141                             <entry>
 142                                 The user name that is used for authentication when carrying out the
 143                                 mount operation. Default value: <literal>None</literal>
 144                             </entry>
 145                         </row>
 146                     </tbody>
 147                 </tgroup>
 148             </informaltable>
 149         </blockquote>
 150
 151     </refsect1>
 152
 153     <refsect1 id="signal-prototypes-giomountoperation">
 154         <title>gio.MountOperation Signal Prototypes</title>
 155
 156         <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
 157
 158         <variablelist>
 159             <varlistentry>
 160                 <term><link linkend="signal-giomountoperation--aborted">"aborted"</link></term>
 161                 <listitem>
 162                     <methodsynopsis language="python"><methodname>callback</methodname>
 163                         <methodparam><parameter>mountoperation</parameter></methodparam>
 164                         <methodparam><parameter>user_param1</parameter></methodparam>
 165                         <methodparam><parameter>...</parameter></methodparam>
 166                     </methodsynopsis>
 167                 </listitem>
 168             </varlistentry>
 169             <varlistentry>
 170                 <term><link linkend="signal-giomountoperation--ask-password">"ask-password"</link></term>
 171                 <listitem>
 172                     <methodsynopsis language="python"><methodname>callback</methodname>
 173                         <methodparam><parameter>mountoperation</parameter></methodparam>
 174                         <methodparam><parameter>message</parameter></methodparam>
 175                         <methodparam><parameter>default_user</parameter></methodparam>
 176                         <methodparam><parameter>default_domain</parameter></methodparam>
 177                         <methodparam><parameter>flags</parameter></methodparam>
 178                         <methodparam><parameter>user_param1</parameter></methodparam>
 179                         <methodparam><parameter>...</parameter></methodparam>
 180                     </methodsynopsis>
 181                 </listitem>
 182             </varlistentry>
 183             <varlistentry>
 184                 <term><link linkend="signal-giomountoperation--ask-question">"ask-question"</link></term>
 185                 <listitem>
 186                     <methodsynopsis language="python"><methodname>callback</methodname>
 187                         <methodparam><parameter>mountoperation</parameter></methodparam>
 188                         <methodparam><parameter>message</parameter></methodparam>
 189                         <methodparam><parameter>choices</parameter></methodparam>
 190                         <methodparam><parameter>user_param1</parameter></methodparam>
 191                         <methodparam><parameter>...</parameter></methodparam>
 192                     </methodsynopsis>
 193                 </listitem>
 194             </varlistentry>
 195             <varlistentry>
 196                 <term><link linkend="signal-giomountoperation--reply">"reply"</link></term>
 197                 <listitem>
 198                     <methodsynopsis language="python"><methodname>callback</methodname>
 199                         <methodparam><parameter>mountoperation</parameter></methodparam>
 200                         <methodparam><parameter>result</parameter></methodparam>
 201                         <methodparam><parameter>user_param1</parameter></methodparam>
 202                         <methodparam><parameter>...</parameter></methodparam>
 203                     </methodsynopsis>
 204                 </listitem>
 205             </varlistentry>
 206         </variablelist>
 207
 208     </refsect1>
 209
 210     <refsect1>
 211         <title>Description</title>
 212
 213         <para>
 214             The <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>
 215         provides a mechanism for authenticating mountable operations, such as loop mounting files,
 216         hard drive partitions or server locations.
 217         </para>
 218         <para>
 219             Mounting operations are handed a
 220             <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>
 221             that then can use if they require any privileges or authentication for their volumes to be
 222             mounted (e.g. a hard disk partition or an encrypted filesystem), or if they are implementing
 223             a remote server protocol which requires user credentials such as FTP or WebDAV.
 224         </para>
 225         <para>
 226             Users should instantiate a subclass of this that implements all the various callbacks
 227             to show the required dialogs, such as
 228             <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
 229         </para>
 230     </refsect1>
 231
 232     <refsect1 id="constructor-giomountoperation">
 233         <title>Constructor</title>
 234
 235         <programlisting><constructorsynopsis language="python">
 236             <methodname>gio.MountOperation</methodname>
 237             <methodparam></methodparam>
 238         </constructorsynopsis></programlisting>
 239         <variablelist>
 240             <varlistentry>
 241                 <term><emphasis>Returns</emphasis>&nbsp;:</term>
 242                 <listitem><simpara>a new
 243                 <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>.
 244                 </simpara></listitem>
 245             </varlistentry>
 246         </variablelist>
 247
 248         <para>
 249             Creates a new mount operation.
 250         </para>
 251
 252     </refsect1>
 253
 254     <refsect1>
 255         <title>Methods</title>
 256
 257         <refsect2 id="method-giomountoperation--get-anonymous">
 258             <title>gio.MountOperation.get_anonymous</title>
 259
 260             <programlisting><methodsynopsis language="python">
 261                 <methodname>get_anonymous</methodname>
 262                 <methodparam></methodparam>
 263             </methodsynopsis></programlisting>
 264
 265             <variablelist>
 266                 <varlistentry>
 267                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 268                     <listitem><simpara><literal>True</literal> if mount operation is anonymous.
 269                     </simpara></listitem>
 270                 </varlistentry>
 271             </variablelist>
 272
 273             <para>
 274                 The <methodname>get_anonymous</methodname>() method check to see whether
 275                 the mount operation is being used for an anonymous user
 276             </para>
 277         </refsect2>
 278
 279         <refsect2 id="method-giomountoperation--get-choice">
 280             <title>gio.MountOperation.get_choice</title>
 281
 282             <programlisting><methodsynopsis language="python">
 283                 <methodname>get_choice</methodname>
 284                 <methodparam></methodparam>
 285             </methodsynopsis></programlisting>
 286
 287             <variablelist>
 288                 <varlistentry>
 289                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 290                     <listitem><simpara>an integer containing an index of the user's
 291                     choice from the choice's list, or 0.
 292                     </simpara></listitem>
 293                 </varlistentry>
 294             </variablelist>
 295
 296             <para>
 297                 The <methodname>get_anonymous</methodname>() method gets a choice
 298                 from the mount operation.
 299             </para>
 300         </refsect2>
 301
 302         <refsect2 id="method-giomountoperation--get-domain">
 303             <title>gio.MountOperation.get_domain</title>
 304
 305             <programlisting><methodsynopsis language="python">
 306                 <methodname>get_domain</methodname>
 307                 <methodparam></methodparam>
 308             </methodsynopsis></programlisting>
 309
 310             <variablelist>
 311                 <varlistentry>
 312                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 313                     <listitem><simpara>a string set to the domain.
 314                     </simpara></listitem>
 315                 </varlistentry>
 316             </variablelist>
 317
 318             <para>
 319                 The <methodname>get_domain</methodname>() method gets the domain
 320                 of the mount operation.
 321             </para>
 322         </refsect2>
 323
 324         <refsect2 id="method-giomountoperation--get-password">
 325             <title>gio.MountOperation.get_password</title>
 326
 327             <programlisting><methodsynopsis language="python">
 328                 <methodname>get_password</methodname>
 329                 <methodparam></methodparam>
 330             </methodsynopsis></programlisting>
 331
 332             <variablelist>
 333                 <varlistentry>
 334                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 335                     <listitem><simpara>a string containing the password within
 336                     the mountoperation.
 337                     </simpara></listitem>
 338                 </varlistentry>
 339             </variablelist>
 340
 341             <para>
 342                 The <methodname>get_password</methodname>() method gets a password
 343                 from the mount operation.
 344             </para>
 345         </refsect2>
 346
 347         <refsect2 id="method-giomountoperation--get-password-save">
 348             <title>gio.MountOperation.get_password_save</title>
 349
 350             <programlisting><methodsynopsis language="python">
 351                 <methodname>get_password_save</methodname>
 352                 <methodparam></methodparam>
 353             </methodsynopsis></programlisting>
 354
 355             <variablelist>
 356                 <varlistentry>
 357                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 358                     <listitem><simpara>a
 359                     <xref linkend="gio-password-save-constants" endterm="gio-password-save-constants-title"></xref>
 360                     flag.
 361                     </simpara></listitem>
 362                 </varlistentry>
 363             </variablelist>
 364
 365             <para>
 366                 The <methodname>get_password_save</methodname>() method gets the state
 367                 of saving passwords for the mount operation.
 368             </para>
 369         </refsect2>
 370
 371         <refsect2 id="method-giomountoperation--get-username">
 372             <title>gio.MountOperation.get_username</title>
 373
 374             <programlisting><methodsynopsis language="python">
 375                 <methodname>get_username</methodname>
 376                 <methodparam></methodparam>
 377             </methodsynopsis></programlisting>
 378
 379             <variablelist>
 380                 <varlistentry>
 381                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 382                     <listitem><simpara>a string containing the user name.
 383                     </simpara></listitem>
 384                 </varlistentry>
 385             </variablelist>
 386
 387             <para>
 388                 The <methodname>get_username</methodname>() method get the user
 389                 name from the mount operation.
 390             </para>
 391         </refsect2>
 392
 393         <refsect2 id="method-giomountoperation--reply">
 394             <title>gio.MountOperation.reply</title>
 395
 396             <programlisting><methodsynopsis language="python">
 397                 <methodname>reply</methodname>
 398                 <methodparam><parameter role="keyword">result</parameter></methodparam>
 399             </methodsynopsis></programlisting>
 400
 401             <variablelist>
 402                 <varlistentry>
 403                     <term><parameter>result</parameter>&nbsp;:</term>
 404                     <listitem><simpara>a
 405                     <xref linkend="gio-mount-operation-result-constants" endterm="gio-mount-operation-result-constants-title"></xref>
 406                     </simpara></listitem>
 407                 </varlistentry>
 408             </variablelist>
 409
 410             <para>
 411                 The <methodname>reply</methodname>() method emits the "reply" signal.
 412             </para>
 413         </refsect2>
 414
 415         <refsect2 id="method-giomountoperation--set-anonymous">
 416             <title>gio.MountOperation.set_anonymous</title>
 417
 418             <programlisting><methodsynopsis language="python">
 419                 <methodname>set_anonymous</methodname>
 420                 <methodparam><parameter role="keyword">anonymous</parameter></methodparam>
 421             </methodsynopsis></programlisting>
 422
 423             <variablelist>
 424                 <varlistentry>
 425                     <term><parameter>anonymous</parameter>&nbsp;:</term>
 426                     <listitem><simpara>boolean value.
 427                     </simpara></listitem>
 428                 </varlistentry>
 429             </variablelist>
 430
 431             <para>
 432                 The <methodname>set_anonymous</methodname>() method sets the mount operation
 433                 to use an anonymous user if anonymous is <literal>True</literal>.
 434             </para>
 435         </refsect2>
 436
 437         <refsect2 id="method-giomountoperation--set-choice">
 438             <title>gio.MountOperation.set_choice</title>
 439
 440             <programlisting><methodsynopsis language="python">
 441                 <methodname>set_choice</methodname>
 442                 <methodparam><parameter role="keyword">choice</parameter></methodparam>
 443             </methodsynopsis></programlisting>
 444
 445             <variablelist>
 446                 <varlistentry>
 447                     <term><parameter>choice</parameter>&nbsp;:</term>
 448                     <listitem><simpara>an integer.
 449                     </simpara></listitem>
 450                 </varlistentry>
 451             </variablelist>
 452
 453             <para>
 454                 The <methodname>set_choice</methodname>() method sets a default choice for the mount operation.
 455             </para>
 456         </refsect2>
 457
 458         <refsect2 id="method-giomountoperation--set-domain">
 459             <title>gio.MountOperation.set_domain</title>
 460
 461             <programlisting><methodsynopsis language="python">
 462                 <methodname>set_domain</methodname>
 463                 <methodparam><parameter role="keyword">domain</parameter></methodparam>
 464             </methodsynopsis></programlisting>
 465
 466             <variablelist>
 467                 <varlistentry>
 468                     <term><parameter>domain</parameter>&nbsp;:</term>
 469                     <listitem><simpara>the domain to set.
 470                     </simpara></listitem>
 471                 </varlistentry>
 472             </variablelist>
 473
 474             <para>
 475                 The <methodname>set_domain</methodname>() method sets the mount operation's domain.
 476             </para>
 477         </refsect2>
 478
 479         <refsect2 id="method-giomountoperation--set-password">
 480             <title>gio.MountOperation.set_password</title>
 481
 482             <programlisting><methodsynopsis language="python">
 483                 <methodname>set_password</methodname>
 484                 <methodparam><parameter role="keyword">password</parameter></methodparam>
 485             </methodsynopsis></programlisting>
 486
 487             <variablelist>
 488                 <varlistentry>
 489                     <term><parameter>password</parameter>&nbsp;:</term>
 490                     <listitem><simpara>password to set.
 491                     </simpara></listitem>
 492                 </varlistentry>
 493             </variablelist>
 494
 495             <para>
 496                 The <methodname>set_password</methodname>() method sets the mount
 497                 operation's password to password.
 498             </para>
 499         </refsect2>
 500
 501         <refsect2 id="method-giomountoperation--set-password-save">
 502             <title>gio.MountOperation.set_password_save</title>
 503
 504             <programlisting><methodsynopsis language="python">
 505                 <methodname>set_password_save</methodname>
 506                 <methodparam><parameter role="keyword">save</parameter></methodparam>
 507             </methodsynopsis></programlisting>
 508
 509             <variablelist>
 510                 <varlistentry>
 511                     <term><parameter>save</parameter>&nbsp;:</term>
 512                     <listitem><simpara>a set of
 513                     <xref linkend="gio-password-save-constants" endterm="gio-password-save-constants-title"></xref>
 514                     </simpara></listitem>
 515                 </varlistentry>
 516             </variablelist>
 517
 518             <para>
 519                 The <methodname>set_password_save</methodname>() method sets the state
 520                 of saving passwords for the mount operation.
 521             </para>
 522         </refsect2>
 523
 524         <refsect2 id="method-giomountoperation--set-username">
 525             <title>gio.MountOperation.set_username</title>
 526
 527             <programlisting><methodsynopsis language="python">
 528                 <methodname>set_username</methodname>
 529                 <methodparam><parameter role="keyword">username</parameter></methodparam>
 530             </methodsynopsis></programlisting>
 531
 532             <variablelist>
 533                 <varlistentry>
 534                     <term><parameter>username</parameter>&nbsp;:</term>
 535                     <listitem><simpara>input username.
 536                     </simpara></listitem>
 537                 </varlistentry>
 538             </variablelist>
 539
 540             <para>
 541                 The <methodname>set_anonymous</methodname>() method sets the user
 542                 name within op to username.
 543             </para>
 544         </refsect2>
 545     </refsect1>
 546
 547     <refsect1>
 548         <title>Signals</title>
 549
 550         <refsect2 id="signal-giomountoperation--aborted">
 551             <title>The "aborted" gio.MountOperation Signal</title>
 552
 553             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 554                 <methodparam><parameter>mountoperation</parameter></methodparam>
 555                 <methodparam><parameter>user_param1</parameter></methodparam>
 556                 <methodparam><parameter>...</parameter></methodparam>
 557             </methodsynopsis></programlisting>
 558
 559             <variablelist>
 560                 <varlistentry>
 561                     <term><parameter>mountoperation</parameter>&nbsp;:</term>
 562                     <listitem><simpara>the mountoperation</simpara></listitem>
 563                 </varlistentry>
 564                 <varlistentry>
 565                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 566                     <listitem><simpara>the first user parameter (if any) specified
 567                     with the <link
 568                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 569                     method</simpara></listitem>
 570                 </varlistentry>
 571                 <varlistentry>
 572                     <term><parameter>...</parameter>&nbsp;:</term>
 573                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 574                 </varlistentry>
 575             </variablelist>
 576
 577             <para>
 578                 Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress.
 579                 Implementations of <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>
 580                 should handle this signal by dismissing open password dialogs.
 581             </para>
 582         </refsect2>
 583
 584         <refsect2 id="signal-giomountoperation--ask-password">
 585             <title>The "ask-password" gio.MountOperation Signal</title>
 586
 587             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 588                 <methodparam><parameter>mountoperation</parameter></methodparam>
 589                 <methodparam><parameter>message</parameter></methodparam>
 590                 <methodparam><parameter>default_user</parameter></methodparam>
 591                 <methodparam><parameter>default_domain</parameter></methodparam>
 592                 <methodparam><parameter>flags</parameter></methodparam>
 593                 <methodparam><parameter>user_param1</parameter></methodparam>
 594                 <methodparam><parameter>...</parameter></methodparam>
 595             </methodsynopsis></programlisting>
 596
 597             <variablelist>
 598                 <varlistentry>
 599                     <term><parameter>mountoperation</parameter>&nbsp;:</term>
 600                     <listitem><simpara>the mountoperation</simpara></listitem>
 601                 </varlistentry>
 602                 <varlistentry>
 603                     <term><parameter>message</parameter>&nbsp;:</term>
 604                     <listitem><simpara>string containing a message to display to the user.</simpara></listitem>
 605                 </varlistentry>
 606                 <varlistentry>
 607                     <term><parameter>default_user</parameter>&nbsp;:</term>
 608                     <listitem><simpara>string containing the default user name.</simpara></listitem>
 609                 </varlistentry>
 610                 <varlistentry>
 611                     <term><parameter>default_domain</parameter>&nbsp;:</term>
 612                     <listitem><simpara>string containing the default domain.</simpara></listitem>
 613                 </varlistentry>
 614                 <varlistentry>
 615                     <term><parameter>flags</parameter>&nbsp;:</term>
 616                     <listitem><simpara>a set of
 617                     <xref linkend="gio-ask-password-flags-constants" endterm="gio-ask-password-flags-constants-title"></xref>
 618                     </simpara></listitem>
 619                 </varlistentry>
 620                 <varlistentry>
 621                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 622                     <listitem><simpara>the first user parameter (if any) specified
 623                     with the <link
 624                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 625                     method</simpara></listitem>
 626                 </varlistentry>
 627                 <varlistentry>
 628                     <term><parameter>...</parameter>&nbsp;:</term>
 629                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 630                 </varlistentry>
 631             </variablelist>
 632
 633             <para>
 634                 This signal is emitted when a mount operation asks the user for a password.
 635                 If the message contains a line break, the first line should be presented as a heading.
 636                 For example, it may be used as the primary text in a
 637                 <link linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>.
 638             </para>
 639         </refsect2>
 640
 641         <refsect2 id="signal-giomountoperation--ask-question">
 642             <title>The "ask-question" gio.MountOperation Signal</title>
 643
 644             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 645                 <methodparam><parameter>mountoperation</parameter></methodparam>
 646                 <methodparam><parameter>message</parameter></methodparam>
 647                 <methodparam><parameter>choices</parameter></methodparam>
 648                 <methodparam><parameter>user_param1</parameter></methodparam>
 649                 <methodparam><parameter>...</parameter></methodparam>
 650             </methodsynopsis></programlisting>
 651
 652             <variablelist>
 653                 <varlistentry>
 654                     <term><parameter>mountoperation</parameter>&nbsp;:</term>
 655                     <listitem><simpara>the mountoperation</simpara></listitem>
 656                 </varlistentry>
 657                 <varlistentry>
 658                     <term><parameter>message</parameter>&nbsp;:</term>
 659                     <listitem><simpara>string containing a message to display to the user.</simpara></listitem>
 660                 </varlistentry>
 661                 <varlistentry>
 662                     <term><parameter>choices</parameter>&nbsp;:</term>
 663                     <listitem><simpara>a list of strings for each possible choice.</simpara></listitem>
 664                 </varlistentry>
 665                 <varlistentry>
 666                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 667                     <listitem><simpara>the first user parameter (if any) specified
 668                     with the <link
 669                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 670                     method</simpara></listitem>
 671                 </varlistentry>
 672                 <varlistentry>
 673                     <term><parameter>...</parameter>&nbsp;:</term>
 674                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 675                 </varlistentry>
 676             </variablelist>
 677
 678             <para>
 679                 This signal is emitted when asking the user a question and gives a list of choices
 680                 for the user to choose from. If the message contains a line break, the first line should be
 681                 presented as a heading. For example, it may be used as the primary text in a
 682                 <link linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>.
 683             </para>
 684         </refsect2>
 685
 686         <refsect2 id="signal-giomountoperation--reply">
 687             <title>The "reply" gio.MountOperation Signal</title>
 688
 689             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 690                 <methodparam><parameter>mountoperation</parameter></methodparam>
 691                 <methodparam><parameter>result</parameter></methodparam>
 692                 <methodparam><parameter>user_param1</parameter></methodparam>
 693                 <methodparam><parameter>...</parameter></methodparam>
 694             </methodsynopsis></programlisting>
 695
 696             <variablelist>
 697                 <varlistentry>
 698                     <term><parameter>mountoperation</parameter>&nbsp;:</term>
 699                     <listitem><simpara>the mountoperation</simpara></listitem>
 700                 </varlistentry>
 701                 <varlistentry>
 702                     <term><parameter>result</parameter>&nbsp;:</term>
 703                     <listitem><simpara>a
 704                     <xref linkend="gio-mount-operation-result-constants" endterm="gio-mount-operation-result-constants-title"></xref>
 705                     indicating how the request was handled</simpara></listitem>
 706                 </varlistentry>
 707                 <varlistentry>
 708                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 709                     <listitem><simpara>the first user parameter (if any) specified
 710                     with the <link
 711                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 712                     method</simpara></listitem>
 713                 </varlistentry>
 714                 <varlistentry>
 715                     <term><parameter>...</parameter>&nbsp;:</term>
 716                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 717                 </varlistentry>
 718             </variablelist>
 719
 720             <para>
 721                 This signal is emitted when the user has replied to the mount operation.
 722             </para>
 723         </refsect2>
 724
 725   </refsect1>
 726 </refentry>