GXK Interface Reference

/opt/src/beast/beast-gtk/bstutils.h

SYNOPSIS

void  _bst_init_radgets  ();
void  _bst_init_utils  ();
void  bst_action_list_add_cat  (alist, cat, skip_levels, stock_fallback, acheck, aexec, user_data);
GxkActionList*  bst_action_list_from_cats  (cseq, skip_levels, stock_fallback, acheck, aexec, user_data);
GxkActionList*  bst_action_list_from_cats_pred  (cseq, skip_levels, stock_fallback, acheck, aexec, user_data, predicate, predicate_data);
void  bst_background_handler1_add  (handler, data, free_func);
void  bst_background_handler2_add  (handler, data, free_func);
GtkWidget*  bst_container_get_named_child  (container, qname);
void  bst_container_set_named_child  (container, qname, child);
BstFFTSize  bst_fft_size_from_int  (sz);
gint  bst_fft_size_to_int  (fft_size);
gchar*  bst_file_scan_find_key  (file, key, value_prefix);
BstGConfig*  bst_gconfig_get_global  ();
GtkWidget*  bst_gmask_container_create  (border_width, dislodge_columns);
void  bst_gmask_foreach  (mask, func, data);
BstGMask*  bst_gmask_form  (gmask_container, action, gpack);
GtkWidget*  bst_gmask_get_action  (mask);
GtkWidget*  bst_gmask_get_aux1  (mask);
GtkWidget*  bst_gmask_get_aux2  (mask);
GtkWidget*  bst_gmask_get_aux3  (mask);
GtkWidget*  bst_gmask_get_prompt  (mask);
void  bst_gmask_pack  (mask);
BstGMask*  bst_gmask_quick  (gmask_container, column, prompt, action, tip_text);
void  bst_gmask_set_aux1  (mask, widget);
void  bst_gmask_set_aux2  (mask, widget);
void  bst_gmask_set_aux3  (mask, widget);
void  bst_gmask_set_column  (mask, column);
void  bst_gmask_set_prompt  (mask, widget);
void  bst_gmask_set_tip  (mask, tip_text);
 void void  bst_gui_error_bell  (widget);
GtkWidget*  bst_hpack  (first_location, ...);
GtkWidget*  bst_hpack0  (first_location, ...);
 void  bst_status_eprintf  (error, message_fmt, ...);
GtkWidget*  bst_stock_button  (stock_id);
GtkWidget*  bst_stock_dbutton  (stock_id);
GtkWidget*  bst_stock_icon_button  (stock_id);
void  bst_stock_register_icon  (stock_id, bytes_per_pixel, width, height, rowstride, pixels);
GtkWidget*  bst_vpack  (first_location, ...);
GtkWidget*  bst_vpack0  (first_location, ...);
void  bst_window_sync_title_to_proxy  (window, proxy, title_format);
GtkWidget*  bst_xpm_view_create  (xpm, colormap_widget);

DESCRIPTION

_bst_init_radgets

 /opt/src/beast/beast-gtk/bstutils.h:235
void  _bst_init_radgets  
();

_bst_init_utils

 /opt/src/beast/beast-gtk/bstutils.h:234
void  _bst_init_utils  
();

bst_action_list_add_cat

 /opt/src/beast/beast-gtk/bstutils.h:58
void  bst_action_list_add_cat  
(GxkActionList *alist,
 BseCategory   *cat,
 guint          skip_levels,
 const gchar   *stock_fallback,
 GxkActionCheck acheck,
 GxkActionExec  aexec,
 gpointer       user_data);

bst_action_list_from_cats

 /opt/src/beast/beast-gtk/bstutils.h:64
GxkActionList*  bst_action_list_from_cats  
(BseCategorySeq *cseq,
 guint           skip_levels,
 const gchar    *stock_fallback,
 GxkActionCheck  acheck,
 GxkActionExec   aexec,
 gpointer        user_data);

bst_action_list_from_cats_pred

 /opt/src/beast/beast-gtk/bstutils.h:74
GxkActionList*  bst_action_list_from_cats_pred  
(BseCategorySeq        *cseq,
 guint                  skip_levels,
 const gchar           *stock_fallback,
 GxkActionCheck         acheck,
 GxkActionExec          aexec,
 gpointer               user_data,
 BstActionListCategoryP predicate,
 gpointer               predicate_data);

bst_background_handler1_add

 /opt/src/beast/beast-gtk/bstutils.h:77
void  bst_background_handler1_add  
(gboolean(*)(gpointer data )handler,
 gpointer                   data,
 void(*)(gpointer data     )free_func);

bst_background_handler2_add

 /opt/src/beast/beast-gtk/bstutils.h:80
void  bst_background_handler2_add  
(gboolean(*)(gpointer data )handler,
 gpointer                   data,
 void(*)(gpointer data     )free_func);

bst_container_get_named_child

 /opt/src/beast/beast-gtk/bstutils.h:41
GtkWidget*  bst_container_get_named_child  
(GtkWidget *container,
 GQuark     qname);

