Gtk Utilities

The API in this file is designed to provide support functions that wrap the base gtk functions and make them easier to use. More...

Files
file	gnc-gtk-utils.h
	gtk helper routines.

Data Structures
struct	GncMenuModelSearch

gtk Miscellaneous Functions
void	gnc_cbwe_set_by_string (GtkComboBox *cbwe, const gchar *text)
	Find an entry in the GtkComboBox by its text value, and set the widget to that value. More...
void	gnc_cbwe_add_completion (GtkComboBox *cbwe)
void	gnc_cbwe_require_list_item (GtkComboBox *cbwe)
gboolean	gnc_is_dark_theme (GdkRGBA *fg_color)
	Return whether the current gtk theme is a dark one. More...
void	gnc_style_context_get_background_color (GtkStyleContext *context, GtkStateFlags state, GdkRGBA *color)
	Wrapper to get the background color of a widget for a given state. More...
void	gnc_style_context_get_border_color (GtkStyleContext *context, GtkStateFlags state, GdkRGBA *color)
	Wrapper to get the border color of a widget for a given state. More...
GtkWidget *	gnc_get_dialog_widget_from_id (GtkDialog *dialog, const gchar *id)
	Find the Widget defined by 'id' in the dialog. More...
void	gnc_disable_all_actions_in_group (GSimpleActionGroup *action_group)
	Disable all the actions in a simple action group. More...
void	gnc_add_accelerator_keys_for_menu (GtkWidget *menu, GMenuModel *model, GtkAccelGroup *accel_group)
	Add accelerator keys for menu item widgets. More...
GtkWidget *	gnc_find_menu_item_by_action_name (GtkWidget *menu, const gchar *action_name)
	Search the menu for the menu item based on action name. More...
GtkWidget *	gnc_find_menu_item_by_action_label (GtkWidget *menu, const gchar *action_label)
	Search the menu for the menu item based on the action label. More...
GList *	gnc_menu_get_items (GtkWidget *menu)
	Return a list of GtkMenuItems. More...
GtkWidget *	gnc_find_toolbar_item (GtkWidget *toolbar, const gchar *action_name)
	Search the toolbar for the tool item based on the action name. More...
void	gnc_menu_item_setup_tooltip_to_statusbar_callback (GtkWidget *menu_item, GtkWidget *statusbar)
	Setup the callbacks for menu bar items so the tooltip can be displayed in the status bar. More...
void	gnc_tool_item_setup_tooltip_to_statusbar_callback (GtkWidget *tool_item, GtkWidget *statusbar)
	Setup the callbacks for tool bar items so the tooltip can be displayed in the status bar. More...
gboolean	gnc_menubar_model_find_item (GMenuModel *menu_model, GncMenuModelSearch *gsm)
	Find a GtkMenu item from the action name. More...
GtkWidget *	gnc_menubar_model_find_menu_item (GMenuModel *menu_model, GtkWidget *menu, const gchar *action_name)
	Find a GtkMenu item from the action name. More...
gboolean	gnc_menubar_model_update_item (GMenuModel *menu_model, const gchar *action_name, const gchar *target, const gchar *label, const gchar *accel_name, const gchar *tooltip)
	Update the GMenuModel item based on the action name by copying existing item, removing it and inserting a new one in same location. More...
void	gnc_menubar_model_remove_items_with_attrib (GMenuModel *menu_model, const gchar *attrib)
	Remove GMenuModel entries based on having an attribute value equal to attrib, it does not matter what the value is. More...
#define	GNC_MENU_ATTRIBUTE_ACCELERATOR   "accel"
#define	GNC_MENU_ATTRIBUTE_TOOLTIP   "tooltip"
#define	GNC_MENU_ATTRIBUTE_TEMPORARY   "temp"

Detailed Description

The API in this file is designed to provide support functions that wrap the base gtk functions and make them easier to use.

Function Documentation

gnc_add_accelerator_keys_for_menu()

void gnc_add_accelerator_keys_for_menu	(	GtkWidget *	menu,
		GMenuModel *	model,
		GtkAccelGroup *	accel_group
	)

Add accelerator keys for menu item widgets.

Parameters

menu	The menu widget.
model	The menu bar model.
accel_group	The accelerator group to use.

Definition at line 431 of file gnc-gtk-utils.c.

{
    g_return_if_fail (GTK_IS_WIDGET(menu));
    g_return_if_fail (model != NULL);
    g_return_if_fail (accel_group != NULL);

    // this updates the menu accelerators based on accelerator-map
    gtk_accel_map_foreach (model, (GtkAccelMapForeach)accel_map_foreach_func);

    gtk_container_foreach (GTK_CONTAINER(menu), add_accel_for_menu_lookup, accel_group);
}

