class Gtk::Assistant

Overview

Gtk::Assistant is used to represent a complex as a series of steps.

An example Gtk::Assistant

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

Gtk::Assistant handles which buttons to show and to make sensitive based on page sequence knowledge and the 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 Gtk::Assistants way of handling buttons, you can use the %GTK_ASSISTANT_PAGE_CUSTOM page type and handle buttons yourself.

Gtk::Assistant maintains a Gtk::AssistantPage object for each added child, which holds additional per-child properties. You obtain the Gtk::AssistantPage for a child with Gtk::Assistant#page.

Gtk::Assistant as Gtk::Buildable

The Gtk::Assistant implementation of the Gtk::Buildable interface exposes the action_area as internal children with the name “action_area”.

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

CSS nodes

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

Included Modules

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/assistant.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gtk::ShortcutManager

to_unsafe to_unsafe

Constructor methods inherited from module Gtk::ShortcutManager

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::ShortcutManager

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Root

display : Gdk::Display display, focus : Gtk::Widget | Nil focus, focus=(focus : Gtk::Widget | Nil) : Nil focus=, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::Root

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Root

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Native

realize : Nil realize, renderer : Gsk::Renderer renderer, surface : Gdk::Surface surface, surface_transform(x : Float64, y : Float64) : Nil surface_transform, to_unsafe to_unsafe, unrealize : Nil unrealize

Constructor methods inherited from module Gtk::Native

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Native

cast?(obj : GObject::Object) : self | Nil cast?, for_surface(surface : Gdk::Surface) : Gtk::Native | Nil for_surface, g_type : UInt64 g_type

Instance methods inherited from module Gtk::ConstraintTarget

to_unsafe to_unsafe

Constructor methods inherited from module Gtk::ConstraintTarget

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::ConstraintTarget

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Buildable

buildable_id : String | Nil buildable_id, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::Buildable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Buildable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Accessible

accessible_role : Gtk::AccessibleRole accessible_role, accessible_role=(value : Gtk::AccessibleRole) : Gtk::AccessibleRole accessible_role=, reset_property(property : Gtk::AccessibleProperty) : Nil reset_property, reset_relation(relation : Gtk::AccessibleRelation) : Nil reset_relation, reset_state(state : Gtk::AccessibleState) : Nil reset_state, to_unsafe to_unsafe, update_property(properties : Enumerable(Gtk::AccessibleProperty), values : Enumerable(_)) : Nil update_property, update_relation(relations : Enumerable(Gtk::AccessibleRelation), values : Enumerable(_)) : Nil update_relation, update_state(states : Enumerable(Gtk::AccessibleState), values : Enumerable(_)) : Nil update_state

Constructor methods inherited from module Gtk::Accessible

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Accessible

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class Gtk::Window

==(other : self) ==, activate_default_signal activate_default_signal, activate_focus_signal activate_focus_signal, application : Gtk::Application | Nil application, application=(application : Gtk::Application | Nil) : Nil application=, child : Gtk::Widget | Nil child, child=(child : Gtk::Widget | Nil) : Nil child=, close : Nil close, close_request_signal close_request_signal, decorated : Bool decorated, decorated=(setting : Bool) : Nil decorated=, decorated? : Bool decorated?, default_height : Int32 default_height, default_height=(value : Int32) : Int32 default_height=, default_size : Nil default_size, default_widget : Gtk::Widget | Nil default_widget, default_widget=(default_widget : Gtk::Widget | Nil) : Nil default_widget=, default_width : Int32 default_width, default_width=(value : Int32) : Int32 default_width=, deletable : Bool deletable, deletable=(setting : Bool) : Nil deletable=, deletable? : Bool deletable?, destroy : Nil destroy, destroy_with_parent : Bool destroy_with_parent, destroy_with_parent=(setting : Bool) : Nil destroy_with_parent=, destroy_with_parent? : Bool destroy_with_parent?, display : Gdk::Display | Nil display, display=(display : Gdk::Display) : Nil
display=(value : Gdk::Display | Nil) : Gdk::Display | Nil
display=
, enable_debugging_signal enable_debugging_signal, focus : Gtk::Widget | Nil focus, focus=(focus : Gtk::Widget | Nil) : Nil focus=, focus_visible : Bool focus_visible, focus_visible=(setting : Bool) : Nil focus_visible=, focus_visible? : Bool focus_visible?, focus_widget : Gtk::Widget | Nil focus_widget, focus_widget=(value : Gtk::Widget | Nil) : Gtk::Widget | Nil focus_widget=, fullscreen : Nil fullscreen, fullscreen_on_monitor(monitor : Gdk::Monitor) : Nil fullscreen_on_monitor, fullscreened=(value : Bool) : Bool fullscreened=, fullscreened? : Bool fullscreened?, group : Gtk::WindowGroup group, handle_menubar_accel : Bool handle_menubar_accel, handle_menubar_accel=(handle_menubar_accel : Bool) : Nil handle_menubar_accel=, handle_menubar_accel? : Bool handle_menubar_accel?, has_group : Bool has_group, hash(hasher) hash, hide_on_close : Bool hide_on_close, hide_on_close=(setting : Bool) : Nil hide_on_close=, hide_on_close? : Bool hide_on_close?, icon_name : String | Nil icon_name, icon_name=(value : String) : String
icon_name=(name : String | Nil) : Nil
icon_name=
, is_active? : Bool is_active?, is_fullscreen : Bool is_fullscreen, is_maximized : Bool is_maximized, keys_changed_signal keys_changed_signal, maximize : Nil maximize, maximized=(value : Bool) : Bool maximized=, maximized? : Bool maximized?, minimize : Nil minimize, mnemonics_visible : Bool mnemonics_visible, mnemonics_visible=(setting : Bool) : Nil mnemonics_visible=, mnemonics_visible? : Bool mnemonics_visible?, modal : Bool modal, modal=(modal : Bool) : Nil modal=, modal? : Bool modal?, present : Nil present, present_with_time(timestamp : UInt32) : Nil present_with_time, resizable : Bool resizable, resizable=(resizable : Bool) : Nil resizable=, resizable? : Bool resizable?, set_default_size(width : Int32, height : Int32) : Nil set_default_size, startup_id=(startup_id : String) : Nil startup_id=, title : String | Nil title, title=(value : String) : String
title=(title : String | Nil) : Nil
title=
, titlebar : Gtk::Widget | Nil titlebar, titlebar=(titlebar : Gtk::Widget | Nil) : Nil titlebar=, transient_for : Gtk::Window | Nil transient_for, transient_for=(parent : Gtk::Window | Nil) : Nil transient_for=, unfullscreen : Nil unfullscreen, unmaximize : Nil unmaximize, unminimize : Nil unminimize

Constructor methods inherited from class Gtk::Window

new : self
new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, application : Gtk::Application | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, child : Gtk::Widget | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, decorated : Bool | Nil = nil, default_height : Int32 | Nil = nil, default_widget : Gtk::Widget | Nil = nil, default_width : Int32 | Nil = nil, deletable : Bool | Nil = nil, destroy_with_parent : Bool | Nil = nil, display : Gdk::Display | Nil = nil, focus_on_click : Bool | Nil = nil, focus_visible : Bool | Nil = nil, focus_widget : Gtk::Widget | Nil = nil, focusable : Bool | Nil = nil, fullscreened : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, handle_menubar_accel : Bool | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, hide_on_close : Bool | Nil = nil, icon_name : String | Nil = nil, is_active : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, maximized : Bool | Nil = nil, mnemonics_visible : Bool | Nil = nil, modal : Bool | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, resizable : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, startup_id : String | Nil = nil, title : String | Nil = nil, titlebar : Gtk::Widget | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, transient_for : Gtk::Window | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil)
new

Class methods inherited from class Gtk::Window

auto_startup_notification=(setting : Bool) : Nil auto_startup_notification=, default_icon_name : String | Nil default_icon_name, default_icon_name=(name : String) : Nil default_icon_name=, g_type : UInt64 g_type, interactive_debugging=(enable : Bool) : Nil interactive_debugging=, list_toplevels : GLib::List list_toplevels, toplevels : Gio::ListModel toplevels

Instance methods inherited from module Gtk::ShortcutManager

to_unsafe to_unsafe

Constructor methods inherited from module Gtk::ShortcutManager

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::ShortcutManager

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Root

display : Gdk::Display display, focus : Gtk::Widget | Nil focus, focus=(focus : Gtk::Widget | Nil) : Nil focus=, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::Root

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Root

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Native

