GtkAssistant: GTK+ 2 Reference Manual

## GtkAssistant GtkAssistant |

## Functions

GtkWidget * | gtk_assistant_new ()
gint | gtk_assistant_get_current_page ()
void | gtk_assistant_set_current_page ()
gint | gtk_assistant_get_n_pages ()
GtkWidget * | gtk_assistant_get_nth_page ()
gint | gtk_assistant_prepend_page ()
gint | gtk_assistant_append_page ()
gint | gtk_assistant_insert_page ()
gint | (*GtkAssistantPageFunc) ()
void | gtk_assistant_set_forward_page_func ()
void | gtk_assistant_set_page_type ()
GtkAssistantPageType | gtk_assistant_get_page_type ()
void | gtk_assistant_set_page_title ()
const gchar * | gtk_assistant_get_page_title ()
void | gtk_assistant_set_page_header_image ()
GdkPixbuf * | gtk_assistant_get_page_header_image ()
void | gtk_assistant_set_page_side_image ()
GdkPixbuf * | gtk_assistant_get_page_side_image ()
void | gtk_assistant_set_page_complete ()
gboolean | gtk_assistant_get_page_complete ()
void | gtk_assistant_add_action_widget ()
void | gtk_assistant_remove_action_widget ()
void | gtk_assistant_update_buttons_state ()
void | gtk_assistant_commit ()

## Child Properties

gboolean | complete | Read / Write
GdkPixbuf * | header-image | Read / Write
GtkAssistantPageType | page-type | Read / Write
GdkPixbuf * | sidebar-image | Read / Write
gchar * | title | Read / Write

## Style Properties

gint | content-padding | Read
gint | header-padding | Read

## Signals

void | apply | Run Last
void | cancel | Run Last
void | close | Run Last
void | prepare | Run Last

## Types and Values

struct | GtkAssistant
enum | GtkAssistantPageType

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkWidget
                    ╰── GtkContainer
                        ╰── GtkBin
                            ╰── GtkWindow
                                ╰── GtkAssistant

## Implemented Interfaces

GtkAssistant implements AtkImplementorIface and GtkBuildable.

## Includes

    #include <gtk/gtk.h>

## Description

## Functions

### gtk_assistant_new ()

    GtkWidget *
    gtk_assistant_new (void);

Since: 2.10

### gtk_assistant_get_current_page ()

    gint
    gtk_assistant_get_current_page (GtkAssistant *assistant);

Since: 2.10

### gtk_assistant_set_current_page ()

    void
    gtk_assistant_set_current_page (GtkAssistant *assistant,
                                    gint page_num);

Since: 2.10

### gtk_assistant_get_n_pages ()

    gint
    gtk_assistant_get_n_pages (GtkAssistant *assistant);

Since: 2.10

### gtk_assistant_get_nth_page ()

    GtkWidget *
    gtk_assistant_get_nth_page (GtkAssistant *assistant,
                                gint page_num);

Since: 2.10

### gtk_assistant_prepend_page ()

    gint
    gtk_assistant_prepend_page (GtkAssistant *assistant,
                                GtkWidget *page);

Since: 2.10

### gtk_assistant_append_page ()

    gint
    gtk_assistant_append_page (GtkAssistant *assistant,
                               GtkWidget *page);

Since: 2.10

### gtk_assistant_insert_page ()

    gint
    gtk_assistant_insert_page (GtkAssistant *assistant,
                               GtkWidget *page,
                               gint position);

Since: 2.10

### GtkAssistantPageFunc ()

    gint
    (*GtkAssistantPageFunc) (gint current_page,
                             gpointer data);

### gtk_assistant_set_forward_page_func ()

    void
    gtk_assistant_set_forward_page_func (GtkAssistant *assistant,
                                         GtkAssistantPageFunc page_func,
                                         gpointer data,
                                         GDestroyNotify destroy);

Since: 2.10

### gtk_assistant_set_page_type ()

    void
    gtk_assistant_set_page_type (GtkAssistant *assistant,
                                 GtkWidget *page,
                                 GtkAssistantPageType type);

Since: 2.10

### gtk_assistant_get_page_type ()

    GtkAssistantPageType
    gtk_assistant_get_page_type (GtkAssistant *assistant,
                                 GtkWidget *page);

Since: 2.10

### gtk_assistant_set_page_title ()

    void
    gtk_assistant_set_page_title (GtkAssistant *assistant,
                                  GtkWidget *page,
                                  const gchar *title);

