doc/tmpl/greeter.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 LdmGreeter
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 LightDM greeter object
   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_provide_secret (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);
  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::quit ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @ldmgreeter: the object which received the signal.
  96
  97 <!-- ##### SIGNAL LdmGreeter::show-error ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @ldmgreeter: the object which received the signal.
 103 @arg1:
 104
 105 <!-- ##### SIGNAL LdmGreeter::show-message ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @ldmgreeter: the object which received the signal.
 111 @arg1:
 112
 113 <!-- ##### SIGNAL LdmGreeter::show-prompt ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @ldmgreeter: the object which received the signal.
 119 @arg1:
 120
 121 <!-- ##### SIGNAL LdmGreeter::timed-login ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @ldmgreeter: the object which received the signal.
 127 @arg1:
 128
 129 <!-- ##### ARG LdmGreeter:can-hibernate ##### -->
 130 <para>
 131
 132 </para>
 133
 134 <!-- ##### ARG LdmGreeter:can-restart ##### -->
 135 <para>
 136
 137 </para>
 138
 139 <!-- ##### ARG LdmGreeter:can-shutdown ##### -->
 140 <para>
 141
 142 </para>
 143
 144 <!-- ##### ARG LdmGreeter:can-suspend ##### -->
 145 <para>
 146
 147 </para>
 148
 149 <!-- ##### ARG LdmGreeter:is-authenticated ##### -->
 150 <para>
 151
 152 </para>
 153
 154 <!-- ##### ARG LdmGreeter:layout ##### -->
 155 <para>
 156
 157 </para>
 158
 159 <!-- ##### ARG LdmGreeter:login-delay ##### -->
 160 <para>
 161
 162 </para>
 163
 164 <!-- ##### ARG LdmGreeter:num-users ##### -->
 165 <para>
 166
 167 </para>
 168
 169 <!-- ##### ARG LdmGreeter:session ##### -->
 170 <para>
 171
 172 </para>
 173
 174 <!-- ##### ARG LdmGreeter:timed-login-user ##### -->
 175 <para>
 176
 177 </para>
 178
 179 <!-- ##### FUNCTION ldm_greeter_new ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @void:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION ldm_greeter_connect ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @greeter:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION ldm_greeter_get_num_users ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @greeter:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION ldm_greeter_get_users ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @greeter:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION ldm_greeter_get_sessions ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @greeter:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION ldm_greeter_get_session ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @greeter:
 230 @Returns:
 231
 232
 233 <!-- ##### FUNCTION ldm_greeter_set_session ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @greeter:
 239 @session:
 240
 241
 242 <!-- ##### FUNCTION ldm_greeter_get_timed_login_user ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @greeter:
 248 @Returns:
 249
 250
 251 <!-- ##### FUNCTION ldm_greeter_get_timed_login_delay ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @greeter:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION ldm_greeter_cancel_timed_login ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @greeter:
 266
 267
 268 <!-- ##### FUNCTION ldm_greeter_start_authentication ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @greeter:
 274 @username:
 275
 276
 277 <!-- ##### FUNCTION ldm_greeter_provide_secret ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @greeter:
 283 @secret:
 284
 285
 286 <!-- ##### FUNCTION ldm_greeter_cancel_authentication ##### -->
 287 <para>
 288
 289 </para>
 290
 291 @greeter:
 292
 293
 294 <!-- ##### FUNCTION ldm_greeter_get_is_authenticated ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @greeter:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION ldm_greeter_login ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @greeter:
 309
 310
 311 <!-- ##### FUNCTION ldm_greeter_get_can_suspend ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @greeter:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION ldm_greeter_suspend ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @greeter:
 326
 327
 328 <!-- ##### FUNCTION ldm_greeter_get_can_hibernate ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @greeter:
 334 @Returns:
 335
 336
 337 <!-- ##### FUNCTION ldm_greeter_hibernate ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @greeter:
 343
 344
 345 <!-- ##### FUNCTION ldm_greeter_get_can_restart ##### -->
 346 <para>
 347
 348 </para>
 349
 350 @greeter:
 351 @Returns:
 352
 353
 354 <!-- ##### FUNCTION ldm_greeter_restart ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @greeter:
 360
 361
 362 <!-- ##### FUNCTION ldm_greeter_get_can_shutdown ##### -->
 363 <para>
 364
 365 </para>
 366
 367 @greeter:
 368 @Returns:
 369
 370
 371 <!-- ##### FUNCTION ldm_greeter_shutdown ##### -->
 372 <para>
 373
 374 </para>
 375
 376 @greeter:
 377
 378