← Back to branch summary

~ubuntu-branches/debian/stretch/lightdm/stretch

« back to all changes in this revision

Viewing changes to doc/html/lightdm-gobject-1-Greeter-Interface.html

  • Committer: Package Import Robot
  • Author(s): Yves-Alexis Perez
  • Date: 2013-10-20 20:45:55 UTC
  • mfrom: (1.1.17)
  • Revision ID: package-import@ubuntu.com-20131020204555-0ht6bt0lw5bof9fn
Tags: 1.8.2-1
* New upstream release.
* debian/patches:
  - 01_set-default-path, 02_default-config, 05_debianize-pam-files
    refreshed.
  - 03_quit-plymouth disabled for now, to check if problem is really fixed
    upstream.
* debian/control:
  - rename liblightdm-qt-2-0 to liblightdm-qt-3-0 to match updated soname.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/lightdm-gobject-1-Greeter-Interface.html
57
57
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
58
58
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-hint" title="lightdm_greeter_get_hint ()">lightdm_greeter_get_hint</a>            (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
59
59
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
 
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-lock-hint" title="lightdm_greeter_get_lock_hint ()">lightdm_greeter_get_lock_hint</a>       (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
60
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-has-guest-account-hint" title="lightdm_greeter_get_has_guest_account_hint ()">lightdm_greeter_get_has_guest_account_hint</a>
61
62
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
62
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-hide-users-hint" title="lightdm_greeter_get_hide_users_hint ()">lightdm_greeter_get_hide_users_hint</a> (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
 
64
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-show-manual-login-hint" title="lightdm_greeter_get_show_manual_login_hint ()">lightdm_greeter_get_show_manual_login_hint</a>
 
65
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
 
66
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-show-remote-login-hint" title="lightdm_greeter_get_show_remote_login_hint ()">lightdm_greeter_get_show_remote_login_hint</a>
 
67
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
63
68
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-select-user-hint" title="lightdm_greeter_get_select_user_hint ()">lightdm_greeter_get_select_user_hint</a>
64
69
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
65
70
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-select-guest-hint" title="lightdm_greeter_get_select_guest_hint ()">lightdm_greeter_get_select_guest_hint</a>
70
75
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
71
76
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-get-autologin-timeout-hint" title="lightdm_greeter_get_autologin_timeout_hint ()">lightdm_greeter_get_autologin_timeout_hint</a>
72
77
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
 
78
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-set-language" title="lightdm_greeter_set_language ()">lightdm_greeter_set_language</a>        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
 
79
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *language</code></em>);
73
80
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-cancel-autologin" title="lightdm_greeter_cancel_autologin ()">lightdm_greeter_cancel_autologin</a>    (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
74
81
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-authenticate" title="lightdm_greeter_authenticate ()">lightdm_greeter_authenticate</a>        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
75
82
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>);
76
83
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-authenticate-as-guest" title="lightdm_greeter_authenticate_as_guest ()">lightdm_greeter_authenticate_as_guest</a>
77
84
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
 
85
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-authenticate-autologin" title="lightdm_greeter_authenticate_autologin ()">lightdm_greeter_authenticate_autologin</a>
 
86
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);
 
87
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-authenticate-remote" title="lightdm_greeter_authenticate_remote ()">lightdm_greeter_authenticate_remote</a> (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
 
88
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *session</code></em>,
 
89
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>);
78
90
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-respond" title="lightdm_greeter_respond ()">lightdm_greeter_respond</a>             (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
79
91
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *response</code></em>);
80
92
<span class="returnvalue">void</span>                <a class="link" href="lightdm-gobject-1-Greeter-Interface.html#lightdm-greeter-cancel-authentication" title="lightdm_greeter_cancel_authentication ()">lightdm_greeter_cancel_authentication</a>
333
345
</div>
334
346
<hr>
335
347
<div class="refsect2">
 
348
<a name="lightdm-greeter-get-lock-hint"></a><h3>lightdm_greeter_get_lock_hint ()</h3>
 
