Gimp/app/display/gimpdisplayshell.c
Jehan 58b3b14082 app, libgimp*, pdb, plug-ins: reimplement generic inter-process transient window.
Having windows ID as guint32 is a mistake. Different systems have
different protocols. In Wayland in particular, Windows handles are
exchanged as strings. What this commit does is the following:

In core:

- get_window_id() virtual function in core GimpProgress is changed to
  return a GBytes, as a generic "data" to represent a window differently
  on different systems.
- All implementations of get_window_id() in various classes implementing
  this interface are updated accordingly:
  * GimpSubProgress
  * GimpDisplay returns the handle of its shell.
  * GimpDisplayShell now creates its window handle at construction with
    libgimpwidget's gimp_widget_set_native_handle() and simply return
    this handle every time it's requested.
  * GimpFileDialog also creates its window handle at construction with
    gimp_widget_set_native_handle().
- gimp_window_set_transient_for() in core is changed to take a
  GimpProgress as argument (instead of a guint32 ID), requests and
  process the ID itself, according to the running platform. In
  particular, the following were improved:
  * Unlike old code, it will work even if the window is not visible yet.
    In such a case, the function simply adds a signal handler to set
    transient at mapping. It makes it easier to use it at construction
    in a reliable way.
  * It now works for Wayland too, additionally to X11.
- GimpPdbProgress now exchanges a GBytes too with the command
  GIMP_PROGRESS_COMMAND_GET_WINDOW.
- display_get_window_id() in gimp-gui.h also returns a GBytes now.

PDB/libgimp:

- gimp_display_get_window_handle() and gimp_progress_get_window_handle()
  now return a GBytes to represent a window handle in an opaque way
  (depending on the running platform).

In libgimp:

- GimpProgress's get_window() virtual function changed to return a
  GBytes and renamed get_window_handle().
- In particular GimpProgressBar is the only implementation of
  get_window_handle(). It creates its handle at object construction with
  libgimpwidget's gimp_widget_set_native_handle() and the virtual
  method's implementation simply returns the GBytes.

In libgimpUi:

- gimp_ui_get_display_window() and gimp_ui_get_progress_window() were
  removed. We should not assume anymore that it is possible to create a
  GdkWindow to be used. For instance this is not possible with Wayland
  which has its own way to set a window transient with a string handle.
- gimp_window_set_transient_for_display() and
  gimp_window_set_transient() now use an internal implementation similar
  to core gimp_window_set_transient_for(), with the same improvements
  (works even at construction when the window is not visible yet + works
  for Wayland too).

In libgimpwidgets:

- New gimp_widget_set_native_handle() is a helper function used both in
  core and libgimp* libraries for widgets which we want to be usable as
  possible parents. It takes care of getting the relevant window handle
  (depending on the running platform) and stores it in a given pointer,
  either immediately or after a callback once the widget is mapped. So
  it can be used at construction. Also it sets a handle for X11 or
  Wayland.

In plug-ins:

- Screenshot uses the new gimp_progress_get_window_handle() directly now
  in its X11 code path and creates out of it a GdkWindows itself with
  gdk_x11_window_foreign_new_for_display().

Our inter-process transient implementation only worked for X11, and with
this commit, it works for Wayland too.

