.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Gtk2::Assistant 3pm" .TH Gtk2::Assistant 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Gtk2::Assistant \- wrapper for GtkAssistant .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 8 \& Glib::Object \& +\-\-\-\-Glib::InitiallyUnowned \& +\-\-\-\-Gtk2::Object \& +\-\-\-\-Gtk2::Widget \& +\-\-\-\-Gtk2::Container \& +\-\-\-\-Gtk2::Bin \& +\-\-\-\-Gtk2::Window \& +\-\-\-\-Gtk2::Assistant .Ve .SH "INTERFACES" .IX Header "INTERFACES" .Vb 2 \& Glib::Object::_Unregistered::AtkImplementorIface \& Gtk2::Buildable .Ve .SH "METHODS" .IX Header "METHODS" .SS "widget = Gtk2::Assistant\->\fBnew\fP" .IX Subsection "widget = Gtk2::Assistant->new" .ie n .SS "$assistant\->\fBadd_action_widget\fP ($child)" .el .SS "\f(CW$assistant\fP\->\fBadd_action_widget\fP ($child)" .IX Subsection "$assistant->add_action_widget ($child)" .IP "\(bu" 4 \&\f(CW$child\fR (Gtk2::Widget) .ie n .SS "integer = $assistant\->\fBappend_page\fP ($page)" .el .SS "integer = \f(CW$assistant\fP\->\fBappend_page\fP ($page)" .IX Subsection "integer = $assistant->append_page ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "widget or undef = $assistant\->\fBget_apply_button\fP" .el .SS "widget or undef = \f(CW$assistant\fP\->\fBget_apply_button\fP" .IX Subsection "widget or undef = $assistant->get_apply_button" .ie n .SS "widget or undef = $assistant\->\fBget_back_button\fP" .el .SS "widget or undef = \f(CW$assistant\fP\->\fBget_back_button\fP" .IX Subsection "widget or undef = $assistant->get_back_button" .ie n .SS "widget or undef = $assistant\->\fBget_cancel_button\fP" .el .SS "widget or undef = \f(CW$assistant\fP\->\fBget_cancel_button\fP" .IX Subsection "widget or undef = $assistant->get_cancel_button" .ie n .SS "widget or undef = $assistant\->\fBget_close_button\fP" .el .SS "widget or undef = \f(CW$assistant\fP\->\fBget_close_button\fP" .IX Subsection "widget or undef = $assistant->get_close_button" .ie n .SS "$assistant\->\fBcommit\fP" .el .SS "\f(CW$assistant\fP\->\fBcommit\fP" .IX Subsection "$assistant->commit" Since: gtk+ 2.22 .ie n .SS "integer = $assistant\->\fBget_current_page\fP" .el .SS "integer = \f(CW$assistant\fP\->\fBget_current_page\fP" .IX Subsection "integer = $assistant->get_current_page" .ie n .SS "$assistant\->\fBset_current_page\fP ($page_num)" .el .SS "\f(CW$assistant\fP\->\fBset_current_page\fP ($page_num)" .IX Subsection "$assistant->set_current_page ($page_num)" .IP "\(bu" 4 \&\f(CW$page_num\fR (integer) .ie n .SS "widget or undef = $assistant\->\fBget_forward_button\fP" .el .SS "widget or undef = \f(CW$assistant\fP\->\fBget_forward_button\fP" .IX Subsection "widget or undef = $assistant->get_forward_button" .ie n .SS "$assistant\->\fBset_forward_page_func\fP ($func, $data=undef)" .el .SS "\f(CW$assistant\fP\->\fBset_forward_page_func\fP ($func, \f(CW$data\fP=undef)" .IX Subsection "$assistant->set_forward_page_func ($func, $data=undef)" .IP "\(bu" 4 \&\f(CW$func\fR (scalar) .IP "\(bu" 4 \&\f(CW$data\fR (scalar) .ie n .SS "integer = $assistant\->\fBinsert_page\fP ($page, $position)" .el .SS "integer = \f(CW$assistant\fP\->\fBinsert_page\fP ($page, \f(CW$position\fP)" .IX Subsection "integer = $assistant->insert_page ($page, $position)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$position\fR (integer) .ie n .SS "widget or undef = $assistant\->\fBget_last_button\fP" .el .SS "widget or undef = \f(CW$assistant\fP\->\fBget_last_button\fP" .IX Subsection "widget or undef = $assistant->get_last_button" .ie n .SS "integer = $assistant\->\fBget_n_pages\fP" .el .SS "integer = \f(CW$assistant\fP\->\fBget_n_pages\fP" .IX Subsection "integer = $assistant->get_n_pages" .ie n .SS "widget = $assistant\->\fBget_nth_page\fP ($page_num)" .el .SS "widget = \f(CW$assistant\fP\->\fBget_nth_page\fP ($page_num)" .IX Subsection "widget = $assistant->get_nth_page ($page_num)" .IP "\(bu" 4 \&\f(CW$page_num\fR (integer) .ie n .SS "boolean = $assistant\->\fBget_page_complete\fP ($page)" .el .SS "boolean = \f(CW$assistant\fP\->\fBget_page_complete\fP ($page)" .IX Subsection "boolean = $assistant->get_page_complete ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBset_page_complete\fP ($page, $complete)" .el .SS "\f(CW$assistant\fP\->\fBset_page_complete\fP ($page, \f(CW$complete\fP)" .IX Subsection "$assistant->set_page_complete ($page, $complete)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$complete\fR (boolean) .ie n .SS "pixbuf = $assistant\->\fBget_page_header_image\fP ($page)" .el .SS "pixbuf = \f(CW$assistant\fP\->\fBget_page_header_image\fP ($page)" .IX Subsection "pixbuf = $assistant->get_page_header_image ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBset_page_header_image\fP ($page, $pixbuf)" .el .SS "\f(CW$assistant\fP\->\fBset_page_header_image\fP ($page, \f(CW$pixbuf\fP)" .IX Subsection "$assistant->set_page_header_image ($page, $pixbuf)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$pixbuf\fR (Gtk2::Gdk::Pixbuf) .ie n .SS "pixbuf = $assistant\->\fBget_page_side_image\fP ($page)" .el .SS "pixbuf = \f(CW$assistant\fP\->\fBget_page_side_image\fP ($page)" .IX Subsection "pixbuf = $assistant->get_page_side_image ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBset_page_side_image\fP ($page, $pixbuf)" .el .SS "\f(CW$assistant\fP\->\fBset_page_side_image\fP ($page, \f(CW$pixbuf\fP)" .IX Subsection "$assistant->set_page_side_image ($page, $pixbuf)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$pixbuf\fR (Gtk2::Gdk::Pixbuf) .ie n .SS "string = $assistant\->\fBget_page_title\fP ($page)" .el .SS "string = \f(CW$assistant\fP\->\fBget_page_title\fP ($page)" .IX Subsection "string = $assistant->get_page_title ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBset_page_title\fP ($page, $title)" .el .SS "\f(CW$assistant\fP\->\fBset_page_title\fP ($page, \f(CW$title\fP)" .IX Subsection "$assistant->set_page_title ($page, $title)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$title\fR (string) .ie n .SS "assistantpagetype = $assistant\->\fBget_page_type\fP ($page)" .el .SS "assistantpagetype = \f(CW$assistant\fP\->\fBget_page_type\fP ($page)" .IX Subsection "assistantpagetype = $assistant->get_page_type ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBset_page_type\fP ($page, $type)" .el .SS "\f(CW$assistant\fP\->\fBset_page_type\fP ($page, \f(CW$type\fP)" .IX Subsection "$assistant->set_page_type ($page, $type)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$type\fR (Gtk2::AssistantPageType) .ie n .SS "integer = $assistant\->\fBprepend_page\fP ($page)" .el .SS "integer = \f(CW$assistant\fP\->\fBprepend_page\fP ($page)" .IX Subsection "integer = $assistant->prepend_page ($page)" .IP "\(bu" 4 \&\f(CW$page\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBremove_action_widget\fP ($child)" .el .SS "\f(CW$assistant\fP\->\fBremove_action_widget\fP ($child)" .IX Subsection "$assistant->remove_action_widget ($child)" .IP "\(bu" 4 \&\f(CW$child\fR (Gtk2::Widget) .ie n .SS "$assistant\->\fBupdate_buttons_state\fP" .el .SS "\f(CW$assistant\fP\->\fBupdate_buttons_state\fP" .IX Subsection "$assistant->update_buttons_state" .SH "CHILD PROPERTIES" .IX Header "CHILD PROPERTIES" .IP "'complete' (boolean : default false : readable / writable)" 4 .IX Item "'complete' (boolean : default false : readable / writable)" Whether all required fields on the page have been filled out .IP "'header\-image' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)" 4 .IX Item "'header-image' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)" Header image for the assistant page .ie n .IP "'page\-type' (Gtk2::AssistantPageType : default ""content"" : readable / writable / private)" 4 .el .IP "'page\-type' (Gtk2::AssistantPageType : default ``content'' : readable / writable / private)" 4 .IX Item "'page-type' (Gtk2::AssistantPageType : default content : readable / writable / private)" The type of the assistant page .IP "'sidebar\-image' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)" 4 .IX Item "'sidebar-image' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)" Sidebar image for the assistant page .IP "'title' (string : default undef : readable / writable / private)" 4 .IX Item "'title' (string : default undef : readable / writable / private)" The title of the assistant page .SH "STYLE PROPERTIES" .IX Header "STYLE PROPERTIES" .IP "'content\-padding' (integer : default 1 : readable / private)" 4 .IX Item "'content-padding' (integer : default 1 : readable / private)" Number of pixels around the content pages. .IP "'header\-padding' (integer : default 6 : readable / private)" 4 .IX Item "'header-padding' (integer : default 6 : readable / private)" Number of pixels around the header. .SH "SIGNALS" .IX Header "SIGNALS" .IP "\fBapply\fR (Gtk2::Assistant)" 4 .IX Item "apply (Gtk2::Assistant)" .PD 0 .IP "\fBcancel\fR (Gtk2::Assistant)" 4 .IX Item "cancel (Gtk2::Assistant)" .IP "\fBclose\fR (Gtk2::Assistant)" 4 .IX Item "close (Gtk2::Assistant)" .IP "\fBprepare\fR (Gtk2::Assistant, Gtk2::Widget)" 4 .IX Item "prepare (Gtk2::Assistant, Gtk2::Widget)" .PD .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum Gtk2::AssistantPageType" .IX Subsection "enum Gtk2::AssistantPageType" .IP "\(bu" 4 \&'content' / '\s-1GTK_ASSISTANT_PAGE_CONTENT\s0' .IP "\(bu" 4 \&'intro' / '\s-1GTK_ASSISTANT_PAGE_INTRO\s0' .IP "\(bu" 4 \&'confirm' / '\s-1GTK_ASSISTANT_PAGE_CONFIRM\s0' .IP "\(bu" 4 \&'summary' / '\s-1GTK_ASSISTANT_PAGE_SUMMARY\s0' .IP "\(bu" 4 \&'progress' / '\s-1GTK_ASSISTANT_PAGE_PROGRESS\s0' .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin, Gtk2::Window .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2003\-2011 by the gtk2\-perl team. .PP This software is licensed under the \s-1LGPL.\s0 See Gtk2 for a full notice.