#include <ytk/gtkwindow.h>

Include dependency graph for gtkassistant.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	_GtkAssistant

struct	_GtkAssistantClass

Macros
#define	GTK_TYPE_ASSISTANT (gtk_assistant_get_type ())

#define	GTK_ASSISTANT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_ASSISTANT, GtkAssistant))

#define	GTK_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), GTK_TYPE_ASSISTANT, GtkAssistantClass))

#define	GTK_IS_ASSISTANT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_ASSISTANT))

#define	GTK_IS_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), GTK_TYPE_ASSISTANT))

#define	GTK_ASSISTANT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_ASSISTANT, GtkAssistantClass))

Typedefs
typedef struct _GtkAssistant	GtkAssistant

typedef struct _GtkAssistantPrivate	GtkAssistantPrivate

typedef struct _GtkAssistantClass	GtkAssistantClass

typedef gint(*	GtkAssistantPageFunc) (gint current_page, gpointer data)

Enumerations
enum	GtkAssistantPageType { GTK_ASSISTANT_PAGE_CONTENT , GTK_ASSISTANT_PAGE_INTRO , GTK_ASSISTANT_PAGE_CONFIRM , GTK_ASSISTANT_PAGE_SUMMARY , GTK_ASSISTANT_PAGE_PROGRESS }

Functions
GType	gtk_assistant_get_type (void) G_GNUC_CONST

GtkWidget *	gtk_assistant_new (void)

gint	gtk_assistant_get_current_page (GtkAssistant *assistant)

void	gtk_assistant_set_current_page (GtkAssistant *assistant, gint page_num)

gint	gtk_assistant_get_n_pages (GtkAssistant *assistant)

GtkWidget *	gtk_assistant_get_nth_page (GtkAssistant *assistant, gint page_num)

gint	gtk_assistant_prepend_page (GtkAssistant assistant, GtkWidget page)

gint	gtk_assistant_append_page (GtkAssistant assistant, GtkWidget page)

gint	gtk_assistant_insert_page (GtkAssistant assistant, GtkWidget page, gint position)

void	gtk_assistant_set_forward_page_func (GtkAssistant *assistant, GtkAssistantPageFunc page_func, gpointer data, GDestroyNotify destroy)

void	gtk_assistant_set_page_type (GtkAssistant assistant, GtkWidget page, GtkAssistantPageType type)

GtkAssistantPageType	gtk_assistant_get_page_type (GtkAssistant assistant, GtkWidget page)

void	gtk_assistant_set_page_title (GtkAssistant assistant, GtkWidget page, const gchar *title)

const gchar *	gtk_assistant_get_page_title (GtkAssistant assistant, GtkWidget page)

void	gtk_assistant_set_page_header_image (GtkAssistant assistant, GtkWidget page, GdkPixbuf *pixbuf)

GdkPixbuf *	gtk_assistant_get_page_header_image (GtkAssistant assistant, GtkWidget page)

void	gtk_assistant_set_page_side_image (GtkAssistant assistant, GtkWidget page, GdkPixbuf *pixbuf)

GdkPixbuf *	gtk_assistant_get_page_side_image (GtkAssistant assistant, GtkWidget page)

void	gtk_assistant_set_page_complete (GtkAssistant assistant, GtkWidget page, gboolean complete)

gboolean	gtk_assistant_get_page_complete (GtkAssistant assistant, GtkWidget page)

void	gtk_assistant_add_action_widget (GtkAssistant assistant, GtkWidget child)

void	gtk_assistant_remove_action_widget (GtkAssistant assistant, GtkWidget child)

void	gtk_assistant_update_buttons_state (GtkAssistant *assistant)

void	gtk_assistant_commit (GtkAssistant *assistant)

Macro Definition Documentation

◆ GTK_ASSISTANT

#define GTK_ASSISTANT ( o ) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_ASSISTANT, GtkAssistant))

Definition at line 38 of file gtkassistant.h.

◆ GTK_ASSISTANT_CLASS

