GfTheme

GfTheme — GfTheme Object API

Synopsis




            GfTheme;
void        (*GfThemeEnumNotificationsCB)   (GfTheme *theme,
                                             GfNotification *notification);
GfTheme*    gf_theme_new                    ();
void        gf_theme_set_filename           (GfTheme *theme,
                                             const gchar *filename);
const gchar* gf_theme_get_filename          (const GfTheme *theme);
void        gf_theme_set_path               (GfTheme *theme,
                                             const gchar *path);
const gchar* gf_theme_get_path              (const GfTheme *theme);
void        gf_theme_set_theme_info         (GfTheme *theme,
                                             GfThemeInfo *theme_info);
GfThemeInfo* gf_theme_get_theme_info        (const GfTheme *theme);
void        gf_theme_set_theme_options      (GfTheme *theme,
                                             GfThemeOptions *theme_options);
GfThemeOptions* gf_theme_get_theme_options  (const GfTheme *theme);
void        gf_theme_add_notification       (GfTheme *theme,
                                             GfNotification *notification);
void        gf_theme_remove_notification    (GfTheme *theme,
                                             GfNotification *notification);
void        gf_theme_enum_notifications     (GfTheme *theme,
                                             GfThemeEnumNotificationsCB callback);

Object Hierarchy


  GObject
   +----GfObject
         +----GfTheme

Properties


  "filename"             gchararray            : Read / Write
  "info"                 GfThemeInfo           : Read / Write
  "options"              GfThemeOptions        : Read / Write
  "path"                 gchararray            : Read / Write

Description

GfTheme is the containing object for an entire theme. It includes a GfThemeInfo, a GfThemeOptions, as well as multiple GfNotification's.

Details

GfTheme

typedef struct _GfTheme GfTheme;

GfTheme is an opaque structure that should not be used directly.


GfThemeEnumNotificationsCB ()

void        (*GfThemeEnumNotificationsCB)   (GfTheme *theme,
                                             GfNotification *notification);

theme :
notification :

gf_theme_new ()

GfTheme*    gf_theme_new                    ();

Creates a new GfTheme instance.

Returns : The new GfTheme instance.

gf_theme_set_filename ()

void        gf_theme_set_filename           (GfTheme *theme,
                                             const gchar *filename);

Sets the filename for theme.

theme : The GfTheme instance.
filename : The new filename.

gf_theme_get_filename ()

const gchar* gf_theme_get_filename          (const GfTheme *theme);

Gets the filename for theme.

theme : The GfTheme instance.
Returns : The filename for theme.

gf_theme_set_path ()

void        gf_theme_set_path               (GfTheme *theme,
                                             const gchar *path);

Sets the path for theme.

theme : The GfTheme instance.
path : The new path.

gf_theme_get_path ()

const gchar* gf_theme_get_path              (const GfTheme *theme);

Gets the path for theme.

theme : The GfTheme instance.
Returns : The path for theme.

gf_theme_set_theme_info ()

void        gf_theme_set_theme_info         (GfTheme *theme,
                                             GfThemeInfo *theme_info);

Sets the GfThemeInfo for theme.

theme : The GfTheme instance.
theme_info : The GfThemeInfo instance.

gf_theme_get_theme_info ()

GfThemeInfo* gf_theme_get_theme_info        (const GfTheme *theme);

Gets the GfThemeInfo for theme.

theme : The GfTheme instance.
Returns : The GfThemeInfo for theme.

gf_theme_set_theme_options ()

void        gf_theme_set_theme_options      (GfTheme *theme,
                                             GfThemeOptions *theme_options);

Sets the GfThemeOptions for theme.

theme : The GfTheme instance.
theme_options : The GfThemeOptions instance.

gf_theme_get_theme_options ()

GfThemeOptions* gf_theme_get_theme_options  (const GfTheme *theme);

Gets the GfThemeOptions for theme.

theme : The GfTheme instance.
Returns : The GfThemeOptions for theme.

gf_theme_add_notification ()

void        gf_theme_add_notification       (GfTheme *theme,
                                             GfNotification *notification);

Adds a GfNotification to theme.

Note: theme will add a reference to notification, it will not inherit your reference!

theme : The GfTheme instance.
notification : The GfNotification instance.

gf_theme_remove_notification ()

void        gf_theme_remove_notification    (GfTheme *theme,
                                             GfNotification *notification);

Removes a GfNotification from theme.

Note: theme will remove it's reference to notification, which could cause notification to be destoryed. If you want to keep notification around longer, you will need to reference it.

theme : The GfTheme instance.
notification : The GfNotification instance.

gf_theme_enum_notifications ()

void        gf_theme_enum_notifications     (GfTheme *theme,
                                             GfThemeEnumNotificationsCB callback);

theme :
callback :

Properties

The "filename" property

  "filename"             gchararray            : Read / Write

The filename for the theme.

Default value: NULL


The "info" property

  "info"                 GfThemeInfo           : Read / Write

The theme info.


The "options" property

  "options"              GfThemeOptions        : Read / Write

The theme options.


The "path" property

  "path"                 gchararray            : Read / Write

The path for the theme.

Default value: NULL