bst_container_set_named_child

 /opt/src/beast/beast-gtk/bstutils.h:39
void  bst_container_set_named_child  
(GtkWidget *container,
 GQuark     qname,
 GtkWidget *child);

bst_fft_size_from_int

 /opt/src/beast/beast-gtk/bstutils.h:101
BstFFTSize  bst_fft_size_from_int  
(guint sz);

bst_fft_size_to_int

 /opt/src/beast/beast-gtk/bstutils.h:100
gint  bst_fft_size_to_int  
(BstFFTSize fft_size);

bst_file_scan_find_key

 /opt/src/beast/beast-gtk/bstutils.h:104
gchar*  bst_file_scan_find_key  
(const gchar *file,
 const gchar *key,
 const gchar *value_prefix);

bst_gconfig_get_global

 /opt/src/beast/beast-gtk/bstutils.h:229
BstGConfig*  bst_gconfig_get_global  
();

bst_gmask_container_create

 /opt/src/beast/beast-gtk/bstutils.h:110
GtkWidget*  bst_gmask_container_create  
(guint    border_width,
 gboolean dislodge_columns);
Create a container capable to hold GUI field masks. This is the container to be passed into bst_gmask_form(). In case multiple field mask columns are packed into the container (by using bst_gmask_set_column() on the filed masks), dislodge_columns specifies whether the field mask columns are to be closely aligned.
border_width: Border width of this GUI mask
dislodge_columns: Provide expandable space between columns
RETURNS: GUI field mask container

bst_gmask_foreach

 /opt/src/beast/beast-gtk/bstutils.h:143
void  bst_gmask_foreach  
(BstGMask *mask,
 gpointer  func,
 gpointer  data);
Invoke func() with each of the widgets set for this field mask.
mask: valid BstGMask
func: foreach function as: void func(GtkWidget*, gpointer data);
data: data passed in to func

bst_gmask_form

 /opt/src/beast/beast-gtk/bstutils.h:122
BstGMask*  bst_gmask_form  
(GtkWidget   *gmask_container,
 GtkWidget   *action,
 BstGMaskPack gpack);
Create a new GUI field mask with action as action widget. Each GUI field mask consists of an action widget which may be neighboured by pre and post action widgets, the action widget is usually something like a GtkEntry input widget. Also, most field masks have a prompt widget, usually a GtkLabel, labeling the field mask with a name. Optionally, up to three auxillary widgets are supported per field mask, layed out between the prompt and the action widgets. The second auxillary widget will expand if additional space is available. Other layout details are configured through the gpack packing type:
  • BST_GMASK_FIT - the action widget is not expanded,
  • BST_GMASK_INTERLEAVE - allow the action widget to expand across auxillary columns if it requests that much space,
  • BST_GMASK_BIG - force expansion of the action widget across all possible columns up to the prompt,
  • BST_GMASK_CENTER - center the action widget within space across all possible columns up to the prompt.
  • BST_GMASK_MULTI_SPAN - span aux2 widget across multiple gmask columns.
gmask_container: container created with bst_gmask_container_create()
action: valid GtkWidget
gpack: BstGMaskPack packing type
RETURNS: a new GUI field mask

bst_gmask_get_action

 /opt/src/beast/beast-gtk/bstutils.h:140
GtkWidget*  bst_gmask_get_action  
(BstGMask *mask);
Retrieve the action widget of this GUI field mask.
mask: valid BstGMask
RETURNS: the requested GtkWidget or NULL

bst_gmask_get_aux1

 /opt/src/beast/beast-gtk/bstutils.h:137
GtkWidget*  bst_gmask_get_aux1  
(BstGMask *mask);
Retrieve the first auxillary widget of this GUI field mask.
mask: valid BstGMask
RETURNS: the requested GtkWidget or NULL

bst_gmask_get_aux2

 /opt/src/beast/beast-gtk/bstutils.h:138
GtkWidget*  bst_gmask_get_aux2  
(BstGMask *mask);
Retrieve the second auxillary widget of this GUI field mask.
mask: valid BstGMask
RETURNS: the requested GtkWidget or NULL

bst_gmask_get_aux3

 /opt/src/beast/beast-gtk/bstutils.h:139
GtkWidget*  bst_gmask_get_aux3  
(BstGMask *mask);
Retrieve the third auxillary widget of this GUI field mask.
mask: valid BstGMask
RETURNS: the requested GtkWidget or NULL

bst_gmask_get_prompt

 /opt/src/beast/beast-gtk/bstutils.h:136
GtkWidget*  bst_gmask_get_prompt  
(BstGMask *mask);
Retrieve the prompt widget of this GUI field mask.
mask: valid BstGMask
RETURNS: the requested GtkWidget or NULL

bst_gmask_pack

 /opt/src/beast/beast-gtk/bstutils.h:144
void  bst_gmask_pack  
(BstGMask *mask);
After the GUI field mask is fully configured, by setting all associated widgets on it, column tooltip text, etc., this function actually packs it into its container. The field mask setters shouldn't be used after this point.
mask: valid BstGMask

