class: Assistant

[33:7] extends: object

GtkAssistant is used to represent a complex as a series of steps. Each step consists of one or more pages. GtkAssistant guides the user through the pages, and controls the page flow to collect the data needed for the operation. GtkAssistant handles which buttons to show and to make sensitive based on page sequence knowledge and the [enum@Gtk.AssistantPageType] of each page in addition to state information like the completed and committed page statuses. If you have a case that doesn’t quite fit in GtkAssistants way of handling buttons, you can use the %GTK_ASSISTANT_PAGE_CUSTOM page type and handle buttons yourself. GtkAssistant maintains a GtkAssistantPage object for each added child, which holds additional per-child properties. You obtain the GtkAssistantPage for a child with [method@Gtk.Assistant.get_page]. # GtkAssistant as GtkBuildable The GtkAssistant implementation of the GtkBuildable interface exposes the @action_area as internal children with the name “action_area”. To add pages to an assistant in GtkBuilder, simply add it as a child to the GtkAssistant object. If you need to set per-object properties, create a GtkAssistantPage object explicitly, and set the child widget as a property on it. # CSS nodes GtkAssistant has a single CSS node with the name window and style class .assistant.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Assistant ()

  Creates a new GtkAssistant.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asWindow ()

  Wraps this handle as Window.

  • @r A Window object.

• asAccessible ()

  Wraps this handle as Accessible.

  • @r A Accessible object.

• asBuildable ()

  Wraps this handle as Buildable.

  • @r A Buildable object.

• asConstraintTarget ()

  Wraps this handle as ConstraintTarget.

  • @r A ConstraintTarget object.

• asNative ()

  Wraps this handle as Native.

  • @r A Native object.

• asRoot ()

  Wraps this handle as Root.

  • @r A Root object.

• asShortcutManager ()

  Wraps this handle as ShortcutManager.

  • @r A ShortcutManager object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnApply (callback Fn, UserData = null)

  Emitted when the apply button is clicked. The default behavior of the GtkAssistant 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 %GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page and handle this operation within the [signal@Gtk.Assistant::prepare] signal of the progress page.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Assistant Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnCancel (callback Fn, UserData = null)

  Emitted when then the cancel button is clicked.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Assistant Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnClose (callback Fn, UserData = null)

  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 %GTK_ASSISTANT_PAGE_CONFIRM) is clicked.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Assistant Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnEscape (callback Fn, UserData = null)

  The action signal for the Escape binding.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Assistant Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnPrepare (callback Fn, UserData = null)

  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.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Assistant Self, Widget Page).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• add_action_widget (object child)

  Adds a widget to the action area of a GtkAssistant.

  • @p child is a GtkWidget.
  • @r None.

• append_page (object page)

  Appends a page to the @assistant.

  • @p page is a GtkWidget.

• commit ()

  Erases the visited page history. GTK will then hide the back button 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.

  • @r None.

• get_current_page ()

  Returns the page number of the current page.

• get_n_pages ()

  Returns the number of pages in the @assistant

• get_nth_page (int page_num)

  Returns the child widget contained in page number @page_num.

  • @p page_num is the index of a page in the @assistant, or -1 to get the last page.

• get_page (object child)

  Returns the GtkAssistantPage object for @child.

  • @p child is a child of @assistant.

• get_page_complete (object page)

  Gets whether @page is complete.

  • @p page is a page of @assistant.

• get_page_title (object page)

  Gets the title for @page.

  • @p page is a page of @assistant.

• get_page_type (object page)

  Gets the page type of @page.

  • @p page is a page of @assistant.

• get_pages ()

  Gets a list model of the assistant pages.

• insert_page (object page, int position)

  Inserts a page in the @assistant at a given position.

  • @p page is a GtkWidget.
  • @p position is the index (starting at 0) at which to insert the page, or -1 to append the page to the @assistant.

• next_page ()

  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.

  • @r None.

• prepend_page (object page)

  Prepends a page to the @assistant.

  • @p page is a GtkWidget.

• previous_page ()

  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.

  • @r None.

• remove_action_widget (object child)

  Removes a widget from the action area of a GtkAssistant.

  • @p child is a GtkWidget.
  • @r None.

• remove_page (int page_num)

  Removes the @page_num’s page from @assistant.

  • @p page_num is the index of a page in the @assistant, or -1 to remove the last page.
  • @r None.

• 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 gtk_assistant_set_forward_page_func().

  • @p page_num is 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..
  • @r None.

• set_page_complete (object page, bool complete)

  Sets whether @page contents are complete. This will make @assistant update the buttons state to be able to continue the task.

  • @p page is a page of @assistant.
  • @p complete is the completeness status of the page.
  • @r None.

• set_page_title (object page, string title)

  Sets a title for @page. The title is displayed in the header area of the assistant when @page is the current page.

  • @p page is a page of @assistant.
  • @p title is the new title for @page.
  • @r None.

• set_page_type (object page, string type)

  Sets the page type for @page. The page type determines the page behavior in the @assistant.

  • @p page is a page of @assistant.
  • @p type is the new type for @page.
  • @r None.

• 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.

  • @r None.

• pages ()

  Returns get_pages as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_pages() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

class: AssistantPrepareCallback

[842:7] extends: object

Generated low-level callback wrapper for GIR callback prepare.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• AssistantPrepareCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, page, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: AssistantMeta

[913:14] static extends: object

Generated metadata helpers for Assistant class surfaces.

Methods

• properties ()

  Returns property metadata for Assistant.

  • @r A list.

• signals ()

  Returns signal metadata for Assistant.

  • @r A list.

class: AssistantCloseCallback

[702:7] extends: object

Generated low-level callback wrapper for GIR callback close.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• AssistantCloseCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: AssistantCancelCallback

[632:7] extends: object

Generated low-level callback wrapper for GIR callback cancel.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• AssistantCancelCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: AssistantApplyCallback

[562:7] extends: object

Generated low-level callback wrapper for GIR callback apply.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• AssistantApplyCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: AssistantEscapeCallback

[772:7] extends: object

Generated low-level callback wrapper for GIR callback escape.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• AssistantEscapeCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.