MateDruid

MateDruid — Widget for sequentially stepping through some pages.

Synopsis

#include <libmateui/libmateui.h>

struct              MateDruid;
GtkWidget *         mate_druid_new                     (void);
void                mate_druid_set_buttons_sensitive   (MateDruid *druid,
                                                         gboolean back_sensitive,
                                                         gboolean next_sensitive,
                                                         gboolean cancel_sensitive,
                                                         gboolean help_sensitive);
void                mate_druid_set_show_finish         (MateDruid *druid,
                                                         gboolean show_finish);
void                mate_druid_set_show_help           (MateDruid *druid,
                                                         gboolean show_help);
void                mate_druid_prepend_page            (MateDruid *druid,
                                                         MateDruidPage *page);
void                mate_druid_insert_page             (MateDruid *druid,
                                                         MateDruidPage *back_page,
                                                         MateDruidPage *page);
void                mate_druid_append_page             (MateDruid *druid,
                                                         MateDruidPage *page);
void                mate_druid_set_page                (MateDruid *druid,
                                                         MateDruidPage *page);
GtkWidget *         mate_druid_new_with_window         (const char *title,
                                                         GtkWindow *parent,
                                                         gboolean close_on_cancel,
                                                         GtkWidget **window);
void                mate_druid_construct_with_window   (MateDruid *druid,
                                                         const char *title,
                                                         GtkWindow *parent,
                                                         gboolean close_on_cancel,
                                                         GtkWidget **window);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----MateDruid

Implemented Interfaces

MateDruid implements AtkImplementorIface and GtkBuildable.

Properties

  "show-finish"              gboolean              : Read / Write
  "show-help"                gboolean              : Read / Write

Signals

  "cancel"                                         : Run Last
  "help"                                           : Run Last

Description

Details

struct MateDruid

struct MateDruid;

Warning

MateDruid 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.


mate_druid_new ()

GtkWidget *         mate_druid_new                     (void);

Warning

mate_druid_new is deprecated and should not be used in newly-written code.

Creates a new MateDruid widget. You need to add this to a dialog yourself, it is not a dialog.

Returns :

A new MateDruid widget

mate_druid_set_buttons_sensitive ()

void                mate_druid_set_buttons_sensitive   (MateDruid *druid,
                                                         gboolean back_sensitive,
                                                         gboolean next_sensitive,
                                                         gboolean cancel_sensitive,
                                                         gboolean help_sensitive);

Warning

mate_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 MateDruidPage widgets.

druid :

A Druid.

back_sensitive :

TRUE if the back button is sensitive.

next_sensitive :

TRUE if the next button is sensitive.

cancel_sensitive :

TRUE if the cancel button is sensitive.

help_sensitive :

TRUE if the help button is sensitive.

mate_druid_set_show_finish ()

void                mate_druid_set_show_finish         (MateDruid *druid,
                                                         gboolean show_finish);

Warning

mate_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").

druid :

A MateDruid widget.

show_finish :

If TRUE, then the "Next" button is changed to be "Finish"

mate_druid_set_show_help ()

void                mate_druid_set_show_help           (MateDruid *druid,
                                                         gboolean show_help);

Warning

mate_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.

druid :

A MateDruid.

show_help :

TRUE, if the "Help" button is to be shown, FALSE otherwise.

mate_druid_prepend_page ()

void                mate_druid_prepend_page            (MateDruid *druid,
                                                         MateDruidPage *page);

Warning

mate_druid_prepend_page is deprecated and should not be used in newly-written code.

This will prepend a MateDruidPage into the internal list of pages that the druid has. Since MateDruid is just a container, you will need to also call gtk_widget_show() on the page, otherwise the page will not be shown.

druid :

A Druid widget.

page :

The page to be inserted.

mate_druid_insert_page ()

void                mate_druid_insert_page             (MateDruid *druid,
                                                         MateDruidPage *back_page,
                                                         MateDruidPage *page);

Warning

mate_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 MateDruid is just a container, you will need to also call gtk_widget_show() on the page, otherwise the page will not be shown.

druid :

A MateDruid widget.

back_page :

The page prior to the page to be inserted.

page :

The page to insert.

mate_druid_append_page ()

void                mate_druid_append_page             (MateDruid *druid,
                                                         MateDruidPage *page);

Warning

mate_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 MateDruid is just a container, you will need to also call gtk_widget_show() on the page, otherwise the page will not be shown.

druid :

A MateDruid widget.

page :

The MateDruidPage to be appended.

mate_druid_set_page ()

void                mate_druid_set_page                (MateDruid *druid,
                                                         MateDruidPage *page);

Warning

mate_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.

druid :

A MateDruid widget.

page :

The MateDruidPage to be brought to the foreground.

mate_druid_new_with_window ()

GtkWidget *         mate_druid_new_with_window         (const char *title,
                                                         GtkWindow *parent,
                                                         gboolean close_on_cancel,
                                                         GtkWidget **window);

Warning

mate_druid_new_with_window is deprecated and should not be used in newly-written code.

Creates a new MateDruid 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.

title :

A title of the window.

parent :

The parent of this window (transient_for).

close_on_cancel :

TRUE if the window should be closed when cancel is pressed.

window :

Optional return of the GtkWindow created.

Returns :

A new MateDruid widget.

mate_druid_construct_with_window ()

void                mate_druid_construct_with_window   (MateDruid *druid,
                                                         const char *title,
                                                         GtkWindow *parent,
                                                         gboolean close_on_cancel,
                                                         GtkWidget **window);

Warning

mate_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 mate_druid_new_with_window().

druid :

The MateDruid.

title :

A title of the window.

parent :

The parent of this window (transient_for).

close_on_cancel :

TRUE if the window should be closed when cancel is pressed.

window :

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                      (MateDruid *druid,
                                                        gpointer    user_data)      : Run Last

druid :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "help" signal

void                user_function                      (MateDruid *druid,
                                                        gpointer    user_data)      : Run Last

druid :

the object which received the signal.

user_data :

user data set when the signal handler was connected.