Memory-managed wrapper type.

Type class for types which can be safely cast to Assistant, for instance with toAssistant.

Cast to Assistant, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe Assistant.

Adds a widget to the action area of a Assistant.

Since: 2.10

Appends a page to the assistant.

Since: 2.10

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.

Since: 2.22

Returns the page number of the current page.

Since: 2.10

Returns the number of pages in the assistant

Since: 2.10

Returns the child widget contained in page number pageNum.

Since: 2.10

Gets whether page is complete.

Since: 2.10

Gets whether page has padding.

Since: 3.18

Gets the header image for page.

Since: 2.10

Gets the side image for page.

Since: 2.10

Gets the title for page.

Since: 2.10

Gets the page type of page.

Since: 2.10

Inserts a page in the assistant at a given position.

Since: 2.10

Creates a new Assistant.

Since: 2.10

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.

Since: 3.0

Prepends a page to the assistant.

Since: 2.10

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.

Since: 3.0

Removes a widget from the action area of a Assistant.

Since: 2.10

Removes the pageNum’s page from assistant.

Since: 3.2

Switches the page to pageNum.

Note that this will only be necessary in custom buttons, as the assistant flow can be set with assistantSetForwardPageFunc.

Since: 2.10

Sets the page forwarding function to be pageFunc.

This function will be used to determine what will be the next page when the user presses the forward button. Setting pageFunc to Nothing will make the assistant to use the default forward function, which just goes to the next visible page.

Since: 2.10

Sets whether page contents are complete.

This will make assistant update the buttons state to be able to continue the task.

Since: 2.10

Sets whether the assistant is adding padding around the page.

Since: 3.18

Sets a header image for page.

Since: 2.10

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.

Since: 2.10

Sets a title for page.

The title is displayed in the header area of the assistant when page is the current page.

Since: 2.10

Sets the page type for page.

The page type determines the page behavior in the assistant.

Since: 2.10

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.

Since: 2.10

Construct a GValueConstruct with valid value for the “use-header-bar” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-header-bar” property. When overloading is enabled, this is equivalent to

get assistant #useHeaderBar

The ::apply 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 ::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 putting a page of type AssistantPageTypeProgress after the confirmation page and handle this operation within the Assistant::prepare signal of the progress page.

Since: 2.10

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “apply” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after assistant #apply callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_AssistantApplyCallback.

A convenience synonym for Nothing :: Maybe AssistantApplyCallback.

Connect a signal handler for the “apply” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on assistant #apply callback

Wrap a AssistantApplyCallback into a C_AssistantApplyCallback.

The ::cancel signal is emitted when then the cancel button is clicked.

Since: 2.10

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “cancel” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after assistant #cancel callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_AssistantCancelCallback.

A convenience synonym for Nothing :: Maybe AssistantCancelCallback.

Connect a signal handler for the “cancel” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on assistant #cancel callback

Wrap a AssistantCancelCallback into a C_AssistantCancelCallback.

The ::close 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 AssistantPageTypeConfirm) is clicked.

Since: 2.10

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “close” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after assistant #close callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_AssistantCloseCallback.

A convenience synonym for Nothing :: Maybe AssistantCloseCallback.

Connect a signal handler for the “close” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on assistant #close callback

Wrap a AssistantCloseCallback into a C_AssistantCloseCallback.

No description available in the introspection data.

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “escape” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after assistant #escape callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_AssistantEscapeCallback.

A convenience synonym for Nothing :: Maybe AssistantEscapeCallback.

Connect a signal handler for the “escape” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on assistant #escape callback

Wrap a AssistantEscapeCallback into a C_AssistantEscapeCallback.

The ::prepare 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 preparations which are necessary before showing page.

Since: 2.10

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “prepare” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after assistant #prepare callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_AssistantPrepareCallback.

A convenience synonym for Nothing :: Maybe AssistantPrepareCallback.

Connect a signal handler for the “prepare” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on assistant #prepare callback

Wrap a AssistantPrepareCallback into a C_AssistantPrepareCallback.