GXK Interface Reference

/opt/src/beast/beast-gtk/gxk/gxkdialog.h

SYNOPSIS

struct  _GxkDialog;
struct  _GxkDialogClass;
   
GtkWidget*  gxk_dialog_action_multi  (dialog, action, callback, data, icon_stock_id, multi_mode);
void  gxk_dialog_add_flags  (dialog, flags);
void  gxk_dialog_clear_flags  (dialog, flags);
GtkWidget*  gxk_dialog_get_child  (dialog);
GxkDialog*  gxk_dialog_get_status_window  ();
GType  gxk_dialog_get_type  ();
gpointer  gxk_dialog_new  (pointer_loc, alive_object, flags, title, child);
gpointer  gxk_dialog_new_radget  (pointer_loc, alive_object, flags, title, domain_name, radget_name);
void  gxk_dialog_remove_actions  (dialog);
void  gxk_dialog_set_child  (dialog, child);
void  gxk_dialog_set_default  (dialog, widget);
void  gxk_dialog_set_focus  (dialog, widget);
void  gxk_dialog_set_sizes  (dialog, min_width, min_height, default_width, default_height);
void  gxk_dialog_set_title  (dialog, title);

DESCRIPTION

_GxkDialog

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:51
struct _GxkDialog
{
  GtkWindow      window;
  GtkWidget     *vbox;
  GtkObject     *alive_object;
  GxkDialogFlags flags;
  gpointer      *pointer_loc;
  GtkWidget     *status_bar;
  GtkWidget     *default_widget;
  GtkWidget     *focus_widget;
  GtkWidget     *sep;
  GtkWidget     *hbox;
  GtkWidget     *mbox;
  GtkWidget     *child;
};

_GxkDialogClass

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:69
struct _GxkDialogClass
{
  GtkWindowClass parent_class;
};

gxk_dialog_action_multi

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:128
GtkWidget*  gxk_dialog_action_multi  
(GxkDialog          *dialog,
 const gchar        *action,
 gpointer            callback,
 gpointer            data,
 const gchar        *icon_stock_id,
 GxkDialogMultiFlags multi_mode);
Add a new (stock) button to a dialog.
dialog: valid GxkDialog
action: button label or stock ID
callback: callback function for button activation
data: callback data

gxk_dialog_add_flags

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:103
void  gxk_dialog_add_flags  
(GxkDialog     *dialog,
 GxkDialogFlags flags);
Alter dialog flags, see gxk_dialog_new().
dialog: valid GxkDialog
flags: additional flags to set on the dialog.

gxk_dialog_clear_flags

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:105
void  gxk_dialog_clear_flags  
(GxkDialog     *dialog,
 GxkDialogFlags flags);
Alter dialog flags, see gxk_dialog_new().
dialog: valid GxkDialog
flags: flags to unset on the dialog.

gxk_dialog_get_child

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:100
GtkWidget*  gxk_dialog_get_child  
(GxkDialog *dialog);
Retrieve the primary child of the dialog.
dialog: valid GxkDialog

gxk_dialog_get_status_window

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:101
GxkDialog*  gxk_dialog_get_status_window  
();
Retrieve the most recently entered GxkDialog if any.
RETURNS: a valid GxkDialog or NULL

gxk_dialog_get_type

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:75
GType  gxk_dialog_get_type  
();

gxk_dialog_new

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:80
gpointer  gxk_dialog_new  
(gpointer       pointer_loc,
 GtkObject     *alive_object,
 GxkDialogFlags flags,
 const gchar   *title,
 GtkWidget     *child);
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.
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

gxk_dialog_new_radget

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:86
gpointer  gxk_dialog_new_radget  
(gpointer       pointer_loc,
 GtkObject     *alive_object,
 GxkDialogFlags flags,
 const gchar   *title,
 const gchar   *domain_name,
 const gchar   *radget_name);

gxk_dialog_remove_actions

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:106
void  gxk_dialog_remove_actions  
(GxkDialog *dialog);
Remove all action buttons setup for this dialog.
dialog: valid GxkDialog

gxk_dialog_set_child

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:99
void  gxk_dialog_set_child  
(GxkDialog *dialog,
 GtkWidget *child);
Change the dialog's primary child to child. Destroys the old child if any.
dialog: valid GxkDialog
child: new child

gxk_dialog_set_default

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:97
void  gxk_dialog_set_default  
(GxkDialog *dialog,
 GtkWidget *widget);
This function is similar to gxk_dialog_set_focus(), it just affects the widget taking the default activation.
dialog: valid GxkDialog
default_widget: valid GtkWidget

gxk_dialog_set_focus

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:95
void  gxk_dialog_set_focus  
(GxkDialog *dialog,
 GtkWidget *widget);
A GxkDialog will automatically unset the focus everytime it is shown, unless focus_widget is a valid widget that can be focused each time.
dialog: valid GxkDialog
focus_widget: valid GtkWidget

gxk_dialog_set_sizes

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:91
void  gxk_dialog_set_sizes  
(GxkDialog *dialog,
 gint       min_width,
 gint       min_height,
 gint       default_width,
 gint       default_height);
Set the dialog's minimum and default sizes, constrained to not exceed the screen dimensions.
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

gxk_dialog_set_title

 /opt/src/beast/beast-gtk/gxk/gxkdialog.h:93
void  gxk_dialog_set_title  
(GxkDialog   *dialog,
 const gchar *title);
Change the dialog's window manager title and role.
dialog: valid GxkDialog
title: dialog window manager title