GXK Interface Reference

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

SYNOPSIS

struct  GxkColorDot;
struct  GxkColorDots;
struct  GxkTypeGenerated;
   
gdouble  g_object_get_double  (object, name);
glong  g_object_get_long  (object, name);
void  g_object_set_double  (object, name, v_double);
void  g_object_set_long  (object, name, v_long);
GdkColor  gdk_color_from_argb  (rgb_value);
GdkColor  gdk_color_from_rgb  (rgb_value);
GdkColor  gdk_color_from_rgba  (rgb_value);
void  gdk_draw_hline  (drawable, gc, x, y, width);
void  gdk_draw_vline  (drawable, gc, x, y, height);
GtkWidget*  gtk_box_get_nth_child  (box, pos);
GtkWidget*  gtk_notebook_current_widget  (notebook);
gboolean  gxk_cell_editable_canceled  (ecell);
void  gxk_cell_editable_is_focus_handler  (ecell);
void  gxk_color_alloc  (colormap, color);
void  gxk_color_dots_destroy  (cdots);
guint  gxk_color_dots_interpolate  (cdots, value, saturation);
GxkColorDots*  gxk_color_dots_new  (n_dots, dots);
guint  gxk_container_get_insertion_slot  (container);
void  gxk_container_slot_reorder_child  (container, widget, slot);
gchar*  gxk_convert_latin1_to_utf8  (string);
void  gxk_expander_connect_to_widget  (expander, widget);
const gchar*  gxk_factory_path_get_leaf  (path);
gchar*  gxk_factory_path_unescape_uline  (path);
GtkWidget*  gxk_file_selection_heal  (fs);
GtkWidget*  gxk_file_selection_split  (fs, bbox);
gchar*  gxk_filename_to_utf8  (string);
gboolean  gxk_grab_pointer_and_keyboard  (window, owner_events, event_mask, confine_to, cursor, time);
void  gxk_idle_show_widget  (widget);
void  gxk_idle_showraise  (widget);
void  gxk_idle_unrealize_widget  (widget);
GtkWidget*  gxk_item_factory_get_item  (ifactory, path);
GtkWidget*  gxk_item_factory_get_widget  (ifactory, path);
GtkWidget*  gxk_item_factory_sensitize  (ifactory, path, sensitive);
void  gxk_label_set_attributes  (label, ...);
void  gxk_menu_attach_as_popup  (menu, widget);
void  gxk_menu_attach_as_popup_with_func  (menu, widget, mdfunc);
void  gxk_menu_attach_as_submenu  (menu, menu_item);
gboolean  gxk_menu_check_sensitive  (menu);
void  gxk_menu_popup  (menu, x, y, mouse_button, time);
void  gxk_menu_popup_pushable  (menu, x, y, pushed_x, pushed_y, mouse_button, time);
void  gxk_menu_popup_pushed_in  (menu, pushed_x, pushed_y, mouse_button, time);
void  gxk_menu_set_active  (menu, child);
void  gxk_notebook_append  (notebook, child, label, fillexpand);
void  gxk_notebook_change_tabulator  (tabulator, label_text, stock_image, tooltip);
GtkWidget*  gxk_notebook_create_tabulator  (label_text, stock_image, tooltip);
GtkWidget*  gxk_notebook_descendant_get_page  (widget);
GtkWidget*  gxk_notebook_descendant_get_tab  (widget);
void  gxk_notebook_set_current_page_widget  (notebook, page);
void  gxk_option_menu_set_menu  (option_menu, menu);
GtkWidget*  gxk_parent_find_descendant  (parent, descendant_type);
GtkWidget*  gxk_scrolled_window_create  (child, shadow_type, xrequest, yrequest);
void  gxk_scrolled_window_spare_space  (scwin);
void  gxk_scrolled_window_unspare_space  (scwin);
gboolean  gxk_signal_handler_exists  (instance, detailed_signal, callback, data);
gboolean  gxk_signal_handler_pending  (instance, detailed_signal, callback, data);
void  gxk_size_group  (sgmode, first_widget, ...);
void  gxk_toplevel_activate_default  (widget);
void  gxk_toplevel_delete  (widget);
void  gxk_toplevel_hide  (widget);
gboolean  gxk_tree_model_get_iter  (tree_model, iter, path);
gboolean  gxk_tree_path_prev  (path);
void  gxk_tree_selection_force_browse  (selection, model);
void  gxk_tree_selection_select_ipath  (selection, first_index, ...);
void  gxk_tree_selection_select_spath  (selection, str_path);
void  gxk_tree_selection_unselect_ipath  (selection, first_index, ...);
void  gxk_tree_selection_unselect_spath  (selection, str_path);
gint  gxk_tree_spath_index0  (strpath);
guint  gxk_tree_view_add_column  (tree_view, position, column, cell, attrib_name, ...);
GtkTreeViewColumn*  gxk_tree_view_add_popup_column  (tree_view, model_column, column_flags, xalign, title, tooltip, edited_callback, popup_callback, data, cflags);
GtkTreeViewColumn*  gxk_tree_view_add_text_column  (tree_view, model_column, column_flags, xalign, title, tooltip, edited_callback, data, cflags);
GtkTreeViewColumn*  gxk_tree_view_add_toggle_column  (tree_view, model_column, column_flags, xalign, title, tooltip, toggled_callback, data, cflags);
void  gxk_tree_view_append_text_columns  (tree_view, n_cols, ...);
void  gxk_tree_view_column_set_tip_title  (tree_column, title, tooltip);
void  gxk_tree_view_focus_row  (tree, row);
void  gxk_tree_view_get_bin_window_pos  (tree, x_p, y_p);
gboolean  gxk_tree_view_get_row_area  (tree, row, y_p, height_p, content_area);
gboolean  gxk_tree_view_get_row_from_coord  (tree, y, row_p);
gint  gxk_tree_view_get_selected_row  (tree);
gboolean  gxk_tree_view_is_row_selected  (tree, row);
void  gxk_tree_view_select_index  (tview, index);
void  gxk_tree_view_set_editable  (tview, maybe_editable);
void  gxk_type_register_generated  (n_entries, entries);
void  gxk_ungrab_pointer_and_keyboard  (window, time);
GtkWidget*  gxk_vseparator_space_new  (draw_seperator);
void  gxk_widget_activate_accel_group  (widget, accel_group);
void  gxk_widget_add_font_requisition  (widget, n_chars, n_digits);
void  gxk_widget_add_option  (widget, option, value);
 gboolean  gxk_widget_ancestry_viewable  (widget);