gnc_cbwe_set_by_string()

void gnc_cbwe_set_by_string	(	GtkComboBox *	cbwe,
		const gchar *	text
	)

Find an entry in the GtkComboBox by its text value, and set the widget to that value.

This function also records the index of that text value for use when the user leaves the widget.

Parameters

cbwe	A pointer to a GtkComboBox with entry widget.
text	The entry text to find in the model of the combo box entry.

Definition at line 41 of file gnc-gtk-utils.c.

{
    GtkTreeModel *model;
    GtkTreeIter iter;
    gchar *tree_string;
    gint column, index, id;
    gboolean match;

    model = gtk_combo_box_get_model(GTK_COMBO_BOX(cbwe));
    if (!gtk_tree_model_get_iter_first(model, &iter))
    {
        /* empty tree */
        gtk_combo_box_set_active(GTK_COMBO_BOX(cbwe), -1);
        return;
    }

    column = gtk_combo_box_get_entry_text_column(cbwe);
    do
    {
        gtk_tree_model_get(model, &iter, column, &tree_string, -1);
        match = g_utf8_collate(text, tree_string) == 0;
        g_free(tree_string);
        if (!match)
            continue;

        /* Found a matching string */
        id = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(cbwe), CHANGED_ID));
        g_signal_handler_block(cbwe, id);
        gtk_combo_box_set_active_iter(GTK_COMBO_BOX(cbwe), &iter);
        g_signal_handler_unblock(cbwe, id);

        index = gtk_combo_box_get_active(GTK_COMBO_BOX(cbwe));
        g_object_set_data(G_OBJECT(cbwe), LAST_INDEX, GINT_TO_POINTER(index));
        return;
    }
    while (gtk_tree_model_iter_next(model, &iter));
}

gnc_disable_all_actions_in_group()

void gnc_disable_all_actions_in_group

(

GSimpleActionGroup *

action_group

)

Disable all the actions in a simple action group.

Parameters

action_group

The GSimpleActionGroup

Definition at line 342 of file gnc-gtk-utils.c.

{
    gchar **actions;
    gint num_actions;

    g_return_if_fail (action_group != NULL);

    actions = g_action_group_list_actions (G_ACTION_GROUP(action_group));
    num_actions = g_strv_length (actions);

    // Disable the actions
    for (gint i = 0; i < num_actions; i++)
    {
        GAction *action = g_action_map_lookup_action (G_ACTION_MAP(action_group),
                                                      actions[i]);
        g_simple_action_set_enabled (G_SIMPLE_ACTION(action), FALSE);
    }
    g_strfreev (actions);
}

gnc_find_menu_item_by_action_label()

GtkWidget* gnc_find_menu_item_by_action_label	(	GtkWidget *	menu,
		const gchar *	action_label
	)

Search the menu for the menu item based on the action label.

Parameters

menu	The menu widget.
action_label	The GtkMenuItem label.

Returns

The menu item widget or NULL.

Definition at line 528 of file gnc-gtk-utils.c.

{
    GtkWidget *ret = NULL;
    const gchar *action_name = NULL;

    g_return_val_if_fail (GTK_IS_WIDGET(menu), NULL);
    g_return_val_if_fail (action_label != NULL, NULL);

    if (GTK_IS_CONTAINER(menu))
    {
        GList *container_list = gtk_container_get_children (GTK_CONTAINER(menu));
        for (GList *n = container_list; !ret && n; n = n->next)
            ret = find_menu_item_func (n->data, action_name, action_label);
        g_list_free (container_list);
    }
    return ret;
}

gnc_find_menu_item_by_action_name()

GtkWidget* gnc_find_menu_item_by_action_name	(	GtkWidget *	menu,
		const gchar *	action_name
	)

Search the menu for the menu item based on action name.

Parameters

menu	The menu widget.
action_name	The GAction name.

Returns

The menu item widget or NULL.

Definition at line 500 of file gnc-gtk-utils.c.

{
    GtkWidget *ret = NULL;
    const gchar *action_label = NULL;

    g_return_val_if_fail (GTK_IS_WIDGET(menu), NULL);
    g_return_val_if_fail (action_name != NULL, NULL);

    if (GTK_IS_CONTAINER(menu))
    {
        GList *container_list = gtk_container_get_children (GTK_CONTAINER(menu));
        for (GList *n = container_list; !ret && n; n = n->next)
            ret = find_menu_item_func (n->data, action_name, action_label);
        g_list_free (container_list);
    }
    return ret;
}

gnc_find_toolbar_item()