bst_gmask_quick

 /opt/src/beast/beast-gtk/bstutils.h:149
BstGMask*  bst_gmask_quick  
(GtkWidget   *gmask_container,
 guint        column,
 const gchar *prompt,
 gpointer     action,
 const gchar *tip_text);
Shorthand to form a GUI field mask in column of type BST_GMASK_INTERLEAVE, with prompt and tip_text. Note that this function already calls bst_gmask_pack(), so the returned field mask already can't be modified anymore.
gmask_container: container created with bst_gmask_container_create()
column: column number for bst_gmask_set_column()
prompt: valid GtkWidget for bst_gmask_set_prompt()
action: valid GtkWidget as with bst_gmask_form()
tip_text: text for bst_gmask_set_tip()
RETURNS: an already packed GUI field mask

bst_gmask_set_aux1

 /opt/src/beast/beast-gtk/bstutils.h:129
void  bst_gmask_set_aux1  
(BstGMask *mask,
 gpointer  widget);
Set the first auxillary widget of this GUI field mask.
mask: valid BstGMask
widget: valid GtkWidget

bst_gmask_set_aux2

 /opt/src/beast/beast-gtk/bstutils.h:131
void  bst_gmask_set_aux2  
(BstGMask *mask,
 gpointer  widget);
Set the second auxillary widget of this GUI field mask. In contrast to the first and third auxillary widget, this one is expanded if extra space is available.
mask: valid BstGMask
widget: valid GtkWidget

bst_gmask_set_aux3

 /opt/src/beast/beast-gtk/bstutils.h:133
void  bst_gmask_set_aux3  
(BstGMask *mask,
 gpointer  widget);
Set the third auxillary widget of this GUI field mask.
mask: valid BstGMask
widget: valid GtkWidget

bst_gmask_set_column

 /opt/src/beast/beast-gtk/bstutils.h:135
void  bst_gmask_set_column  
(BstGMask *mask,
 guint     column);
Set the field mask column. By default all field masks are packed into column 0, so that only vertical packing occours.
mask: valid BstGMask
column: column number

bst_gmask_set_prompt

 /opt/src/beast/beast-gtk/bstutils.h:127
void  bst_gmask_set_prompt  
(BstGMask *mask,
 gpointer  widget);
Set the prompt widget of this GUI field mask.
mask: valid BstGMask
widget: valid GtkWidget

bst_gmask_set_tip

 /opt/src/beast/beast-gtk/bstutils.h:125
void  bst_gmask_set_tip  
(BstGMask    *mask,
 const gchar *tip_text);
Set the tooltip text of this GUI field mask.
mask: valid BstGMask
tip_text: tooltip text

bst_gui_error_bell

 /opt/src/beast/beast-gtk/bstutils.h:33
 void void  bst_gui_error_bell  
(gpointer widget);

bst_hpack

 /opt/src/beast/beast-gtk/bstutils.h:47
GtkWidget*  bst_hpack  
(const gchar *first_location,
 ...);

bst_hpack0

 /opt/src/beast/beast-gtk/bstutils.h:51
GtkWidget*  bst_hpack0  
(const gchar *first_location,
 ...);

bst_status_eprintf

 /opt/src/beast/beast-gtk/bstutils.h:32
 void  bst_status_eprintf  
(BseErrorType error,
 const gchar *message_fmt,
 ...);

bst_stock_button

 /opt/src/beast/beast-gtk/bstutils.h:84
GtkWidget*  bst_stock_button  
(const gchar *stock_id);

bst_stock_dbutton

 /opt/src/beast/beast-gtk/bstutils.h:85
GtkWidget*  bst_stock_dbutton  
(const gchar *stock_id);

bst_stock_icon_button

 /opt/src/beast/beast-gtk/bstutils.h:86
GtkWidget*  bst_stock_icon_button  
(const gchar *stock_id);

bst_stock_register_icon

 /opt/src/beast/beast-gtk/bstutils.h:92
void  bst_stock_register_icon  
(const gchar  *stock_id,
 guint         bytes_per_pixel,
 guint         width,
 guint         height,
 guint         rowstride,
 const guint8 *pixels);

bst_vpack

 /opt/src/beast/beast-gtk/bstutils.h:45
GtkWidget*  bst_vpack  
(const gchar *first_location,
 ...);

bst_vpack0

 /opt/src/beast/beast-gtk/bstutils.h:49
GtkWidget*  bst_vpack0  
(const gchar *first_location,
 ...);

bst_window_sync_title_to_proxy

 /opt/src/beast/beast-gtk/bstutils.h:36
void  bst_window_sync_title_to_proxy  
(gpointer     window,
 SfiProxy     proxy,
 const gchar *title_format);

bst_xpm_view_create

 /opt/src/beast/beast-gtk/bstutils.h:43
GtkWidget*  bst_xpm_view_create  
(const gchar **xpm,
 GtkWidget    *colormap_widget);