void  gxk_widget_attached_hierarchy_changed  (widget);
gboolean  gxk_widget_check_option  (widget, option);
GtkWidget*  gxk_widget_find_level_ordered  (toplevel, name);
void  gxk_widget_force_bg_clear  (widget);
GtkWidget*  gxk_widget_get_attach_toplevel  (widget);
const gchar*  gxk_widget_get_latent_tooltip  (widget);
const gchar*  gxk_widget_get_options  (widget);
gboolean  gxk_widget_has_ancestor  (widget, ancestor);
void  gxk_widget_make_insensitive  (widget);
void  gxk_widget_make_sensitive  (widget);
void  gxk_widget_modify_as_title  (widget);
void  gxk_widget_modify_base_as_bg  (widget);
void  gxk_widget_modify_bg_as_active  (widget);
void  gxk_widget_modify_bg_as_base  (widget);
void  gxk_widget_modify_normal_bg_as_base  (widget);
void  gxk_widget_proxy_requisition  (widget, xscale, yscale);
void  gxk_widget_regulate  (widget, sensitive, active);
gboolean  gxk_widget_regulate_uses_active  (widget);
void  gxk_widget_request_hclient_height  (widget, client);
void  gxk_widget_request_vclient_width  (widget, client);
void  gxk_widget_set_latent_tooltip  (widget, tooltip);
void  gxk_widget_set_tooltip  (widget, tooltip);
void  gxk_widget_showraise  (widget);
gboolean  gxk_widget_viewable  (widget);
void  gxk_widget_viewable_changed  (widget);
GtkAccelGroup*  gxk_window_get_menu_accel_group  (window);
void  gxk_window_process_next  (window, update_children);
void  gxk_window_set_cursor_type  (window, cursor);
void  gxk_window_set_geometry_height_inc  (window, height_increment);
void  gxk_window_set_geometry_min_height  (window, min_height);
void  gxk_window_set_geometry_min_width  (window, min_width);
void  gxk_window_set_geometry_width_inc  (window, width_increment);
void  gxk_window_set_menu_accel_group  (window, agroup);
gchar*  gxk_zfile_uncompress  (uncompressed_size, cdata, cdata_size);

DESCRIPTION

GxkColorDot

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:191
struct GxkColorDot
{
  double value;
  guint  rgb;
};

GxkColorDots

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:195
struct GxkColorDots
{
  guint        n_colors;
  GxkColorDot *colors;
};