realize : Nil realize, renderer : Gsk::Renderer renderer, surface : Gdk::Surface surface, surface_transform(x : Float64, y : Float64) : Nil surface_transform, to_unsafe to_unsafe, unrealize : Nil unrealize

Constructor methods inherited from module Gtk::Native

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Native

cast?(obj : GObject::Object) : self | Nil cast?, for_surface(surface : Gdk::Surface) : Gtk::Native | Nil for_surface, g_type : UInt64 g_type

Instance methods inherited from module Gtk::ConstraintTarget

to_unsafe to_unsafe

Constructor methods inherited from module Gtk::ConstraintTarget

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::ConstraintTarget

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Buildable

buildable_id : String | Nil buildable_id, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::Buildable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Buildable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Accessible

accessible_role : Gtk::AccessibleRole accessible_role, accessible_role=(value : Gtk::AccessibleRole) : Gtk::AccessibleRole accessible_role=, reset_property(property : Gtk::AccessibleProperty) : Nil reset_property, reset_relation(relation : Gtk::AccessibleRelation) : Nil reset_relation, reset_state(state : Gtk::AccessibleState) : Nil reset_state, to_unsafe to_unsafe, update_property(properties : Enumerable(Gtk::AccessibleProperty), values : Enumerable(_)) : Nil update_property, update_relation(relations : Enumerable(Gtk::AccessibleRelation), values : Enumerable(_)) : Nil update_relation, update_state(states : Enumerable(Gtk::AccessibleState), values : Enumerable(_)) : Nil update_state

Constructor methods inherited from module Gtk::Accessible

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Accessible

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class Gtk::Widget