GtkWidget* gnc_find_toolbar_item	(	GtkWidget *	toolbar,
		const gchar *	action_name
	)

Search the toolbar for the tool item based on the action name.

Parameters

toolbar	The toolbar widget.
action_name	The GAction name.

Returns

The tool item widget or NULL.

Definition at line 613 of file gnc-gtk-utils.c.

{
    struct find_tool_item_struct ftis;

    g_return_val_if_fail (GTK_IS_TOOLBAR(toolbar), NULL);
    g_return_val_if_fail (action_name != NULL, NULL);

    ftis.action_name = action_name;
    ftis.found_tool_item = NULL;

    gtk_container_foreach (GTK_CONTAINER(toolbar), find_tool_action, &ftis);

    return ftis.found_tool_item;
}

gnc_get_dialog_widget_from_id()

GtkWidget* gnc_get_dialog_widget_from_id	(	GtkDialog *	dialog,
		const gchar *	id
	)

Find the Widget defined by 'id' in the dialog.

Parameters

dialog	The dialog to search for 'id'.
id	The widget name to find in the dialog.

Returns

The widget defined by id in the dialog or NULL.

Definition at line 330 of file gnc-gtk-utils.c.

{
    GtkWidget *content_area = gtk_dialog_get_content_area (dialog);
    return find_widget_func (content_area, id);
}

gnc_is_dark_theme()

gboolean gnc_is_dark_theme

(

GdkRGBA *

fg_color

)

Return whether the current gtk theme is a dark one.

A theme is considered "dark" if it has a dark background color with a light foreground color (used for text and so on). We only test on the foreground color assuming a sane theme chooses enough contrast between foreground and background colors.

Parameters

fg_color

The foreground color to test.

Returns

TRUE if the theme is considered dark, FALSE otherwise.

Definition at line 236 of file gnc-gtk-utils.c.

{
    gboolean is_dark = FALSE;

    // Counting the perceptive luminance - human eye favors green color...
    double lightness = (0.299 * fg_color->red + 0.587 * fg_color->green + 0.114 * fg_color->blue);

    if (lightness > 0.5)
        is_dark = TRUE;

    return is_dark;
}

gnc_menu_get_items()

GList* gnc_menu_get_items

(

GtkWidget *

menu

)

Return a list of GtkMenuItems.

Parameters

menu	The menu widget.

Returns

A GList of menu items or NULL.

Definition at line 571 of file gnc-gtk-utils.c.

{
    GList *list = NULL;

    g_return_val_if_fail (GTK_IS_WIDGET(menu), NULL);

    gtk_container_foreach (GTK_CONTAINER(menu), menu_item_list, &list);

    return list;
}

gnc_menu_item_setup_tooltip_to_statusbar_callback()

void gnc_menu_item_setup_tooltip_to_statusbar_callback	(	GtkWidget *	menu_item,
		GtkWidget *	statusbar
	)

Setup the callbacks for menu bar items so the tooltip can be displayed in the status bar.

Parameters

menu_item	The menubar menu item widget.
statusbar	The statusbar widget to display the tooltip.

Definition at line 1053 of file gnc-gtk-utils.c.

{
    g_return_if_fail (menu_item != NULL);
    g_return_if_fail (statusbar != NULL);

    if (GPOINTER_TO_INT(g_object_get_data(G_OBJECT(menu_item), "added-callbacks")))
        return;

    g_signal_connect (menu_item, "select",
                      G_CALLBACK(menu_item_select_cb),
                      statusbar);
    g_signal_connect (menu_item, "deselect",
                      G_CALLBACK(menu_item_deselect_cb),
                      statusbar);
    g_object_set (G_OBJECT(menu_item), "has-tooltip", FALSE, NULL);

    g_object_set_data (G_OBJECT(menu_item), "added-callbacks", GINT_TO_POINTER(1));
}

gnc_menubar_model_find_item()

gboolean gnc_menubar_model_find_item	(	GMenuModel *	menu_model,
		GncMenuModelSearch *	gsm
	)

Find a GtkMenu item from the action name.

This is done by first finding the action name in the GMenuModel and then doing a search for the label text in the GtkMenu.

NOTE: This is done this way as the action_name field of the GtkMenuItem is not populated from the model.

Parameters

menu_model	The GMenuModel of the menu.
gsm	The GncMenuModelSearch structure.

Returns

TRUE if GMenuModel item found or FALSE if not.

Definition at line 745 of file gnc-gtk-utils.c.

{

    g_return_val_if_fail (menu_model != NULL, FALSE);
    g_return_val_if_fail (gsm != NULL, FALSE);

    gsm->model = NULL;

    items_from_model (menu_model, gsm);

    if (gsm->model)
       return TRUE;

    return FALSE;
}

