![]() |

A Gtk::Assistant is a widget used to represent a generally complex operation split into several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.
Public Types | |
| typedef sigc::slot<int, int> | SlotForwardPage |
Public Member Functions | |
| void | add_action_widget (Widget& child) |
| Adds a widget to the action area of a Gtk::Assistant. | |
| int | append_page (Widget& page) |
| Appends a page to the assistant . | |
| Assistant () | |
| int | get_current_page () const |
| Return value: The index (starting from 0) of the current page in. | |
| int | get_n_pages () const |
| Return value: The number of pages in the assistant . | |
| const Widget* | get_nth_page (int page_num) const |
Return value: The child widget, or 0 if page_num is out of bounds. | |
| Widget* | get_nth_page (int page_num) |
Return value: The child widget, or 0 if page_num is out of bounds. | |
| bool | get_page_complete (const Widget& page) const |
| Gets whether page is complete. | |
| Glib::RefPtr<const Gdk::Pixbuf> | get_page_header_image (const Widget& page) const |
| Gets the header image for page . | |
| Glib::RefPtr<Gdk::Pixbuf> | get_page_header_image (const Widget& page) |
| Gets the header image for page . | |
| Glib::RefPtr<const Gdk::Pixbuf> | get_page_side_image (const Widget& page) const |
| Gets the header image for page . | |
| Glib::RefPtr<Gdk::Pixbuf> | get_page_side_image (const Widget& page) |
| Gets the header image for page . | |
| Glib::ustring | get_page_title (const Widget& page) const |
| Gets the title for page . | |
| AssistantPageType | get_page_type (const Widget& page) const |
| Gets the page type of page . | |
| const GtkAssistant* | gobj () const |
| Provides access to the underlying C GtkObject. | |
| GtkAssistant* | gobj () |
| Provides access to the underlying C GtkObject. | |
| int | insert_page (Widget& page, int position) |
| Inserts a page in the assistant at a given position. | |
| int | prepend_page (Widget& page) |
| Prepends a page to the assistant . | |
| void | remove_action_widget (Widget& child) |
| Removes a widget from the action area of a Gtk::Assistant. | |
| void | set_current_page (int page_num) |
| Switches the page to page_num . | |
| void | set_forward_page_func (const SlotForwardPage& slot) |
| void | set_page_complete (const Widget& page, bool complete=true) |
| Sets whether page contents are complete. | |
| void | set_page_header_image (const Widget& page, const Glib::RefPtr<Gdk::Pixbuf>& pixbuf) |
| Sets a header image for page . | |
| void | set_page_side_image (const Widget& page, const Glib::RefPtr<Gdk::Pixbuf>& pixbuf) |
| Sets a header image for page . | |
| void | set_page_title (const Widget& page, const Glib::ustring& title) |
| Sets a title for page . | |
| void | set_page_type (const Widget& page, AssistantPageType type) |
| Sets the page type for page . | |
| Glib::SignalProxy0<void> | signal_apply () |
| |
| Glib::SignalProxy0<void> | signal_cancel () |
| |
| Glib::SignalProxy0<void> | signal_close () |
| |
| Glib::SignalProxy1< void, Gtk::Widget* > | signal_prepare () |
| |
| void | update_buttons_state () |
| Forces assistant to recompute the buttons state. | |
| virtual | ~Assistant () |
Protected Member Functions | |
| virtual void | on_apply () |
| virtual void | on_cancel () |
| virtual void | on_close () |
| virtual void | on_prepare (Gtk::Widget* page) |
Related Functions | |
| (Note that these are not member functions.) | |
| Gtk::Assistant* | wrap (GtkAssistant* object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
| typedef sigc::slot<int, int > Gtk::Assistant::SlotForwardPage |
| virtual Gtk::Assistant::~Assistant | ( | ) | [virtual] |
| Gtk::Assistant::Assistant | ( | ) |
| void Gtk::Assistant::add_action_widget | ( | Widget& | child | ) |
| int Gtk::Assistant::append_page | ( | Widget& | page | ) |
Appends a page to the assistant .
| page | A Gtk::Widget. |
| int Gtk::Assistant::get_current_page | ( | ) | const |
Return value: The index (starting from 0) of the current page in.
| int Gtk::Assistant::get_n_pages | ( | ) | const |
Return value: The number of pages in the assistant .
| const Widget* Gtk::Assistant::get_nth_page | ( | int | page_num | ) | const |
Return value: The child widget, or 0 if page_num is out of bounds.
| page_num | The index of a page in the assistant , or -1 to get the last page;. |
0 if page_num is out of bounds.| Widget* Gtk::Assistant::get_nth_page | ( | int | page_num | ) |
Return value: The child widget, or 0 if page_num is out of bounds.
| page_num | The index of a page in the assistant , or -1 to get the last page;. |
0 if page_num is out of bounds.| bool Gtk::Assistant::get_page_complete | ( | const Widget& | page | ) | const |
Gets whether page is complete.
| page | A page of assistant . |
true if page is complete.| Glib::RefPtr<const Gdk::Pixbuf> Gtk::Assistant::get_page_header_image | ( | const Widget& | page | ) | const |
Gets the header image for page .
| page | A page of assistant . |
0 if there's no header image for the page.| Glib::RefPtr<Gdk::Pixbuf> Gtk::Assistant::get_page_header_image | ( | const Widget& | page | ) |
Gets the header image for page .
| page | A page of assistant . |
0 if there's no header image for the page.| Glib::RefPtr<const Gdk::Pixbuf> Gtk::Assistant::get_page_side_image | ( | const Widget& | page | ) | const |
Gets the header image for page .
| page | A page of assistant . |
0 if there's no side image for the page.| Glib::RefPtr<Gdk::Pixbuf> Gtk::Assistant::get_page_side_image | ( | const Widget& | page | ) |
Gets the header image for page .
| page | A page of assistant . |
0 if there's no side image for the page.| Glib::ustring Gtk::Assistant::get_page_title | ( | const Widget& | page | ) | const |
Gets the title for page .
| page | A page of assistant . |
| AssistantPageType Gtk::Assistant::get_page_type | ( | const Widget& | page | ) | const |
Gets the page type of page .
| page | A page of assistant . |
| const GtkAssistant* Gtk::Assistant::gobj | ( | ) | const [inline] |
| GtkAssistant* Gtk::Assistant::gobj | ( | ) | [inline] |
| int Gtk::Assistant::insert_page | ( | Widget& | page, | |
| int | position | |||
| ) |
Inserts a page in the assistant at a given position.
| page | A Gtk::Widget. | |
| position | The index (starting at 0) at which to insert the page, or -1 to append the page to the assistant . |
| virtual void Gtk::Assistant::on_apply | ( | ) | [protected, virtual] |
| virtual void Gtk::Assistant::on_cancel | ( | ) | [protected, virtual] |
| virtual void Gtk::Assistant::on_close | ( | ) | [protected, virtual] |
| virtual void Gtk::Assistant::on_prepare | ( | Gtk::Widget* | page | ) | [protected, virtual] |
| int Gtk::Assistant::prepend_page | ( | Widget& | page | ) |
Prepends a page to the assistant .
| page | A Gtk::Widget. |
| void Gtk::Assistant::remove_action_widget | ( | Widget& | child | ) |
| void Gtk::Assistant::set_current_page | ( | int | page_num | ) |
Switches the page to page_num .
Note that this will only be necessary in custom buttons, as the assistant flow can be set with set_forward_page_func().
| page_num | Index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the assistant , nothing will be done. |
| void Gtk::Assistant::set_forward_page_func | ( | const SlotForwardPage& | slot | ) |
| void Gtk::Assistant::set_page_complete | ( | const Widget& | page, | |
| bool | complete = true | |||
| ) |
Sets whether page contents are complete.
This will make assistant update the buttons state to be able to continue the task.
| page | A page of assistant . | |
| complete | The completeness status of the page. |
| void Gtk::Assistant::set_page_header_image | ( | const Widget& | page, | |
| const Glib::RefPtr<Gdk::Pixbuf>& | pixbuf | |||
| ) |
Sets a header image for page .
This image is displayed in the header area of the assistant when page is the current page.
| page | A page of assistant . | |
| pixbuf | The new header image page . |
| void Gtk::Assistant::set_page_side_image | ( | const Widget& | page, | |
| const Glib::RefPtr<Gdk::Pixbuf>& | pixbuf | |||
| ) |
Sets a header image for page .
This image is displayed in the side area of the assistant when page is the current page.
| page | A page of assistant . | |
| pixbuf | The new header image page . |
| void Gtk::Assistant::set_page_title | ( | const Widget& | page, | |
| const Glib::ustring & | title | |||
| ) |
Sets a title for page .
The title is displayed in the header area of the assistant when page is the current page.
| page | A page of assistant . | |
| title | The new title for page . |
| void Gtk::Assistant::set_page_type | ( | const Widget& | page, | |
| AssistantPageType | type | |||
| ) |
Sets the page type for page .
The page type determines the page behavior in the assistant .
| page | A page of assistant . | |
| type | The new type for page . |
| Glib::SignalProxy0< void > Gtk::Assistant::signal_apply | ( | ) |
void on_my_apply()
| Glib::SignalProxy0< void > Gtk::Assistant::signal_cancel | ( | ) |
void on_my_cancel()
| Glib::SignalProxy0< void > Gtk::Assistant::signal_close | ( | ) |
void on_my_close()
| Glib::SignalProxy1<void,Gtk::Widget*> Gtk::Assistant::signal_prepare | ( | ) |
| void Gtk::Assistant::update_buttons_state | ( | ) |
Forces assistant to recompute the buttons state.
GTK+ automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.
One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.
| Gtk::Assistant* wrap | ( | GtkAssistant * | object, | |
| bool | take_copy = false | |||
| ) | [related] |
A Glib::wrap() method for this object.
| object | The C instance. | |
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |