GnomePropertyBox

Name

GnomePropertyBox -- 

Synopsis



#define     GNOME_PROPERTY_BOX_DIRTY
GtkWidget*  gnome_property_box_new          (void);
void        gnome_property_box_changed      (GnomePropertyBox *property_box);
void        gnome_property_box_set_modified (GnomePropertyBox *property_box,
                                             gboolean state);
gint        gnome_property_box_append_page  (GnomePropertyBox *property_box,
                                             GtkWidget *child,
                                             GtkWidget *tab_label);
void        gnome_property_box_set_state    (GnomePropertyBox *property_box,
                                             gboolean state);

Description

Details

GNOME_PROPERTY_BOX_DIRTY

#define GNOME_PROPERTY_BOX_DIRTY	"gnome_property_box_dirty"


gnome_property_box_new ()

GtkWidget*  gnome_property_box_new          (void);

Creates a new GnomePropertyBox widget. The PropertyBox widget is useful for making consistent configuration dialog boxes.

When a setting has been made to a property in the PropertyBox your program needs to invoke the gnome_property_box_changed to signal a change (this will enable the Ok/Apply buttons).

Returns :a newly created GnomePropertyBox widget.


gnome_property_box_changed ()

void        gnome_property_box_changed      (GnomePropertyBox *property_box);

When a setting has changed, the code needs to invoke this routine to make the Ok/Apply buttons sensitive.

property_box : The GnomePropertyBox that contains the changed data


gnome_property_box_set_modified ()

void        gnome_property_box_set_modified (GnomePropertyBox *property_box,
                                             gboolean state);

This sets the modified flag of the GnomePropertyBox to the value in state. Affects whether the OK/Apply buttons are sensitive.

property_box : The GnomePropertyBox that contains the changed data
state : The state. TRUE means modified, FALSE means unmodified.


gnome_property_box_append_page ()

gint        gnome_property_box_append_page  (GnomePropertyBox *property_box,
                                             GtkWidget *child,
                                             GtkWidget *tab_label);

Appends a new page to the GnomePropertyBox.

property_box : The property box where we are inserting a new page
child : The widget that is being inserted
tab_label : The widget used as the label for this confiugration page
Returns :the assigned index of the page inside the GnomePropertyBox or -1 if one of the arguments is invalid.


gnome_property_box_set_state ()

void        gnome_property_box_set_state    (GnomePropertyBox *property_box,
                                             gboolean state);

property_box : 
state :