==(other : self) ==, action_set_enabled(action_name : String, enabled : Bool) : Nil action_set_enabled, activate : Bool activate, activate_action(name : String, args : _ | Nil) : Bool activate_action, activate_default : Nil activate_default, add_controller(controller : Gtk::EventController) : Nil add_controller, add_css_class(css_class : String) : Nil add_css_class, add_mnemonic_label(label : Gtk::Widget) : Nil add_mnemonic_label, add_tick_callback(callback : Gtk::TickCallback) : UInt32 add_tick_callback, allocate(width : Int32, height : Int32, baseline : Int32, transform : Gsk::Transform | Nil) : Nil allocate, allocated_baseline : Int32 allocated_baseline, allocated_height : Int32 allocated_height, allocated_width : Int32 allocated_width, allocation : Gdk::Rectangle allocation, ancestor(widget_type : UInt64) : Gtk::Widget | Nil ancestor, can_focus : Bool can_focus, can_focus=(can_focus : Bool) : Nil can_focus=, can_focus? : Bool can_focus?, can_target : Bool can_target, can_target=(can_target : Bool) : Nil can_target=, can_target? : Bool can_target?, child_focus(direction : Gtk::DirectionType) : Bool child_focus, child_visible : Bool child_visible, child_visible=(child_visible : Bool) : Nil child_visible=, children : Iterator(Widget) children, clipboard : Gdk::Clipboard clipboard, compute_bounds(target : Gtk::Widget) : Graphene::Rect compute_bounds, compute_expand(orientation : Gtk::Orientation) : Bool compute_expand, compute_point(target : Gtk::Widget, point : Graphene::Point) : Graphene::Point compute_point, compute_transform(target : Gtk::Widget) : Graphene::Matrix compute_transform, contains(x : Float64, y : Float64) : Bool contains, create_pango_context : Pango::Context create_pango_context, create_pango_layout(text : String | Nil) : Pango::Layout create_pango_layout, css_classes : Enumerable(String) css_classes, css_classes=(classes : Enumerable(String)) : Nil css_classes=, css_name : String css_name, css_name=(value : String) : String css_name=, cursor : Gdk::Cursor | Nil cursor, cursor=(cursor : Gdk::Cursor | Nil) : Nil cursor=, cursor_from_name=(name : String | Nil) : Nil cursor_from_name=, destroy_signal destroy_signal, direction : Gtk::TextDirection direction, direction=(dir : Gtk::TextDirection) : Nil direction=, direction_changed_signal direction_changed_signal, display : Gdk::Display display, drag_check_threshold(start_x : Int32, start_y : Int32, current_x : Int32, current_y : Int32) : Bool drag_check_threshold, error_bell : Nil error_bell, first_child : Gtk::Widget | Nil first_child, focus_child : Gtk::Widget | Nil focus_child, focus_child=(child : Gtk::Widget | Nil) : Nil focus_child=, focus_on_click : Bool focus_on_click, focus_on_click=(focus_on_click : Bool) : Nil focus_on_click=, focus_on_click? : Bool focus_on_click?, focusable : Bool focusable, focusable=(focusable : Bool) : Nil focusable=, focusable? : Bool focusable?, font_map : Pango::FontMap | Nil font_map, font_map=(font_map : Pango::FontMap | Nil) : Nil font_map=, font_options : Cairo::FontOptions | Nil font_options, font_options=(options : Cairo::FontOptions | Nil) : Nil font_options=, frame_clock : Gdk::FrameClock | Nil frame_clock, grab_focus : Bool grab_focus, halign : Gtk::Align halign, halign=(align : Gtk::Align) : Nil halign=, has_css_class(css_class : String) : Bool has_css_class, has_default : Bool has_default, has_default? : Bool has_default?, has_focus : Bool has_focus, has_focus? : Bool has_focus?, has_tooltip : Bool has_tooltip, has_tooltip=(has_tooltip : Bool) : Nil has_tooltip=, has_tooltip? : Bool has_tooltip?, has_visible_focus : Bool has_visible_focus, hash(hasher) hash, height : Int32 height, height_request : Int32 height_request, height_request=(value : Int32) : Int32 height_request=, hexpand : Bool hexpand, hexpand=(expand : Bool) : Nil hexpand=, hexpand? : Bool hexpand?, hexpand_set : Bool hexpand_set, hexpand_set=(set : Bool) : Nil hexpand_set=, hexpand_set? : Bool hexpand_set?, hide : Nil hide, hide_signal hide_signal, in_destruction : Bool in_destruction, init_template : Nil init_template, insert_action_group(name : String, group : Gio::ActionGroup | Nil) : Nil insert_action_group, insert_after(parent : Gtk::Widget, previous_sibling : Gtk::Widget | Nil) : Nil insert_after, insert_before(parent : Gtk::Widget, next_sibling : Gtk::Widget | Nil) : Nil insert_before, is_ancestor(ancestor : Gtk::Widget) : Bool is_ancestor, is_drawable : Bool is_drawable, is_focus : Bool is_focus, is_sensitive : Bool is_sensitive, is_visible : Bool is_visible, keynav_failed(direction : Gtk::DirectionType) : Bool keynav_failed, keynav_failed_signal keynav_failed_signal, last_child : Gtk::Widget | Nil last_child, layout_manager : Gtk::LayoutManager | Nil layout_manager, layout_manager=(layout_manager : Gtk::LayoutManager | Nil) : Nil layout_manager=, list_mnemonic_labels : GLib::List list_mnemonic_labels, map : Nil map, map_signal map_signal, mapped : Bool mapped, margin_bottom : Int32 margin_bottom, margin_bottom=(margin : Int32) : Nil margin_bottom=, margin_end : Int32 margin_end, margin_end=(margin : Int32) : Nil margin_end=, margin_start : Int32 margin_start, margin_start=(margin : Int32) : Nil margin_start=, margin_top : Int32 margin_top, margin_top=(margin : Int32) : Nil margin_top=, measure(orientation : Gtk::Orientation, for_size : Int32) : Nil measure, mnemonic_activate(group_cycling : Bool) : Bool mnemonic_activate, mnemonic_activate_signal mnemonic_activate_signal, move_focus_signal move_focus_signal, name : String name, name=(name : String) : Nil name=, native : Gtk::Native | Nil native, next_sibling : Gtk::Widget | Nil next_sibling, observe_children : Gio::ListModel observe_children, observe_controllers : Gio::ListModel observe_controllers, opacity : Float64 opacity, opacity=(opacity : Float64) : Nil opacity=, overflow : Gtk::Overflow overflow, overflow=(overflow : Gtk::Overflow) : Nil overflow=, pango_context : Pango::Context pango_context, parent : Gtk::Widget | Nil parent, parent=(parent : Gtk::Widget) : Nil parent=, pick(x : Float64, y : Float64, flags : Gtk::PickFlags) : Gtk::Widget | Nil pick, preferred_size : Gtk::Requisition preferred_size, prev_sibling : Gtk::Widget | Nil prev_sibling, primary_clipboard : Gdk::Clipboard primary_clipboard, query_tooltip_signal query_tooltip_signal, queue_allocate : Nil queue_allocate, queue_draw : Nil queue_draw, queue_resize : Nil queue_resize, realize : Nil realize, realize_signal realize_signal, realized : Bool realized, receives_default : Bool receives_default, receives_default=(receives_default : Bool) : Nil receives_default=, receives_default? : Bool receives_default?, remove_controller(controller : Gtk::EventController) : Nil remove_controller, remove_css_class(css_class : String) : Nil remove_css_class, remove_mnemonic_label(label : Gtk::Widget) : Nil remove_mnemonic_label, remove_tick_callback(id : UInt32) : Nil remove_tick_callback, request_mode : Gtk::SizeRequestMode request_mode, root : Gtk::Root | Nil root, scale_factor : Int32 scale_factor, sensitive : Bool sensitive, sensitive=(sensitive : Bool) : Nil sensitive=, sensitive? : Bool sensitive?, set_size_request(width : Int32, height : Int32) : Nil set_size_request, set_state_flags(flags : Gtk::StateFlags, clear : Bool) : Nil set_state_flags, settings : Gtk::Settings settings, should_layout : Bool should_layout, show : Nil show, show_signal show_signal, size(orientation : Gtk::Orientation) : Int32 size, size_allocate(allocation : Gdk::Rectangle, baseline : Int32) : Nil size_allocate, size_request : Nil size_request, snapshot_child(child : Gtk::Widget, snapshot : Gtk::Snapshot) : Nil snapshot_child, state_flags : Gtk::StateFlags state_flags, state_flags_changed_signal state_flags_changed_signal, style_context : Gtk::StyleContext style_context, template_child(widget_type : UInt64, name : String) : GObject::Object
template_child(name : String) : GObject::Object
template_child
, tooltip_markup : String | Nil tooltip_markup, tooltip_markup=(value : String) : String
tooltip_markup=(markup : String | Nil) : Nil
tooltip_markup=
, tooltip_text : String | Nil tooltip_text, tooltip_text=(value : String) : String
tooltip_text=(text : String | Nil) : Nil
tooltip_text=
, translate_coordinates(dest_widget : Gtk::Widget, src_x : Float64, src_y : Float64) : Bool translate_coordinates, trigger_tooltip_query : Nil trigger_tooltip_query, unmap : Nil unmap, unmap_signal unmap_signal, unparent : Nil unparent, unrealize : Nil unrealize, unrealize_signal unrealize_signal, unset_state_flags(flags : Gtk::StateFlags) : Nil unset_state_flags, valign : Gtk::Align valign, valign=(align : Gtk::Align) : Nil valign=, vexpand : Bool vexpand, vexpand=(expand : Bool) : Nil vexpand=, vexpand? : Bool vexpand?, vexpand_set : Bool vexpand_set, vexpand_set=(set : Bool) : Nil vexpand_set=, vexpand_set? : Bool vexpand_set?, visible : Bool visible, visible=(visible : Bool) : Nil visible=, visible? : Bool visible?, width : Int32 width, width_request : Int32 width_request, width_request=(value : Int32) : Int32 width_request=