#define GTK_ASSISTANT_CLASS ( c ) (G_TYPE_CHECK_CLASS_CAST ((c), GTK_TYPE_ASSISTANT, GtkAssistantClass))

Definition at line 39 of file gtkassistant.h.

◆ GTK_ASSISTANT_GET_CLASS

#define GTK_ASSISTANT_GET_CLASS ( o ) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_ASSISTANT, GtkAssistantClass))

Definition at line 42 of file gtkassistant.h.

◆ GTK_IS_ASSISTANT

#define GTK_IS_ASSISTANT ( o ) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_ASSISTANT))

Definition at line 40 of file gtkassistant.h.

◆ GTK_IS_ASSISTANT_CLASS

#define GTK_IS_ASSISTANT_CLASS ( c ) (G_TYPE_CHECK_CLASS_TYPE ((c), GTK_TYPE_ASSISTANT))

Definition at line 41 of file gtkassistant.h.

◆ GTK_TYPE_ASSISTANT

#define GTK_TYPE_ASSISTANT (gtk_assistant_get_type ())

Definition at line 37 of file gtkassistant.h.

Typedef Documentation

◆ GtkAssistant

typedef struct _GtkAssistant GtkAssistant

Definition at line 35 of file gtkassistant.h.

◆ GtkAssistantClass

typedef struct _GtkAssistantClass GtkAssistantClass

Definition at line 35 of file gtkassistant.h.

◆ GtkAssistantPageFunc

typedef gint(* GtkAssistantPageFunc) (gint current_page, gpointer data)

GtkAssistantPageFunc:

Parameters

current_page	The page number used to calculate the next page.
data	user data.

A function used by gtk_assistant_set_forward_page_func() to know which is the next page given a current one. It's called both for computing the next page when the user presses the "forward" button and for handling the behavior of the "last" button.

Returns: The next page number.

Definition at line 120 of file gtkassistant.h.

◆ GtkAssistantPrivate

typedef struct _GtkAssistantPrivate GtkAssistantPrivate

Definition at line 35 of file gtkassistant.h.

Enumeration Type Documentation

◆ GtkAssistantPageType

enum GtkAssistantPageType

GtkAssistantPageType:

Parameters

GTK_ASSISTANT_PAGE_CONTENT	The page has regular contents.
GTK_ASSISTANT_PAGE_INTRO	The page contains an introduction to the assistant task.
GTK_ASSISTANT_PAGE_CONFIRM	The page lets the user confirm or deny the changes.
GTK_ASSISTANT_PAGE_SUMMARY	The page informs the user of the changes done.
GTK_ASSISTANT_PAGE_PROGRESS	Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.

An enum for determining the page role inside the GtkAssistant. It's used to handle buttons sensitivity and visibility.

Note that an assistant needs to end its page flow with a page of type GTK_ASSISTANT_PAGE_CONFIRM, GTK_ASSISTANT_PAGE_SUMMARY or GTK_ASSISTANT_PAGE_PROGRESS to be correct.

Enumerator
GTK_ASSISTANT_PAGE_CONTENT
GTK_ASSISTANT_PAGE_INTRO
GTK_ASSISTANT_PAGE_CONFIRM
GTK_ASSISTANT_PAGE_SUMMARY
GTK_ASSISTANT_PAGE_PROGRESS

Definition at line 63 of file gtkassistant.h.

Function Documentation

◆ gtk_assistant_add_action_widget()

void gtk_assistant_add_action_widget	(	GtkAssistant *	assistant,
		GtkWidget *	child
	)

◆ gtk_assistant_append_page()

gint gtk_assistant_append_page	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_commit()

void gtk_assistant_commit ( GtkAssistant * assistant )

◆ gtk_assistant_get_current_page()

gint gtk_assistant_get_current_page ( GtkAssistant * assistant )

◆ gtk_assistant_get_n_pages()

gint gtk_assistant_get_n_pages ( GtkAssistant * assistant )

◆ gtk_assistant_get_nth_page()