gnc_menubar_model_find_menu_item()

GtkWidget* gnc_menubar_model_find_menu_item	(	GMenuModel *	menu_model,
		GtkWidget *	menu,
		const gchar *	action_name
	)

Find a GtkMenu item from the action name.

This is done by first finding the action name in the GMenuModel and then doing a search for the label text in the GtkMenu.

NOTE: This is done this way as the action_name field of the GtkMenuItem is not populated from the model.

Parameters

menu_model	The GMenuModel of the menu.
menu	The GtkMenu built from the model.
action_name	The action name of the menu item to find.

Returns

The GtkMenuItem if found or NULL

Definition at line 778 of file gnc-gtk-utils.c.

{
    GncMenuModelSearch *gsm;
    GtkWidget *menu_item = NULL;

    g_return_val_if_fail (menu_model != NULL, NULL);
    g_return_val_if_fail (menu != NULL, NULL);
    g_return_val_if_fail (action_name != NULL, NULL);

    gsm = g_new0 (GncMenuModelSearch, 1);

    gsm->search_action_label = NULL;
    gsm->search_action_name = action_name;
    gsm->search_action_target = NULL;

    if (gnc_menubar_model_find_item (menu_model, gsm))
        menu_item = gnc_find_menu_item_by_action_label (menu, gsm->search_action_label);

    g_free (gsm);
    return menu_item;
}

gnc_menubar_model_remove_items_with_attrib()

void gnc_menubar_model_remove_items_with_attrib	(	GMenuModel *	menu_model,
		const gchar *	attrib
	)

Remove GMenuModel entries based on having an attribute value equal to attrib, it does not matter what the value is.

Parameters

menu_model	The GMenuModel of the menu.
attrib	The attribute to look for.

Definition at line 987 of file gnc-gtk-utils.c.

{
    GList *remove_list = NULL;

    g_return_if_fail (menu_model != NULL);
    g_return_if_fail (attrib != NULL);

    remove_items_from_model (menu_model, &remove_list, attrib);

    g_list_foreach (remove_list, (GFunc)remove_items, NULL);
    g_list_free (remove_list);
}

gnc_menubar_model_update_item()

gboolean gnc_menubar_model_update_item	(	GMenuModel *	menu_model,
		const gchar *	action_name,
		const gchar *	target,
		const gchar *	label,
		const gchar *	accel_name,
		const gchar *	tooltip
	)

Update the GMenuModel item based on the action name by copying existing item, removing it and inserting a new one in same location.

Parameters

menu_model	The GMenuModel of the menu.
action_name	The action name to update.
target	The action target if required, else NULL.
label	The new menu label text.
accel_name	The accelerator string
tooltip	The new tooltip text if any.

Returns

TRUE if item found and updated or FALSE if not.

Definition at line 819 of file gnc-gtk-utils.c.