GxkTypeGenerated

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:133
struct GxkTypeGenerated
{
  gchar        *type_name;
  GType         parent;
  GType        *type_id;
  gconstpointer type_data;
};

g_object_get_double

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:145
gdouble  g_object_get_double  
(gpointer     object,
 const gchar *name);
Convenience variant of g_object_get_data() to retrieve a double instead of a pointer.
object: a valid GObject
name: name of the double value to retrieve
RETURNS: the actual value

g_object_get_long

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:150
glong  g_object_get_long  
(gpointer     object,
 const gchar *name);
Convenience variant of g_object_get_data() to retrieve a long instead of a pointer.
object: a valid GObject
name: name of the long value to retrieve
RETURNS: the actual value

g_object_set_double

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:143
void  g_object_set_double  
(gpointer     object,
 const gchar *name,
 gdouble      v_double);
Convenience variant of g_object_set_data() to set a double instead of a pointer.
object: a valid GObject
name: name of the double value to set
v_double: the actual value

g_object_set_long

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:148
void  g_object_set_long  
(gpointer     object,
 const gchar *name,
 glong        v_long);
Convenience variant of g_object_set_data() to set a long instead of a pointer.
object: a valid GObject
name: name of the long value to set
v_long: the actual value

gdk_color_from_argb

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:187
GdkColor  gdk_color_from_argb  
(guint rgb_value);
Fill out a GdkColor with red, green and blue color values, from Rr, Gg and Bb respectively. Aa maybe an alpha value and will be ignored. GdkColor.pixel will be 0-initialized.
rgb_value: 0xAaRrGgBb color value

gdk_color_from_rgb

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:186
GdkColor  gdk_color_from_rgb  
(guint rgb_value);
Fill out a GdkColor with red, green and blue color values, from Rr, Gg and Bb respectively. GdkColor.pixel will be 0-initialized.
rgb_value: 0xRrGgBb color value

gdk_color_from_rgba

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:188
GdkColor  gdk_color_from_rgba  
(guint rgb_value);
Fill out a GdkColor with red, green and blue color values, from Rr, Gg and Bb respectively. Aa maybe an alpha value and will be ignored. GdkColor.pixel will be 0-initialized.
rgb_value: 0xRrGgBbAa color value

gdk_draw_hline

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:178
void  gdk_draw_hline  
(GdkDrawable *drawable,
 GdkGC       *gc,
 gint         x,
 gint         y,
 gint         width);
Convenience variant of gdk_draw_line() to draw a horizontal line.

gdk_draw_vline

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:183
void  gdk_draw_vline  
(GdkDrawable *drawable,
 GdkGC       *gc,
 gint         x,
 gint         y,
 gint         height);
Convenience variant of gdk_draw_line() to draw a vertical line.

gtk_box_get_nth_child

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:232
GtkWidget*  gtk_box_get_nth_child  
(GtkBox *box,
 gint    pos);
Find the child at position pos (0 indicates the first child) of box and return it. To retrieve the last xchild of box, -1 may be passed as pos.
box: a valid GtkBox
pos: position of the requested child
RETURNS: a child of box or NULL

gtk_notebook_current_widget

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:224
GtkWidget*  gtk_notebook_current_widget  
(GtkNotebook *notebook);
This function is essentially a shortcut for gtk_notebook_get_current_page() and gtk_notebook_get_nth_page().
notebook: valid GtkNotebook
RETURNS: the widget corresponding to the current page

gxk_cell_editable_canceled

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:34
gboolean  gxk_cell_editable_canceled  
(GtkCellEditable *ecell);
Return whether editing was canceled (currently supported by GtkEntry and triggered by pressing Escape during editing).
ecell: valid GtkCellEditable
RETURNS: whether editing got aborted

gxk_cell_editable_is_focus_handler

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:33
void  gxk_cell_editable_is_focus_handler  
(GtkCellEditable *ecell);
Call gtk_cell_editable_editing_done() if necessary and return FALSE. This function is meant to be used to handle "notify::is-focus" signals on GtkCellEditable widgets.
ecell: valid GtkCellEditable
RETURNS: returns FALSE

gxk_color_alloc

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:185
void  gxk_color_alloc  
(GdkColormap *colormap,
 GdkColor    *color);
Allocate a color like gdk_color_alloc() with automated error checking.
colormap: valid GdkColormap
color: valid GdkColor

gxk_color_dots_destroy

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:204
void  gxk_color_dots_destroy  
(GxkColorDots *cdots);

