Class: Gtk::Assistant
- Inherits:
-
Object
- Object
- Gtk::Assistant
- Defined in:
- (unknown)
Instance Method Summary collapse
-
#add_action_widget(child) ⇒ nil
Adds a widget to the action area of a Gtk::Assistant.
-
#append_page(page) ⇒ Integer
Appends a page to the assistant.
-
#commit ⇒ nil
Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages.
-
#current_page ⇒ Integer
Returns the page number of the current page.
-
#current_page=(page_num) ⇒ nil
Switches the page to page_num.
-
#get_nth_page(page_num) ⇒ Gtk::Widget
Returns the child widget contained in page number page_num.
-
#get_page_complete(page) ⇒ TrueClass
Gets whether page is complete.
-
#get_page_has_padding(page) ⇒ TrueClass
Gets whether page has padding.
-
#get_page_header_image(page) ⇒ GdkPixbuf::Pixbuf
Gets the header image for page.
-
#get_page_side_image(page) ⇒ GdkPixbuf::Pixbuf
Gets the side image for page.
-
#get_page_title(page) ⇒ String
Gets the title for page.
-
#get_page_type(page) ⇒ Gtk::AssistantPageType
Gets the page type of page.
-
#insert_page(page, position) ⇒ Integer
Inserts a page in the assistant at a given position.
-
#n_pages ⇒ Integer
Returns the number of pages in the assistant.
-
#new ⇒ Gtk::Widget
Creates a new Gtk::Assistant.
-
#next_page ⇒ nil
Navigate to the next page.
-
#prepend_page(page) ⇒ Integer
Prepends a page to the assistant.
-
#previous_page ⇒ nil
Navigate to the previous visited page.
-
#remove_action_widget(child) ⇒ nil
Removes a widget from the action area of a Gtk::Assistant.
-
#remove_page(page_num) ⇒ nil
Removes the page_num’s page from assistant.
-
#set_forward_page_func(page_func, data, destroy) ⇒ nil
Sets the page forwarding function to be page_func.
-
#set_page_complete(page, complete) ⇒ nil
Sets whether page contents are complete.
-
#set_page_has_padding(page, has_padding) ⇒ nil
Sets whether the assistant is adding padding around the page.
-
#set_page_header_image(page, pixbuf) ⇒ nil
Sets a header image for page.
-
#set_page_side_image(page, pixbuf) ⇒ nil
Sets a side image for page.
-
#set_page_title(page, title) ⇒ nil
Sets a title for page.
-
#set_page_type(page, type) ⇒ nil
Sets the page type for page.
-
#update_buttons_state ⇒ nil
Forces assistant to recompute the buttons state.
-
#use_header_bar ⇒ Integer
true if the assistant uses a Gtk::HeaderBar for action buttons instead of the action-area.
-
#use_header_bar=(use_header_bar) ⇒ Integer
true if the assistant uses a Gtk::HeaderBar for action buttons instead of the action-area.
Instance Method Details
#add_action_widget(child) ⇒ nil
Adds a widget to the action area of a Gtk::Assistant.
#append_page(page) ⇒ Integer
Appends a page to the assistant.
#commit ⇒ nil
Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages.
Use this when the information provided up to the current page is hereafter deemed permanent and cannot be modified or undone. For example, showing a progress page to track a long-running, unreversible operation after the user has clicked apply on a confirmation page.
#current_page ⇒ Integer
Returns the page number of the current page.
#current_page=(page_num) ⇒ nil
Switches the page to page_num.
Note that this will only be necessary in custom buttons, as the assistant flow can be set with gtk_assistant_set_forward_page_func().
#get_nth_page(page_num) ⇒ Gtk::Widget
Returns the child widget contained in page number page_num.
#get_page_complete(page) ⇒ TrueClass
Gets whether page is complete.
#get_page_has_padding(page) ⇒ TrueClass
Gets whether page has padding.
#get_page_header_image(page) ⇒ GdkPixbuf::Pixbuf
Gets the header image for page.
#get_page_side_image(page) ⇒ GdkPixbuf::Pixbuf
Gets the side image for page.
#get_page_title(page) ⇒ String
Gets the title for page.
#get_page_type(page) ⇒ Gtk::AssistantPageType
Gets the page type of page.
#insert_page(page, position) ⇒ Integer
Inserts a page in the assistant at a given position.
#n_pages ⇒ Integer
Returns the number of pages in the assistant
#new ⇒ Gtk::Widget
Creates a new Gtk::Assistant.
#next_page ⇒ nil
Navigate to the next page.
It is a programming error to call this function when there is no next page.
This function is for use when creating pages of the #GTK_ASSISTANT_PAGE_CUSTOM type.
#prepend_page(page) ⇒ Integer
Prepends a page to the assistant.
#previous_page ⇒ nil
Navigate to the previous visited page.
It is a programming error to call this function when no previous page is available.
This function is for use when creating pages of the #GTK_ASSISTANT_PAGE_CUSTOM type.
#remove_action_widget(child) ⇒ nil
Removes a widget from the action area of a Gtk::Assistant.
#remove_page(page_num) ⇒ nil
Removes the page_num’s page from assistant.
#set_forward_page_func(page_func, data, destroy) ⇒ nil
Sets the page forwarding function to be page_func.
This function will be used to determine what will be the next page when the user presses the forward button. Setting page_func to nil will make the assistant to use the default forward function, which just goes to the next visible page.
#set_page_complete(page, complete) ⇒ nil
Sets whether page contents are complete.
This will make assistant update the buttons state to be able to continue the task.
#set_page_has_padding(page, has_padding) ⇒ nil
Sets whether the assistant is adding padding around the page.
#set_page_header_image(page, pixbuf) ⇒ nil
Sets a header image for page.
#set_page_side_image(page, pixbuf) ⇒ nil
Sets a side image for page.
This image used to be displayed in the side area of the assistant when page is the current page.
#set_page_title(page, title) ⇒ nil
Sets a title for page.
The title is displayed in the header area of the assistant when page is the current page.
#set_page_type(page, type) ⇒ nil
Sets the page type for page.
The page type determines the page behavior in the assistant.
#update_buttons_state ⇒ nil
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.
#use_header_bar ⇒ Integer
true if the assistant uses a Gtk::HeaderBar for action buttons instead of the action-area.
For technical reasons, this property is declared as an integer property, but you should only set it to true or false.
#use_header_bar=(use_header_bar) ⇒ Integer
true if the assistant uses a Gtk::HeaderBar for action buttons instead of the action-area.
For technical reasons, this property is declared as an integer property, but you should only set it to true or false.