349
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            lightdm_greeter_get_lock_hint       (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
 
350
<p>
 
351
Check if the greeter is acting as a lock screen.
 
352
</p>
 
353
<div class="variablelist"><table border="0" class="variablelist">
 
354
<colgroup>
 
355
<col align="left" valign="top">
 
356
<col>
 
357
</colgroup>
 
358
<tbody>
 
359
<tr>
 
360
<td><p><span class="term"><em class="parameter"><code>greeter</code></em> :</span></p></td>
 
361
<td>A <span class="type">LightDMGreeter</span>
 
362
</td>
 
363
</tr>
 
364
<tr>
 
365
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
366
<td>
 
367
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the greeter was triggered by locking the seat.</td>
 
368
</tr>
 
369
</tbody>
 
370
</table></div>
 
371
</div>
 
372
<hr>
 
373
<div class="refsect2">
336
374
<a name="lightdm-greeter-get-has-guest-account-hint"></a><h3>lightdm_greeter_get_has_guest_account_hint ()</h3>
337
375
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            lightdm_greeter_get_has_guest_account_hint
338
376
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
393
431
</div>
394
432
<hr>
395
433
<div class="refsect2">
 
434
<a name="lightdm-greeter-get-show-manual-login-hint"></a><h3>lightdm_greeter_get_show_manual_login_hint ()</h3>
 
435
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            lightdm_greeter_get_show_manual_login_hint
 
436
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
 
437
<p>
 
438
Check if a manual login option should be shown.  If set the GUI
 
439
should provide a way for a username to be entered manually.
 
440
Without this hint a greeter which is showing a user list can
 
441
limit logins to only those users.
 
442
</p>
 
443
<div class="variablelist"><table border="0" class="variablelist">
 
444
<colgroup>
 
445
<col align="left" valign="top">
 
446
<col>
 
447
</colgroup>
 
448
<tbody>
 
449
<tr>
 
450
<td><p><span class="term"><em class="parameter"><code>greeter</code></em> :</span></p></td>
 
451
<td>A <span class="type">LightDMGreeter</span>
 
452
</td>
 
453
</tr>
 
454
<tr>
 
455
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
456
<td>
 
457
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if a manual login option should be shown.</td>
 
458
</tr>
 
459
</tbody>
 
460
</table></div>
 
461
</div>
 
462
<hr>
 
463
<div class="refsect2">
 
464
<a name="lightdm-greeter-get-show-remote-login-hint"></a><h3>lightdm_greeter_get_show_remote_login_hint ()</h3>
 
465
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            lightdm_greeter_get_show_remote_login_hint
 
466
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
 
467
<p>
 
468
Check if a remote login option should be shown.  If set the GUI
 
469
should provide a way for a user to log into a remote desktop server.
 
470
</p>
 
471
<div class="variablelist"><table border="0" class="variablelist">
 
472
<colgroup>
 
473
<col align="left" valign="top">
 
474
<col>
 
475
</colgroup>
 
476
<tbody>
 
477
<tr>
 
478
<td><p><span class="term"><em class="parameter"><code>greeter</code></em> :</span></p></td>
 
479
<td>A <span class="type">LightDMGreeter</span>
 
480
</td>
 
481
</tr>
 
482
<tr>
 
483
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
484
<td>
 
485
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if a remote login option should be shown.</td>
 
486
</tr>
 
487
</tbody>
 
488
</table></div>
 
489
</div>
 
490
<hr>
 
491
<div class="refsect2">
396
492
<a name="lightdm-greeter-get-select-user-hint"></a><h3>lightdm_greeter_get_select_user_hint ()</h3>
397
493
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       lightdm_greeter_get_select_user_hint
398
494
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
525
621
</div>
526
622
<hr>
527
623
<div class="refsect2">
 
624
<a name="lightdm-greeter-set-language"></a><h3>lightdm_greeter_set_language ()</h3>
 
625
<pre class="programlisting"><span class="returnvalue">void</span>                lightdm_greeter_set_language        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
 
626
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *language</code></em>);</pre>
 