{
    GncMenuModelSearch *gsm;
    gboolean found = FALSE;

    g_return_val_if_fail (menu_model != NULL, FALSE);
    g_return_val_if_fail (action_name != NULL, FALSE);

    gsm = g_new0 (GncMenuModelSearch, 1);

    gsm->search_action_label = NULL;
    gsm->search_action_name = action_name;
    gsm->search_action_target = target;

    if (gnc_menubar_model_find_item (menu_model, gsm))
    {
        GMenuAttributeIter *iter;
        const gchar *key;
        GVariant *value;
        GVariant *old_target = NULL;
        const gchar *old_action = NULL;
        const gchar *old_temp = NULL;
        const gchar *old_accel = NULL;
        const gchar *old_tooltip = NULL;

        iter = g_menu_model_iterate_item_attributes (gsm->model, gsm->index);
        while (g_menu_attribute_iter_get_next (iter, &key, &value))
        {
            if (g_str_equal (key, GNC_MENU_ATTRIBUTE_TEMPORARY) &&
                g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
                old_temp = g_variant_get_string (value, NULL);
            else if (g_str_equal (key, G_MENU_ATTRIBUTE_ACTION) &&
                     g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
                old_action = g_variant_get_string (value, NULL);
            else if (g_str_equal (key, GNC_MENU_ATTRIBUTE_ACCELERATOR) &&
                     g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
                old_accel = g_variant_get_string (value, NULL);
            else if (g_str_equal (key, GNC_MENU_ATTRIBUTE_TOOLTIP) &&
                     g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
                old_tooltip = g_variant_get_string (value, NULL);
            else if (g_str_equal (key, G_MENU_ATTRIBUTE_TARGET))
                old_target = g_variant_ref (value);

            g_variant_unref (value);
        }
        g_object_unref (iter);

        if (!label && !gsm->search_action_label)
        {
            if (old_target)
                g_variant_unref (old_target);

            g_free (gsm);
            return found;
        }

        if ((accel_name && g_strcmp0 (old_accel, accel_name) != 0) ||
            (tooltip && g_strcmp0 (old_tooltip, tooltip) != 0) ||
            (label && g_strcmp0 (gsm->search_action_label, label) != 0))
        {
            GMenuItem *item = NULL;

            if (label)
                item = g_menu_item_new (label, old_action);
            else
                item = g_menu_item_new (gsm->search_action_label, old_action);

            if (tooltip)
                g_menu_item_set_attribute (item, GNC_MENU_ATTRIBUTE_TOOLTIP, "s", tooltip);
            else
            {
                if (old_tooltip)
                   g_menu_item_set_attribute (item, GNC_MENU_ATTRIBUTE_TOOLTIP, "s", old_tooltip);
            }
            if (accel_name)
                g_menu_item_set_attribute (item, GNC_MENU_ATTRIBUTE_ACCELERATOR, "s", accel_name);
            else
            {
                if (old_accel)
                    g_menu_item_set_attribute (item, GNC_MENU_ATTRIBUTE_ACCELERATOR, "s", old_accel);
            }
            if (old_temp)
                g_menu_item_set_attribute (item, GNC_MENU_ATTRIBUTE_TEMPORARY, "s", old_temp);

            if (old_target)
                g_menu_item_set_attribute_value (item, G_MENU_ATTRIBUTE_TARGET, old_target);

            g_menu_remove (G_MENU(gsm->model), gsm->index);
            g_menu_insert_item (G_MENU(gsm->model), gsm->index, item);
            g_object_unref (item);
            found = TRUE;
        }
        if (old_target)
            g_variant_unref (old_target);
    }
    g_free (gsm);
    return found;
}

gnc_style_context_get_background_color()

void gnc_style_context_get_background_color	(	GtkStyleContext *	context,
		GtkStateFlags	state,
		GdkRGBA *	color
	)

Wrapper to get the background color of a widget for a given state.

Parameters

context	Style context of widget.
state	The stateflag of the widget.
color	The returned background color of the widget.

Definition at line 258 of file gnc-gtk-utils.c.

{
    GdkRGBA *c;

    g_return_if_fail (color != NULL);
    g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));

    gtk_style_context_get (context,
                           state,
                           GTK_STYLE_PROPERTY_BACKGROUND_COLOR, &c,
                           NULL);
    *color = *c;
    gdk_rgba_free (c);
}

gnc_style_context_get_border_color()

void gnc_style_context_get_border_color	(	GtkStyleContext *	context,
		GtkStateFlags	state,
		GdkRGBA *	color
	)

Wrapper to get the border color of a widget for a given state.

Parameters

context	Style context of widget.
state	The stateflag of the widget.
color	The returned border color of the widget.

Definition at line 284 of file gnc-gtk-utils.c.

{
    GdkRGBA *c;

    g_return_if_fail (color != NULL);
    g_return_if_fail (GTK_IS_STYLE_CONTEXT (context));

    gtk_style_context_get (context,
                           state,
                           GTK_STYLE_PROPERTY_BORDER_COLOR, &c,
                           NULL);
    *color = *c;
    gdk_rgba_free (c);
}

gnc_tool_item_setup_tooltip_to_statusbar_callback()

void gnc_tool_item_setup_tooltip_to_statusbar_callback	(	GtkWidget *	tool_item,
		GtkWidget *	statusbar
	)

Setup the callbacks for tool bar items so the tooltip can be displayed in the status bar.

Parameters

tool_item	The toolbar tool item widget.
statusbar	The statusbar widget to display the tooltip.

Definition at line 1101 of file gnc-gtk-utils.c.

{
    GtkWidget *child;

    g_return_if_fail (tool_item != NULL);
    g_return_if_fail (statusbar != NULL);

    child = gtk_bin_get_child (GTK_BIN(tool_item));

    gtk_widget_add_events (GTK_WIDGET(child),
                           GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK
                           | GDK_FOCUS_CHANGE_MASK);

    g_signal_connect (child, "enter-notify-event",
                      G_CALLBACK (tool_item_enter_event),
                      statusbar);

    g_signal_connect (child, "leave-notify-event",
                      G_CALLBACK (tool_item_leave_event),
                      statusbar);

    g_object_set (G_OBJECT(tool_item), "has-tooltip", FALSE, NULL);
}