|
/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 |
GxkColorDots | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:195 |
GxkTypeGenerated | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:133 |
g_object_get_double | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:145 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Convenience variant of gdk_draw_line() to draw a horizontal line.
gdk_draw_vline | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:183 |
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 |
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 |
|
gxk_cell_editable_canceled | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:34 |
Return whether editing was canceled (currently supported
by GtkEntry and triggered by pressing Escape during editing).
gxk_cell_editable_is_focus_handler | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:33 |
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.
gxk_color_alloc | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:185 |
Allocate a color like gdk_color_alloc() with automated
error checking.
gxk_color_dots_destroy | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:204 |
gxk_color_dots_interpolate | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:203 |
gxk_color_dots_new | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:200 |
gxk_container_get_insertion_slot | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:112 |
gxk_container_slot_reorder_child | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:115 |
gxk_convert_latin1_to_utf8 | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:156 |
gxk_expander_connect_to_widget | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:108 |
Setup signal connections, so that the visibility of widget
is controlled by the ::expanded property of expander.
gxk_factory_path_get_leaf | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:158 |
gxk_factory_path_unescape_uline | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:159 |
gxk_file_selection_heal | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:127 |
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.
gxk_file_selection_split | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:129 |
gxk_filename_to_utf8 | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:157 |
gxk_grab_pointer_and_keyboard | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:121 |
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 |
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.
gxk_idle_showraise | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:211 |
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.
gxk_idle_unrealize_widget | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:213 |
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.
gxk_item_factory_get_item | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:39 |
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 |
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_sensitize | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:37 |
This function turns the menu item found via
gxk_item_factory_get_item() (in-)sensitive
according to sensitive. Additional checks
are performed before making a menu item sensitive
to avoid showing e.g. empty submenus.
| ifactory: | | valid GtkItemFactory
|
| path: | | item factory path
|
| sensitive: | | whether menu item should be sensitive
|
| RETURNS: | | menu item according to path |
|
gxk_label_set_attributes | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:110 |
Sets Pango attributes on a GtkLabel in a more convenient way than
gtk_label_set_attributes().
This function is useful if you want to change the font attributes
of a GtkLabel. This is an alternative to using PangoMarkup which
is slow to parse and akward to handle in an i18n-friendly way.
The attributes are set on the complete label, from start to end. If
you need to set attributes on part of the label, you will have to
use the PangoAttributes API directly.
This function is based on gimp_label_set_attributes().
gxk_menu_attach_as_popup | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:63 |
This function is a replacement for gtk_menu_attach_to_widget().
Similar to gxk_menu_attach_as_submenu(), it sets up a propagation
mechanism, so menu and submenus thereof automatically fetch their
accelerator groups via gxk_window_get_menu_accel_group() from the
toplevel window. In addition, this function allowes
gxk_widget_find_level_ordered() to also consider popup menus
in its search.
gxk_menu_attach_as_popup_with_func | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:66 |
Variant of gxk_menu_attach_as_popup() which preserves the GtkMenuDetachFunc.
gxk_menu_attach_as_submenu | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:59 |
This function is a replacement for
gtk_menu_item_set_submenu(). It installs
the necessary hooks on the menu to automatically
update sensitivity of menu_item in response
to children being deleted or added to the menu.
The rationale behind this is to avoid empty
submenus popups.
Also, a propagation mechanism is set up, so menu
and submenus thereof automatically fetch their
accelerator groups via gxk_window_get_menu_accel_group()
from the toplevel window.
gxk_menu_check_sensitive | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:57 |
This function tests whether a menu contains
selectable menu items. It can be used to determine
sensitivity for menu items containing submenus.
| menu: | | valid GtkMenu
|
| RETURNS: | | TRUE if menu contains selectable items |
|
gxk_menu_popup | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:71 |
gxk_menu_popup_pushable | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:78 |
gxk_menu_popup_pushed_in | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:83 |
gxk_menu_set_active | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:52 |
This function replaces gtk_menu_set_active(). The child to be
set as last selection is passed in as ordinary child pointer
and if the menu is attached to an option menu or menu button,
the attach widget is updated after the selection changed, due
to the emission of ::selection-done.
| menu: | | valid GtkMenu
|
| child: | | an immediate child of menu |
|
gxk_notebook_append | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:230 |
Add a new page containing child to notebook,
naming the page label.
| notebook: | | a valid notebook
|
| child: | | a valid parent-less widget
|
| label: | | notebook page name
|
| fillexpand: | | whether the tab label should expand |
|
gxk_notebook_change_tabulator | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:220 |
gxk_notebook_create_tabulator | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:216 |
gxk_notebook_descendant_get_page | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:225 |
Find the innermost notebook page widget that contains widget.
| widget: | | valid GtkWidget
|
| RETURNS: | | notebook page widget or NULL |
|
gxk_notebook_descendant_get_tab | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:226 |
Find the innermost notebook page widget that contains widget
and return its tabulator widget.
| widget: | | valid GtkWidget
|
| RETURNS: | | notebook page tab widget or NULL |
|
gxk_notebook_set_current_page_widget | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:222 |
Set the current notebook page from a page widget, instead
of a page number.
gxk_option_menu_set_menu | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:61 |
This function is a replacement for
gtk_option_menu_set_menu(). Similar to
gxk_menu_attach_as_submenu(), it sets up
a propagation mechanism, so menu
and submenus thereof automatically fetch their
accelerator groups via gxk_window_get_menu_accel_group()
from the toplevel window.
gxk_parent_find_descendant | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:247 |
gxk_scrolled_window_create | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:238 |
Create a GtkScrolledWindow with a GtkViewport as parent of child.
The xrequest and yrequest arguments are passed on
to gxk_widget_proxy_requisition().
| child: | | valid GtkWidget
|
| shadow_type: | | shadow around the GtkViewport
|
| xrequest: | | fractional factor for screen width
|
| yrequest: | | fractional factor for screen height
|
| spare_space: | | whether to call gxk_scrolled_window_spare_space()
|
| RETURNS: | | the newly created GtkScrolledWindow |
|
gxk_scrolled_window_spare_space | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:233 |
A normal GtkScrolledWindow requests extra space for a horizontal scrollbar
if the vertical scroll policy is set to GTK_POLICY_NEVER and vice versa,
regardless of whether the scrollbars have to be shown or not.
This function patches up this behaviour to spare the extra requested space
from the outer scrolled window requisition if possible (that is, if the
corresponding scrollbar is not currently visible).
gxk_scrolled_window_unspare_space | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:234 |
Undo the effect of a call to gxk_scrolled_window_spare_space().
gxk_signal_handler_exists | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:350 |
Find out whether a specific callback is connected to a
specific signal on an instance, the callback may be blocked.
detailed_signal may be
NULL to act as a wildcard. TRUE is returned if
the callback is found, FALSE otherwise.
| instance: | | object instance with signals
|
| detailed_signal: | | signal name
|
| callback: | | custom callback function
|
| data: | | callback data
|
| RETURNS: | | whether callback is connected |
|
gxk_signal_handler_pending | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:354 |
Find out whether a specific callback is pending
(connected and unblocked) for a
specific signal on an instance. detailed_signal may be
NULL to act as a wildcard. TRUE is returned if
the callback is found, FALSE otherwise.
| instance: | | object instance with signals
|
| detailed_signal: | | signal name
|
| callback: | | custom callback function
|
| data: | | callback data
|
| RETURNS: | | whether callback is connected |
|
gxk_size_group | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:263 |
Group horizontal and/or vertical resizing behaviour of
widgets. See gtk_size_group_set_mode() on the effect of
the various grouping modes.
| sgmode: | | size group mode, one of GTK_SIZE_GROUP_NONE,
GTK_SIZE_GROUP_HORIZONTAL, GTK_SIZE_GROUP_VERTICAL or
GTK_SIZE_GROUP_BOTH
|
| ...:: | | NULL terminated list of widgets to group together |
|
gxk_toplevel_activate_default | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:243 |
Activate the default widget of the toplevel of widget.
| widget: | | a widget having a toplevel |
|
gxk_toplevel_delete | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:241 |
This function is useful to produce the an effect
similar to user caused window manager triggered
window deletion on the toplevel of widget.
Note that this function will cause window deletion
despite any grabs in effect however.
| widget: | | a widget having a toplevel |
|
gxk_toplevel_hide | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:242 |
Hide the toplevel of widget.
| widget: | | a widget having a toplevel |
|
gxk_tree_model_get_iter | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:269 |
This function is a replacement for gtk_tree_model_get_iter()
for Gtk+-2.4. For sort models, gtk_tree_model_get_iter() can
erroneously return TRUE which is corrected by calling this
function instead.
gxk_tree_path_prev | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:270 |
Workaround for gtk_tree_path_prev() which corrupts memory
if called on empty paths (up to version Gtk+-2.4 at least).
gxk_tree_selection_force_browse | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:328 |
Watch deletion and insertions into empty trees to
ensure valid selections across these events.
gxk_tree_selection_select_ipath | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:321 |
Select the row denoted by the path to be constructed from the
-1 terminated indices.
gxk_tree_selection_select_spath | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:316 |
Select the row denoted by str_path.
gxk_tree_selection_unselect_ipath | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:324 |
Select the row denoted by the path to be constructed from the
-1 terminated indices.
gxk_tree_selection_unselect_spath | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:318 |
Unselect the row denoted by str_path.
gxk_tree_spath_index0 | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:266 |
Return index[ 0] of strpath. Useful for paths in lists,
where index[ 0] usually corresponds to the nth row.
gxk_tree_view_add_column | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:276 |
Appends cell to column and adds column
to tree_view at the specified position.
This function takes a NULL-terminated list
of attribute mappings consisting of a string
and a guint, mapping cell attributes to
model columns as documented in
gtk_tree_view_column_add_attribute().
gxk_tree_view_add_popup_column | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:298 |
Add a text column with popup facility, similar to
gxk_tree_view_add_text_column(). This function takes
an additional argument popup_callback() which is
called when the user clicks on the cells "popup"
button.
| tree_view: | | valid GtkTreeView
|
| model_column: | | model column
|
| xalign: | | horizontal text alignment
|
| title: | | column title
|
| tooltip: | | column tooltip
|
| edited_callback: | | edit notification callback
|
| popup_callback: | | popup notification callback
|
| data: | | data passed in to toggled_callback
|
| cflags: | | connection flags
|
| RETURNS: | | a newly added GtkTreeViewColumn |
|
gxk_tree_view_add_text_column | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:288 |
Add a new column with text cell to a tree_view.
The model_column indicates the column number
of the tree model containing the text to be
displayed, the column_flags toggle specific
column characteristics (see
gxk_tree_view_append_text_columns() for details)
and xalign controls the horizontal cell alignment
(between 0 and 1).
If non-NULL, edited_callback( data) is connected
with cflags (see g_signal_connect_data()) to the
"::edited" signal of the text cell and the cell is
made editable.
| tree_view: | | valid GtkTreeView
|
| model_column: | | model column
|
| column_flags: | | column flags
|
| xalign: | | horizontal text alignment
|
| title: | | column title
|
| tooltip: | | column tooltip
|
| edited_callback: | | notification callback
|
| data: | | data passed in to toggled_callback
|
| cflags: | | connection flags
|
| RETURNS: | | a newly added GtkTreeViewColumn |
|
gxk_tree_view_add_toggle_column | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:307 |
Add a toggle button column, similar
to gxk_tree_view_add_text_column(), however
the model column is expected to be of type
G_TYPE_BOOLEAN, and instead of an edited_callback(),
this function has a
void toggled_callback( GtkCellRendererToggle*, const gchar *strpath, data)
callback which is connected to the "toggled" signal of
the new cell.
| tree_view: | | valid GtkTreeView
|
| model_column: | | model column
|
| xalign: | | horizontal text alignment
|
| title: | | column title
|
| tooltip: | | column tooltip
|
| toggled_callback: | | notification callback
|
| data: | | data passed in to toggled_callback
|
| cflags: | | connection flags
|
| RETURNS: | | a newly added GtkTreeViewColumn |
|
gxk_tree_view_append_text_columns | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:279 |
Add n_cols new columns with text cells to
tree_view (a short hand version for multiple
calls to gxk_tree_view_add_text_column()).
Per column, the caller needs to
supply a guint, a string, a gdouble and another
string. The Arguments are used as model column
number (for the text to be displayed), the column
specific flags, the horizontal cell alignment
(between 0 and 1) and the column title respectively.
The column_flags argument is a combination of letters that
are able to switch certain characteristics on or off,
currently supported are:
- F - column is fixed in sizing;
- A - column resizes automatically;
- G - columns sizing behaviour is grow only;
- S - column is sortable;
- s - column is unsortable;
- O - column is reorderable;
- o - column is not reorderable;
- R - column is user-resizable;
- r - column is not user-resizable;
- P - add extra padding between multiple cells of the same column;
- p - cancel a previous #P flag;
- # - automatically popup dialogs for popup cell renderers.
| tree_view: | | valid GtkTreeView
|
| n_cols: | | number of columns to append
|
| ...:: | | column arguments |
|
gxk_tree_view_column_set_tip_title | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:310 |
Set a tree view column title and its tooltip.
This is a bug workaroud for missing tree view
column API to set tooltips, so the column title
or column title widget shouldn't be changed
after calling this function.
gxk_tree_view_focus_row | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:341 |
Force focus to row, causes automatic selection of
row in browse mode.
gxk_tree_view_get_bin_window_pos | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:331 |
Retrieve the position of the bin window (row display area) of
a GtkTreeView widget once it's realized.
| tree: | | valid GtkTreeView
|
| x_p: | | x position
|
| y_p: | | y position |
|
gxk_tree_view_get_row_area | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:336 |
Retrieve the position and height of a row of a
GtkTreeView widget within its bin window.
| tree: | | valid GtkTreeView
|
| row: | | row to retrieve area coordinates for
|
| y_p: | | y position of row
|
| height_p: | | height of row
|
| content_area: | | whether the cell background area or content area is returned |
|
gxk_tree_view_get_row_from_coord | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:339 |
Retrieve the row within which y lies. If y lies
outside the visible area, the row is clamped to
visible rows.
| tree: | | valid GtkTreeView
|
| y: | | bin window y coordinate
|
| row_p: | | row pointed to by y
|
| RETURNS: | | whether y lies within the visible area |
|
gxk_tree_view_get_selected_row | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:344 |
Retrieve the selected row in browse mode (for other
selection modes, return the first selected row if any).
| tree: | | valid GtkTreeView
|
| RETURNS: | | first selected row or -1 |
|
gxk_tree_view_is_row_selected | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:343 |
Check whether row in tree is selected.
| tree: | | valid GtkTreeView
|
| row: | | row to test
|
| RETURNS: | | whether row is selected |
|
gxk_tree_view_select_index | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:326 |
gxk_tree_view_set_editable | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:312 |
gxk_type_register_generated | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:140 |
Register each of the generated type entries with the
type system. Currently supported parent types are
G_TYPE_ENUM and G_TYPE_FLAGS in which cases the
type_data member must point to a NULL terminated
array of GEnumValue or GFlagValue structures. No
extra copying is performed, so the passed in
structures have to persist throughout runtime.
| n_entries: | | number of generated types to register
|
| entries: | | GxkTypeGenerated type descriptions |
|
gxk_ungrab_pointer_and_keyboard | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:123 |
This function releases a pointer and keyboard grab
acquired through gxk_grab_pointer_and_keyboard().
The window is used to release grabs on the correct
display, see gdk_display_pointer_ungrab() and
gdk_display_keyboard_ungrab() on this.
| window: | | window pointer was previously grabed on |
|
gxk_vseparator_space_new | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:223 |
Create a vertical seperator widget. draw_seperator indicates
whether the seperator should be amount to simple space or not.
| draw_seperator: | | enable visible vertical seperator
|
| RETURNS: | | visible vertical space/seperator widget |
|
gxk_widget_activate_accel_group | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:260 |
Activate accelerators within accel group when widget
receives key press events. This function isn't pure
convenience, as it works around Gtk+ version prior to
Gtk+-2.4 not exporting
gtk_accel_group_activate(), gtk_accel_group_attach()
and gtk_accel_group_detach().
gxk_widget_add_font_requisition | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:89 |
This function adds up extra space to the widget size
requisition. The space is an approximation of the space
required by n_chars characters and n_digits digits
written with the widget's font.
| widget: | | valid GtkWidget
|
| n_chars: | | number of characters to request space for
|
| n_digits: | | number of digits to request space for |
|
gxk_widget_add_option | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:92 |
Add/set a custom option of widget to a particular value.
Custom options on widgets are used to attach extra information
to widgets which may be useful to otherwise disjoint code
portions. The actual options are implemented by means of
g_option_concat(), g_option_check() and g_option_get().
| widget: | | valid GtkWidget
|
| option: | | option to add to widget
|
| value: | | value of option (currently just "+" and "-" are supported) |
|
gxk_widget_ancestry_viewable | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:32 |
Checks for widget to be effectively visible on screen.
This function works around a bug in Gtk+ versions <= 2.4.10,
with newer Gtk+ versions, ( gdk_window_is_viewable(widget->window) &&
GTK_WIDGET_DRAWABLE(widget)) is a suitable replacement.
| widget: | | a valid GtkWidget
|
| RETURNS: | | whether widget is visible on screen |
|
gxk_widget_attached_hierarchy_changed | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:165 |
Setting or unsetting a parent on a widget leads to emission
of the ::hirarchy-changed signal on the widget and any children
it contains. However, popup menus which are merely attached to
widgets aren't properly notified upon such hirarchy changes,
for this gxk_widget_attached_hierarchy_changed() is provided.
On menus which got attached to a widget with
gxk_menu_attach_as_popup(), the signal ::attached-hirarchy-changed
is emitted if ::hirarchy-changed is emitted on the widget,
by calling gxk_widget_attached_hierarchy_changed() on the menu.
gxk_widget_check_option | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:94 |
Test whether the custom option is set on widget.
| widget: | | valid GtkWidget
|
| option: | | option to check for
|
| RETURNS: | | whether option is set |
|
gxk_widget_find_level_ordered | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:85 |
Search for a widget named name, child of toplevel.
The search is ordered by looking at all children of
a container before increasing depth.
This function also considers submenus in menu items
"children", as well as popup menus attached via
gxk_menu_attach_as_popup() (not ones attached via
gtk_menu_attach_to_widget() though, since Gtk+ doesn't
store/export the neccessary information).
| toplevel: | | valid GtkWidget
|
| name: | | name of the widget being looked for
|
| RETURNS: | | a widget named name or NULL |
|
gxk_widget_force_bg_clear | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:253 |
Enforce drawing of a widget's background.
Some widgets do not explicitely draw their background,
but simply draw themsleves on top of their parent's
background. This function forces the widget into
drawing its background according to its style settings.
gxk_widget_get_attach_toplevel | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:86 |
This function returns the topmost container widget
for widget, much like gtk_widget_get_toplevel().
The only difference is that for menus, not the immediate
parent is returned (the GtkWindow used to display a
menu) but the tree walk continues on the menu item
using the menu as submenu.
For example, for a window containing a menubar with
submenus, gtk_widget_get_toplevel() invoked on one
of the menu items will return the GtkWindow widgets
for the corresponding submenus, while
gxk_widget_get_attach_toplevel() will return the
actual GtkWindow containing the menubar.
gxk_widget_get_latent_tooltip | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:258 |
Retrieve the latent tooltip for widget. See
gxk_widget_set_latent_tooltip() for the purpose of latent
tooltips.
| widget: | | a valid GtkWidget
|
| RETURNS: | | descriptive tooltip |
|
gxk_widget_get_options | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:95 |
This function returns the set of custom options
currently set on the widget.
| widget: | | valid GtkWidget
|
| RETURNS: | | custom options set on the widget |
|
gxk_widget_has_ancestor | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:50 |
This function checks whether widget and ancestor are equal,
or whether ancestor is an ancestor of widget, in the same
way gtk_widget_is_ancestor() tests it.
| widget: | | valid GtkWidget
|
| ancestor: | | valid GtkWidget
|
| RETURNS: | | whether ancestor is ancestor of widget |
|
gxk_widget_make_insensitive | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:208 |
This function is euqivalent to gtk_widget_set_sensitive ( widget, FALSE);
It exists as a convenient signal connection callback.
gxk_widget_make_sensitive | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:209 |
This function is euqivalent to gtk_widget_set_sensitive ( widget, TRUE);
It exists as a convenient signal connection callback.
gxk_widget_modify_as_title | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:248 |
Modify the widget and it's style, so that it is insensitive,
but doesn't quite look that way. Useful for inactive title
menu items in menus ( widget should be the menu item's label).
gxk_widget_modify_base_as_bg | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:251 |
Modify the widget's base background (used by list and
text widgets) to look like an ordinary widget background.
This is useful if a list, text or similar widget shouldn't
stand out as such, e.g. when the GtkTextView widget displaying
a long non-editable text should look similar to a GtkLabel.
gxk_widget_modify_bg_as_active | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:252 |
Modify the widget's background to look like the background
of depressed button.
gxk_widget_modify_bg_as_base | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:250 |
Modify the widget's background to look like the background
of a text or list widget (usually white). This is useful
if a hbox or similar widget is used to "simulate" a list
or text widget.
gxk_widget_modify_normal_bg_as_base | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:249 |
Modify the widget's background like gxk_widget_modify_bg_as_base()
does, as long as the widget isn't activated or selected.
gxk_widget_proxy_requisition | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:44 |
Proxy the size requisition of widget through the ::width-request
and ::height-request properties. This is useful only for immediate
children of a GtkScrolledWindow (e.g. a GtkViewport), to have
the GtkScrolledWindow honour the widgets size requisition.
If xscale or yscale is passed as -1, the corresponding dimension
::width-request or ::height-request is left unset.
If xscale or yscale is passed a value between 0 and +1, it is
interpreted as a fraction of the screen width or screen height to
constrain the corresponding requested dimension.
| widget: | | valid GtkWidget
|
| xscale: | | fractional factor for screen width
|
| yscale: | | fractional factor for screen height |
|
gxk_widget_regulate | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:55 |
Regulate a widgets state. The sensitive parameter
controls sensitivity like gtk_widget_set_sensitive()
and active controls whether the widget is active
like gtk_toggle_button_set_active() or
gtk_check_menu_item_set_active().
For menu items, the menu item is also made the
active widget in its parent menu, possibly affecting
option menus.
| widget: | | valid GtkWidget
|
| sensitive: | | whether widget should be sensitive
|
| active: | | whether widget should be active |
|
gxk_widget_regulate_uses_active | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:56 |
Check whether gxk_widget_regulate() will actually make
use of its active argument for widget. If not,
FALSE is returned, and gxk_widget_regulate() is
fully equivalent to just gtk_widget_set_sensitive().
| widget: | | valid GtkWidget
|
| RETURNS: | | TRUE if gxk_widget_regulate() uses active for widget |
|
gxk_widget_request_hclient_height | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:46 |
Request the horizontal size of client as height
for widget.
gxk_widget_request_vclient_width | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:48 |
Request the vertical size of client as width
for widget.
gxk_widget_set_latent_tooltip | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:257 |
Set the latent tooltip for this widget. A latent tooltip
will not be shown on mouse over for this widget. Instead
it can be querried by other widgets via
gxk_widget_get_latent_tooltip() to be shown when appropriate.
For instance, GxkMenuButton shows the latent tooltip of its
currently selected menu item.
| widget: | | a valid GtkWidget
|
| tooltip: | | descriptive tooltip |
|
gxk_widget_set_tooltip | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:255 |
As a convenience function, this sets the tooltip for widget
on GXK_TOOLTIPS, if widget is supposed to have tooltips
according to the system configuration and also sets the latent tooltip.
| widget: | | a valid GtkWidget
|
| tooltip: | | descriptive tooltip |
|
gxk_widget_showraise | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:210 |
Show the widget. If the widget is a toplevel,
also raise its window to top.
gxk_widget_viewable | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:164 |
Check whether a widget is viewable by verifying the mapped
state of the widget and all its parent widgets.
| widget: | | valid GtkWidget
RETURNS: TRUE if the widget is viewable, FALSE otherwise |
|
gxk_widget_viewable_changed | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:163 |
A widget should call this function if it changed
the mapped state of one of its children (or if it
is a toplevel and gets show or hidden) to emit the
::viewable-changed signal on the related sub-tree.
GxkDialog properly emits this signal if show or
hidden, containers like GtkNotebook need this
function be explicitely connected to their ::switch-page
signal, in order for their children to get properly
notified.
gxk_window_get_menu_accel_group | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:98 |
This function hands out an accel group for window
specifically targeted at holding accelerators of
menu items in this window.
gxk_window_process_next | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:173 |
Cause window to be updated asyncronously as soon as possible via
gdk_window_process_updates().
| window: | | valid GdkWindow
|
| update_children: | | whether to also process updates for child windows |
|
gxk_window_set_cursor_type | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:171 |
Set a window's cursor type. If GXK_DEFAULT_CURSOR is specified
the window's cursor will be inherited from it's parent.
gxk_window_set_geometry_height_inc | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:106 |
gxk_window_set_geometry_min_height | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:102 |
gxk_window_set_geometry_min_width | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:100 |
gxk_window_set_geometry_width_inc | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:104 |
gxk_window_set_menu_accel_group | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:97 |
gxk_zfile_uncompress | | /opt/src/beast/beast-gtk/gxk/gxkutils.h:360 |
|
|