NbtkStyle

NbtkStyle — a data store for style properties

Synopsis

enum                NbtkStyleError;
                    NbtkStyle;
NbtkStyle *         nbtk_style_get_default              (void);
NbtkStyle *         nbtk_style_new                      (void);
gboolean            nbtk_style_load_from_file           (NbtkStyle *style,
                                                         const gchar *filename,
                                                         GError **error);
void                nbtk_style_get_property             (NbtkStyle *style,
                                                         NbtkStylable *stylable,
                                                         GParamSpec *pspec,
                                                         GValue *value);
void                nbtk_style_get                      (NbtkStyle *style,
                                                         NbtkStylable *stylable,
                                                         const gchar *first_property_name,
                                                         ...);
void                nbtk_style_get_valist               (NbtkStyle *style,
                                                         NbtkStylable *stylable,
                                                         const gchar *first_property_name,
                                                         va_list va_args);

Object Hierarchy

  GObject
   +----NbtkStyle

Signals

  "changed"                                        : Run Last

Description

NbtkStyle is a property data store that can read properties from a style sheet. It is queried with objects that implement the NbtkStylable interface.

Details

enum NbtkStyleError

typedef enum { /*< prefix=NBTK_STYLE_ERROR >*/
  NBTK_STYLE_ERROR_INVALID_FILE
} NbtkStyleError;

NbtkStyle

typedef struct _NbtkStyle NbtkStyle;

The contents of this structure is private and should only be accessed using the provided API.

nbtk_style_get_default ()

NbtkStyle *         nbtk_style_get_default              (void);

Return the default NbtkStyle object. This includes the current theme (if any).

Returns :

 a NbtkStyle object. This must not be freed or unref'd by applications

nbtk_style_new ()

NbtkStyle *         nbtk_style_new                      (void);

Creates a new NbtkStyle object. This must be freed using g_object_unref when no longer required.

Returns :

 a newly allocated NbtkStyle

nbtk_style_load_from_file ()

gboolean            nbtk_style_load_from_file           (NbtkStyle *style,
                                                         const gchar *filename,
                                                         GError **error);

Load style information from the specified file.

style :

 a NbtkStyle

filename :

 filename of the style sheet to load

error :

 a GError or NULL

Returns :

 TRUE if the style information was loaded successfully. Returns FALSE on error.

nbtk_style_get_property ()

void                nbtk_style_get_property             (NbtkStyle *style,
                                                         NbtkStylable *stylable,
                                                         GParamSpec *pspec,
                                                         GValue *value);

Requests the property described in pspec for the specified stylable

style :

 the style data store object

stylable :

 a stylable to retreive the data for

pspec :

 a GParamSpec describing the property required

value :

 a GValue to place the return value in

nbtk_style_get ()

void                nbtk_style_get                      (NbtkStyle *style,
                                                         NbtkStylable *stylable,
                                                         const gchar *first_property_name,
                                                         ...);

Gets the style properties for stylable from style.

In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the property type.

style :

 a NbtkStyle

stylable :

 a NbtkStylable

first_property_name :

 name of the first property to get

... :

 return location for the first property, followed optionally by more name/return location pairs, followed by NULL

nbtk_style_get_valist ()

void                nbtk_style_get_valist               (NbtkStyle *style,
                                                         NbtkStylable *stylable,
                                                         const gchar *first_property_name,
                                                         va_list va_args);

Gets the style properties for stylable from style.

Please refer to nbtk_style_get() for further information.

style :

 a NbtkStyle

stylable :

 a NbtkStylable

first_property_name :

 name of the first property to get

va_args :

 return location for the first property, followed optionally by more name/return location pairs, followed by NULL

Signal Details

The "changed" signal

void                user_function                      (NbtkStyle *arg0,
                                                        gpointer   user_data)      : Run Last

Indicates that the style data has changed in some way. For example, a new stylesheet may have been loaded.

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.14