Since: 2.10

### gtk_assistant_get_page_title ()

    const gchar *
    gtk_assistant_get_page_title (GtkAssistant *assistant,
                                  GtkWidget *page);

Since: 2.10

### gtk_assistant_set_page_header_image ()

    void
    gtk_assistant_set_page_header_image (GtkAssistant *assistant,
                                         GtkWidget *page,
                                         GdkPixbuf *pixbuf);

Since: 2.10

### gtk_assistant_get_page_header_image ()

    GdkPixbuf *
    gtk_assistant_get_page_header_image (GtkAssistant *assistant,
                                         GtkWidget *page);

Since: 2.10

### gtk_assistant_set_page_side_image ()

    void
    gtk_assistant_set_page_side_image (GtkAssistant *assistant,
                                       GtkWidget *page,
                                       GdkPixbuf *pixbuf);

Since: 2.10

### gtk_assistant_get_page_side_image ()

    GdkPixbuf *
    gtk_assistant_get_page_side_image (GtkAssistant *assistant,
                                       GtkWidget *page);

Since: 2.10

### gtk_assistant_set_page_complete ()

    void
    gtk_assistant_set_page_complete (GtkAssistant *assistant,
                                     GtkWidget *page,
                                     gboolean complete);

Since: 2.10

### gtk_assistant_get_page_complete ()

    gboolean
    gtk_assistant_get_page_complete (GtkAssistant *assistant,
                                     GtkWidget *page);

Since: 2.10

### gtk_assistant_add_action_widget ()

    void
    gtk_assistant_add_action_widget (GtkAssistant *assistant,
                                     GtkWidget *child);

Since: 2.10

### gtk_assistant_remove_action_widget ()

    void
    gtk_assistant_remove_action_widget (GtkAssistant *assistant,
                                        GtkWidget *child);

Since: 2.10

### gtk_assistant_update_buttons_state ()

    void
    gtk_assistant_update_buttons_state (GtkAssistant *assistant);

Since: 2.10

### gtk_assistant_commit ()

    void
    gtk_assistant_commit (GtkAssistant *assistant);

Since: 2.22

## Types and Values

### struct GtkAssistant

    struct GtkAssistant;

### enum GtkAssistantPageType

#### Members

GTK_ASSISTANT_PAGE_CONTENT |  |
GTK_ASSISTANT_PAGE_INTRO |  |
GTK_ASSISTANT_PAGE_CONFIRM |  |
GTK_ASSISTANT_PAGE_SUMMARY |  |
GTK_ASSISTANT_PAGE_PROGRESS |  |

## Child Property Details

### The `“complete”` child property

      “complete”                 gboolean

Whether all required fields on the page have been filled out.

Flags: Read / Write

Default value: FALSE

Since: 2.10

### The `“header-image”` child property

      “header-image”             GdkPixbuf *

Header image for the assistant page.

Flags: Read / Write

Since: 2.10

### The `“page-type”` child property

      “page-type”                GtkAssistantPageType

The type of the assistant page.

Flags: Read / Write

Default value: GTK_ASSISTANT_PAGE_CONTENT

Since: 2.10

### The `“sidebar-image”` child property

      “sidebar-image”            GdkPixbuf *

Sidebar image for the assistant page.

Flags: Read / Write

### The `“title”` child property

      “title”                    gchar *

The title of the assistant page.

Flags: Read / Write

Default value: NULL

Since: 2.10

## Style Property Details

### The `“content-padding”` style property

      “content-padding”          gint

Number of pixels around the content pages.

Flags: Read

Allowed values: >= 0

Default value: 1

### The `“header-padding”` style property

      “header-padding”           gint

Number of pixels around the header.

Flags: Read

Allowed values: >= 0

Default value: 6

## Signal Details

### The `“apply”` signal

    void
    user_function (GtkAssistant *assistant,
                   gpointer      user_data)

Flags: Run Last

Since: 2.10

### The `“cancel”` signal

    void
    user_function (GtkAssistant *assistant,
                   gpointer      user_data)

Flags: Run Last

Since: 2.10

### The `“close”` signal

    void
    user_function (GtkAssistant *assistant,
                   gpointer      user_data)

Flags: Run Last

Since: 2.10

### The `“prepare”` signal

    void
    user_function (GtkAssistant *assistant,
                   GtkWidget    *page,
                   gpointer      user_data)

Flags: Run Last

Since: 2.10