627
<p>
 
628
Set the language for the currently authenticated user.
 
629
</p>
 
630
<div class="variablelist"><table border="0" class="variablelist">
 
631
<colgroup>
 
632
<col align="left" valign="top">
 
633
<col>
 
634
</colgroup>
 
635
<tbody>
 
636
<tr>
 
637
<td><p><span class="term"><em class="parameter"><code>greeter</code></em> :</span></p></td>
 
638
<td>A <span class="type">LightDMGreeter</span>
 
639
</td>
 
640
</tr>
 
641
<tr>
 
642
<td><p><span class="term"><em class="parameter"><code>language</code></em> :</span></p></td>
 
643
<td>The language to use for this user in the form of a locale specification (e.g. "de_DE.UTF-8").</td>
 
644
</tr>
 
645
</tbody>
 
646
</table></div>
 
647
</div>
 
648
<hr>
 
649
<div class="refsect2">
528
650
<a name="lightdm-greeter-cancel-autologin"></a><h3>lightdm_greeter_cancel_autologin ()</h3>
529
651
<pre class="programlisting"><span class="returnvalue">void</span>                lightdm_greeter_cancel_autologin    (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
530
652
<p>
591
713
</div>
592
714
<hr>
593
715
<div class="refsect2">
 
716
<a name="lightdm-greeter-authenticate-autologin"></a><h3>lightdm_greeter_authenticate_autologin ()</h3>
 
717
<pre class="programlisting"><span class="returnvalue">void</span>                lightdm_greeter_authenticate_autologin
 
718
                                                        (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>);</pre>
 
719
<p>
 
720
Starts the authentication procedure for the automatic login user.
 
721
</p>
 
722
<div class="variablelist"><table border="0" class="variablelist">
 
723
<colgroup>
 
724
<col align="left" valign="top">
 
725
<col>
 
726
</colgroup>
 
727
<tbody><tr>
 
728
<td><p><span class="term"><em class="parameter"><code>greeter</code></em> :</span></p></td>
 
729
<td>A <span class="type">LightDMGreeter</span>
 
730
</td>
 
731
</tr></tbody>
 
732
</table></div>
 
733
</div>
 
734
<hr>
 
735
<div class="refsect2">
 
736
<a name="lightdm-greeter-authenticate-remote"></a><h3>lightdm_greeter_authenticate_remote ()</h3>
 
737
<pre class="programlisting"><span class="returnvalue">void</span>                lightdm_greeter_authenticate_remote (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
 
738
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *session</code></em>,
 
739
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>);</pre>
 
740
<p>
 
741
Start authentication for a remote session type.
 
742
</p>
 
743
<div class="variablelist"><table border="0" class="variablelist">
 
744
<colgroup>
 
745
<col align="left" valign="top">
 
746
<col>
 
747
</colgroup>
 
748
<tbody>
 
749
<tr>
 
750
<td><p><span class="term"><em class="parameter"><code>greeter</code></em> :</span></p></td>
 
751
<td>A <span class="type">LightDMGreeter</span>
 
752
</td>
 
753
</tr>
 
754
<tr>
 
755
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
 
756
<td>The name of a remote session</td>
 
757
</tr>
 
758
<tr>
 
759
<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
 
760
<td>A username of <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> to prompt for a username. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
761
</td>
 
762
</tr>
 
763
</tbody>
 
764
</table></div>
 
765
</div>
 
766
<hr>
 
767
<div class="refsect2">
594
768
<a name="lightdm-greeter-respond"></a><h3>lightdm_greeter_respond ()</h3>
595
769
<pre class="programlisting"><span class="returnvalue">void</span>                lightdm_greeter_respond             (<em class="parameter"><code><span class="type">LightDMGreeter</span> *greeter</code></em>,
596
770
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *response</code></em>);</pre>