GtkWidget* gtk_assistant_get_nth_page	(	GtkAssistant *	assistant,
		gint	page_num
	)

◆ gtk_assistant_get_page_complete()

gboolean gtk_assistant_get_page_complete	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_get_page_header_image()

GdkPixbuf* gtk_assistant_get_page_header_image	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_get_page_side_image()

GdkPixbuf* gtk_assistant_get_page_side_image	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_get_page_title()

const gchar* gtk_assistant_get_page_title	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_get_page_type()

GtkAssistantPageType gtk_assistant_get_page_type	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_get_type()

GType gtk_assistant_get_type ( void )

◆ gtk_assistant_insert_page()

gint gtk_assistant_insert_page	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		gint	position
	)

◆ gtk_assistant_new()

GtkWidget* gtk_assistant_new ( void )

◆ gtk_assistant_prepend_page()

gint gtk_assistant_prepend_page	(	GtkAssistant *	assistant,
		GtkWidget *	page
	)

◆ gtk_assistant_remove_action_widget()

void gtk_assistant_remove_action_widget	(	GtkAssistant *	assistant,
		GtkWidget *	child
	)

◆ gtk_assistant_set_current_page()

void gtk_assistant_set_current_page	(	GtkAssistant *	assistant,
		gint	page_num
	)

◆ gtk_assistant_set_forward_page_func()

void gtk_assistant_set_forward_page_func	(	GtkAssistant *	assistant,
		GtkAssistantPageFunc	page_func,
		gpointer	data,
		GDestroyNotify	destroy
	)

◆ gtk_assistant_set_page_complete()

void gtk_assistant_set_page_complete	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		gboolean	complete
	)

◆ gtk_assistant_set_page_header_image()

void gtk_assistant_set_page_header_image	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		GdkPixbuf *	pixbuf
	)

◆ gtk_assistant_set_page_side_image()

void gtk_assistant_set_page_side_image	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		GdkPixbuf *	pixbuf
	)

◆ gtk_assistant_set_page_title()

void gtk_assistant_set_page_title	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		const gchar *	title
	)

◆ gtk_assistant_set_page_type()

void gtk_assistant_set_page_type	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		GtkAssistantPageType	type
	)

◆ gtk_assistant_update_buttons_state()

void gtk_assistant_update_buttons_state ( GtkAssistant * assistant )

Classes

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ GTK_ASSISTANT

◆ GTK_ASSISTANT_CLASS

◆ GTK_ASSISTANT_GET_CLASS

◆ GTK_IS_ASSISTANT

◆ GTK_IS_ASSISTANT_CLASS

◆ GTK_TYPE_ASSISTANT

Typedef Documentation

◆ GtkAssistant

◆ GtkAssistantClass

◆ GtkAssistantPageFunc

◆ GtkAssistantPrivate

Enumeration Type Documentation

◆ GtkAssistantPageType

Function Documentation

◆ gtk_assistant_add_action_widget()

◆ gtk_assistant_append_page()

◆ gtk_assistant_commit()

◆ gtk_assistant_get_current_page()

◆ gtk_assistant_get_n_pages()

◆ gtk_assistant_get_nth_page()

◆ gtk_assistant_get_page_complete()

◆ gtk_assistant_get_page_header_image()

◆ gtk_assistant_get_page_side_image()

◆ gtk_assistant_get_page_title()

◆ gtk_assistant_get_page_type()

◆ gtk_assistant_get_type()

◆ gtk_assistant_insert_page()

◆ gtk_assistant_new()

◆ gtk_assistant_prepend_page()

◆ gtk_assistant_remove_action_widget()

◆ gtk_assistant_set_current_page()

◆ gtk_assistant_set_forward_page_func()

◆ gtk_assistant_set_page_complete()

◆ gtk_assistant_set_page_header_image()

◆ gtk_assistant_set_page_side_image()

◆ gtk_assistant_set_page_title()

◆ gtk_assistant_set_page_type()

◆ gtk_assistant_update_buttons_state()