Assistant

gtk.assistant.Assistant is used to represent a complex as a series of steps.

An example GtkAssistant

Each step consists of one or more pages. gtk.assistant.Assistant guides the user through the pages, and controls the page flow to collect the data needed for the operation.

gtk.assistant.Assistant handles which buttons to show and to make sensitive based on page sequence knowledge and the gtk.types.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 gtk.assistant.Assistants way of handling buttons, you can use the gtk.types.AssistantPageType.Custom page type and handle buttons yourself.

gtk.assistant.Assistant maintains a gtk.assistant_page.AssistantPage object for each added child, which holds additional per-child properties. You obtain the gtk.assistant_page.AssistantPage for a child with gtk.assistant.Assistant.getPage.

GtkAssistant as GtkBuildable

The gtk.assistant.Assistant implementation of the gtk.buildable.Buildable interface exposes the @action_area as internal children with the name “action_area”.

To add pages to an assistant in gtk.builder.Builder, simply add it as a child to the gtk.assistant.Assistant object. If you need to set per-object properties, create a gtk.assistant_page.AssistantPage object explicitly, and set the child widget as a property on it.

CSS nodes

gtk.assistant.Assistant has a single CSS node with the name window and style class .assistant.

More...

class Assistant : Window {

this();

void addActionWidget(gtk.widget.Widget child);

int appendPage(gtk.widget.Widget page);

void commit();

int getCurrentPage();

int getNPages();

gtk.widget.Widget getNthPage(int pageNum);

gtk.assistant_page.AssistantPage getPage(gtk.widget.Widget child);

bool getPageComplete(gtk.widget.Widget page);

string getPageTitle(gtk.widget.Widget page);

gtk.types.AssistantPageType getPageType(gtk.widget.Widget page);

gio.list_model.ListModel getPages();

int insertPage(gtk.widget.Widget page, int position);

void nextPage();

int prependPage(gtk.widget.Widget page);

void previousPage();

void removeActionWidget(gtk.widget.Widget child);

void removePage(int pageNum);

void setCurrentPage(int pageNum);

void setForwardPageFunc(gtk.types.AssistantPageFunc pageFunc);

void setPageComplete(gtk.widget.Widget page, bool complete);

void setPageTitle(gtk.widget.Widget page, string title);

void setPageType(gtk.widget.Widget page, gtk.types.AssistantPageType type);

void updateButtonsState();

ulong connectApply(T callback, Flag!"After" after);

ulong connectCancel(T callback, Flag!"After" after);

ulong connectClose(T callback, Flag!"After" after);

ulong connectEscape(T callback, Flag!"After" after);

ulong connectPrepare(T callback, Flag!"After" after);

}

Constructors

this this(): Creates a new gtk.assistant.Assistant.

Members

Functions

