Index

Package: Assistant

Description

package Gtk.Assistant is
A Gtk_Assistant is a widget used to represent a generally complex operation split into several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.

Binding from C File version 2.16.6

<testgtk>create_assistant.adb</testgtk>

Packages

Generic_Assistant_Functions (generic)

Full description

Classes

Gtk_Assistant_Record 

type Gtk_Assistant_Record is new Gtk.Window.Gtk_Window_Record with private;

Ancestors:

Primitive operations:

Add_Action_Widget
Get_Current_Page
Get_Nth_Page
Get_Page_Complete
Get_Page_Header_Image
Get_Page_Side_Image
Get_Page_Title
Get_Page_Type
Glib.Object.Deallocate (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (Inherited)
Glib.Object.Ref_Sink (Inherited)
Glib.Object.Unref (Inherited)
Gtk.Bin.Get_Child (Inherited)
Gtk.Container.Add (Inherited)
Gtk.Container.Check_Resize (Inherited)
Gtk.Container.Child_Get_Property (Inherited)
Gtk.Container.Child_Set_Property (Inherited)
Gtk.Container.Child_Type (Inherited)
Gtk.Container.Forall (Inherited)
Gtk.Container.Foreach (Inherited)
Gtk.Container.Get_Border_Width (Inherited)
Gtk.Container.Get_Children (Inherited)
Gtk.Container.Get_Focus_Chain (Inherited)
Gtk.Container.Get_Focus_Child (Inherited)
Gtk.Container.Get_Focus_Hadjustment (Inherited)
Gtk.Container.Get_Focus_Vadjustment (Inherited)
Gtk.Container.Get_Resize_Mode (Inherited)
Gtk.Container.Propagate_Expose (Inherited)
Gtk.Container.Remove (Inherited)
Gtk.Container.Resize_Children (Inherited)
Gtk.Container.Set_Border_Width (Inherited)
Gtk.Container.Set_Focus_Chain (Inherited)
Gtk.Container.Set_Focus_Child (Inherited)
Gtk.Container.Set_Focus_Hadjustment (Inherited)
Gtk.Container.Set_Focus_Vadjustment (Inherited)
Gtk.Container.Set_Reallocate_Redraws (Inherited)
Gtk.Container.Set_Resize_Mode (Inherited)
Gtk.Container.Unset_Focus_Chain (Inherited)
Gtk.Object.Destroy (Inherited)
Gtk.Object.Flag_Is_Set (Inherited)
Gtk.Object.Flags (Inherited)
Gtk.Object.Get_Type (Inherited)
Gtk.Object.Set_Flags (Inherited)
Gtk.Object.Sink (Inherited)
Gtk.Object.Unset_Flags (Inherited)
Gtk.Widget.Activate (Inherited)
Gtk.Widget.Add_Accelerator (Inherited)
Gtk.Widget.Add_Events (Inherited)
Gtk.Widget.Add_Mnemonic_Label (Inherited)
Gtk.Widget.Can_Activate_Accel (Inherited)
Gtk.Widget.Child_Notify (Inherited)
Gtk.Widget.Class_Path (Inherited)
Gtk.Widget.Class_Path_Reversed (Inherited)
Gtk.Widget.Create_Pango_Context (Inherited)
Gtk.Widget.Create_Pango_Layout (Inherited)
Gtk.Widget.Draw (Inherited)
Gtk.Widget.Ensure_Style (Inherited)
Gtk.Widget.Error_Bell (Inherited)
Gtk.Widget.Freeze_Child_Notify (Inherited)
Gtk.Widget.Get_Allocation_Height (Inherited)
Gtk.Widget.Get_Allocation_Width (Inherited)
Gtk.Widget.Get_Allocation_X (Inherited)
Gtk.Widget.Get_Allocation_Y (Inherited)
Gtk.Widget.Get_Ancestor (Inherited)
Gtk.Widget.Get_Child_Requisition (Inherited)
Gtk.Widget.Get_Child_Visible (Inherited)
Gtk.Widget.Get_Colormap (Inherited)
Gtk.Widget.Get_Composite_Name (Inherited)
Gtk.Widget.Get_Direction (Inherited)
Gtk.Widget.Get_Events (Inherited)
Gtk.Widget.Get_Extension_Events (Inherited)
Gtk.Widget.Get_Has_Tooltip (Inherited)
Gtk.Widget.Get_Name (Inherited)
Gtk.Widget.Get_No_Show_All (Inherited)
Gtk.Widget.Get_Pango_Context (Inherited)
Gtk.Widget.Get_Parent (Inherited)
Gtk.Widget.Get_Parent_Window (Inherited)
Gtk.Widget.Get_Pointer (Inherited)
Gtk.Widget.Get_Root_Window (Inherited)
Gtk.Widget.Get_Size_Request (Inherited)
Gtk.Widget.Get_Snapshot (Inherited)
Gtk.Widget.Get_State (Inherited)
Gtk.Widget.Get_Style (Inherited)
Gtk.Widget.Get_Tooltip_Markup (Inherited)
Gtk.Widget.Get_Tooltip_Text (Inherited)
Gtk.Widget.Get_Tooltip_Window (Inherited)
Gtk.Widget.Get_Toplevel (Inherited)
Gtk.Widget.Get_Visual (Inherited)
Gtk.Widget.Get_Window (Inherited)
Gtk.Widget.Grab_Default (Inherited)
Gtk.Widget.Grab_Focus (Inherited)
Gtk.Widget.Has_Screen (Inherited)
Gtk.Widget.Hide (Inherited)
Gtk.Widget.Hide_All (Inherited)
Gtk.Widget.Input_Shape_Combine_Mask (Inherited)
Gtk.Widget.Intersect (Inherited)
Gtk.Widget.Is_Ancestor (Inherited)
Gtk.Widget.Is_Composited (Inherited)
Gtk.Widget.Is_Focus (Inherited)
Gtk.Widget.Keynav_Failed (Inherited)
Gtk.Widget.List_Mnemonic_Labels (Inherited)
Gtk.Widget.Map (Inherited)
Gtk.Widget.Mnemonic_Activate (Inherited)
Gtk.Widget.Modify_Base (Inherited)
Gtk.Widget.Modify_Bg (Inherited)
Gtk.Widget.Modify_Cursor (Inherited)
Gtk.Widget.Modify_Fg (Inherited)
Gtk.Widget.Modify_Font (Inherited)
Gtk.Widget.Modify_Text (Inherited)
Gtk.Widget.Path (Inherited)
Gtk.Widget.Path_Reversed (Inherited)
Gtk.Widget.Queue_Clear (Inherited)
Gtk.Widget.Queue_Clear_Area (Inherited)
Gtk.Widget.Queue_Draw (Inherited)
Gtk.Widget.Queue_Draw_Area (Inherited)
Gtk.Widget.Queue_Resize (Inherited)
Gtk.Widget.Queue_Resize_No_Redraw (Inherited)
Gtk.Widget.Realize (Inherited)
Gtk.Widget.Region_Intersect (Inherited)
Gtk.Widget.Remove_Accelerator (Inherited)
Gtk.Widget.Remove_Mnemonic_Label (Inherited)
Gtk.Widget.Render_Icon (Inherited)
Gtk.Widget.Reparent (Inherited)
Gtk.Widget.Reset_Rc_Styles (Inherited)
Gtk.Widget.Reset_Shapes (Inherited)
Gtk.Widget.Restore_Default_Style (Inherited)
Gtk.Widget.Send_Expose (Inherited)
Gtk.Widget.Set_Accel_Path (Inherited)
Gtk.Widget.Set_App_Paintable (Inherited)
Gtk.Widget.Set_Child_Visible (Inherited)
Gtk.Widget.Set_Colormap (Inherited)
Gtk.Widget.Set_Composite_Name (Inherited)
Gtk.Widget.Set_Direction (Inherited)
Gtk.Widget.Set_Double_Buffered (Inherited)
Gtk.Widget.Set_Events (Inherited)
Gtk.Widget.Set_Extension_Events (Inherited)
Gtk.Widget.Set_Has_Tooltip (Inherited)
Gtk.Widget.Set_Name (Inherited)
Gtk.Widget.Set_No_Show_All (Inherited)
Gtk.Widget.Set_Parent (Inherited)
Gtk.Widget.Set_Parent_Window (Inherited)
Gtk.Widget.Set_Redraw_On_Allocate (Inherited)
Gtk.Widget.Set_Scroll_Adjustments (Inherited)
Gtk.Widget.Set_Sensitive (Inherited)
Gtk.Widget.Set_Size_Request (Inherited)
Gtk.Widget.Set_State (Inherited)
Gtk.Widget.Set_Style (Inherited)
Gtk.Widget.Set_Tooltip_Markup (Inherited)
Gtk.Widget.Set_Tooltip_Text (Inherited)
Gtk.Widget.Set_Tooltip_Window (Inherited)
Gtk.Widget.Set_UPosition (Inherited)
Gtk.Widget.Set_USize (Inherited)
Gtk.Widget.Set_Window (Inherited)
Gtk.Widget.Shape_Combine_Mask (Inherited)
Gtk.Widget.Show (Inherited)
Gtk.Widget.Show_All (Inherited)
Gtk.Widget.Show_Now (Inherited)
Gtk.Widget.Size_Allocate (Inherited)
Gtk.Widget.Size_Request (Inherited)
Gtk.Widget.Style_Get_Property (Inherited)
Gtk.Widget.Thaw_Child_Notify (Inherited)
Gtk.Widget.Trigger_Tooltip_Query (Inherited)
Gtk.Widget.Unmap (Inherited)
Gtk.Widget.Unrealize (Inherited)
Gtk.Window.Activate_Default (Inherited)
Gtk.Window.Activate_Focus (Inherited)
Gtk.Window.Activate_Key (Inherited)
Gtk.Window.Add_Accel_Group (Inherited)
Gtk.Window.Add_Mnemonic (Inherited)
Gtk.Window.Begin_Move_Drag (Inherited)
Gtk.Window.Begin_Resize_Drag (Inherited)
Gtk.Window.Deiconify (Inherited)
Gtk.Window.Fullscreen (Inherited)
Gtk.Window.Get_Accept_Focus (Inherited)
Gtk.Window.Get_Decorated (Inherited)
Gtk.Window.Get_Default_Size (Inherited)
Gtk.Window.Get_Default_Widget (Inherited)
Gtk.Window.Get_Deletable (Inherited)
Gtk.Window.Get_Destroy_With_Parent (Inherited)
Gtk.Window.Get_Focus (Inherited)
Gtk.Window.Get_Focus_On_Map (Inherited)
Gtk.Window.Get_Frame_Dimensions (Inherited)
Gtk.Window.Get_Gravity (Inherited)
Gtk.Window.Get_Group (Inherited)
Gtk.Window.Get_Has_Frame (Inherited)
Gtk.Window.Get_Icon (Inherited)
Gtk.Window.Get_Icon_List (Inherited)
Gtk.Window.Get_Icon_Name (Inherited)
Gtk.Window.Get_Mnemonic_Modifier (Inherited)
Gtk.Window.Get_Modal (Inherited)
Gtk.Window.Get_Opacity (Inherited)
Gtk.Window.Get_Position (Inherited)
Gtk.Window.Get_Resizable (Inherited)
Gtk.Window.Get_Role (Inherited)
Gtk.Window.Get_Size (Inherited)
Gtk.Window.Get_Skip_Pager_Hint (Inherited)
Gtk.Window.Get_Skip_Taskbar_Hint (Inherited)
Gtk.Window.Get_Title (Inherited)
Gtk.Window.Get_Transient_For (Inherited)
Gtk.Window.Get_Type_Hint (Inherited)
Gtk.Window.Get_Urgency_Hint (Inherited)
Gtk.Window.Has_Toplevel_Focus (Inherited)
Gtk.Window.Iconify (Inherited)
Gtk.Window.Is_Active (Inherited)
Gtk.Window.Maximize (Inherited)
Gtk.Window.Mnemonic_Activate (Inherited)
Gtk.Window.Move (Inherited)
Gtk.Window.Parse_Geometry (Inherited)
Gtk.Window.Present (Inherited)
Gtk.Window.Present_With_Time (Inherited)
Gtk.Window.Propagate_Key_Event (Inherited)
Gtk.Window.Remove_Accel_Group (Inherited)
Gtk.Window.Remove_Mnemonic (Inherited)
Gtk.Window.Reshow_With_Initial_Size (Inherited)
Gtk.Window.Resize (Inherited)
Gtk.Window.Set_Accept_Focus (Inherited)
Gtk.Window.Set_Decorated (Inherited)
Gtk.Window.Set_Default (Inherited)
Gtk.Window.Set_Default_Size (Inherited)
Gtk.Window.Set_Deletable (Inherited)
Gtk.Window.Set_Destroy_With_Parent (Inherited)
Gtk.Window.Set_Focus (Inherited)
Gtk.Window.Set_Focus_On_Map (Inherited)
Gtk.Window.Set_Frame_Dimensions (Inherited)
Gtk.Window.Set_Geometry_Hints (Inherited)
Gtk.Window.Set_Gravity (Inherited)
Gtk.Window.Set_Has_Frame (Inherited)
Gtk.Window.Set_Icon (Inherited)
Gtk.Window.Set_Icon_From_File (Inherited)
Gtk.Window.Set_Icon_List (Inherited)
Gtk.Window.Set_Icon_Name (Inherited)
Gtk.Window.Set_Keep_Above (Inherited)
Gtk.Window.Set_Keep_Below (Inherited)
Gtk.Window.Set_Mnemonic_Modifier (Inherited)
Gtk.Window.Set_Modal (Inherited)
Gtk.Window.Set_Opacity (Inherited)
Gtk.Window.Set_Policy (Inherited)
Gtk.Window.Set_Position (Inherited)
Gtk.Window.Set_Resizable (Inherited)
Gtk.Window.Set_Role (Inherited)
Gtk.Window.Set_Skip_Pager_Hint (Inherited)
Gtk.Window.Set_Skip_Taskbar_Hint (Inherited)
Gtk.Window.Set_Startup_Id (Inherited)
Gtk.Window.Set_Title (Inherited)
Gtk.Window.Set_Transient_For (Inherited)
Gtk.Window.Set_Type_Hint (Inherited)
Gtk.Window.Set_Urgency_Hint (Inherited)
Gtk.Window.Set_Wmclass (Inherited)
Gtk.Window.Stick (Inherited)
Gtk.Window.Unfullscreen (Inherited)
Gtk.Window.Unmaximize (Inherited)
Gtk.Window.Unstick (Inherited)
Prepend_Page
Remove_Action_Widget
Set_Current_Page
Set_Page_Complete
Set_Page_Header_Image
Set_Page_Side_Image
Set_Page_Title
Set_Page_Type
Update_Buttons_State

Types

Gtk_Assistant 

type Gtk_Assistant is access all Gtk_Assistant_Record'Class;

Gtk_Assistant_Page_Type 

type Gtk_Assistant_Page_Type is
     (Gtk_Assistant_Page_Content,
      Gtk_Assistant_Page_Intro,
      Gtk_Assistant_Page_Confirm,
      Gtk_Assistant_Page_Summary,
      Gtk_Assistant_Page_Progress);
Definition of various page types. See Get_Page_Type/Set_Page_Type for more info.

Constants & Global variables

Complete_Property (Glib.Properties.Property_Boolean) 

Complete_Property      : constant Glib.Properties.Property_Boolean;

Header_Image_Property (Glib.Properties.Property_Object) 

Header_Image_Property  : constant Glib.Properties.Property_Object;

Page_Type_Property (Glib.Properties.Property_Enum) 

Page_Type_Property     : constant Glib.Properties.Property_Enum;

Sidebar_Image_Property (Glib.Properties.Property_Object) 

Sidebar_Image_Property : constant Glib.Properties.Property_Object;

Title_Property (Glib.Properties.Property_String) 

Title_Property         : constant Glib.Properties.Property_String;

Content_Padding_Property (Glib.Properties.Property_Int) 

Content_Padding_Property : constant Glib.Properties.Property_Int;

Header_Padding_Property (Glib.Properties.Property_Int) 

Header_Padding_Property  : constant Glib.Properties.Property_Int;

Subprograms & Entries

Gtk_New 

procedure Gtk_New 
(Widget: out Gtk_Assistant);

Initialize 

procedure Initialize 
(Widget: access Gtk_Assistant_Record'Class);
Creates a new Gtk_Assistant.

Add_Action_Widget 

procedure Add_Action_Widget 
(Assistant: access Gtk_Assistant_Record;
Child: access Gtk_Widget_Record'Class);
Adds a widget to the action area of a Gtk_Assistant.

Append_Page 

function Append_Page 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return Gint;
Appends a page to the Assistant. Return value: the index (starting at 0) of the inserted page

Get_Current_Page 

function Get_Current_Page 
(Assistant: access Gtk_Assistant_Record) return Gint;
Returns the index (starting from 0) of the current page in the Assistant. If the Assistant has no pages, -1 will be returned

Get_N_Pages 

function Get_N_Pages 
(Assistant: access Gtk_Assistant_Record) return Gint;
Returns the number of pages in the Assistant

Get_Nth_Page 

function Get_Nth_Page 
(Assistant: access Gtk_Assistant_Record;
Page_Num: Gint) return Gtk_Widget;
Assistant: a Gtk_Assistant Page_Num: The index of a page in the Assistant, or -1 to get the last page Returns the child widget contained in page number Page_Num, or null if Page_Num is out of bounds.

Get_Page_Complete 

function Get_Page_Complete 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return Boolean;
Returns whether Page is complete.

Get_Page_Header_Image 

function Get_Page_Header_Image 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return Gdk_Pixbuf;
Gets the header image for Page. Returns null if there's no header image for the page.

Get_Page_Side_Image 

function Get_Page_Side_Image 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return Gdk_Pixbuf;
Gets the side image for Page. Returns null if there's no side image for the page.

Get_Page_Title 

function Get_Page_Title 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return String;
Gets the title for Page.

Get_Page_Type 

function Get_Page_Type 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return Gtk_Assistant_Page_Type;
Gets the page type of Page.

Get_Type 

function Get_Type return GType;
Return the internal value associated with a Gtk_Assistant.

Insert_Page 

function Insert_Page 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class;
Position: Gint) return Gint;
Assistant: a Gtk_Assistant Page: a Gtk_Widget Position: the index (starting at 0) at which to insert the page, or -1 to append the page to the Assistant Inserts a page in the Assistant at a given position. Return value: the index (starting from 0) of the inserted page

Prepend_Page 

function Prepend_Page 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class) return Gint;
Prepends a page to the Assistant. Return value: the index (starting at 0) of the inserted page

Remove_Action_Widget 

procedure Remove_Action_Widget 
(Assistant: access Gtk_Assistant_Record;
Child: access Gtk_Widget_Record'Class);
Removes a widget from the action area of a Gtk_Assistant.

Set_Current_Page 

procedure Set_Current_Page 
(Assistant: access Gtk_Assistant_Record;
Page_Num: Gint);
Assistant: a Gtk_Assistant Page_Num: 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. Switches the page to Page_Num. Note that this will only be necessary in custom buttons, as the Assistant flow can be set with Set_Forward_Page_Func.

Set_Page_Complete 

procedure Set_Page_Complete 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class;
Complete: Boolean);
Sets whether Page contents are complete. This will make Assistant update the buttons' state to be able to continue the task.

Set_Page_Header_Image 

procedure Set_Page_Header_Image 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class;
Pixbuf: Gdk_Pixbuf);
Sets a header image for Page. This image is displayed in the header area of the assistant when Page is the current page.

Set_Page_Side_Image 

procedure Set_Page_Side_Image 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class;
Pixbuf: Gdk_Pixbuf);
Sets a side image for Page. This image is displayed in the side area of the assistant when Page is the current page.

Set_Page_Title 

procedure Set_Page_Title 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class;
Title: String);
Sets a title for Page. The title is displayed in the header area of the assistant when Page is the current page.

Set_Page_Type 

procedure Set_Page_Type 
(Assistant: access Gtk_Assistant_Record;
Page: access Gtk_Widget_Record'Class;
Page_Type: Gtk_Assistant_Page_Type);
Sets the page type for Page. The page type determines the page behavior in the Assistant.

Update_Buttons_State 

procedure Update_Buttons_State 
(Assistant: access Gtk_Assistant_Record);
Forces Assistant to recompute the state of the buttons. 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.