---
name: "Gtk2::Assistant"
section: "3pm"
platform: "linux"
package: "libgtk2-perl-doc"
version: "2:1.24992-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::Assistant"
---

# Gtk2::Assistant(3pm)

wrapper for GtkAssistant

## NAME

Gtk2::Assistant - wrapper for GtkAssistant

## HIERARCHY

```
  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Container
                      +----Gtk2::Bin
                           +----Gtk2::Window
                                +----Gtk2::Assistant
```

## INTERFACES

```
  Glib::Object::_Unregistered::AtkImplementorIface
  Gtk2::Buildable
```

## METHODS

### widget = Gtk2::Assistant-\>new

### $assistant-\>add\_action\_widget ($child)

- •

  `$child` (Gtk2::Widget)

### integer = $assistant-\>append\_page ($page)

- •

  `$page` (Gtk2::Widget)

### widget or undef = $assistant-\>get\_apply\_button

### widget or undef = $assistant-\>get\_back\_button

### widget or undef = $assistant-\>get\_cancel\_button

### widget or undef = $assistant-\>get\_close\_button

### $assistant-\>commit

Since: gtk+ 2.22

### integer = $assistant-\>get\_current\_page

### $assistant-\>set\_current\_page ($page\_num)

- •

  `$page_num` (integer)

### widget or undef = $assistant-\>get\_forward\_button

### $assistant-\>set\_forward\_page\_func ($func, $data=undef)

- •

  `$func` (scalar)

- •

  `$data` (scalar)

### integer = $assistant-\>insert\_page ($page, $position)

- •

  `$page` (Gtk2::Widget)

- •

  `$position` (integer)

### widget or undef = $assistant-\>get\_last\_button

### integer = $assistant-\>get\_n\_pages

### widget = $assistant-\>get\_nth\_page ($page\_num)

- •

  `$page_num` (integer)

### boolean = $assistant-\>get\_page\_complete ($page)

- •

  `$page` (Gtk2::Widget)

### $assistant-\>set\_page\_complete ($page, $complete)

- •

  `$page` (Gtk2::Widget)

- •

  `$complete` (boolean)

### pixbuf = $assistant-\>get\_page\_header\_image ($page)

- •

  `$page` (Gtk2::Widget)

### $assistant-\>set\_page\_header\_image ($page, $pixbuf)

- •

  `$page` (Gtk2::Widget)

- •

  `$pixbuf` (Gtk2::Gdk::Pixbuf)

### pixbuf = $assistant-\>get\_page\_side\_image ($page)

- •

  `$page` (Gtk2::Widget)

### $assistant-\>set\_page\_side\_image ($page, $pixbuf)

- •

  `$page` (Gtk2::Widget)

- •

  `$pixbuf` (Gtk2::Gdk::Pixbuf)

### string = $assistant-\>get\_page\_title ($page)

- •

  `$page` (Gtk2::Widget)

### $assistant-\>set\_page\_title ($page, $title)

- •

  `$page` (Gtk2::Widget)

- •

  `$title` (string)

### assistantpagetype = $assistant-\>get\_page\_type ($page)

- •

  `$page` (Gtk2::Widget)

### $assistant-\>set\_page\_type ($page, $type)

- •

  `$page` (Gtk2::Widget)

- •

  `$type` (Gtk2::AssistantPageType)

### integer = $assistant-\>prepend\_page ($page)

- •

  `$page` (Gtk2::Widget)

### $assistant-\>remove\_action\_widget ($child)

- •

  `$child` (Gtk2::Widget)

### $assistant-\>update\_buttons\_state

## CHILD PROPERTIES

- 'complete' (boolean : default false : readable / writable)

  Whether all required fields on the page have been filled out

- 'header-image' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)

  Header image for the assistant page

- 'page-type' (Gtk2::AssistantPageType : default "content" : readable / writable / private)

  The type of the assistant page

- 'sidebar-image' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)

  Sidebar image for the assistant page

- 'title' (string : default undef : readable / writable / private)

  The title of the assistant page

## STYLE PROPERTIES

- 'content-padding' (integer : default 1 : readable / private)

  Number of pixels around the content pages.

- 'header-padding' (integer : default 6 : readable / private)

  Number of pixels around the header.

## SIGNALS

- **apply** (Gtk2::Assistant)

  - **cancel** (Gtk2::Assistant)

  - **close** (Gtk2::Assistant)

  - **prepare** (Gtk2::Assistant, Gtk2::Widget)

  ## ENUMS AND FLAGS

### enum Gtk2::AssistantPageType

- •

  'content' / 'GTK\_ASSISTANT\_PAGE\_CONTENT'

- •

  'intro' / 'GTK\_ASSISTANT\_PAGE\_INTRO'

- •

  'confirm' / 'GTK\_ASSISTANT\_PAGE\_CONFIRM'

- •

  'summary' / 'GTK\_ASSISTANT\_PAGE\_SUMMARY'

- •

  'progress' / 'GTK\_ASSISTANT\_PAGE\_PROGRESS'

## SEE ALSO

Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin, Gtk2::Window

## COPYRIGHT

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL.  See Gtk2 for a full notice.