addActionWidget void addActionWidget(gtk.widget.Widget child): Adds a widget to the action area of a gtk.assistant.Assistant.
appendPage int appendPage(gtk.widget.Widget page): Appends a page to the assistant.
commit void commit(): Erases the visited page history.
connectApply ulong connectApply(T callback, Flag!"After" after): Connect to Apply signal.
connectCancel ulong connectCancel(T callback, Flag!"After" after): Connect to Cancel signal.
connectClose ulong connectClose(T callback, Flag!"After" after): Connect to Close signal.
connectEscape ulong connectEscape(T callback, Flag!"After" after): Connect to Escape signal.
connectPrepare ulong connectPrepare(T callback, Flag!"After" after): Connect to Prepare signal.
getCurrentPage int getCurrentPage(): Returns the page number of the current page.
getNPages int getNPages(): Returns the number of pages in the assistant
getNthPage gtk.widget.Widget getNthPage(int pageNum): Returns the child widget contained in page number page_num.
getPage gtk.assistant_page.AssistantPage getPage(gtk.widget.Widget child): Returns the gtk.assistant_page.AssistantPage object for child.
getPageComplete bool getPageComplete(gtk.widget.Widget page): Gets whether page is complete.
getPageTitle string getPageTitle(gtk.widget.Widget page): Gets the title for page.
getPageType gtk.types.AssistantPageType getPageType(gtk.widget.Widget page): Gets the page type of page.
getPages gio.list_model.ListModel getPages(): Gets a list model of the assistant pages.
insertPage int insertPage(gtk.widget.Widget page, int position): Inserts a page in the assistant at a given position.
nextPage void nextPage(): Navigate to the next page.
prependPage int prependPage(gtk.widget.Widget page): Prepends a page to the assistant.
previousPage void previousPage(): Navigate to the previous visited page.
removeActionWidget void removeActionWidget(gtk.widget.Widget child): Removes a widget from the action area of a gtk.assistant.Assistant.
removePage void removePage(int pageNum): Removes the page_num’s page from assistant.
setCurrentPage void setCurrentPage(int pageNum): Switches the page to page_num.
setForwardPageFunc void setForwardPageFunc(gtk.types.AssistantPageFunc pageFunc): Sets the page forwarding function to be page_func.
setPageComplete void setPageComplete(gtk.widget.Widget page, bool complete): Sets whether page contents are complete.
setPageTitle void setPageTitle(gtk.widget.Widget page, string title): Sets a title for page.
setPageType void setPageType(gtk.widget.Widget page, gtk.types.AssistantPageType type): Sets the page type for page.
updateButtonsState void updateButtonsState(): Forces assistant to recompute the buttons state.

Inherited Members

From Window