Constructor methods inherited from class Gtk::Widget

new
new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, focus_on_click : Bool | Nil = nil, focusable : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil)
new

Class methods inherited from class Gtk::Widget

default_direction : Gtk::TextDirection default_direction, default_direction=(dir : Gtk::TextDirection) : Nil default_direction=, g_type : UInt64 g_type

Instance methods inherited from module Gtk::ConstraintTarget

to_unsafe to_unsafe

Constructor methods inherited from module Gtk::ConstraintTarget

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::ConstraintTarget

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Buildable

buildable_id : String | Nil buildable_id, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::Buildable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Buildable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gtk::Accessible

accessible_role : Gtk::AccessibleRole accessible_role, accessible_role=(value : Gtk::AccessibleRole) : Gtk::AccessibleRole accessible_role=, reset_property(property : Gtk::AccessibleProperty) : Nil reset_property, reset_relation(relation : Gtk::AccessibleRelation) : Nil reset_relation, reset_state(state : Gtk::AccessibleState) : Nil reset_state, to_unsafe to_unsafe, update_property(properties : Enumerable(Gtk::AccessibleProperty), values : Enumerable(_)) : Nil update_property, update_relation(relations : Enumerable(Gtk::AccessibleRelation), values : Enumerable(_)) : Nil update_relation, update_state(states : Enumerable(Gtk::AccessibleState), values : Enumerable(_)) : Nil update_state

