LdmUser

LdmUser — Information about a user

Synopsis

#include <lightdm/greeter.h>

                    LdmUser;
const gchar *       ldm_user_get_name                   (LdmUser *user);
const gchar *       ldm_user_get_real_name              (LdmUser *user);
const gchar *       ldm_user_get_display_name           (LdmUser *user);
const gchar *       ldm_user_get_image                  (LdmUser *user);
const gchar *       ldm_user_get_language               (LdmUser *user);
const gchar *       ldm_user_get_layout                 (LdmUser *user);
const gchar *       ldm_user_get_session                (LdmUser *user);
gboolean            ldm_user_get_logged_in              (LdmUser *user);

Object Hierarchy

  GObject
   +----LdmUser

Properties

  "display-name"             gchar*                : Read
  "greeter"                  LdmGreeter*           : Write / Construct Only
  "image"                    gchar*                : Read / Write / Construct Only
  "language"                 gchar*                : Read
  "layout"                   gchar*                : Read
  "logged-in"                gboolean              : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only
  "real-name"                gchar*                : Read / Write / Construct Only
  "session"                  gchar*                : Read

Description

Object containing information about a user present on this system. LdmUser objects are not created by the user, but provided by the LdmGreeter object.

A user has the following properties:

  • The user name is used to refer to this user.

  • The real name is the name of the person that owns this user account.

  • The display name provides text to use for the user label.

  • The image URI provides an image to use for the user.

Details

LdmUser

typedef struct _LdmUser LdmUser;


ldm_user_get_name ()

const gchar *       ldm_user_get_name                   (LdmUser *user);

Get the name of a user.

user :

A LdmUser

Returns :

The name of the given user

ldm_user_get_real_name ()

const gchar *       ldm_user_get_real_name              (LdmUser *user);

Get the real name of a user.

user :

A LdmUser

Returns :

The real name of the given user (may be blank)

ldm_user_get_display_name ()

const gchar *       ldm_user_get_display_name           (LdmUser *user);

Get the display name of a user.

user :

A LdmUser

Returns :

The display name of the given user

ldm_user_get_image ()

const gchar *       ldm_user_get_image                  (LdmUser *user);

Get the image URI for a user.

user :

A LdmUser

Returns :

The image URI for the given user or NULL if no URI

ldm_user_get_language ()

const gchar *       ldm_user_get_language               (LdmUser *user);

Get the language for a user.

user :

A LdmUser

Returns :

The language for the given user or NULL if using system defaults.

ldm_user_get_layout ()

const gchar *       ldm_user_get_layout                 (LdmUser *user);

Get the keyboard layout for a user.

user :

A LdmUser

Returns :

The keyboard layoyt for the given user or NULL if using system defaults.

ldm_user_get_session ()

const gchar *       ldm_user_get_session                (LdmUser *user);

Get the session for a user.

user :

A LdmUser

Returns :

The session for the given user or NULL if using system defaults.

ldm_user_get_logged_in ()

gboolean            ldm_user_get_logged_in              (LdmUser *user);

Check if a user is logged in.

user :

A LdmUser

Returns :

TRUE if the user is currently logged in.

Property Details

The "display-name" property

  "display-name"             gchar*                : Read

Users display name.

Default value: NULL


The "greeter" property

  "greeter"                  LdmGreeter*           : Write / Construct Only

Greeter.


The "image" property

  "image"                    gchar*                : Read / Write / Construct Only

Avatar image.

Default value: NULL


The "language" property

  "language"                 gchar*                : Read

Language used by this user.

Default value: NULL


The "layout" property

  "layout"                   gchar*                : Read

Keyboard layout used by this user.

Default value: NULL


The "logged-in" property

  "logged-in"                gboolean              : Read / Write / Construct Only

TRUE if the user is currently in a session.

Default value: FALSE


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Username.

Default value: NULL


The "real-name" property

  "real-name"                gchar*                : Read / Write / Construct Only

Users real name.

Default value: NULL


The "session" property

  "session"                  gchar*                : Read

Session used by this user.

Default value: NULL