summaryrefslogtreecommitdiffstats
path: root/libgimp/gimpui.c
diff options
context:
space:
mode:
Diffstat (limited to 'libgimp/gimpui.c')
-rw-r--r--libgimp/gimpui.c505
1 files changed, 505 insertions, 0 deletions
diff --git a/libgimp/gimpui.c b/libgimp/gimpui.c
new file mode 100644
index 0000000..04c316a
--- /dev/null
+++ b/libgimp/gimpui.c
@@ -0,0 +1,505 @@
+/* LIBGIMP - The GIMP Library
+ * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
+ *
+ * This library is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see
+ * <https://www.gnu.org/licenses/>.
+ */
+
+#include "config.h"
+
+#ifdef GDK_DISABLE_DEPRECATED
+#undef GDK_DISABLE_DEPRECATED
+#endif
+#include <gtk/gtk.h>
+
+#ifdef GDK_WINDOWING_WIN32
+#include <gdk/gdkwin32.h>
+#endif
+
+#ifdef GDK_WINDOWING_X11
+#include <gdk/gdkx.h>
+#endif
+
+#ifdef GDK_WINDOWING_QUARTZ
+#include <Cocoa/Cocoa.h>
+#endif
+
+#include "gimp.h"
+#include "gimpui.h"
+
+#include "libgimpmodule/gimpmodule.h"
+
+#include "libgimpwidgets/gimpwidgets.h"
+#include "libgimpwidgets/gimpwidgets-private.h"
+
+
+/**
+ * SECTION: gimpui
+ * @title: gimpui
+ * @short_description: Common user interface functions. This header includes
+ * all other GIMP User Interface Library headers.
+ * @see_also: gtk_init(), gdk_set_use_xshm(), gdk_rgb_get_visual(),
+ * gdk_rgb_get_cmap(), gtk_widget_set_default_visual(),
+ * gtk_widget_set_default_colormap(), gtk_preview_set_gamma().
+ *
+ * Common user interface functions. This header includes all other
+ * GIMP User Interface Library headers.
+ **/
+
+
+/* local function prototypes */
+
+static void gimp_ui_help_func (const gchar *help_id,
+ gpointer help_data);
+static void gimp_ensure_modules (void);
+static void gimp_window_transient_realized (GtkWidget *window,
+ GdkWindow *parent);
+static gboolean gimp_window_set_transient_for (GtkWindow *window,
+ GdkWindow *parent);
+
+static void gimp_ui_theme_changed (void);
+static void gimp_ui_fix_pixbuf_style (void);
+static void gimp_ui_draw_pixbuf_layout (GtkStyle *style,
+ GdkWindow *window,
+ GtkStateType state_type,
+ gboolean use_text,
+ GdkRectangle *area,
+ GtkWidget *widget,
+ const gchar *detail,
+ gint x,
+ gint y,
+ PangoLayout *layout);
+#ifdef GDK_WINDOWING_QUARTZ
+static gboolean gimp_osx_focus_window (gpointer);
+#endif
+
+static gboolean gimp_ui_initialized = FALSE;
+
+
+/* public functions */
+
+/**
+ * gimp_ui_init:
+ * @prog_name: The name of the plug-in which will be passed as argv[0] to
+ * gtk_init(). It's a convention to use the name of the
+ * executable and _not_ the PDB procedure name.
+ * @preview: This parameter is unused and exists for historical
+ * reasons only.
+ *
+ * This function initializes GTK+ with gtk_init() and initializes GDK's
+ * image rendering subsystem (GdkRGB) to follow the GIMP main program's
+ * colormap allocation/installation policy.
+ *
+ * It also sets up various other things so that the plug-in user looks
+ * and behaves like the GIMP core. This includes selecting the GTK+
+ * theme and setting up the help system as chosen in the GIMP
+ * preferences. Any plug-in that provides a user interface should call
+ * this function.
+ **/
+void
+gimp_ui_init (const gchar *prog_name,
+ gboolean preview)
+{
+ GdkScreen *screen;
+ const gchar *display_name;
+ gchar *themerc;
+ GFileMonitor *rc_monitor;
+ GFile *file;
+
+ g_return_if_fail (prog_name != NULL);
+
+ if (gimp_ui_initialized)
+ return;
+
+ g_set_prgname (prog_name);
+
+ display_name = gimp_display_name ();
+
+ if (display_name)
+ {
+#if defined (GDK_WINDOWING_X11)
+ g_setenv ("DISPLAY", display_name, TRUE);
+#else
+ g_setenv ("GDK_DISPLAY", display_name, TRUE);
+#endif
+ }
+
+ if (gimp_user_time ())
+ {
+ /* Construct a fake startup ID as we only want to pass the
+ * interaction timestamp, see _gdk_windowing_set_default_display().
+ */
+ gchar *startup_id = g_strdup_printf ("_TIME%u", gimp_user_time ());
+
+ g_setenv ("DESKTOP_STARTUP_ID", startup_id, TRUE);
+ g_free (startup_id);
+ }
+
+ gtk_init (NULL, NULL);
+
+ themerc = gimp_personal_rc_file ("themerc");
+ gtk_rc_parse (themerc);
+
+ file = g_file_new_for_path (themerc);
+ g_free (themerc);
+
+ rc_monitor = g_file_monitor (file, G_FILE_MONITOR_NONE, NULL, NULL);
+ g_object_unref (file);
+
+ g_signal_connect (rc_monitor, "changed",
+ G_CALLBACK (gimp_ui_theme_changed),
+ NULL);
+
+ gdk_set_program_class (gimp_wm_class ());
+
+ screen = gdk_screen_get_default ();
+ gtk_widget_set_default_colormap (gdk_screen_get_rgb_colormap (screen));
+
+ if (gimp_icon_theme_dir ())
+ {
+ file = g_file_new_for_path (gimp_icon_theme_dir ());
+ gimp_icons_set_icon_theme (file);
+ g_object_unref (file);
+ }
+
+ gimp_widgets_init (gimp_ui_help_func,
+ gimp_context_get_foreground,
+ gimp_context_get_background,
+ gimp_ensure_modules);
+
+ if (! gimp_show_tool_tips ())
+ gimp_help_disable_tooltips ();
+
+ gimp_dialogs_show_help_button (gimp_show_help_button ());
+
+#ifdef GDK_WINDOWING_QUARTZ
+ g_idle_add (gimp_osx_focus_window, NULL);
+#endif
+
+ gimp_ui_fix_pixbuf_style ();
+ gimp_ui_initialized = TRUE;
+}
+
+static GdkWindow *
+gimp_ui_get_foreign_window (guint32 window)
+{
+#ifdef GDK_WINDOWING_X11
+ return gdk_x11_window_foreign_new_for_display (gdk_display_get_default (),
+ window);
+#endif
+
+#ifdef GDK_WINDOWING_WIN32
+ return gdk_win32_window_foreign_new_for_display (gdk_display_get_default (),
+ (HWND) (uintptr_t) window);
+#endif
+
+ return NULL;
+}
+
+/**
+ * gimp_ui_get_display_window:
+ * @gdisp_ID: a GimpDisplay ID.
+ *
+ * Returns the #GdkWindow of a display window. The purpose is to allow
+ * to make plug-in dialogs transient to the image display as explained
+ * with gdk_window_set_transient_for().
+ *
+ * You shouldn't have to call this function directly. Use
+ * gimp_window_set_transient_for_display() instead.
+ *
+ * Return value: A reference to a #GdkWindow or %NULL. You should
+ * unref the window using g_object_unref() as soon as
+ * you don't need it any longer.
+ *
+ * Since: 2.4
+ */
+GdkWindow *
+gimp_ui_get_display_window (guint32 gdisp_ID)
+{
+ guint32 window;
+
+ g_return_val_if_fail (gimp_ui_initialized, NULL);
+
+ window = gimp_display_get_window_handle (gdisp_ID);
+ if (window)
+ return gimp_ui_get_foreign_window (window);
+
+ return NULL;
+}
+
+/**
+ * gimp_ui_get_progress_window:
+ *
+ * Returns the #GdkWindow of the window this plug-in's progress bar is
+ * shown in. Use it to make plug-in dialogs transient to this window
+ * as explained with gdk_window_set_transient_for().
+ *
+ * You shouldn't have to call this function directly. Use
+ * gimp_window_set_transient() instead.
+ *
+ * Return value: A reference to a #GdkWindow or %NULL. You should
+ * unref the window using g_object_unref() as soon as
+ * you don't need it any longer.
+ *
+ * Since: 2.4
+ */
+GdkWindow *
+gimp_ui_get_progress_window (void)
+{
+ guint32 window;
+
+ g_return_val_if_fail (gimp_ui_initialized, NULL);
+
+ window = gimp_progress_get_window_handle ();
+ if (window)
+ return gimp_ui_get_foreign_window (window);
+
+ return NULL;
+}
+
+#ifdef GDK_WINDOWING_QUARTZ
+static void
+gimp_window_transient_show (GtkWidget *window)
+{
+ g_signal_handlers_disconnect_by_func (window,
+ gimp_window_transient_show,
+ NULL);
+ [NSApp arrangeInFront: nil];
+}
+#endif
+
+/**
+ * gimp_window_set_transient_for_display:
+ * @window: the #GtkWindow that should become transient
+ * @gdisp_ID: display ID of the image window that should become the parent
+ *
+ * Indicates to the window manager that @window is a transient dialog
+ * associated with the GIMP image window that is identified by it's
+ * display ID. See gdk_window_set_transient_for () for more information.
+ *
+ * Most of the time you will want to use the convenience function
+ * gimp_window_set_transient().
+ *
+ * Since: 2.4
+ */
+void
+gimp_window_set_transient_for_display (GtkWindow *window,
+ guint32 gdisp_ID)
+{
+ g_return_if_fail (gimp_ui_initialized);
+ g_return_if_fail (GTK_IS_WINDOW (window));
+
+ if (! gimp_window_set_transient_for (window,
+ gimp_ui_get_display_window (gdisp_ID)))
+ {
+ /* if setting the window transient failed, at least set
+ * WIN_POS_CENTER, which will center the window on the screen
+ * where the mouse is (see bug #684003).
+ */
+ gtk_window_set_position (window, GTK_WIN_POS_CENTER);
+
+#ifdef GDK_WINDOWING_QUARTZ
+ g_signal_connect (window, "show",
+ G_CALLBACK (gimp_window_transient_show),
+ NULL);
+#endif
+ }
+}
+
+/**
+ * gimp_window_set_transient:
+ * @window: the #GtkWindow that should become transient
+ *
+ * Indicates to the window manager that @window is a transient dialog
+ * associated with the GIMP window that the plug-in has been
+ * started from. See also gimp_window_set_transient_for_display().
+ *
+ * Since: 2.4
+ */
+void
+gimp_window_set_transient (GtkWindow *window)
+{
+ g_return_if_fail (gimp_ui_initialized);
+ g_return_if_fail (GTK_IS_WINDOW (window));
+
+ if (! gimp_window_set_transient_for (window, gimp_ui_get_progress_window ()))
+ {
+ /* see above */
+ gtk_window_set_position (window, GTK_WIN_POS_CENTER);
+
+#ifdef GDK_WINDOWING_QUARTZ
+ g_signal_connect (window, "show",
+ G_CALLBACK (gimp_window_transient_show),
+ NULL);
+#endif
+ }
+}
+
+
+/* private functions */
+
+static void
+gimp_ui_help_func (const gchar *help_id,
+ gpointer help_data)
+{
+ gimp_help (NULL, help_id);
+}
+
+static void
+gimp_ensure_modules (void)
+{
+ static GimpModuleDB *module_db = NULL;
+
+ if (! module_db)
+ {
+ gchar *load_inhibit = gimp_get_module_load_inhibit ();
+ gchar *module_path = gimp_gimprc_query ("module-path");
+
+ module_db = gimp_module_db_new (FALSE);
+
+ gimp_module_db_set_load_inhibit (module_db, load_inhibit);
+ gimp_module_db_load (module_db, module_path);
+
+ g_free (module_path);
+ g_free (load_inhibit);
+ }
+}
+
+static void
+gimp_window_transient_realized (GtkWidget *window,
+ GdkWindow *parent)
+{
+ if (gtk_widget_get_realized (window))
+ gdk_window_set_transient_for (gtk_widget_get_window (window), parent);
+}
+
+static gboolean
+gimp_window_set_transient_for (GtkWindow *window,
+ GdkWindow *parent)
+{
+ gtk_window_set_transient_for (window, NULL);
+
+#ifndef GDK_WINDOWING_WIN32
+ g_signal_handlers_disconnect_matched (window, G_SIGNAL_MATCH_FUNC,
+ 0, 0, NULL,
+ gimp_window_transient_realized,
+ NULL);
+
+ if (! parent)
+ return FALSE;
+
+ if (gtk_widget_get_realized (GTK_WIDGET (window)))
+ gdk_window_set_transient_for (gtk_widget_get_window (GTK_WIDGET (window)),
+ parent);
+
+ g_signal_connect_object (window, "realize",
+ G_CALLBACK (gimp_window_transient_realized),
+ parent, 0);
+ g_object_unref (parent);
+
+ return TRUE;
+#endif
+
+ return FALSE;
+}
+
+static void
+gimp_ui_theme_changed (void)
+{
+ gtk_rc_reparse_all ();
+
+ gimp_ui_fix_pixbuf_style ();
+}
+
+static void
+gimp_ui_fix_pixbuf_style (void)
+{
+ /* Same hack as in app/gui/themes.c, to be removed for GTK+ 3.x */
+
+ static GtkStyleClass *pixbuf_style_class = NULL;
+
+ if (! pixbuf_style_class)
+ {
+ GType type = g_type_from_name ("PixbufStyle");
+
+ if (type)
+ {
+ pixbuf_style_class = g_type_class_ref (type);
+
+ if (pixbuf_style_class)
+ pixbuf_style_class->draw_layout = gimp_ui_draw_pixbuf_layout;
+ }
+ }
+}
+
+static void
+gimp_ui_draw_pixbuf_layout (GtkStyle *style,
+ GdkWindow *window,
+ GtkStateType state_type,
+ gboolean use_text,
+ GdkRectangle *area,
+ GtkWidget *widget,
+ const gchar *detail,
+ gint x,
+ gint y,
+ PangoLayout *layout)
+{
+ GdkGC *gc;
+
+ gc = use_text ? style->text_gc[state_type] : style->fg_gc[state_type];
+
+ if (area)
+ gdk_gc_set_clip_rectangle (gc, area);
+
+ if (state_type == GTK_STATE_INSENSITIVE)
+ {
+ GdkGC *copy = gdk_gc_new (window);
+ GdkGCValues orig;
+ GdkColor fore;
+ guint16 r, g, b;
+
+ gdk_gc_copy (copy, gc);
+ gdk_gc_get_values (gc, &orig);
+
+ r = 0x40 + (((orig.foreground.pixel >> 16) & 0xff) >> 1);
+ g = 0x40 + (((orig.foreground.pixel >> 8) & 0xff) >> 1);
+ b = 0x40 + (((orig.foreground.pixel >> 0) & 0xff) >> 1);
+
+ fore.pixel = (r << 16) | (g << 8) | b;
+ fore.red = r * 257;
+ fore.green = g * 257;
+ fore.blue = b * 257;
+
+ gdk_gc_set_foreground (copy, &fore);
+ gdk_draw_layout (window, copy, x, y, layout);
+
+ g_object_unref (copy);
+ }
+ else
+ {
+ gdk_draw_layout (window, gc, x, y, layout);
+ }
+
+ if (area)
+ gdk_gc_set_clip_rectangle (gc, NULL);
+}
+
+#ifdef GDK_WINDOWING_QUARTZ
+static gboolean
+gimp_osx_focus_window (gpointer user_data)
+{
+ [NSApp activateIgnoringOtherApps:YES];
+ return FALSE;
+}
+#endif