doc/tmpl/greeter.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 LdmGreeter
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Manages connection to LightDM server and provides greeter functionality
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #LdmGreeter is an object that manages the connection to the LightDM server and provides common greeter functionality.
  10 </para>
  11 <para>
  12 To connect to the display manager instanciate a #LdmGreeter object from inside the greeter process:
  13 <example>
  14 <title>Connecting to the display manager</title>
  15 <programlisting><![CDATA[
  16 LdmGreeter *greeter = ldm_greeter_new ();
  17 if (!ldm_greeter_connect (LDM_GREETER (greeter))) {
  18     // Log an error
  19     exit (0);
  20 }
  21 ]]></programlisting>
  22 </example>
  23 Information on how to connect to the display manager is passed using environment variables.
  24 </para>
  25 <para>
  26 Once connected, start an authentication conversation like this:
  27 <example>
  28 <title>Example Authorization Conversation</title>
  29 <programlisting><![CDATA[
  30 static void show_prompt_cb (LdmGreeter *greeter, const char *text)
  31 {
  32     // Show the user the message and prompt for some response
  33     gchar *secret = prompt_user (text);
  34
  35     // Give the result to the user
  36     ldm_greeter_respond (greeter, secret);
  37 }
  38
  39 static void authentication_complete_cb (LdmGreeter *greeter)
  40 {
  41     if (ldm_greeter_get_is_authenticated (greeter)) {
  42         // Log in to this session.
  43         ldm_greeter_login (greeter, ldm_greeter_get_authentication_user (greeter), ldm_greeter_get_default_session (greeter));
  44     }
  45     else {
  46         // Display a warning and reset the greeter
  47         reset_login_screen ();
  48     }
  49 }
  50
  51 static void quit_cb (LdmGreeter *greeter)
  52 {
  53     // Clean up
  54     // ...
  55
  56     exit (0);
  57 }
  58
  59 g_object_connect (G_OBJECT (greeter), "show-prompt", G_CALLBACK (show_prompt_cb), NULL);
  60 g_object_connect (G_OBJECT (greeter), "authentication-complete", G_CALLBACK (authentication_complete_cb), NULL);
  61 g_object_connect (G_OBJECT (greeter), "quit", G_CALLBACK (quit_cb), NULL);
  62 ]]></programlisting>
  63 </example>
  64 </para>
  65
  66 <!-- ##### SECTION See_Also ##### -->
  67 <para>
  68
  69 </para>
  70
  71 <!-- ##### SECTION Stability_Level ##### -->
  72
  73
  74 <!-- ##### SECTION Image ##### -->
  75
  76
  77 <!-- ##### STRUCT LdmGreeter ##### -->
  78 <para>
  79
  80 </para>
  81
  82
  83 <!-- ##### SIGNAL LdmGreeter::authentication-complete ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @ldmgreeter: the object which received the signal.
  89
  90 <!-- ##### SIGNAL LdmGreeter::autologin-timer-expired ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @ldmgreeter: the object which received the signal.
  96
  97 <!-- ##### SIGNAL LdmGreeter::connected ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @ldmgreeter: the object which received the signal.
 103
 104 <!-- ##### SIGNAL LdmGreeter::quit ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @ldmgreeter: the object which received the signal.
 110
 111 <!-- ##### SIGNAL LdmGreeter::session-failed ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @ldmgreeter: the object which received the signal.
 117
 118 <!-- ##### SIGNAL LdmGreeter::show-message ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @ldmgreeter: the object which received the signal.
 124 @arg1:
 125 @Param3:
 126
 127 <!-- ##### SIGNAL LdmGreeter::show-prompt ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @ldmgreeter: the object which received the signal.
 133 @arg1:
 134 @Param3:
 135
 136 <!-- ##### SIGNAL LdmGreeter::user-added ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @ldmgreeter: the object which received the signal.
 142 @Param2:
 143
 144 <!-- ##### SIGNAL LdmGreeter::user-changed ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @ldmgreeter: the object which received the signal.
 150 @Param2:
 151
 152 <!-- ##### SIGNAL LdmGreeter::user-removed ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @ldmgreeter: the object which received the signal.
 158 @arg1:
 159
 160 <!-- ##### ARG LdmGreeter:authentication-user ##### -->
 161 <para>
 162
 163 </para>
 164
 165 <!-- ##### ARG LdmGreeter:autologin-guest-hint ##### -->
 166 <para>
 167
 168 </para>
 169
 170 <!-- ##### ARG LdmGreeter:autologin-timeout-hint ##### -->
 171 <para>
 172
 173 </para>
 174
 175 <!-- ##### ARG LdmGreeter:autologin-user-hint ##### -->
 176 <para>
 177
 178 </para>
 179
 180 <!-- ##### ARG LdmGreeter:can-hibernate ##### -->
 181 <para>
 182
 183 </para>
 184
 185 <!-- ##### ARG LdmGreeter:can-restart ##### -->
 186 <para>
 187
 188 </para>
 189
 190 <!-- ##### ARG LdmGreeter:can-shutdown ##### -->
 191 <para>
 192
 193 </para>
 194
 195 <!-- ##### ARG LdmGreeter:can-suspend ##### -->
 196 <para>
 197
 198 </para>
 199
 200 <!-- ##### ARG LdmGreeter:default-session-hint ##### -->
 201 <para>
 202
 203 </para>
 204
 205 <!-- ##### ARG LdmGreeter:has-guest-account-hint ##### -->
 206 <para>
 207
 208 </para>
 209
 210 <!-- ##### ARG LdmGreeter:hide-users-hint ##### -->
 211 <para>
 212
 213 </para>
 214
 215 <!-- ##### ARG LdmGreeter:hostname ##### -->
 216 <para>
 217
 218 </para>
 219
 220 <!-- ##### ARG LdmGreeter:in-authentication ##### -->
 221 <para>
 222
 223 </para>
 224
 225 <!-- ##### ARG LdmGreeter:is-authenticated ##### -->
 226 <para>
 227
 228 </para>
 229
 230 <!-- ##### ARG LdmGreeter:layout ##### -->
 231 <para>
 232
 233 </para>
 234
 235 <!-- ##### ARG LdmGreeter:num-users ##### -->
 236 <para>
 237
 238 </para>
 239
 240 <!-- ##### ARG LdmGreeter:select-guest-hint ##### -->
 241 <para>
 242
 243 </para>
 244
 245 <!-- ##### ARG LdmGreeter:select-user-hint ##### -->
 246 <para>
 247
 248 </para>
 249
 250 <!-- ##### FUNCTION ldm_greeter_new ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @void:
 256 @Returns:
 257
 258
 259 <!-- ##### FUNCTION ldm_greeter_connect_to_server ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @greeter:
 265 @Returns:
 266
 267
 268 <!-- ##### FUNCTION ldm_greeter_get_hostname ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @greeter:
 274 @Returns:
 275
 276
 277 <!-- ##### FUNCTION ldm_greeter_get_num_users ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @greeter:
 283 @Returns:
 284
 285
 286 <!-- ##### FUNCTION ldm_greeter_get_users ##### -->
 287 <para>
 288
 289 </para>
 290
 291 @greeter:
 292 @Returns:
 293
 294
 295 <!-- ##### FUNCTION ldm_greeter_get_user_by_name ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @greeter:
 301 @username:
 302 @Returns:
 303
 304
 305 <!-- ##### FUNCTION ldm_greeter_get_default_language ##### -->
 306 <para>
 307
 308 </para>
 309
 310 @greeter:
 311 @Returns:
 312
 313
 314 <!-- ##### FUNCTION ldm_greeter_get_languages ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @greeter:
 320 @Returns:
 321
 322
 323 <!-- ##### FUNCTION ldm_greeter_get_layouts ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @greeter:
 329 @Returns:
 330
 331
 332 <!-- ##### FUNCTION ldm_greeter_get_layout ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @greeter:
 338 @Returns:
 339
 340
 341 <!-- ##### FUNCTION ldm_greeter_set_layout ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @greeter:
 347 @layout:
 348
 349
 350 <!-- ##### FUNCTION ldm_greeter_get_sessions ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @greeter:
 356 @Returns:
 357
 358
 359 <!-- ##### FUNCTION ldm_greeter_get_default_session_hint ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @greeter:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION ldm_greeter_get_hint ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @greeter:
 374 @name:
 375 @Returns:
 376
 377
 378 <!-- ##### FUNCTION ldm_greeter_get_has_guest_account_hint ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @greeter:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION ldm_greeter_get_hide_users_hint ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @greeter:
 393 @Returns:
 394
 395
 396 <!-- ##### FUNCTION ldm_greeter_get_select_user_hint ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @greeter:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION ldm_greeter_get_select_guest_hint ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @greeter:
 411 @Returns:
 412
 413
 414 <!-- ##### FUNCTION ldm_greeter_get_autologin_user_hint ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @greeter:
 420 @Returns:
 421
 422
 423 <!-- ##### FUNCTION ldm_greeter_get_autologin_guest_hint ##### -->
 424 <para>
 425
 426 </para>
 427
 428 @greeter:
 429 @Returns:
 430
 431
 432 <!-- ##### FUNCTION ldm_greeter_get_autologin_timeout_hint ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @greeter:
 438 @Returns:
 439
 440
 441 <!-- ##### FUNCTION ldm_greeter_cancel_timed_login ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @greeter:
 447
 448
 449 <!-- ##### FUNCTION ldm_greeter_login ##### -->
 450 <para>
 451
 452 </para>
 453
 454 @greeter:
 455 @username:
 456
 457
 458 <!-- ##### FUNCTION ldm_greeter_login_with_user_prompt ##### -->
 459 <para>
 460
 461 </para>
 462
 463 @greeter:
 464
 465
 466 <!-- ##### FUNCTION ldm_greeter_login_as_guest ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @greeter:
 472
 473
 474 <!-- ##### FUNCTION ldm_greeter_respond ##### -->
 475 <para>
 476
 477 </para>
 478
 479 @greeter:
 480 @response:
 481
 482
 483 <!-- ##### FUNCTION ldm_greeter_cancel_authentication ##### -->
 484 <para>
 485
 486 </para>
 487
 488 @greeter:
 489
 490
 491 <!-- ##### FUNCTION ldm_greeter_get_in_authentication ##### -->
 492 <para>
 493
 494 </para>
 495
 496 @greeter:
 497 @Returns:
 498
 499
 500 <!-- ##### FUNCTION ldm_greeter_get_is_authenticated ##### -->
 501 <para>
 502
 503 </para>
 504
 505 @greeter:
 506 @Returns:
 507
 508
 509 <!-- ##### FUNCTION ldm_greeter_get_authentication_user ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @greeter:
 515 @Returns:
 516
 517
 518 <!-- ##### FUNCTION ldm_greeter_start_session ##### -->
 519 <para>
 520
 521 </para>
 522
 523 @greeter:
 524 @session:
 525
 526
 527 <!-- ##### FUNCTION ldm_greeter_start_default_session ##### -->
 528 <para>
 529
 530 </para>
 531
 532 @greeter:
 533
 534
 535 <!-- ##### FUNCTION ldm_greeter_get_can_suspend ##### -->
 536 <para>
 537
 538 </para>
 539
 540 @greeter:
 541 @Returns:
 542
 543
 544 <!-- ##### FUNCTION ldm_greeter_suspend ##### -->
 545 <para>
 546
 547 </para>
 548
 549 @greeter:
 550
 551
 552 <!-- ##### FUNCTION ldm_greeter_get_can_hibernate ##### -->
 553 <para>
 554
 555 </para>
 556
 557 @greeter:
 558 @Returns:
 559
 560
 561 <!-- ##### FUNCTION ldm_greeter_hibernate ##### -->
 562 <para>
 563
 564 </para>
 565
 566 @greeter:
 567
 568
 569 <!-- ##### FUNCTION ldm_greeter_get_can_restart ##### -->
 570 <para>
 571
 572 </para>
 573
 574 @greeter:
 575 @Returns:
 576
 577
 578 <!-- ##### FUNCTION ldm_greeter_restart ##### -->
 579 <para>
 580
 581 </para>
 582
 583 @greeter:
 584
 585
 586 <!-- ##### FUNCTION ldm_greeter_get_can_shutdown ##### -->
 587 <para>
 588
 589 </para>
 590
 591 @greeter:
 592 @Returns:
 593
 594
 595 <!-- ##### FUNCTION ldm_greeter_shutdown ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @greeter:
 601
 602