getDefaultIconName string getDefaultIconName(): Returns the fallback icon name for windows.
getToplevels gio.list_model.ListModel getToplevels(): Returns a list of all existing toplevel windows.
listToplevels gtk.widget.Widget[] listToplevels(): Returns a list of all existing toplevel windows.
setAutoStartupNotification void setAutoStartupNotification(bool setting): Sets whether the window should request startup notification.
setDefaultIconName void setDefaultIconName(string name): Sets an icon to be used as fallback.
setInteractiveDebugging void setInteractiveDebugging(bool enable): Opens or closes the interactive debugger.
close void close(): Requests that the window is closed.
destroy void destroy(): Drop the internal reference GTK holds on toplevel windows.
fullscreen void fullscreen(): Asks to place window in the fullscreen state.
fullscreenOnMonitor void fullscreenOnMonitor(gdk.monitor.MonitorG monitor): Asks to place window in the fullscreen state on the given monitor.
getApplication gtk.application.Application getApplication(): Gets the gtk.application.Application associated with the window.
getChild gtk.widget.Widget getChild(): Gets the child widget of window.
getDecorated bool getDecorated(): Returns whether the window has been set to have decorations.
getDefaultSize void getDefaultSize(int width, int height): Gets the default size of the window.
getDefaultWidget gtk.widget.Widget getDefaultWidget(): Returns the default widget for window.
getDeletable bool getDeletable(): Returns whether the window has been set to have a close button.
getDestroyWithParent bool getDestroyWithParent(): Returns whether the window will be destroyed with its transient parent.
getFocus gtk.widget.Widget getFocus(): Retrieves the current focused widget within the window.
getFocusVisible bool getFocusVisible(): Gets whether “focus rectangles” are supposed to be visible.
getGroup gtk.window_group.WindowGroup getGroup(): Returns the group for window.
getHandleMenubarAccel bool getHandleMenubarAccel(): Returns whether this window reacts to F10 key presses by activating a menubar it contains.
getHideOnClose bool getHideOnClose(): Returns whether the window will be hidden when the close button is clicked.
getIconName string getIconName(): Returns the name of the themed icon for the window.
getMnemonicsVisible bool getMnemonicsVisible(): Gets whether mnemonics are supposed to be visible.
getModal bool getModal(): Returns whether the window is modal.
getResizable bool getResizable(): Gets the value set by gtk.window.Window.setResizable.
getTitle string getTitle(): Retrieves the title of the window.
getTitlebar gtk.widget.Widget getTitlebar(): Returns the custom titlebar that has been set with gtk.window.Window.setTitlebar.
getTransientFor gtk.window.Window getTransientFor(): Fetches the transient parent for this window.
hasGroup bool hasGroup(): Returns whether window has an explicit window group.
isActive bool isActive(): Returns whether the window is part of the current active toplevel.
isFullscreen bool isFullscreen(): Retrieves the current fullscreen state of window.
isMaximized bool isMaximized(): Retrieves the current maximized state of window.
isSuspended bool isSuspended(): Retrieves the current suspended state of window.
maximize void maximize(): Asks to maximize window, so that it fills the screen.
minimize void minimize(): Asks to minimize the specified window.
present void present(): Presents a window to the user.
presentWithTime void presentWithTime(uint timestamp): Presents a window to the user in response to an user interaction.
setApplication void setApplication(gtk.application.Application application): Sets or unsets the gtk.application.Application associated with the window.
setChild void setChild(gtk.widget.Widget child): Sets the child widget of window.
setDecorated void setDecorated(bool setting): Sets whether the window should be decorated.
setDefaultSize void setDefaultSize(int width, int height): Sets the default size of a window.
setDefaultWidget void setDefaultWidget(gtk.widget.Widget defaultWidget): Sets the default widget.
setDeletable void setDeletable(bool setting): Sets whether the window should be deletable.
setDestroyWithParent void setDestroyWithParent(bool setting): If setting is true, then destroying the transient parent of window will also destroy window itself.
setDisplay void setDisplay(gdk.display.Display display): Sets the gdk.display.Display where the window is displayed.
setFocus void setFocus(gtk.widget.Widget focus): Sets the focus widget.
setFocusVisible void setFocusVisible(bool setting): Sets whether “focus rectangles” are supposed to be visible.
setHandleMenubarAccel void setHandleMenubarAccel(bool handleMenubarAccel): Sets whether this window should react to F10 key presses by activating a menubar it contains.
setHideOnClose void setHideOnClose(bool setting): If setting is true, then clicking the close button on the window will not destroy it, but only hide it.
setIconName void setIconName(string name): Sets the icon for the window from a named themed icon.
setMnemonicsVisible void setMnemonicsVisible(bool setting): Sets whether mnemonics are supposed to be visible.
setModal void setModal(bool modal): Sets a window modal or non-modal.
setResizable void setResizable(bool resizable): Sets whether the user can resize a window.
setStartupId void setStartupId(string startupId): Sets the startup notification ID.
setTitle void setTitle(string title): Sets the title of the gtk.window.Window.
setTitlebar void setTitlebar(gtk.widget.Widget titlebar): Sets a custom titlebar for window.
setTransientFor void setTransientFor(gtk.window.Window parent): Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. gtk.dialog.Dialog.newWithButtons and other convenience functions in GTK will sometimes call gtk.window.Window.setTransientFor on your behalf.
unfullscreen void unfullscreen(): Asks to remove the fullscreen state for window, and return to its previous state.
unmaximize void unmaximize(): Asks to unmaximize window.
unminimize void unminimize(): Asks to unminimize the specified window.
connectActivateDefault ulong connectActivateDefault(T callback, Flag!"After" after): Connect to ActivateDefault signal.
connectActivateFocus ulong connectActivateFocus(T callback, Flag!"After" after): Connect to ActivateFocus signal.
connectCloseRequest ulong connectCloseRequest(T callback, Flag!"After" after): Connect to CloseRequest signal.
connectEnableDebugging ulong connectEnableDebugging(T callback, Flag!"After" after): Connect to EnableDebugging signal.
connectKeysChanged ulong connectKeysChanged(T callback, Flag!"After" after): Connect to KeysChanged signal.

Detailed Description

Deprecated: This widget will be removed in GTK 5

gtk assistant classes

Assistant