LauncherFavorites

LauncherFavorites — Stores a users 'favorite' applications for easy access

Synopsis

                    LauncherFavorites;
enum                LauncherFavoritesListValue;
LauncherFavorites * launcher_favorites_get_default      (void);
GSList *            launcher_favorites_get_favorites    (LauncherFavorites *self);
void                launcher_favorites_set_favorites    (LauncherFavorites *self,
                                                         GSList *list);
gboolean            launcher_favorites_add_favorite     (LauncherFavorites *self,
                                                         const gchar *uid);
gboolean            launcher_favorites_remove_favorite  (LauncherFavorites *self,
                                                         const gchar *uid);
gchar *             launcher_favorites_get_string       (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);
void                launcher_favorites_set_string       (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         const gchar *value);
gint                launcher_favorites_get_int          (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);
void                launcher_favorites_set_int          (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         gint value);
gfloat              launcher_favorites_get_float        (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);
void                launcher_favorites_set_float        (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         gfloat value);
gboolean            launcher_favorites_get_bool         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);
void                launcher_favorites_set_bool         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         gboolean value);
GSList *            launcher_favorites_get_list         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         LauncherFavoritesListValue value_type);
void                launcher_favorites_set_list         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         LauncherFavoritesListValue value_type,
                                                         GSList *value);
gboolean            launcher_favorites_get_readonly     (LauncherFavorites *favorites,
                                                         const gchar *uid,
                                                         const gchar *key);

Description

LauncherFavorites will store favorite LauncherApplication applications for easy access

Details

LauncherFavorites

typedef struct {
  GObject         parent;
} LauncherFavorites;


enum LauncherFavoritesListValue

typedef enum
{
  LAUNCHER_FAVORITES_STRING,
  LAUNCHER_FAVORITES_INT,
  LAUNCHER_FAVORITES_FLOAT,
  LAUNCHER_FAVORITES_BOOL,
} LauncherFavoritesListValue;


launcher_favorites_get_default ()

LauncherFavorites * launcher_favorites_get_default      (void);

Returns :


launcher_favorites_get_favorites ()

GSList *            launcher_favorites_get_favorites    (LauncherFavorites *self);

Retrives a GCONF_VALUE_LIST of favorite applications

self :

Returns :

An unowned GSList

launcher_favorites_set_favorites ()

void                launcher_favorites_set_favorites    (LauncherFavorites *self,
                                                         GSList *list);

Allows you to set all the favorite applications at once using one gslist, see gconf_client_set_list() for list stucture

self :

a LauncherFavorites object

list :

A GSList object

launcher_favorites_add_favorite ()

gboolean            launcher_favorites_add_favorite     (LauncherFavorites *self,
                                                         const gchar *uid);

Allows you to add a new favorite to the list of favorites, you need to supply a unique id

self :

uid :

a unique string

Returns :

A boolean indicating wheather the function completed succesfully or not

launcher_favorites_remove_favorite ()

gboolean            launcher_favorites_remove_favorite  (LauncherFavorites *self,
                                                         const gchar *uid);

Allows you to remove a favorite to the list of favorites, you need to supply a unique id

self :

uid :

a unique string

Returns :

A boolean indicating wheather the function completed succesfully or not

launcher_favorites_get_string ()

gchar *             launcher_favorites_get_string       (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);

self :

uid :

key :

Returns :


launcher_favorites_set_string ()

void                launcher_favorites_set_string       (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         const gchar *value);

self :

uid :

key :

value :


launcher_favorites_get_int ()

gint                launcher_favorites_get_int          (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);

self :

uid :

key :

Returns :


launcher_favorites_set_int ()

void                launcher_favorites_set_int          (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         gint value);

self :

uid :

key :

value :


launcher_favorites_get_float ()

gfloat              launcher_favorites_get_float        (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);

self :

uid :

key :

Returns :


launcher_favorites_set_float ()

void                launcher_favorites_set_float        (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         gfloat value);

self :

uid :

key :

value :


launcher_favorites_get_bool ()

gboolean            launcher_favorites_get_bool         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key);

self :

uid :

key :

Returns :


launcher_favorites_set_bool ()

void                launcher_favorites_set_bool         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         gboolean value);

self :

uid :

key :

value :


launcher_favorites_get_list ()

GSList *            launcher_favorites_get_list         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         LauncherFavoritesListValue value_type);

self :

uid :

key :

value_type :

Returns :


launcher_favorites_set_list ()

void                launcher_favorites_set_list         (LauncherFavorites *self,
                                                         const gchar *uid,
                                                         const gchar *key,
                                                         LauncherFavoritesListValue value_type,
                                                         GSList *value);

self :

uid :

key :

value_type :

value :


launcher_favorites_get_readonly ()

gboolean            launcher_favorites_get_readonly     (LauncherFavorites *favorites,
                                                         const gchar *uid,
                                                         const gchar *key);

favorites :

uid :

key :

Returns :