GNOME UI Library Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
Synopsis
#include <libgnomeui/libgnomeui.h> struct GnomeDruid; GtkWidget * gnome_druid_new (void
); void gnome_druid_set_buttons_sensitive (GnomeDruid *druid
,gboolean back_sensitive
,gboolean next_sensitive
,gboolean cancel_sensitive
,gboolean help_sensitive
); void gnome_druid_set_show_finish (GnomeDruid *druid
,gboolean show_finish
); void gnome_druid_set_show_help (GnomeDruid *druid
,gboolean show_help
); void gnome_druid_prepend_page (GnomeDruid *druid
,GnomeDruidPage *page
); void gnome_druid_insert_page (GnomeDruid *druid
,GnomeDruidPage *back_page
,GnomeDruidPage *page
); void gnome_druid_append_page (GnomeDruid *druid
,GnomeDruidPage *page
); void gnome_druid_set_page (GnomeDruid *druid
,GnomeDruidPage *page
); GtkWidget * gnome_druid_new_with_window (const char *title
,GtkWindow *parent
,gboolean close_on_cancel
,GtkWidget **window
); void gnome_druid_construct_with_window (GnomeDruid *druid
,const char *title
,GtkWindow *parent
,gboolean close_on_cancel
,GtkWidget **window
);
Object Hierarchy
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GnomeDruid
Details
struct GnomeDruid
struct GnomeDruid;
Warning
GnomeDruid
is deprecated and should not be used in newly-written code.
The widget which ultimately holds all of the druid's pages and information. This is the widget which the application developer then places inside an outer widget, such as a dialog box for ultimate display.
gnome_druid_new ()
GtkWidget * gnome_druid_new (void
);
Warning
gnome_druid_new
is deprecated and should not be used in newly-written code.
Creates a new GnomeDruid widget. You need to add this to a dialog yourself, it is not a dialog.
Returns : |
A new GnomeDruid widget |
gnome_druid_set_buttons_sensitive ()
void gnome_druid_set_buttons_sensitive (GnomeDruid *druid
,gboolean back_sensitive
,gboolean next_sensitive
,gboolean cancel_sensitive
,gboolean help_sensitive
);
Warning
gnome_druid_set_buttons_sensitive
is deprecated and should not be used in newly-written code.
Sets the sensitivity of druid
's control-buttons. If the
variables are TRUE
, then they will be clickable. This function is used
primarily by the actual GnomeDruidPage widgets.
gnome_druid_set_show_finish ()
void gnome_druid_set_show_finish (GnomeDruid *druid
,gboolean show_finish
);
Warning
gnome_druid_set_show_finish
is deprecated and should not be used in newly-written code.
Used to specify if druid
is currently showing the last page of the sequence
(and hence should display "Finish", rather than "Next").
|
A GnomeDruid widget. |
|
If TRUE , then the "Next" button is changed to be "Finish" |
gnome_druid_set_show_help ()
void gnome_druid_set_show_help (GnomeDruid *druid
,gboolean show_help
);
Warning
gnome_druid_set_show_help
is deprecated and should not be used in newly-written code.
Sets the "Help" button on the druid to be visible in the lower left corner of
the widget, if show_help
is TRUE
.
|
A GnomeDruid. |
|
TRUE , if the "Help" button is to be shown, FALSE otherwise. |
gnome_druid_prepend_page ()
void gnome_druid_prepend_page (GnomeDruid *druid
,GnomeDruidPage *page
);
Warning
gnome_druid_prepend_page
is deprecated and should not be used in newly-written code.
This will prepend a GnomeDruidPage into the internal list of
pages that the druid
has. Since GnomeDruid is just a container, you will
need to also call gtk_widget_show()
on the page, otherwise the page will not
be shown.
|
A Druid widget. |
|
The page to be inserted. |
gnome_druid_insert_page ()
void gnome_druid_insert_page (GnomeDruid *druid
,GnomeDruidPage *back_page
,GnomeDruidPage *page
);
Warning
gnome_druid_insert_page
is deprecated and should not be used in newly-written code.
This will insert page
after back_page
into the list of
internal pages that the druid
has. If back_page
is not present in the
list or NULL
, page
will be prepended to the list. Since GnomeDruid is
just a container, you will need to also call gtk_widget_show()
on the page,
otherwise the page will not be shown.
|
A GnomeDruid widget. |
|
The page prior to the page to be inserted. |
|
The page to insert. |
gnome_druid_append_page ()
void gnome_druid_append_page (GnomeDruid *druid
,GnomeDruidPage *page
);
Warning
gnome_druid_append_page
is deprecated and should not be used in newly-written code.
This will append page
onto the end of the internal list.
Since GnomeDruid is just a container, you will need to also call
gtk_widget_show()
on the page, otherwise the page will not be shown.
|
A GnomeDruid widget. |
|
The GnomeDruidPage to be appended. |
gnome_druid_set_page ()
void gnome_druid_set_page (GnomeDruid *druid
,GnomeDruidPage *page
);
Warning
gnome_druid_set_page
is deprecated and should not be used in newly-written code.
This will make page
the currently showing page in the druid.
page
must already be in the druid.
|
A GnomeDruid widget. |
|
The GnomeDruidPage to be brought to the foreground. |
gnome_druid_new_with_window ()
GtkWidget * gnome_druid_new_with_window (const char *title
,GtkWindow *parent
,gboolean close_on_cancel
,GtkWidget **window
);
Warning
gnome_druid_new_with_window
is deprecated and should not be used in newly-written code.
Creates a new GnomeDruid widget. It also creates a new
toplevel window with the title of title
(which can be NULL
) and a parent
of parent
(which also can be NULL
). The window and the druid will both be
shown. If you need the window widget pointer you can optionally get it
through the last argument. When the druid gets destroyed, so will the
window that is created here.
|
A title of the window. |
|
The parent of this window (transient_for). |
|
TRUE if the window should be closed when cancel is
pressed. |
|
Optional return of the GtkWindow created. |
Returns : |
A new GnomeDruid widget. |
gnome_druid_construct_with_window ()
void gnome_druid_construct_with_window (GnomeDruid *druid
,const char *title
,GtkWindow *parent
,gboolean close_on_cancel
,GtkWidget **window
);
Warning
gnome_druid_construct_with_window
is deprecated and should not be used in newly-written code.
Creates a new toplevel window with the title of title
(which
can be NULL
) and a parent of parent
(which also can be NULL
). The druid
will be placed inside this window. The window and the druid will both be
shown. If you need the window widget pointer you can optionally get it
through the last argument. When the druid gets destroyed, so will the
window that is created here.
See also gnome_druid_new_with_window()
.
|
The GnomeDruid. |
|
A title of the window. |
|
The parent of this window (transient_for). |
|
TRUE if the window should be closed when cancel is
pressed. |
|
Optional return of the GtkWindow created. |
Property Details
The "show-finish"
property
"show-finish" gboolean : Read / Write
Show the 'Finish' button instead of the 'Next' button.
Default value: FALSE
The "show-help"
property
"show-help" gboolean : Read / Write
Show the 'Help' button.
Default value: FALSE
Signal Details
The "cancel"
signal
void user_function (GnomeDruid *druid,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
The "help"
signal
void user_function (GnomeDruid *druid,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |