src/adg/adg-gtk-utils.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007-2019  Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 /**
  22  * SECTION:adg-gtk-utils
  23  * @Section_Id:gtk-utilities
  24  * @title: GTK+ utilities
  25  * @short_description: Assorted macros and backward compatible fallbacks
  26  *
  27  * Collection of macros and functions that do not fit inside any other topic.
  28  *
  29  * Since: 1.0
  30  **/
  31
  32
  33 /**
  34  * ADG_GTK_MODIFIERS:
  35  *
  36  * A GDK mask of the key/mouse modifiers accepted by the GTK+ widgets
  37  * of the ADG library. This means the state of the specified modifiers
  38  * is always checked: for example %GDK_CONTROL_MASK and %GDK_SHIFT_MASK
  39  * are included, hence keeping <keycap>CTRL</keycap>
  40  * and <keycap>SHIFT</keycap> pressed is different from keeping
  41  * only <keycap>SHIFT</keycap> pressed. %GDK_LOCK_MASK instead is not
  42  * considered, so having it enabled or disabled does not make any
  43  * difference while monitoring the status <keycap>SHIFT</keycap>
  44  * or <keycap>CTRL</keycap>.
  45  *
  46  * Since: 1.0
  47  **/
  48
  49
  50 #include "adg-internal.h"
  51 #include <gtk/gtk.h>
  52
  53 #include "adg-gtk-utils.h"
  54
  55
  56 #if GTK_CHECK_VERSION(2, 14, 0)
  57 #else
  58
  59 /**
  60  * gtk_widget_get_window:
  61  * @widget: a #GtkWidget
  62  *
  63  * Returns the widget's window if it is realized
  64  * or <constant>NULL</constant> otherwise.
  65  *
  66  * This is a fallback API for GTK+ prior to 2.14.
  67  *
  68  * Return value: @widget's window.
  69  *
  70  * Since: 1.0
  71  **/
  72 GdkWindow *
  73 gtk_widget_get_window(GtkWidget *widget)
  74 {
  75   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
  76
  77   return widget->window;
  78 }
  79
  80 #endif
  81
  82 #if GTK_CHECK_VERSION(2, 20, 0)
  83 #else
  84
  85 /**
  86  * gtk_widget_get_realized:
  87  * @widget: a #GtkWidget
  88  *
  89  * Determines whether @widget is realized.
  90  *
  91  * Return value: %TRUE if @widget is realized, %FALSE otherwise
  92  *
  93  * Since: 1.0
  94  **/
  95 gboolean
  96 gtk_widget_get_realized(GtkWidget *widget)
  97 {
  98     g_return_val_if_fail(GTK_IS_WIDGET(widget), FALSE);
  99     return GTK_WIDGET_REALIZED(widget);
 100 }
 101
 102 #endif
 103
 104 /**
 105  * adg_gtk_window_hide_here:
 106  * @window: a #GtkWindow
 107  *
 108  * A convenient function that hides @window and tries to store the
 109  * current position. Any subsequent call to gtk_widget_show() will
 110  * hopefully reopen the window at the same position.
 111  *
 112  * It can be used instead of gtk_widget_hide() or by connecting it
 113  * to a #GtkDialog::response signal, for instance:
 114  *
 115  * <informalexample><programlisting language="C">
 116  * g_signal_connect(dialog, "response",
 117  *                  G_CALLBACK(adg_gtk_window_hide_here), NULL);
 118  * </programlisting></informalexample>
 119  *
 120  * Since: 1.0
 121  **/
 122 void
 123 adg_gtk_window_hide_here(GtkWindow *window)
 124 {
 125     gint x, y;
 126
 127     g_return_if_fail(GTK_IS_WINDOW(window));
 128
 129     gtk_window_get_position(window, &x, &y);
 130     gtk_widget_hide((GtkWidget *) window);
 131     gtk_window_set_position(window, GTK_WIN_POS_NONE);
 132     gtk_window_move(window, x, y);
 133 }
 134
 135 /**
 136  * adg_gtk_toggle_button_sensitivize:
 137  * @toggle_button: a #GtkToggleButton
 138  * @widget: the #GtkWidget
 139  *
 140  * Assigns the value of the #GtkToggleButton:active property of
 141  * @toggle_button to the #GtkWidget:sensitive property of @widget.
 142  * Useful to set or reset the sensitiveness of @widget depending
 143  * of the state of a check button, for example:
 144  *
 145  * <informalexample><programlisting language="C">
 146  * g_signal_connect(toggle_button, "toggled",
 147  *                  G_CALLBACK(adg_gtk_toggle_button_sensitivize), widget1);
 148  * g_signal_connect(toggle_button, "toggled",
 149  *                  G_CALLBACK(adg_gtk_toggle_button_sensitivize), widget2);
 150  * g_signal_connect(toggle_button, "toggled",
 151  *                  G_CALLBACK(adg_gtk_toggle_button_sensitivize), widget3);
 152  * </programlisting></informalexample>
 153  *
 154  * Since: 1.0
 155  **/
 156 void
 157 adg_gtk_toggle_button_sensitivize(GtkToggleButton *toggle_button,
 158                                   GtkWidget *widget)
 159 {
 160     gboolean is_active;
 161
 162     g_return_if_fail(GTK_IS_TOGGLE_BUTTON(toggle_button));
 163     g_return_if_fail(GTK_IS_WIDGET(widget));
 164
 165     is_active = gtk_toggle_button_get_active(toggle_button);
 166     gtk_widget_set_sensitive(widget, is_active);
 167 }
 168
 169 /**
 170  * adg_gtk_use_default_icons:
 171  * @dir: the directory where the icons should be installed
 172  *
 173  * Sets the default icon list of every #GtkWindow to a hand-coded
 174  * list of ADG icons. Check gtk gtk_window_set_default_icon_list()
 175  * for further details.
 176  **/
 177 void
 178 adg_gtk_use_default_icons(const gchar *dir)
 179 {
 180     const gchar **p_file;
 181     const gchar *files[] = {
 182         "adg-16.png",
 183         "adg-32.png",
 184         "adg-48.png",
 185         "adg-64.png",
 186         "adg-128.png",
 187         NULL
 188     };
 189     GList *list;
 190     gchar *path;
 191     GdkPixbuf *icon;
 192
 193     list = NULL;
 194     for (p_file = files; *p_file != NULL; ++p_file) {
 195         path = adg_find_file(*p_file, dir, NULL);
 196         if (path == NULL)
 197             continue;
 198         icon = gdk_pixbuf_new_from_file(path, NULL);
 199         g_free(path);
 200         if (icon != NULL)
 201             list = g_list_append(list, icon);
 202     }
 203
 204     if (list != NULL) {
 205         gtk_window_set_default_icon_list(list);
 206         g_list_free(list);
 207     }
 208 }