Constructor methods inherited from module Gtk::Accessible

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Accessible

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class GObject::InitiallyUnowned

==(other : self) ==, hash(hasher) hash

Constructor methods inherited from class GObject::InitiallyUnowned

new new

Class methods inherited from class GObject::InitiallyUnowned

g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new
new
, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Constructor Detail

def self.new : self #

Creates a new Gtk::Assistant.


[View source]
def self.new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, application : Gtk::Application | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, child : Gtk::Widget | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, decorated : Bool | Nil = nil, default_height : Int32 | Nil = nil, default_widget : Gtk::Widget | Nil = nil, default_width : Int32 | Nil = nil, deletable : Bool | Nil = nil, destroy_with_parent : Bool | Nil = nil, display : Gdk::Display | Nil = nil, focus_on_click : Bool | Nil = nil, focus_visible : Bool | Nil = nil, focus_widget : Gtk::Widget | Nil = nil, focusable : Bool | Nil = nil, fullscreened : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, handle_menubar_accel : Bool | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, hide_on_close : Bool | Nil = nil, icon_name : String | Nil = nil, is_active : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, maximized : Bool | Nil = nil, mnemonics_visible : Bool | Nil = nil, modal : Bool | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, pages : Gio::ListModel | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, resizable : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, startup_id : String | Nil = nil, title : String | Nil = nil, titlebar : Gtk::Widget | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, transient_for : Gtk::Window | Nil = nil, use_header_bar : Int32 | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def add_action_widget(child : Gtk::Widget) : Nil #

Adds a widget to the action area of a Gtk::Assistant.


[View source]
def append_page(page : Gtk::Widget) : Int32 #

Appends a page to the assistant.


[View source]
def apply_signal #

[View source]
def cancel_signal #

[View source]
def close_signal #

[View source]
def commit : Nil #

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.


[View source]
def current_page : Int32 #

Returns the page number of the current page.


[View source]
def current_page=(page_num : Int32) : 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().


[View source]
def escape_signal #

[View source]
def forward_page_func=(page_func : Gtk::AssistantPageFunc | Nil) : 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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def insert_page(page : Gtk::Widget, position : Int32) : Int32 #

Inserts a page in the assistant at a given position.


[View source]
def n_pages : Int32 #

Returns the number of pages in the assistant


[View source]
def 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.


[View source]
def nth_page(page_num : Int32) : Gtk::Widget | Nil #

Returns the child widget contained in page number page_num.


[View source]
def page(child : Gtk::Widget) : Gtk::AssistantPage #

Returns the Gtk::AssistantPage object for child.


[View source]
def page_complete(page : Gtk::Widget) : Bool #

Gets whether page is complete.


[View source]
def page_title(page : Gtk::Widget) : String #

Gets the title for page.


[View source]
def page_type(page : Gtk::Widget) : Gtk::AssistantPageType #

Gets the page type of page.


[View source]
def pages : Gio::ListModel #

Gets a list model of the assistant pages.


[View source]
def prepare_signal #

[View source]
def prepend_page(page : Gtk::Widget) : Int32 #

Prepends a page to the assistant.


[View source]
def 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.


[View source]
def remove_action_widget(child : Gtk::Widget) : Nil #

Removes a widget from the action area of a Gtk::Assistant.


[View source]
def remove_page(page_num : Int32) : Nil #

Removes the page_num’s page from assistant.


[View source]
def set_page_complete(page : Gtk::Widget, complete : Bool) : Nil #

Sets whether page contents are complete.

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


[View source]
def set_page_title(page : Gtk::Widget, title : String) : Nil #

Sets a title for page.

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


[View source]
def set_page_type(page : Gtk::Widget, type : Gtk::AssistantPageType) : Nil #

Sets the page type for page.

The page type determines the page behavior in the assistant.


[View source]
def 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.


[View source]
def use_header_bar : Int32 #

[View source]
def use_header_bar=(value : Int32) : Int32 #

[View source]