gxk_color_dots_interpolate

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:203
guint  gxk_color_dots_interpolate  
(GxkColorDots *cdots,
 double        value,
 double        saturation);

gxk_color_dots_new

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:200
GxkColorDots*  gxk_color_dots_new  
(guint              n_dots,
 const GxkColorDot *dots);

gxk_container_get_insertion_slot

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:112
guint  gxk_container_get_insertion_slot  
(GtkContainer *container);

gxk_container_slot_reorder_child

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:115
void  gxk_container_slot_reorder_child  
(GtkContainer *container,
 GtkWidget    *widget,
 guint         slot);

gxk_convert_latin1_to_utf8

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:156
gchar*  gxk_convert_latin1_to_utf8  
(const gchar *string);

gxk_expander_connect_to_widget

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:108
void  gxk_expander_connect_to_widget  
(GtkWidget *expander,
 GtkWidget *widget);
Setup signal connections, so that the visibility of widget is controlled by the ::expanded property of expander.
expander: valid GtkWidget with boolean ::expanded property
widget: valid GtkWidget

gxk_factory_path_get_leaf

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:158
const gchar*  gxk_factory_path_get_leaf  
(const gchar *path);

gxk_factory_path_unescape_uline

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:159
gchar*  gxk_factory_path_unescape_uline  
(const gchar *path);

gxk_file_selection_heal

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:127
GtkWidget*  gxk_file_selection_heal  
(GtkFileSelection *fs);
Fixup various oddities that happened to the Gtk+ file selection widget over time. This function corrects container border widths, spacing, button placement and the default and focus widgets. Also, the lifetime of the file selection window is tied to the returned GtkVBox, enabling removal of the GtkVBox from it's parent and thus using the file selection widgets in a custom GtkWindow.
fs: valid GtkFileSelection
RETURNS: new toplevel VBox of the file selection

gxk_file_selection_split

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:129
GtkWidget*  gxk_file_selection_split  
(GtkFileSelection *fs,
 GtkWidget       **bbox);

gxk_filename_to_utf8

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:157
gchar*  gxk_filename_to_utf8  
(const gchar *string);

gxk_grab_pointer_and_keyboard

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:121
gboolean  gxk_grab_pointer_and_keyboard  
(GdkWindow   *window,
 gboolean     owner_events,
 GdkEventMask event_mask,
 GdkWindow   *confine_to,
 GdkCursor   *cursor,
 guint32      time);
This function grabs the pointer and keyboard simultaneously. This is recommended over plain pointer grabs, to reduce the risk of other applications (for instance the window manager) aborting the current grab and leaving the application in an invalid state.
window: the window receiving the grab
owner_events: if TRUE, events will be reported relative to window
event_mask: mask of interesting events
confine_to: limits the pointer to the specified window
cursor: cursor to use for the duration of the grab
time: event time when grab is requested
RETURNS: TRUE if pointer and keyboard could successfully be grabbed

gxk_idle_show_widget

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:212
void  gxk_idle_show_widget  
(GtkWidget *widget);
Defer showing this widget until the next idle handler is run. This is useful if other things are pending which need to be processed first, for instance hiding other toplevels.
widget: a valid GtkWidget

gxk_idle_showraise

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:211
void  gxk_idle_showraise  
(GtkWidget *widget);
Defers showing and raising this widget like gxk_widget_showraise() until the next idle handler is run. This is useful if other things are pending which need to be processed first, for instance hiding other toplevels or constructing remaining parts of the widget hierarchy.
widget: a valid GtkWidget

gxk_idle_unrealize_widget

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:213
void  gxk_idle_unrealize_widget  
(GtkWidget *widget);
Defer unrealizing this widget until the next idle handler is run. This is useful if other things are pending which need to be processed first, e.g. completing a running signal emission.
widget: a valid GtkWindow

gxk_item_factory_get_item

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:39
GtkWidget*  gxk_item_factory_get_item  
(GtkItemFactory *ifactory,
 const gchar    *path);
This function strips unescaped underlines ('_') from path and then calls gtk_item_factory_get_item().
ifactory: valid GtkItemFactory
path: item factory path
RETURNS: menu item according to path

gxk_item_factory_get_widget

 /opt/src/beast/beast-gtk/gxk/gxkutils.h:41
GtkWidget*  gxk_item_factory_get_widget  
(GtkItemFactory *ifactory,
 const gchar    *path);
This function strips unescaped underlines ('_') from path and then calls gtk_item_factory_get_widget().
ifactory: valid GtkItemFactory
path: item factory path
RETURNS: widget according to path

gxk_item_factory_