There is code for Windows but it is currently disabled as it apparently
hangs (there is a comment in-code which links to this old report:
https://bugzilla.gnome.org/show_bug.cgi?id=359538). NikcDC tested
yesterday with re-enabling the code and said they experienced a freeze.
;-(

Finally there is no infrastructure yet to make this work on macOS and
apparently there is no implementation of window handle in GDK for macOS
that I could find. I'm not sure if macOS doesn't have this concept of
setting transient on another processus's window or GDK is simply lacking
the implementation.
2023-10-01 21:02:33 +02:00

2205 lines
72 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <string.h>
#include <stdlib.h>
#include <gegl.h>
#include <gtk/gtk.h>
#ifdef GDK_WINDOWING_WAYLAND
#include <gdk/gdkwayland.h>
#endif
#include "libgimpbase/gimpbase.h"
#include "libgimpmath/gimpmath.h"
#include "libgimpcolor/gimpcolor.h"
#include "libgimpconfig/gimpconfig.h"
#include "libgimpwidgets/gimpwidgets.h"
#include "display-types.h"
#include "tools/tools-types.h"
#include "config/gimpcoreconfig.h"
#include "config/gimpdisplayconfig.h"
#include "config/gimpdisplayoptions.h"
#include "gegl/gimp-babl.h"
#include "core/gimp.h"
#include "core/gimp-utils.h"
#include "core/gimpchannel.h"
#include "core/gimpcontext.h"
#include "core/gimpimage.h"
#include "core/gimpimage-grid.h"
#include "core/gimpimage-guides.h"
#include "core/gimpimage-snap.h"
#include "core/gimppickable.h"
#include "core/gimpprojectable.h"
#include "core/gimpprojection.h"
#include "core/gimptemplate.h"
#include "menus/menus.h"
#include "widgets/gimpdevices.h"
#include "widgets/gimphelp-ids.h"
#include "widgets/gimpuimanager.h"
#include "widgets/gimpwidgets-utils.h"
#include "tools/tool_manager.h"
#include "gimpcanvas.h"
#include "gimpcanvascanvasboundary.h"
#include "gimpcanvaslayerboundary.h"
#include "gimpdisplay.h"
#include "gimpdisplayshell.h"
#include "gimpdisplayshell-appearance.h"
#include "gimpdisplayshell-callbacks.h"
#include "gimpdisplayshell-cursor.h"
#include "gimpdisplayshell-dnd.h"
#include "gimpdisplayshell-expose.h"
#include "gimpdisplayshell-filter.h"
#include "gimpdisplayshell-handlers.h"
#include "gimpdisplayshell-items.h"
#include "gimpdisplayshell-profile.h"
#include "gimpdisplayshell-progress.h"
#include "gimpdisplayshell-render.h"
#include "gimpdisplayshell-rotate.h"
#include "gimpdisplayshell-rulers.h"
#include "gimpdisplayshell-scale.h"
#include "gimpdisplayshell-scroll.h"
#include "gimpdisplayshell-scrollbars.h"
#include "gimpdisplayshell-selection.h"
#include "gimpdisplayshell-title.h"
#include "gimpdisplayshell-tool-events.h"
#include "gimpdisplayshell-transform.h"
#include "gimpimagewindow.h"
#include "gimpmotionbuffer.h"
#include "gimpstatusbar.h"
#include "about.h"
#include "gimp-log.h"
#include "gimp-priorities.h"
#include "gimp-intl.h"
enum
{
PROP_0,
PROP_POPUP_MANAGER,
PROP_INITIAL_MONITOR,
PROP_DISPLAY,
PROP_UNIT,
PROP_TITLE,
PROP_STATUS,
PROP_SHOW_ALL,
PROP_INFINITE_CANVAS
};
enum
{
SCALED,
SCROLLED,
ROTATED,
RECONNECT,
LAST_SIGNAL
};
typedef struct _GimpDisplayShellOverlay GimpDisplayShellOverlay;
struct _GimpDisplayShellOverlay
{
GimpDisplayShell *shell;
gdouble image_x;
gdouble image_y;
GimpHandleAnchor anchor;
gint spacing_x;
gint spacing_y;
};
/* local function prototypes */
static void gimp_color_managed_iface_init (GimpColorManagedInterface *iface);
static void gimp_display_shell_constructed (GObject *object);
static void gimp_display_shell_dispose (GObject *object);
static void gimp_display_shell_finalize (GObject *object);
static void gimp_display_shell_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_display_shell_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static void gimp_display_shell_unrealize (GtkWidget *widget);
static void gimp_display_shell_unmap (GtkWidget *widget);
static void gimp_display_shell_screen_changed (GtkWidget *widget,
GdkScreen *previous);
static gboolean gimp_display_shell_popup_menu (GtkWidget *widget);
static void gimp_display_shell_real_scaled (GimpDisplayShell *shell);
static void gimp_display_shell_real_scrolled (GimpDisplayShell *shell);
static void gimp_display_shell_real_rotated (GimpDisplayShell *shell);
static const guint8 *
gimp_display_shell_get_icc_profile(GimpColorManaged *managed,
gsize *len);
static GimpColorProfile *
gimp_display_shell_get_color_profile(GimpColorManaged *managed);
static void gimp_display_shell_profile_changed(GimpColorManaged *managed);
static void gimp_display_shell_simulation_profile_changed
(GimpColorManaged *managed);
static void gimp_display_shell_simulation_intent_changed
(GimpColorManaged *managed);
static void gimp_display_shell_simulation_bpc_changed
(GimpColorManaged *managed);
static void gimp_display_shell_zoom_button_callback
(GimpDisplayShell *shell,
GtkWidget *zoom_button);
static void gimp_display_shell_sync_config (GimpDisplayShell *shell,
GimpDisplayConfig *config);
static void gimp_display_shell_overlay_allocate (GtkWidget *child,
GtkAllocation *allocation,
GimpDisplayShellOverlay *overlay);
static void gimp_display_shell_remove_overlay (GtkWidget *canvas,
GtkWidget *child,
GimpDisplayShell *shell);
static void gimp_display_shell_transform_overlay (GimpDisplayShell *shell,
GtkWidget *child,
gdouble *x,
gdouble *y);
G_DEFINE_TYPE_WITH_CODE (GimpDisplayShell, gimp_display_shell,
GTK_TYPE_EVENT_BOX,
G_IMPLEMENT_INTERFACE (GIMP_TYPE_PROGRESS,
gimp_display_shell_progress_iface_init)
G_IMPLEMENT_INTERFACE (GIMP_TYPE_COLOR_MANAGED,
gimp_color_managed_iface_init))
#define parent_class gimp_display_shell_parent_class
static guint display_shell_signals[LAST_SIGNAL] = { 0 };
static void
gimp_display_shell_class_init (GimpDisplayShellClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
display_shell_signals[SCALED] =
g_signal_new ("scaled",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpDisplayShellClass, scaled),
NULL, NULL, NULL,
G_TYPE_NONE, 0);
display_shell_signals[SCROLLED] =
g_signal_new ("scrolled",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpDisplayShellClass, scrolled),
NULL, NULL, NULL,
G_TYPE_NONE, 0);
display_shell_signals[ROTATED] =
g_signal_new ("rotated",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpDisplayShellClass, rotated),
NULL, NULL, NULL,
G_TYPE_NONE, 0);
display_shell_signals[RECONNECT] =
g_signal_new ("reconnect",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpDisplayShellClass, reconnect),
NULL, NULL, NULL,
G_TYPE_NONE, 0);
object_class->constructed = gimp_display_shell_constructed;
object_class->dispose = gimp_display_shell_dispose;
object_class->finalize = gimp_display_shell_finalize;
object_class->set_property = gimp_display_shell_set_property;
object_class->get_property = gimp_display_shell_get_property;
widget_class->unrealize = gimp_display_shell_unrealize;
widget_class->unmap = gimp_display_shell_unmap;
widget_class->screen_changed = gimp_display_shell_screen_changed;
widget_class->popup_menu = gimp_display_shell_popup_menu;
klass->scaled = gimp_display_shell_real_scaled;
klass->scrolled = gimp_display_shell_real_scrolled;
klass->rotated = gimp_display_shell_real_rotated;
klass->reconnect = NULL;
g_object_class_install_property (object_class, PROP_POPUP_MANAGER,
g_param_spec_object ("popup-manager",
NULL, NULL,
GIMP_TYPE_UI_MANAGER,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_INITIAL_MONITOR,
g_param_spec_object ("initial-monitor",
NULL, NULL,
GDK_TYPE_MONITOR,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_DISPLAY,
g_param_spec_object ("display", NULL, NULL,
GIMP_TYPE_DISPLAY,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_UNIT,
gimp_param_spec_unit ("unit", NULL, NULL,
TRUE, FALSE,
GIMP_UNIT_PIXEL,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_TITLE,
g_param_spec_string ("title", NULL, NULL,
GIMP_NAME,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
g_object_class_install_property (object_class, PROP_STATUS,
g_param_spec_string ("status", NULL, NULL,
NULL,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_SHOW_ALL,
g_param_spec_boolean ("show-all",
NULL, NULL,
FALSE,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_INFINITE_CANVAS,
g_param_spec_boolean ("infinite-canvas",
NULL, NULL,
FALSE,
GIMP_PARAM_READABLE));
gtk_widget_class_set_css_name (widget_class, "GimpDisplayShell");
}
static void
gimp_color_managed_iface_init (GimpColorManagedInterface *iface)
{
iface->get_icc_profile = gimp_display_shell_get_icc_profile;
iface->get_color_profile = gimp_display_shell_get_color_profile;
iface->profile_changed = gimp_display_shell_profile_changed;
iface->simulation_profile_changed = gimp_display_shell_simulation_profile_changed;
iface->simulation_intent_changed = gimp_display_shell_simulation_intent_changed;
iface->simulation_bpc_changed = gimp_display_shell_simulation_bpc_changed;
}
static void
gimp_display_shell_init (GimpDisplayShell *shell)
{
const gchar *env;
shell->options = g_object_new (GIMP_TYPE_DISPLAY_OPTIONS, NULL);
shell->fullscreen_options = g_object_new (GIMP_TYPE_DISPLAY_OPTIONS_FULLSCREEN, NULL);
shell->no_image_options = g_object_new (GIMP_TYPE_DISPLAY_OPTIONS_NO_IMAGE, NULL);
shell->zoom = gimp_zoom_model_new ();
shell->dot_for_dot = TRUE;
shell->scale_x = 1.0;
shell->scale_y = 1.0;
shell->show_image = TRUE;
shell->show_all = FALSE;
gimp_display_shell_items_init (shell);
shell->cursor_handedness = GIMP_HANDEDNESS_RIGHT;
shell->current_cursor = (GimpCursorType) -1;
shell->tool_cursor = GIMP_TOOL_CURSOR_NONE;
shell->cursor_modifier = GIMP_CURSOR_MODIFIER_NONE;
shell->override_cursor = (GimpCursorType) -1;
shell->filter_format = babl_format ("R'G'B'A float");
shell->filter_profile = gimp_babl_get_builtin_color_profile (GIMP_RGB,
GIMP_TRC_NON_LINEAR);
shell->render_scale = 1;
shell->render_buf_width = 256;
shell->render_buf_height = 256;
shell->snapped_side_horizontal = GIMP_ARRANGE_HFILL;
shell->snapped_layer_horizontal = NULL;
shell->snapped_side_vertical = GIMP_ARRANGE_HFILL;
shell->snapped_layer_vertical = NULL;
shell->equidistance_side_horizontal = GIMP_ARRANGE_HFILL;
shell->near_layer_horizontal1 = NULL;
shell->near_layer_horizontal2 = NULL;
shell->equidistance_side_vertical = GIMP_ARRANGE_HFILL;
shell->near_layer_vertical1 = NULL;
shell->near_layer_vertical2 = NULL;
env = g_getenv ("GIMP_DISPLAY_RENDER_BUF_SIZE");
if (env)
{
gint width = atoi (env);
gint height = width;
env = strchr (env, 'x');
if (env)
height = atoi (env + 1);
if (width > 0 && width <= 8192 &&
height > 0 && height <= 8192)
{
shell->render_buf_width = width;
shell->render_buf_height = height;
}
}
shell->motion_buffer = gimp_motion_buffer_new ();
g_signal_connect (shell->motion_buffer, "stroke",
G_CALLBACK (gimp_display_shell_buffer_stroke),
shell);
g_signal_connect (shell->motion_buffer, "hover",
G_CALLBACK (gimp_display_shell_buffer_hover),
shell);
shell->zoom_focus_point = NULL;
gtk_widget_set_events (GTK_WIDGET (shell), (GDK_POINTER_MOTION_MASK |
GDK_BUTTON_PRESS_MASK |
GDK_KEY_PRESS_MASK |
GDK_KEY_RELEASE_MASK |
GDK_FOCUS_CHANGE_MASK |
GDK_VISIBILITY_NOTIFY_MASK |
GDK_SCROLL_MASK |
GDK_SMOOTH_SCROLL_MASK));
/* zoom model callback */
g_signal_connect_swapped (shell->zoom, "zoomed",
G_CALLBACK (gimp_display_shell_scale_update),
shell);
/* active display callback */
g_signal_connect (shell, "button-press-event",
G_CALLBACK (gimp_display_shell_events),
shell);
g_signal_connect (shell, "button-release-event",
G_CALLBACK (gimp_display_shell_events),
shell);
g_signal_connect (shell, "key-press-event",
G_CALLBACK (gimp_display_shell_events),
shell);
gimp_help_connect (GTK_WIDGET (shell), gimp_standard_help_func,
GIMP_HELP_IMAGE_WINDOW, NULL, NULL);
}
static void
gimp_display_shell_constructed (GObject *object)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (object);
GimpDisplayConfig *config;
GimpImage *image;
GtkWidget *grid;
GtkWidget *gtk_image;
GimpAction *action;
gint image_width;
gint image_height;
gint shell_width;
gint shell_height;
G_OBJECT_CLASS (parent_class)->constructed (object);
gimp_assert (GIMP_IS_UI_MANAGER (shell->popup_manager));
gimp_assert (GIMP_IS_DISPLAY (shell->display));
config = shell->display->config;
image = gimp_display_get_image (shell->display);
gimp_display_shell_profile_init (shell);
if (image)
{
image_width = gimp_image_get_width (image);
image_height = gimp_image_get_height (image);
}
else
{
/* These values are arbitrary. The width is determined by the
* menubar and the height is chosen to give a window aspect
* ratio of roughly 3:1 (as requested by the UI team).
*/
image_width = GIMP_DEFAULT_IMAGE_WIDTH;
image_height = GIMP_DEFAULT_IMAGE_HEIGHT / 3;
}
shell->dot_for_dot = config->default_dot_for_dot;
if (config->monitor_res_from_gdk)
{
gimp_get_monitor_resolution (shell->initial_monitor,
&shell->monitor_xres, &shell->monitor_yres);
}
else
{
shell->monitor_xres = config->monitor_xres;
shell->monitor_yres = config->monitor_yres;
}
/* adjust the initial scale -- so that window fits on screen. */
if (image)
{
gimp_display_shell_set_initial_scale (shell, 1.0, //scale,
&shell_width, &shell_height);
}
else
{
shell_width = -1;
shell_height = image_height;
}
gimp_display_shell_sync_config (shell, config);
/* the grid containing everything */
grid = gtk_grid_new ();
gtk_container_add (GTK_CONTAINER (shell), grid);
gtk_widget_show (grid);
/* the horizontal scrollbar */
shell->hsbdata = gtk_adjustment_new (0, 0, image_width,
1, 1, image_width);
shell->hsb = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, shell->hsbdata);
gtk_widget_set_can_focus (shell->hsb, FALSE);
/* the vertical scrollbar */
shell->vsbdata = gtk_adjustment_new (0, 0, image_height,
1, 1, image_height);
shell->vsb = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, shell->vsbdata);
gtk_widget_set_can_focus (shell->vsb, FALSE);
/* the menu popup button */
shell->origin = gtk_event_box_new ();
gtk_image = gtk_image_new_from_icon_name (GIMP_ICON_MENU_RIGHT,
GTK_ICON_SIZE_MENU);
gtk_container_add (GTK_CONTAINER (shell->origin), gtk_image);
gtk_widget_show (gtk_image);
g_signal_connect (shell->origin, "button-press-event",
G_CALLBACK (gimp_display_shell_origin_button_press),
shell);
gimp_help_set_help_data (shell->origin,
_("Access the image menu"),
GIMP_HELP_IMAGE_WINDOW_ORIGIN);
/* the canvas */
shell->canvas = gimp_canvas_new (config);
gtk_widget_set_size_request (shell->canvas, shell_width, shell_height);
gtk_container_set_border_width (GTK_CONTAINER (shell->canvas), 10);
g_signal_connect (shell->canvas, "remove",
G_CALLBACK (gimp_display_shell_remove_overlay),
shell);
gimp_display_shell_dnd_init (shell);
gimp_display_shell_selection_init (shell);
shell->zoom_gesture = gtk_gesture_zoom_new (GTK_WIDGET (shell->canvas));
gtk_event_controller_set_propagation_phase (GTK_EVENT_CONTROLLER (shell->zoom_gesture),
GTK_PHASE_CAPTURE);
shell->zoom_gesture_active = FALSE;
shell->rotate_gesture = gtk_gesture_rotate_new (GTK_WIDGET (shell->canvas));
gtk_event_controller_set_propagation_phase (GTK_EVENT_CONTROLLER (shell->rotate_gesture),
GTK_PHASE_CAPTURE);
shell->rotate_gesture_active = FALSE;
/* the horizontal ruler */
shell->hrule = gimp_ruler_new (GTK_ORIENTATION_HORIZONTAL);
gtk_widget_set_events (GTK_WIDGET (shell->hrule),
GDK_BUTTON_PRESS_MASK |
GDK_BUTTON_RELEASE_MASK);
gimp_ruler_add_track_widget (GIMP_RULER (shell->hrule), shell->canvas);
g_signal_connect (shell->hrule, "button-press-event",
G_CALLBACK (gimp_display_shell_hruler_button_press),
shell);
gimp_help_set_help_data (shell->hrule, NULL, GIMP_HELP_IMAGE_WINDOW_RULER);
/* the vertical ruler */
shell->vrule = gimp_ruler_new (GTK_ORIENTATION_VERTICAL);
gtk_widget_set_events (GTK_WIDGET (shell->vrule),
GDK_BUTTON_PRESS_MASK |
GDK_BUTTON_RELEASE_MASK);
gimp_ruler_add_track_widget (GIMP_RULER (shell->vrule), shell->canvas);
g_signal_connect (shell->vrule, "button-press-event",
G_CALLBACK (gimp_display_shell_vruler_button_press),
shell);
gimp_help_set_help_data (shell->vrule, NULL, GIMP_HELP_IMAGE_WINDOW_RULER);
/* set the rulers as track widgets for each other, so we don't end up
* with one ruler wrongly being stuck a few pixels off while we are
* hovering the other
*/
gimp_ruler_add_track_widget (GIMP_RULER (shell->hrule), shell->vrule);
gimp_ruler_add_track_widget (GIMP_RULER (shell->vrule), shell->hrule);
gimp_devices_add_widget (shell->display->gimp, shell->hrule);
gimp_devices_add_widget (shell->display->gimp, shell->vrule);
g_signal_connect (shell->canvas, "grab-notify",
G_CALLBACK (gimp_display_shell_canvas_grab_notify),
shell);
gimp_widget_set_native_handle (GTK_WIDGET (shell), &shell->window_handle);
g_signal_connect (shell->canvas, "realize",
G_CALLBACK (gimp_display_shell_canvas_realize),
shell);
g_signal_connect (shell->canvas, "size-allocate",
G_CALLBACK (gimp_display_shell_canvas_size_allocate),
shell);
g_signal_connect (shell->canvas, "draw",
G_CALLBACK (gimp_display_shell_canvas_draw),
shell);
g_signal_connect (shell->canvas, "enter-notify-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "leave-notify-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "proximity-in-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "proximity-out-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "focus-in-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "focus-out-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "button-press-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "button-release-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "scroll-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "motion-notify-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "key-press-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->canvas, "key-release-event",
G_CALLBACK (gimp_display_shell_canvas_tool_events),
shell);
g_signal_connect (shell->zoom_gesture, "begin",
G_CALLBACK (gimp_display_shell_zoom_gesture_begin),
shell);
g_signal_connect (shell->zoom_gesture, "update",
G_CALLBACK (gimp_display_shell_zoom_gesture_update),
shell);
g_signal_connect (shell->zoom_gesture, "end",
G_CALLBACK (gimp_display_shell_zoom_gesture_end),
shell);
g_signal_connect (shell->rotate_gesture, "begin",
G_CALLBACK (gimp_display_shell_rotate_gesture_begin),
shell);
g_signal_connect (shell->rotate_gesture, "update",
G_CALLBACK (gimp_display_shell_rotate_gesture_update),
shell);
g_signal_connect (shell->rotate_gesture, "end",
G_CALLBACK (gimp_display_shell_rotate_gesture_end),
shell);
/* the zoom button */
shell->zoom_button = g_object_new (GTK_TYPE_CHECK_BUTTON,
"draw-indicator", FALSE,
"relief", GTK_RELIEF_NONE,
"width-request", 18,
"height-request", 18,
NULL);
gtk_widget_set_can_focus (shell->zoom_button, FALSE);
gtk_image = gtk_image_new_from_icon_name (GIMP_ICON_ZOOM_FOLLOW_WINDOW,
GTK_ICON_SIZE_MENU);
gtk_container_add (GTK_CONTAINER (shell->zoom_button), gtk_image);
gtk_widget_show (gtk_image);
g_signal_connect_swapped (shell->zoom_button, "toggled",
G_CALLBACK (gimp_display_shell_zoom_button_callback),
shell);
gimp_help_set_help_data (shell->zoom_button,
_("Zoom image when window size changes"),
GIMP_HELP_IMAGE_WINDOW_ZOOM_FOLLOW_BUTTON);
/* the quick mask button */
shell->quick_mask_button = g_object_new (GTK_TYPE_CHECK_BUTTON,
"draw-indicator", FALSE,
"relief", GTK_RELIEF_NONE,
"width-request", 18,
"height-request", 18,
NULL);
gtk_widget_set_can_focus (shell->quick_mask_button, FALSE);
gtk_image = gtk_image_new_from_icon_name (GIMP_ICON_QUICK_MASK_OFF,
GTK_ICON_SIZE_MENU);
gtk_container_add (GTK_CONTAINER (shell->quick_mask_button), gtk_image);
gtk_widget_show (gtk_image);
g_signal_connect (shell->quick_mask_button, "toggled",
G_CALLBACK (gimp_display_shell_quick_mask_toggled),
shell);
g_signal_connect (shell->quick_mask_button, "button-press-event",
G_CALLBACK (gimp_display_shell_quick_mask_button_press),
shell);
action = gimp_ui_manager_find_action (shell->popup_manager,
"quick-mask", "quick-mask-toggle");
if (action)
gimp_widget_set_accel_help (shell->quick_mask_button, action);
else
gimp_help_set_help_data (shell->quick_mask_button,
_("Toggle Quick Mask"),
GIMP_HELP_IMAGE_WINDOW_QUICK_MASK_BUTTON);
/* the navigation window button */
shell->nav_ebox = gtk_event_box_new ();
gtk_image = gtk_image_new_from_icon_name (GIMP_ICON_DIALOG_NAVIGATION,
GTK_ICON_SIZE_MENU);
gtk_container_add (GTK_CONTAINER (shell->nav_ebox), gtk_image);
gtk_widget_show (gtk_image);
g_signal_connect (shell->nav_ebox, "button-press-event",
G_CALLBACK (gimp_display_shell_navigation_button_press),
shell);
gimp_help_set_help_data (shell->nav_ebox,
_("Navigate the image display"),
GIMP_HELP_IMAGE_WINDOW_NAV_BUTTON);
/* the statusbar */
shell->statusbar = gimp_statusbar_new ();
gimp_statusbar_set_shell (GIMP_STATUSBAR (shell->statusbar), shell);
gimp_help_set_help_data (shell->statusbar, NULL,
GIMP_HELP_IMAGE_WINDOW_STATUS_BAR);
/* pack all the widgets */
gtk_grid_attach (GTK_GRID (grid), shell->origin, 0, 0, 1, 1);
gtk_widget_set_hexpand (shell->hrule, TRUE);
gtk_grid_attach (GTK_GRID (grid), shell->hrule, 1, 0, 1, 1);
gtk_widget_set_vexpand (shell->vrule, TRUE);
gtk_grid_attach (GTK_GRID (grid), shell->vrule, 0, 1, 1, 1);
gtk_widget_set_hexpand (shell->canvas, TRUE);
gtk_widget_set_vexpand (shell->canvas, TRUE);
gtk_grid_attach (GTK_GRID (grid), shell->canvas, 1, 1, 1, 1);
gtk_grid_attach (GTK_GRID (grid), shell->zoom_button, 2, 0, 1, 1);
gtk_grid_attach (GTK_GRID (grid), shell->quick_mask_button, 0, 2, 1, 1);
gtk_grid_attach (GTK_GRID (grid), shell->vsb, 2, 1, 1, 1);
gtk_grid_attach (GTK_GRID (grid), shell->hsb, 1, 2, 1, 1);
gtk_grid_attach (GTK_GRID (grid), shell->nav_ebox, 2, 2, 1, 1);
gtk_widget_set_hexpand (shell->statusbar, TRUE);
gtk_grid_attach (GTK_GRID (grid), shell->statusbar, 0, 3, 3, 1);
/* show everything that is always shown */
gtk_widget_show (GTK_WIDGET (shell->canvas));
if (image)
{
gimp_display_shell_connect (shell);
/* After connecting to the image we want to center it. Since we
* not even finished creating the display shell, we can safely
* assume we will get a size-allocate later.
*/
shell->size_allocate_center_image = TRUE;
}
else
{
#if 0
/* Disabled because it sets GDK_POINTER_MOTION_HINT on
* shell->canvas. For info see Bug 677375
*/
gimp_help_set_help_data (shell->canvas,
_("Drop image files here to open them"),
NULL);
#endif
gimp_statusbar_empty (GIMP_STATUSBAR (shell->statusbar));
}
/* make sure the information is up-to-date */
gimp_display_shell_scale_update (shell);
gimp_display_shell_set_show_all (shell, config->default_show_all);
}
static void
gimp_display_shell_dispose (GObject *object)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (object);
if (shell->display && gimp_display_get_shell (shell->display))
gimp_display_shell_disconnect (shell);
shell->popup_manager = NULL;
if (shell->selection)
gimp_display_shell_selection_free (shell);
gimp_display_shell_filter_set (shell, NULL);
if (shell->filter_idle_id)
{
g_source_remove (shell->filter_idle_id);
shell->filter_idle_id = 0;
}
g_clear_object (&shell->zoom_gesture);
g_clear_object (&shell->rotate_gesture);
g_clear_pointer (&shell->render_cache, cairo_surface_destroy);
g_clear_pointer (&shell->render_cache_valid, cairo_region_destroy);
g_clear_pointer (&shell->render_surface, cairo_surface_destroy);
g_clear_pointer (&shell->mask_surface, cairo_surface_destroy);
g_clear_pointer (&shell->checkerboard, cairo_pattern_destroy);
gimp_display_shell_profile_finalize (shell);
g_clear_object (&shell->filter_buffer);
shell->filter_data = NULL;
shell->filter_stride = 0;
g_clear_object (&shell->mask);
gimp_display_shell_items_free (shell);
g_clear_object (&shell->motion_buffer);
if (shell->zoom_focus_point)
{
g_slice_free (GdkPoint, shell->zoom_focus_point);
shell->zoom_focus_point = NULL;
}
if (shell->title_idle_id)
{
g_source_remove (shell->title_idle_id);
shell->title_idle_id = 0;
}
if (shell->fill_idle_id)
{
g_source_remove (shell->fill_idle_id);
shell->fill_idle_id = 0;
}
g_clear_pointer (&shell->nav_popup, gtk_widget_destroy);
if (shell->blink_timeout_id)
{
g_source_remove (shell->blink_timeout_id);
shell->blink_timeout_id = 0;
}
shell->display = NULL;
if (shell->window_handle != NULL)
{
#ifdef GDK_WINDOWING_WAYLAND
if (GDK_IS_WAYLAND_DISPLAY (gdk_display_get_default ()) &&
/* The GdkWindow is likely already destroyed. */
gtk_widget_get_window (GTK_WIDGET (shell)) != NULL)
gdk_wayland_window_unexport_handle (gtk_widget_get_window (GTK_WIDGET (shell)));
#endif
g_clear_pointer (&shell->window_handle, g_bytes_unref);
}
G_OBJECT_CLASS (parent_class)->dispose (object);
}
static void
gimp_display_shell_finalize (GObject *object)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (object);
g_clear_object (&shell->zoom);
g_clear_pointer (&shell->rotate_transform, g_free);
g_clear_pointer (&shell->rotate_untransform, g_free);
g_clear_object (&shell->options);
g_clear_object (&shell->fullscreen_options);
g_clear_object (&shell->no_image_options);
g_clear_pointer (&shell->title, g_free);
g_clear_pointer (&shell->status, g_free);
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static void
gimp_display_shell_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (object);
switch (property_id)
{
case PROP_POPUP_MANAGER:
shell->popup_manager = g_value_get_object (value);
break;
case PROP_INITIAL_MONITOR:
shell->initial_monitor = g_value_get_object (value);
break;
case PROP_DISPLAY:
shell->display = g_value_get_object (value);
break;
case PROP_UNIT:
gimp_display_shell_set_unit (shell, g_value_get_int (value));
break;
case PROP_TITLE:
g_free (shell->title);
shell->title = g_value_dup_string (value);
break;
case PROP_STATUS:
g_free (shell->status);
shell->status = g_value_dup_string (value);
break;
case PROP_SHOW_ALL:
gimp_display_shell_set_show_all (shell, g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_display_shell_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (object);
switch (property_id)
{
case PROP_POPUP_MANAGER:
g_value_set_object (value, shell->popup_manager);
break;
case PROP_INITIAL_MONITOR:
g_value_set_object (value, shell->initial_monitor);
break;
case PROP_DISPLAY:
g_value_set_object (value, shell->display);
break;
case PROP_UNIT:
g_value_set_int (value, shell->unit);
break;
case PROP_TITLE:
g_value_set_string (value, shell->title);
break;
case PROP_STATUS:
g_value_set_string (value, shell->status);
break;
case PROP_SHOW_ALL:
g_value_set_boolean (value, shell->show_all);
break;
case PROP_INFINITE_CANVAS:
g_value_set_boolean (value,
gimp_display_shell_get_infinite_canvas (shell));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_display_shell_unrealize (GtkWidget *widget)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (widget);
if (shell->nav_popup)
gtk_widget_unrealize (shell->nav_popup);
GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}
static void
gimp_display_shell_unmap (GtkWidget *widget)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (widget);
gimp_display_shell_selection_undraw (shell);
GTK_WIDGET_CLASS (parent_class)->unmap (widget);
}
static void
gimp_display_shell_screen_changed (GtkWidget *widget,
GdkScreen *previous)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (widget);
if (GTK_WIDGET_CLASS (parent_class)->screen_changed)
GTK_WIDGET_CLASS (parent_class)->screen_changed (widget, previous);
if (shell->display->config->monitor_res_from_gdk)
{
gimp_get_monitor_resolution (gimp_widget_get_monitor (widget),
&shell->monitor_xres,
&shell->monitor_yres);
}
else
{
shell->monitor_xres = shell->display->config->monitor_xres;
shell->monitor_yres = shell->display->config->monitor_yres;
}
}
static gboolean
gimp_display_shell_popup_menu (GtkWidget *widget)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (widget);
gimp_context_set_display (gimp_get_user_context (shell->display->gimp),
shell->display);
gimp_ui_manager_ui_popup_at_widget (shell->popup_manager,
"/image-menubar",
NULL, NULL,
shell->origin,
GDK_GRAVITY_EAST,
GDK_GRAVITY_NORTH_WEST,
NULL,
NULL, NULL);
return TRUE;
}
static void
gimp_display_shell_real_scaled (GimpDisplayShell *shell)
{
GimpContext *user_context;
if (! shell->display)
return;
gimp_display_shell_title_update (shell);
user_context = gimp_get_user_context (shell->display->gimp);
if (shell->display == gimp_context_get_display (user_context))
{
gimp_display_shell_update_priority_rect (shell);
gimp_ui_manager_update (shell->popup_manager, shell->display);
}
}
static void
gimp_display_shell_real_scrolled (GimpDisplayShell *shell)
{
GimpContext *user_context;
if (! shell->display)
return;
gimp_display_shell_title_update (shell);
user_context = gimp_get_user_context (shell->display->gimp);
if (shell->display == gimp_context_get_display (user_context))
{
gimp_display_shell_update_priority_rect (shell);
}
}
static void
gimp_display_shell_real_rotated (GimpDisplayShell *shell)
{
GimpContext *user_context;
if (! shell->display)
return;
gimp_display_shell_title_update (shell);
user_context = gimp_get_user_context (shell->display->gimp);
if (shell->display == gimp_context_get_display (user_context))
{
gimp_display_shell_update_priority_rect (shell);
gimp_ui_manager_update (shell->popup_manager, shell->display);
}
}
static const guint8 *
gimp_display_shell_get_icc_profile (GimpColorManaged *managed,
gsize *len)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (managed);
GimpImage *image = gimp_display_get_image (shell->display);
if (image)
return gimp_color_managed_get_icc_profile (GIMP_COLOR_MANAGED (image), len);
return NULL;
}
static GimpColorProfile *
gimp_display_shell_get_color_profile (GimpColorManaged *managed)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (managed);
GimpImage *image = gimp_display_get_image (shell->display);
if (image)
return gimp_color_managed_get_color_profile (GIMP_COLOR_MANAGED (image));
return NULL;
}
static void
gimp_display_shell_profile_changed (GimpColorManaged *managed)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (managed);
gimp_display_shell_profile_update (shell);
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
}
static void
gimp_display_shell_simulation_profile_changed (GimpColorManaged *managed)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (managed);
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
}
static void
gimp_display_shell_simulation_intent_changed (GimpColorManaged *managed)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (managed);
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
}
static void
gimp_display_shell_simulation_bpc_changed (GimpColorManaged *managed)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (managed);
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
}
static void
gimp_display_shell_zoom_button_callback (GimpDisplayShell *shell,
GtkWidget *zoom_button)
{
shell->zoom_on_resize =
gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (zoom_button));
if (shell->zoom_on_resize &&
gimp_display_shell_scale_image_is_within_viewport (shell, NULL, NULL))
{
/* Implicitly make a View -> Fit Image in Window */
gimp_display_shell_scale_fit_in (shell);
}
}
static void
gimp_display_shell_sync_config (GimpDisplayShell *shell,
GimpDisplayConfig *config)
{
gimp_config_sync (G_OBJECT (config->default_view),
G_OBJECT (shell->options), 0);
gimp_config_sync (G_OBJECT (config->default_fullscreen_view),
G_OBJECT (shell->fullscreen_options), 0);
}
static void
gimp_display_shell_overlay_allocate (GtkWidget *child,
GtkAllocation *allocation,
GimpDisplayShellOverlay *overlay)
{
gdouble x, y;
gimp_display_shell_transform_overlay (overlay->shell, child, &x, &y);
gimp_overlay_box_set_child_position (GIMP_OVERLAY_BOX (overlay->shell->canvas),
child, x, y);
}
static void
gimp_display_shell_remove_overlay (GtkWidget *canvas,
GtkWidget *child,
GimpDisplayShell *shell)
{
GimpDisplayShellOverlay *overlay;
overlay = g_object_get_data (G_OBJECT (child), "image-coords-overlay");
g_signal_handlers_disconnect_by_func (child,
gimp_display_shell_overlay_allocate,
overlay);
shell->children = g_list_remove (shell->children, child);
}
static void
gimp_display_shell_transform_overlay (GimpDisplayShell *shell,
GtkWidget *child,
gdouble *x,
gdouble *y)
{
GimpDisplayShellOverlay *overlay;
GtkRequisition requisition;
overlay = g_object_get_data (G_OBJECT (child), "image-coords-overlay");
gimp_display_shell_transform_xy_f (shell,
overlay->image_x,
overlay->image_y,
x, y);
gtk_widget_get_preferred_size (child, &requisition, NULL);
switch (overlay->anchor)
{
case GIMP_HANDLE_ANCHOR_CENTER:
*x -= requisition.width / 2;
*y -= requisition.height / 2;
break;
case GIMP_HANDLE_ANCHOR_NORTH:
*x -= requisition.width / 2;
*y += overlay->spacing_y;
break;
case GIMP_HANDLE_ANCHOR_NORTH_WEST:
*x += overlay->spacing_x;
*y += overlay->spacing_y;
break;
case GIMP_HANDLE_ANCHOR_NORTH_EAST:
*x -= requisition.width + overlay->spacing_x;
*y += overlay->spacing_y;
break;
case GIMP_HANDLE_ANCHOR_SOUTH:
*x -= requisition.width / 2;
*y -= requisition.height + overlay->spacing_y;
break;
case GIMP_HANDLE_ANCHOR_SOUTH_WEST:
*x += overlay->spacing_x;
*y -= requisition.height + overlay->spacing_y;
break;
case GIMP_HANDLE_ANCHOR_SOUTH_EAST:
*x -= requisition.width + overlay->spacing_x;
*y -= requisition.height + overlay->spacing_y;
break;
case GIMP_HANDLE_ANCHOR_WEST:
*x += overlay->spacing_x;
*y -= requisition.height / 2;
break;
case GIMP_HANDLE_ANCHOR_EAST:
*x -= requisition.width + overlay->spacing_x;
*y -= requisition.height / 2;
break;
}
}
/* public functions */
GtkWidget *
gimp_display_shell_new (GimpDisplay *display,
GimpUnit unit,
gdouble scale,
GimpUIManager *popup_manager,
GdkMonitor *monitor)
{
g_return_val_if_fail (GIMP_IS_DISPLAY (display), NULL);
g_return_val_if_fail (GIMP_IS_UI_MANAGER (popup_manager), NULL);
g_return_val_if_fail (GDK_IS_MONITOR (monitor), NULL);
return g_object_new (GIMP_TYPE_DISPLAY_SHELL,
"popup-manager", popup_manager,
"initial-monitor", monitor,
"display", display,
"unit", unit,
NULL);
}
void
gimp_display_shell_add_overlay (GimpDisplayShell *shell,
GtkWidget *child,
gdouble image_x,
gdouble image_y,
GimpHandleAnchor anchor,
gint spacing_x,
gint spacing_y)
{
GimpDisplayShellOverlay *overlay;
gdouble x, y;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (GTK_IS_WIDGET (shell));
overlay = g_new0 (GimpDisplayShellOverlay, 1);
overlay->shell = shell;
overlay->image_x = image_x;
overlay->image_y = image_y;
overlay->anchor = anchor;
overlay->spacing_x = spacing_x;
overlay->spacing_y = spacing_y;
g_object_set_data_full (G_OBJECT (child), "image-coords-overlay", overlay,
(GDestroyNotify) g_free);
shell->children = g_list_prepend (shell->children, child);
g_signal_connect (child, "size-allocate",
G_CALLBACK (gimp_display_shell_overlay_allocate),
overlay);
gimp_display_shell_transform_overlay (shell, child, &x, &y);
gimp_overlay_box_add_child (GIMP_OVERLAY_BOX (shell->canvas), child, 0.0, 0.0);
gimp_overlay_box_set_child_position (GIMP_OVERLAY_BOX (shell->canvas),
child, x, y);
}
void
gimp_display_shell_move_overlay (GimpDisplayShell *shell,
GtkWidget *child,
gdouble image_x,
gdouble image_y,
GimpHandleAnchor anchor,
gint spacing_x,
gint spacing_y)
{
GimpDisplayShellOverlay *overlay;
gdouble x, y;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (GTK_IS_WIDGET (shell));
overlay = g_object_get_data (G_OBJECT (child), "image-coords-overlay");
g_return_if_fail (overlay != NULL);
overlay->image_x = image_x;
overlay->image_y = image_y;
overlay->anchor = anchor;
overlay->spacing_x = spacing_x;
overlay->spacing_y = spacing_y;
gimp_display_shell_transform_overlay (shell, child, &x, &y);
gimp_overlay_box_set_child_position (GIMP_OVERLAY_BOX (shell->canvas),
child, x, y);
}
GimpImageWindow *
gimp_display_shell_get_window (GimpDisplayShell *shell)
{
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);
return GIMP_IMAGE_WINDOW (gtk_widget_get_ancestor (GTK_WIDGET (shell),
GIMP_TYPE_IMAGE_WINDOW));
}
GimpStatusbar *
gimp_display_shell_get_statusbar (GimpDisplayShell *shell)
{
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);
return GIMP_STATUSBAR (shell->statusbar);
}
GimpColorConfig *
gimp_display_shell_get_color_config (GimpDisplayShell *shell)
{
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);
return shell->color_config;
}
void
gimp_display_shell_present (GimpDisplayShell *shell)
{
GimpImageWindow *window;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
window = gimp_display_shell_get_window (shell);
if (window)
{
gimp_image_window_set_active_shell (window, shell);
gtk_window_present (GTK_WINDOW (window));
}
}
void
gimp_display_shell_reconnect (GimpDisplayShell *shell)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (GIMP_IS_DISPLAY (shell->display));
g_return_if_fail (gimp_display_get_image (shell->display) != NULL);
if (shell->fill_idle_id)
{
g_source_remove (shell->fill_idle_id);
shell->fill_idle_id = 0;
}
g_signal_emit (shell, display_shell_signals[RECONNECT], 0);
gimp_color_managed_profile_changed (GIMP_COLOR_MANAGED (shell));
gimp_display_shell_simulation_profile_changed (GIMP_COLOR_MANAGED (shell));
gimp_display_shell_simulation_intent_changed (GIMP_COLOR_MANAGED (shell));
gimp_display_shell_simulation_bpc_changed (GIMP_COLOR_MANAGED (shell));
gimp_display_shell_scroll_clamp_and_update (shell);
gimp_display_shell_scaled (shell);
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
}
static gboolean
gimp_display_shell_blink (GimpDisplayShell *shell)
{
shell->blink_timeout_id = 0;
if (shell->blink)
{
shell->blink = FALSE;
}
else
{
shell->blink = TRUE;
shell->blink_timeout_id =
g_timeout_add (100, (GSourceFunc) gimp_display_shell_blink, shell);
}
gimp_display_shell_expose_full (shell);
return FALSE;
}
void
gimp_display_shell_empty (GimpDisplayShell *shell)
{
GimpContext *user_context;
GimpImageWindow *window;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (GIMP_IS_DISPLAY (shell->display));
g_return_if_fail (gimp_display_get_image (shell->display) == NULL);
window = gimp_display_shell_get_window (shell);
if (shell->fill_idle_id)
{
g_source_remove (shell->fill_idle_id);
shell->fill_idle_id = 0;
}
gimp_display_shell_selection_undraw (shell);
gimp_display_shell_unset_cursor (shell);
gimp_display_shell_filter_set (shell, NULL);
gimp_display_shell_sync_config (shell, shell->display->config);
gimp_display_shell_appearance_update (shell);
gimp_image_window_update_tabs (window);
#if 0
gimp_help_set_help_data (shell->canvas,
_("Drop image files here to open them"), NULL);
#endif
gimp_statusbar_empty (GIMP_STATUSBAR (shell->statusbar));
shell->flip_horizontally = FALSE;
shell->flip_vertically = FALSE;
shell->rotate_angle = 0.0;
gimp_display_shell_rotate_update_transform (shell);
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
user_context = gimp_get_user_context (shell->display->gimp);
if (shell->display == gimp_context_get_display (user_context))
gimp_ui_manager_update (shell->popup_manager, shell->display);
shell->blink_timeout_id =
g_timeout_add (1403230, (GSourceFunc) gimp_display_shell_blink, shell);
}
static gboolean
gimp_display_shell_fill_idle (GimpDisplayShell *shell)
{
GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (shell));
shell->fill_idle_id = 0;
if (GTK_IS_WINDOW (toplevel))
{
gimp_display_shell_scale_shrink_wrap (shell, TRUE);
gtk_window_present (GTK_WINDOW (toplevel));
}
return FALSE;
}
void
gimp_display_shell_fill (GimpDisplayShell *shell,
GimpImage *image,
GimpUnit unit,
gdouble scale)
{
GimpDisplayConfig *config;
GimpImageWindow *window;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (GIMP_IS_DISPLAY (shell->display));
g_return_if_fail (GIMP_IS_IMAGE (image));
config = shell->display->config;
window = gimp_display_shell_get_window (shell);
shell->show_image = TRUE;
shell->dot_for_dot = config->default_dot_for_dot;
gimp_display_shell_set_unit (shell, unit);
gimp_display_shell_set_initial_scale (shell, scale, NULL, NULL);
gimp_display_shell_scale_update (shell);
gimp_display_shell_sync_config (shell, config);
gimp_image_window_suspend_keep_pos (window);
gimp_display_shell_appearance_update (shell);
gimp_image_window_resume_keep_pos (window);
gimp_image_window_update_tabs (window);
#if 0
gimp_help_set_help_data (shell->canvas, NULL, NULL);
#endif
gimp_statusbar_fill (GIMP_STATUSBAR (shell->statusbar));
/* make sure a size-allocate always occurs, even when the rulers and
* scrollbars are hidden. see issue #4968.
*/
shell->size_allocate_center_image = TRUE;
gtk_widget_queue_resize (GTK_WIDGET (shell->canvas));
if (shell->blink_timeout_id)
{
g_source_remove (shell->blink_timeout_id);
shell->blink_timeout_id = 0;
}
shell->fill_idle_id =
g_idle_add_full (GIMP_PRIORITY_DISPLAY_SHELL_FILL_IDLE,
(GSourceFunc) gimp_display_shell_fill_idle, shell,
NULL);
gimp_display_shell_set_show_all (shell, config->default_show_all);
}
void
gimp_display_shell_scaled (GimpDisplayShell *shell)
{
GList *list;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
gimp_display_shell_rotate_update_transform (shell);
for (list = shell->children; list; list = g_list_next (list))
{
GtkWidget *child = list->data;
gdouble x, y;
gimp_display_shell_transform_overlay (shell, child, &x, &y);
gimp_overlay_box_set_child_position (GIMP_OVERLAY_BOX (shell->canvas),
child, x, y);
}
g_signal_emit (shell, display_shell_signals[SCALED], 0);
}
void
gimp_display_shell_scrolled (GimpDisplayShell *shell)
{
GList *list;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
gimp_display_shell_rotate_update_transform (shell);
for (list = shell->children; list; list = g_list_next (list))
{
GtkWidget *child = list->data;
gdouble x, y;
gimp_display_shell_transform_overlay (shell, child, &x, &y);
gimp_overlay_box_set_child_position (GIMP_OVERLAY_BOX (shell->canvas),
child, x, y);
}
g_signal_emit (shell, display_shell_signals[SCROLLED], 0);
}
void
gimp_display_shell_rotated (GimpDisplayShell *shell)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
gimp_display_shell_rotate_update_transform (shell);
g_signal_emit (shell, display_shell_signals[ROTATED], 0);
}
void
gimp_display_shell_set_unit (GimpDisplayShell *shell,
GimpUnit unit)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
if (shell->unit != unit)
{
shell->unit = unit;
gimp_display_shell_rulers_update (shell);
gimp_display_shell_scaled (shell);
g_object_notify (G_OBJECT (shell), "unit");
}
}
GimpUnit
gimp_display_shell_get_unit (GimpDisplayShell *shell)
{
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), GIMP_UNIT_PIXEL);
return shell->unit;
}
gboolean
gimp_display_shell_snap_coords (GimpDisplayShell *shell,
GimpCoords *coords,
gint snap_offset_x,
gint snap_offset_y,
gint snap_width,
gint snap_height)
{
GimpImageSnapData snapping_data =
{
GIMP_ARRANGE_HFILL,
NULL,
GIMP_ARRANGE_HFILL,
NULL,
GIMP_ARRANGE_HFILL,
NULL,
NULL,
GIMP_ARRANGE_HFILL,
NULL,
NULL
};
GimpImage *image;
gboolean snap_to_guides = FALSE;
gboolean snap_to_grid = FALSE;
gboolean snap_to_canvas = FALSE;
gboolean snap_to_vectors = FALSE;
gboolean snap_to_bbox = FALSE;
gboolean snap_to_equidistance = FALSE;
gboolean snapped = FALSE;
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), FALSE);
g_return_val_if_fail (coords != NULL, FALSE);
image = gimp_display_get_image (shell->display);
if (gimp_display_shell_get_snap_to_guides (shell) &&
gimp_image_get_guides (image))
{
snap_to_guides = TRUE;
}
if (gimp_display_shell_get_snap_to_grid (shell) &&
gimp_image_get_grid (image))
{
snap_to_grid = TRUE;
}
snap_to_canvas = gimp_display_shell_get_snap_to_canvas (shell);
if (gimp_display_shell_get_snap_to_vectors (shell) &&
gimp_image_get_selected_vectors (image))
{
snap_to_vectors = TRUE;
}
if (gimp_display_shell_get_snap_to_bbox (shell))
{
snap_to_bbox = TRUE;
}
shell->snapped_side_horizontal = GIMP_ARRANGE_HFILL;
shell->snapped_side_vertical = GIMP_ARRANGE_HFILL;
if (gimp_display_shell_get_snap_to_equidistance (shell))
{
snap_to_equidistance = TRUE;
}
shell->equidistance_side_horizontal = GIMP_ARRANGE_HFILL;
shell->equidistance_side_vertical = GIMP_ARRANGE_HFILL;
if (snap_to_guides || snap_to_grid || snap_to_canvas || snap_to_vectors || snap_to_bbox || snap_to_equidistance)
{
gint snap_distance;
gdouble tx, ty;
snap_distance = shell->display->config->snap_distance;
if (snap_width > 0 && snap_height > 0)
{
snapped = gimp_image_snap_rectangle (image,
&snapping_data,
coords->x + snap_offset_x,
coords->y + snap_offset_y,
coords->x + snap_offset_x +
snap_width,
coords->y + snap_offset_y +
snap_height,
&tx,
&ty,
FUNSCALEX (shell, snap_distance),
FUNSCALEY (shell, snap_distance),
snap_to_guides,
snap_to_grid,
snap_to_canvas,
snap_to_vectors,
snap_to_bbox,
snap_to_equidistance);
shell->snapped_side_horizontal = snapping_data.snapped_side_horizontal;
shell->snapped_layer_horizontal = snapping_data.snapped_layer_horizontal;
shell->snapped_side_vertical = snapping_data.snapped_side_vertical;
shell->snapped_layer_vertical = snapping_data.snapped_layer_vertical;
shell->equidistance_side_horizontal = snapping_data.equidistance_side_horizontal;
shell->equidistance_side_vertical = snapping_data.equidistance_side_vertical;
shell->near_layer_horizontal1 = snapping_data.near_layer_horizontal1;
shell->near_layer_horizontal2 = snapping_data.near_layer_horizontal2;
shell->near_layer_vertical1 = snapping_data.near_layer_vertical1;
shell->near_layer_vertical2 = snapping_data.near_layer_vertical2;
}
else
{
snapped = gimp_image_snap_point (image,
coords->x + snap_offset_x,
coords->y + snap_offset_y,
&tx,
&ty,
FUNSCALEX (shell, snap_distance),
FUNSCALEY (shell, snap_distance),
snap_to_guides,
snap_to_grid,
snap_to_canvas,
snap_to_vectors,
snap_to_bbox,
shell->show_all);
}
if (snapped)
{
coords->x = tx - snap_offset_x;
coords->y = ty - snap_offset_y;
}
}
return snapped;
}
gboolean
gimp_display_shell_mask_bounds (GimpDisplayShell *shell,
gint *x,
gint *y,
gint *width,
gint *height)
{
GimpImage *image;
GimpLayer *layer;
gint x1, y1;
gint x2, y2;
gdouble x1_f, y1_f;
gdouble x2_f, y2_f;
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), FALSE);
g_return_val_if_fail (x != NULL, FALSE);
g_return_val_if_fail (y != NULL, FALSE);
g_return_val_if_fail (width != NULL, FALSE);
g_return_val_if_fail (height != NULL, FALSE);
image = gimp_display_get_image (shell->display);
/* If there is a floating selection, handle things differently */
if ((layer = gimp_image_get_floating_selection (image)))
{
gint fs_x;
gint fs_y;
gint fs_width;
gint fs_height;
gimp_item_get_offset (GIMP_ITEM (layer), &fs_x, &fs_y);
fs_width = gimp_item_get_width (GIMP_ITEM (layer));
fs_height = gimp_item_get_height (GIMP_ITEM (layer));
if (! gimp_item_bounds (GIMP_ITEM (gimp_image_get_mask (image)),
x, y, width, height))
{
*x = fs_x;
*y = fs_y;
*width = fs_width;
*height = fs_height;
}
else
{
gimp_rectangle_union (*x, *y, *width, *height,
fs_x, fs_y, fs_width, fs_height,
x, y, width, height);
}
}
else if (! gimp_item_bounds (GIMP_ITEM (gimp_image_get_mask (image)),
x, y, width, height))
{
return FALSE;
}
x1 = *x;
y1 = *y;
x2 = *x + *width;
y2 = *y + *height;
gimp_display_shell_transform_bounds (shell,
x1, y1, x2, y2,
&x1_f, &y1_f, &x2_f, &y2_f);
/* Make sure the extents are within bounds */
x1 = CLAMP (floor (x1_f), 0, shell->disp_width);
y1 = CLAMP (floor (y1_f), 0, shell->disp_height);
x2 = CLAMP (ceil (x2_f), 0, shell->disp_width);
y2 = CLAMP (ceil (y2_f), 0, shell->disp_height);
*x = x1;
*y = y1;
*width = x2 - x1;
*height = y2 - y1;
return (*width > 0) && (*height > 0);
}
void
gimp_display_shell_set_show_image (GimpDisplayShell *shell,
gboolean show_image)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
if (show_image != shell->show_image)
{
shell->show_image = show_image;
gimp_display_shell_expose_full (shell);
}
}
void
gimp_display_shell_set_show_all (GimpDisplayShell *shell,
gboolean show_all)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
if (show_all != shell->show_all)
{
shell->show_all = show_all;
if (shell->display && gimp_display_get_image (shell->display))
{
GimpImage *image = gimp_display_get_image (shell->display);
GimpContext *user_context;
if (show_all)
gimp_image_inc_show_all_count (image);
else
gimp_image_dec_show_all_count (image);
gimp_image_flush (image);
gimp_display_update_bounding_box (shell->display);
gimp_display_shell_update_show_canvas (shell);
gimp_display_shell_scroll_clamp_and_update (shell);
gimp_display_shell_scrollbars_update (shell);
gimp_display_shell_expose_full (shell);
user_context = gimp_get_user_context (shell->display->gimp);
if (shell->display == gimp_context_get_display (user_context))
{
gimp_display_shell_update_priority_rect (shell);
gimp_ui_manager_update (shell->popup_manager, shell->display);
}
}
g_object_notify (G_OBJECT (shell), "show-all");
g_object_notify (G_OBJECT (shell), "infinite-canvas");
}
}
GimpPickable *
gimp_display_shell_get_pickable (GimpDisplayShell *shell)
{
GimpImage *image;
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);
image = gimp_display_get_image (shell->display);
if (image)
{
if (! shell->show_all)
return GIMP_PICKABLE (image);
else
return GIMP_PICKABLE (gimp_image_get_projection (image));
}
return NULL;
}
GimpPickable *
gimp_display_shell_get_canvas_pickable (GimpDisplayShell *shell)
{
GimpImage *image;
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);
image = gimp_display_get_image (shell->display);
if (image)
{
if (! gimp_display_shell_get_infinite_canvas (shell))
return GIMP_PICKABLE (image);
else
return GIMP_PICKABLE (gimp_image_get_projection (image));
}
return NULL;
}
GeglRectangle
gimp_display_shell_get_bounding_box (GimpDisplayShell *shell)
{
GeglRectangle bounding_box = {};
GimpImage *image;
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), bounding_box);
image = gimp_display_get_image (shell->display);
if (image)
{
if (! shell->show_all)
{
bounding_box.width = gimp_image_get_width (image);
bounding_box.height = gimp_image_get_height (image);
}
else
{
bounding_box = gimp_projectable_get_bounding_box (
GIMP_PROJECTABLE (image));
}
}
return bounding_box;
}
gboolean
gimp_display_shell_get_infinite_canvas (GimpDisplayShell *shell)
{
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), FALSE);
return shell->show_all &&
! gimp_display_shell_get_padding_in_show_all (shell);
}
void
gimp_display_shell_update_priority_rect (GimpDisplayShell *shell)
{
GimpImage *image;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
image = gimp_display_get_image (shell->display);
if (image)
{
GimpProjection *projection = gimp_image_get_projection (image);
gint x, y;
gint width, height;
gimp_display_shell_untransform_viewport (shell, ! shell->show_all,
&x, &y, &width, &height);
gimp_projection_set_priority_rect (projection, x, y, width, height);
}
}
void
gimp_display_shell_flush (GimpDisplayShell *shell)
{
GimpImageWindow *window;
GimpContext *context;
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
window = gimp_display_shell_get_window (shell);
gimp_display_shell_title_update (shell);
gimp_canvas_layer_boundary_set_layers (GIMP_CANVAS_LAYER_BOUNDARY (shell->layer_boundary),
gimp_image_get_selected_layers (gimp_display_get_image (shell->display)));
gimp_canvas_canvas_boundary_set_image (GIMP_CANVAS_CANVAS_BOUNDARY (shell->canvas_boundary),
gimp_display_get_image (shell->display));
if (window && gimp_image_window_get_active_shell (window) == shell)
{
GimpUIManager *manager = menus_get_image_manager_singleton (shell->display->gimp);
gimp_ui_manager_update (manager, shell->display);
}
context = gimp_get_user_context (shell->display->gimp);
if (shell->display == gimp_context_get_display (context))
{
gimp_ui_manager_update (shell->popup_manager, shell->display);
}
}
/**
* gimp_display_shell_pause:
* @shell: a display shell
*
* This function increments the pause count or the display shell.
* If it was zero coming in, then the function pauses the active tool,
* so that operations on the display can take place without corrupting
* anything that the tool has drawn. It "undraws" the current tool
* drawing, and must be followed by gimp_display_shell_resume() after
* the operation in question is completed.
**/
void
gimp_display_shell_pause (GimpDisplayShell *shell)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
shell->paused_count++;
if (shell->paused_count == 1)
{
/* pause the currently active tool */
tool_manager_control_active (shell->display->gimp,
GIMP_TOOL_ACTION_PAUSE,
shell->display);
}
}
/**
* gimp_display_shell_resume:
* @shell: a display shell
*
* This function decrements the pause count for the display shell.
* If this brings it to zero, then the current tool is resumed.
* It is an error to call this function without having previously
* called gimp_display_shell_pause().
**/
void
gimp_display_shell_resume (GimpDisplayShell *shell)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (shell->paused_count > 0);
shell->paused_count--;
if (shell->paused_count == 0)
{
/* start the currently active tool */
tool_manager_control_active (shell->display->gimp,
GIMP_TOOL_ACTION_RESUME,
shell->display);
}
}
/**
* gimp_display_shell_set_highlight:
* @shell: a #GimpDisplayShell
* @highlight: a rectangle in image coordinates that should be brought out
* @opacity: how much to hide the unselected area
*
* This function sets an area of the image that should be
* accentuated. The actual implementation is to dim all pixels outside
* this rectangle. Passing %NULL for @highlight unsets the rectangle.
**/
void
gimp_display_shell_set_highlight (GimpDisplayShell *shell,
const GdkRectangle *highlight,
gdouble opacity)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
if (highlight)
{
gimp_canvas_item_begin_change (shell->passe_partout);
gimp_canvas_rectangle_set (shell->passe_partout,
highlight->x,
highlight->y,
highlight->width,
highlight->height);
g_object_set (shell->passe_partout, "opacity", opacity, NULL);
gimp_canvas_item_set_visible (shell->passe_partout, TRUE);
gimp_canvas_item_end_change (shell->passe_partout);
}
else
{
gimp_canvas_item_set_visible (shell->passe_partout, FALSE);
}
}
/**
* gimp_display_shell_set_mask:
* @shell: a #GimpDisplayShell
* @mask: a #GimpDrawable (1 byte per pixel)
* @color: the color to use for drawing the mask
* @inverted: %TRUE if the mask should be drawn inverted
*
* Previews a mask originating at offset_x, offset_x. Depending on
* @inverted, pixels that are selected or not selected are tinted with
* the given color.
**/
void
gimp_display_shell_set_mask (GimpDisplayShell *shell,
GeglBuffer *mask,
gint offset_x,
gint offset_y,
const GimpRGB *color,
gboolean inverted)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
g_return_if_fail (mask == NULL || GEGL_IS_BUFFER (mask));
g_return_if_fail (mask == NULL || color != NULL);
if (mask)
g_object_ref (mask);
if (shell->mask)
g_object_unref (shell->mask);
shell->mask = mask;
shell->mask_offset_x = offset_x;
shell->mask_offset_y = offset_y;
if (mask)
shell->mask_color = *color;
shell->mask_inverted = inverted;
gimp_display_shell_expose_full (shell);
gimp_display_shell_render_invalidate_full (shell);
}