gxkdialog.hh File Reference

#include "gxkutils.hh"

Go to the source code of this file.

Classes
struct	GxkDialog
struct	GxkDialogClass
Defines
#define	GXK_TYPE_DIALOG
#define	GXK_DIALOG(object)
#define	GXK_DIALOG_CLASS(klass)
#define	GXK_IS_DIALOG(object)
#define	GXK_IS_DIALOG_CLASS(klass)
#define	GXK_DIALOG_GET_CLASS(object)
#define	gxk_dialog_action(dialog, action, callback, data)
#define	gxk_dialog_default_action(dialog, action, callback, data)
#define	gxk_dialog_action_swapped(dialog, action, callback, data)
#define	gxk_dialog_default_action_swapped(dialog, action, callback, data)
Enumerations
enum	GxkDialogFlags {   GXK_DIALOG_HIDE_ON_DELETE, GXK_DIALOG_IGNORE_ESCAPE, GXK_DIALOG_DELETE_BUTTON, GXK_DIALOG_STATUS_BAR,   GXK_DIALOG_WINDOW_GROUP, GXK_DIALOG_MODAL, GXK_DIALOG_POPUP_POS, GXK_DIALOG_PRESERVE_STATE }
enum	GxkDialogMultiFlags { GXK_DIALOG_MULTI_DEFAULT, GXK_DIALOG_MULTI_SWAPPED }
Functions
GType	gxk_dialog_get_type (void)
gpointer	gxk_dialog_new (gpointer pointer_loc, GtkObject *alive_object, GxkDialogFlags flags, const gchar *title, GtkWidget *child)
gpointer	gxk_dialog_new_radget (gpointer pointer_loc, GtkObject *alive_object, GxkDialogFlags flags, const gchar *title, const gchar *domain_name, const gchar *radget_name)
void	gxk_dialog_set_sizes (GxkDialog *dialog, gint min_width, gint min_height, gint default_width, gint default_height)
void	gxk_dialog_set_title (GxkDialog *dialog, const gchar *title)
void	gxk_dialog_set_focus (GxkDialog *dialog, GtkWidget *widget)
void	gxk_dialog_set_default (GxkDialog *dialog, GtkWidget *widget)
void	gxk_dialog_set_child (GxkDialog *dialog, GtkWidget *child)
GtkWidget *	gxk_dialog_get_child (GxkDialog *dialog)
GxkDialog *	gxk_dialog_get_status_window (void)
void	gxk_dialog_add_flags (GxkDialog *dialog, GxkDialogFlags flags)
void	gxk_dialog_clear_flags (GxkDialog *dialog, GxkDialogFlags flags)
void	gxk_dialog_remove_actions (GxkDialog *dialog)
GtkWidget *	gxk_dialog_action_multi (GxkDialog *dialog, const gchar *action, gpointer callback, gpointer data, const gchar *icon_stock_id, GxkDialogMultiFlags multi_mode)

---

Detailed Description

---

Function Documentation

GtkWidget* gxk_dialog_action_multi	(	GxkDialog *	self,
		const gchar *	action,
		gpointer	callback,
		gpointer	data,
		const gchar *	icon_stock_id,
		GxkDialogMultiFlags	multi_mode
	)

Parameters:

dialog	valid GxkDialog
action	button label or stock ID
callback	callback function for button activation
data	callback data

Add a new (stock) button to a dialog.

void gxk_dialog_add_flags	(	GxkDialog *	dialog,
		GxkDialogFlags	flags
	)

Parameters:

dialog	valid GxkDialog
flags	additional flags to set on the dialog.

Alter dialog flags, see gxk_dialog_new().

void gxk_dialog_clear_flags	(	GxkDialog *	dialog,
		GxkDialogFlags	flags
	)

Parameters:

dialog	valid GxkDialog
flags	flags to unset on the dialog.

Alter dialog flags, see gxk_dialog_new().

GtkWidget* gxk_dialog_get_child

(

GxkDialog *

dialog

)

Parameters:

dialog

valid GxkDialog

Retrieve the primary child of the dialog.

GxkDialog* gxk_dialog_get_status_window

(

void

)

Returns:

a valid GxkDialog or NULL

Retrieve the most recently entered GxkDialog if any.

gpointer gxk_dialog_new	(	gpointer	pointer_loc,
		GtkObject *	alive_object,
		GxkDialogFlags	flags,
		const gchar *	title,
		GtkWidget *	child
	)

Parameters:

pointer_loc	pointer to nullify upon dialog destruction
alive_object	object which upon destruction, takes the dialog with it
flags	dialog flags
title	window title for the dialog
child	child to pack into the dialog

Create a new configurable dialog. Possible values for the flags are:

• GXK_DIALOG_HIDE_ON_DELETE - only hide and not destroy the dialog upon window manager delete events;
• GXK_DIALOG_IGNORE_ESCAPE - prevents delete event generation on Escape key presses;
• GXK_DIALOG_DELETE_BUTTON - add a "Close" button to the dialog;
• GXK_DIALOG_STATUS_BAR - add a status bar widget to the dialog;
• GXK_DIALOG_WINDOW_GROUP - open up an extra window group for the dialog;
• GXK_DIALOG_MODAL - the dialog is modal while visible;
• GXK_DIALOG_POPUP_POS - popup the dialog below mouse pointer;
• GXK_DIALOG_PRESERVE_STATE - prevents unrealization of the dialog upon hiding, which preserves properties like the window size.

void gxk_dialog_remove_actions

(

GxkDialog *

dialog

)

Parameters:

dialog

valid GxkDialog

Remove all action buttons setup for this dialog.

void gxk_dialog_set_child	(	GxkDialog *	dialog,
		GtkWidget *	child
	)

Parameters:

dialog	valid GxkDialog
child	new child

Change the dialog's primary child to child. Destroys the old child if any.

void gxk_dialog_set_default	(	GxkDialog *	self,
		GtkWidget *	default_widget
	)

Parameters:

dialog	valid GxkDialog
default_widget	valid GtkWidget

This function is similar to gxk_dialog_set_focus(), it just affects the widget taking the default activation.

void gxk_dialog_set_focus	(	GxkDialog *	self,
		GtkWidget *	focus_widget
	)

Parameters:

dialog	valid GxkDialog
focus_widget	valid GtkWidget

A GxkDialog will automatically unset the focus everytime it is shown, unless focus_widget is a valid widget that can be focused each time.

void gxk_dialog_set_sizes	(	GxkDialog *	dialog,
		gint	min_width,
		gint	min_height,
		gint	default_width,
		gint	default_height
	)

Parameters:

dialog	valid GxkDialog
min_width	minimum dialog width or -1
min_height	minimum dialog height or -1
default_width	default dialog width or -1
default_height	default dialog height or -1

Set the dialog's minimum and default sizes, constrained to not exceed the screen dimensions.

void gxk_dialog_set_title	(	GxkDialog *	dialog,
		const gchar *	title
	)

Parameters:

dialog	valid GxkDialog
title	dialog window manager title

Change the dialog's window manager title and role.