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.

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...

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_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_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_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);
}