6.2.6 assistant

Superclass: gtk-window atk-implementor-iface buildable

A assistant is a widget used to represent a generally complex operation splitted in several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.

Slots:

• current-page. Type: integer. Accessor: assistant-current-page.

  The index (starting from 0) of the current page in the assistant, or -1 if the assistant has no pages.

• forward-page-function. function. Accessor: assistant-forward-page-function. Write-only.

  Page forwarding function is used to determine what will be the next page when the user presses the forward button. Setting this to NIL will make the assistant to use the default forward function, which just goes to the next visible page. The function called both for computing the next page when the user presses the "forward" button and for handling the behavior of the "last" button. The function accepts a single integer - the current page number and returns the page number for the next page.

• n-pages. Type: integer. Accessor: assistant-n-pages. Read-only.

  The number of pages in the assistant

Signals:

• "apply". Signature: (instance assistant) => void. Options: run-last.

  This signal is emitted when the apply button is clicked. The default behavior of the assistant is to switch to the page after the current page, unless the current page is the last one.

  A handler for the assistant::apply signal should carry out the actions for which the wizard has collected data. If the action takes a long time to complete, you might consider to put a page of type :progress after the confirmation page and handle this operation within the assistant::prepare signal of the progress page.

• "cancel". Signature: (instance assistant) => void. Options: run-last.

  This signal is emitted when then the cancel button is clicked.

• "close". Signature: (instance assistant) => void. Options: run-last.

  This signal is emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type :confirm) is clicked.

• "prepare". Signature: (instance assistant), (page widget) => void. Options: run-last.

  This signal is emitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparation which are necessary before showing page.

     (assistant-nth-page assistant page-number) => page-widget

Returns the child widget (a widget) contained in page number page-number (an integer).

     (assistant-append-page assistant page)

Appends a page (a widget) to the assistant (a assistant).

     (assistant-prepend-page assistant page)

Prepends a page (a widget) to the assistant (a assistant).

     (assistant-insert-page assistant page position) => page-number

Inserts a page (a widget) in the assistant (a assistant) at a given position. position is the index (starting at 0) at which to insert the page, or -1 to append the page. Returns the index of inserted page.

     (assistant-add-action-widget assistant widget)

Adds the widget (a widget) to the action area of a assistant (a assistant).

     (assistant-remove-action-widget assistant widget)

Removes the widget (a widget) from the action area of a assistant (a assistant).

     (assistant-update-buttons-state assistant)

Forces assistant (a 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.