gimp/app/display/gimpimagewindow.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 <http://www.gnu.org/licenses/>.
 */

#include "config.h"

#include <gegl.h>
#include <gtk/gtk.h>

#include "libgimpwidgets/gimpwidgets.h"

#include "display-types.h"

#include "widgets/gimpactiongroup.h"
#include "widgets/gimpdialogfactory.h"
#include "widgets/gimphelp-ids.h"
#include "widgets/gimpmenufactory.h"
#include "widgets/gimpsessioninfo.h"
#include "widgets/gimpuimanager.h"

#include "gimpdisplay.h"
#include "gimpdisplay-foreach.h"
#include "gimpdisplayshell.h"
#include "gimpimagewindow.h"
#include "gimpstatusbar.h"

#include "gimp-log.h"
#include "gimp-intl.h"


enum
{
  PROP_0,
  PROP_MENU_FACTORY,
  PROP_DISPLAY_FACTORY
};


/*  local function prototypes  */

static GObject * gimp_image_window_constructor  (GType                type,
                                                 guint                n_params,
                                                 GObjectConstructParam *params);
static void      gimp_image_window_finalize     (GObject             *object);
static void      gimp_image_window_set_property (GObject             *object,
                                                 guint                property_id,
                                                 const GValue        *value,
                                                 GParamSpec          *pspec);
static void      gimp_image_window_get_property (GObject             *object,
                                                 guint                property_id,
                                                 GValue              *value,
                                                 GParamSpec          *pspec);

static void      gimp_image_window_destroy      (GtkObject           *object);

static gboolean  gimp_image_window_window_state (GtkWidget           *widget,
                                                 GdkEventWindowState *event);
static void      gimp_image_window_style_set    (GtkWidget           *widget,
                                                 GtkStyle            *prev_style);

static void      gimp_image_window_show_tooltip (GimpUIManager       *manager,
                                                 const gchar         *tooltip,
                                                 GimpImageWindow     *window);
static void      gimp_image_window_hide_tooltip (GimpUIManager       *manager,
                                                 GimpImageWindow     *window);

static void      gimp_image_window_image_notify        (GimpDisplay         *display,
                                                        const GParamSpec    *pspec,
                                                        GimpImageWindow     *window);
static void      gimp_image_window_shell_scaled        (GimpDisplayShell    *shell,
                                                        GimpImageWindow     *window);
static void      gimp_image_window_shell_title_notify  (GimpDisplayShell    *shell,
                                                        const GParamSpec    *pspec,
                                                        GimpImageWindow     *window);
static void      gimp_image_window_shell_status_notify (GimpDisplayShell    *shell,
                                                        const GParamSpec    *pspec,
                                                        GimpImageWindow     *window);
static void      gimp_image_window_shell_icon_notify   (GimpDisplayShell    *shell,
                                                        const GParamSpec    *pspec,
                                                        GimpImageWindow     *window);


G_DEFINE_TYPE (GimpImageWindow, gimp_image_window, GIMP_TYPE_WINDOW)

#define parent_class gimp_image_window_parent_class


static const gchar image_window_rc_style[] =
  "style \"fullscreen-menubar-style\"\n"
  "{\n"
  "  GtkMenuBar::shadow-type      = none\n"
  "  GtkMenuBar::internal-padding = 0\n"
  "}\n"
  "widget \"*.gimp-menubar-fullscreen\" style \"fullscreen-menubar-style\"\n";

static void
gimp_image_window_class_init (GimpImageWindowClass *klass)
{
  GObjectClass   *object_class     = G_OBJECT_CLASS (klass);
  GtkObjectClass *gtk_object_class = GTK_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class     = GTK_WIDGET_CLASS (klass);

  object_class->constructor        = gimp_image_window_constructor;
  object_class->finalize           = gimp_image_window_finalize;
  object_class->set_property       = gimp_image_window_set_property;
  object_class->get_property       = gimp_image_window_get_property;

  gtk_object_class->destroy        = gimp_image_window_destroy;

  widget_class->window_state_event = gimp_image_window_window_state;
  widget_class->style_set          = gimp_image_window_style_set;

  g_object_class_install_property (object_class, PROP_MENU_FACTORY,
                                   g_param_spec_object ("menu-factory",
                                                        NULL, NULL,
                                                        GIMP_TYPE_MENU_FACTORY,
                                                        GIMP_PARAM_WRITABLE |
                                                        G_PARAM_CONSTRUCT_ONLY));

  g_object_class_install_property (object_class, PROP_DISPLAY_FACTORY,
                                   g_param_spec_object ("display-factory",
                                                        NULL, NULL,
                                                        GIMP_TYPE_DIALOG_FACTORY,
                                                        GIMP_PARAM_READWRITE |
                                                        G_PARAM_CONSTRUCT_ONLY));

  gtk_rc_parse_string (image_window_rc_style);
}

static void
gimp_image_window_init (GimpImageWindow *window)
{
  gtk_window_set_role (GTK_WINDOW (window), "gimp-image-window");
  gtk_window_set_resizable (GTK_WINDOW (window), TRUE);
}

static GObject *
gimp_image_window_constructor (GType                  type,
                               guint                  n_params,
                               GObjectConstructParam *params)
{
  GObject         *object;
  GimpImageWindow *window;

  object = G_OBJECT_CLASS (parent_class)->constructor (type, n_params, params);

  window = GIMP_IMAGE_WINDOW (object);

  g_assert (GIMP_IS_UI_MANAGER (window->menubar_manager));

  gtk_window_add_accel_group (GTK_WINDOW (window),
                              gtk_ui_manager_get_accel_group (GTK_UI_MANAGER (window->menubar_manager)));

  g_signal_connect (window->menubar_manager, "show-tooltip",
                    G_CALLBACK (gimp_image_window_show_tooltip),
                    window);
  g_signal_connect (window->menubar_manager, "hide-tooltip",
                    G_CALLBACK (gimp_image_window_hide_tooltip),
                    window);

  window->main_vbox = gtk_vbox_new (FALSE, 0);
  gtk_container_add (GTK_CONTAINER (window), window->main_vbox);
  gtk_widget_show (window->main_vbox);

#ifndef GDK_WINDOWING_QUARTZ
  window->menubar =
    gtk_ui_manager_get_widget (GTK_UI_MANAGER (window->menubar_manager),
                               "/image-menubar");
#endif /* !GDK_WINDOWING_QUARTZ */

  if (window->menubar)
    {
      gtk_box_pack_start (GTK_BOX (window->main_vbox),
                          window->menubar, FALSE, FALSE, 0);

      /*  make sure we can activate accels even if the menubar is invisible
       *  (see http://bugzilla.gnome.org/show_bug.cgi?id=137151)
       */
      g_signal_connect (window->menubar, "can-activate-accel",
                        G_CALLBACK (gtk_true),
                        NULL);
    }

  window->statusbar = gimp_statusbar_new ();
  gimp_help_set_help_data (window->statusbar, NULL,
                           GIMP_HELP_IMAGE_WINDOW_STATUS_BAR);
  gtk_box_pack_end (GTK_BOX (window->main_vbox), window->statusbar,
                    FALSE, FALSE, 0);

  return object;
}

static void
gimp_image_window_finalize (GObject *object)
{
  GimpImageWindow *window = GIMP_IMAGE_WINDOW (object);

  if (window->menubar_manager)
    {
      g_object_unref (window->menubar_manager);
      window->menubar_manager = NULL;
    }

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
gimp_image_window_set_property (GObject      *object,
                                guint         property_id,
                                const GValue *value,
                                GParamSpec   *pspec)
{
  GimpImageWindow *window = GIMP_IMAGE_WINDOW (object);

  switch (property_id)
    {
    case PROP_MENU_FACTORY:
      {
        GimpMenuFactory *factory = g_value_get_object (value);

        window->menubar_manager = gimp_menu_factory_manager_new (factory,
                                                                 "<Image>",
                                                                 window,
                                                                 FALSE);
      }
      break;
    case PROP_DISPLAY_FACTORY:
      window->display_factory = g_value_get_object (value);
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gimp_image_window_get_property (GObject    *object,
                                guint       property_id,
                                GValue     *value,
                                GParamSpec *pspec)
{
  GimpImageWindow *window = GIMP_IMAGE_WINDOW (object);

  switch (property_id)
    {
    case PROP_DISPLAY_FACTORY:
      g_value_set_object (value, window->display_factory);
      break;

    case PROP_MENU_FACTORY:
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gimp_image_window_destroy (GtkObject *object)
{
  GimpImageWindow *window = GIMP_IMAGE_WINDOW (object);

  if (window->menubar_manager)
    {
      g_object_unref (window->menubar_manager);
      window->menubar_manager = NULL;
    }

  GTK_OBJECT_CLASS (parent_class)->destroy (object);
}

static gboolean
gimp_image_window_window_state (GtkWidget           *widget,
                                GdkEventWindowState *event)
{
  GimpImageWindow *window  = GIMP_IMAGE_WINDOW (widget);
  GimpDisplay     *display = gimp_image_window_get_active_display (window);

  window->window_state = event->new_window_state;

  if (event->changed_mask & GDK_WINDOW_STATE_FULLSCREEN)
    {
      GimpActionGroup *group;
      gboolean         fullscreen;

      fullscreen = gimp_image_window_get_fullscreen (window);

      GIMP_LOG (WM, "Image window '%s' [%p] set fullscreen %s",
                gtk_window_get_title (GTK_WINDOW (widget)),
                widget,
                fullscreen ? "TURE" : "FALSE");

      if (window->menubar)
        gtk_widget_set_name (window->menubar,
                             fullscreen ? "gimp-menubar-fullscreen" : NULL);

      gtk_statusbar_set_has_resize_grip (GTK_STATUSBAR (window->statusbar),
                                         ! fullscreen);

      group = gimp_ui_manager_get_action_group (window->menubar_manager, "view");
      gimp_action_group_set_action_active (group,
                                           "view-fullscreen", fullscreen);
    }

  if (event->changed_mask & GDK_WINDOW_STATE_ICONIFIED)
    {
      gboolean iconified = (event->new_window_state &
                            GDK_WINDOW_STATE_ICONIFIED) != 0;

      GIMP_LOG (WM, "Image window '%s' [%p] set %s",
                gtk_window_get_title (GTK_WINDOW (widget)),
                widget,
                iconified ? "iconified" : "uniconified");

      if (iconified)
        {
          if (gimp_displays_get_num_visible (display->gimp) == 0)
            {
              GIMP_LOG (WM, "No displays visible any longer");

              gimp_dialog_factories_hide_with_display ();
            }
        }
      else
        {
          gimp_dialog_factories_show_with_display ();
        }

    }

  return FALSE;
}

static void
gimp_image_window_style_set (GtkWidget *widget,
                             GtkStyle  *prev_style)
{
  GimpImageWindow *window = GIMP_IMAGE_WINDOW (widget);
  GtkRequisition   requisition;
  GdkGeometry      geometry;
  GdkWindowHints   geometry_mask;

  GTK_WIDGET_CLASS (parent_class)->style_set (widget, prev_style);

  gtk_widget_size_request (window->statusbar, &requisition);

  geometry.min_height = 23;

  geometry.min_width   = requisition.width;
  geometry.min_height += requisition.height;

  if (window->menubar)
    {
      gtk_widget_size_request (window->menubar, &requisition);

      geometry.min_height += requisition.height;
    }

  geometry_mask = GDK_HINT_MIN_SIZE;

  /*  Only set user pos on the empty display because it gets a pos
   *  set by gimp. All other displays should be placed by the window
   *  manager. See http://bugzilla.gnome.org/show_bug.cgi?id=559580
   */
  if (! gimp_image_window_get_active_display (window)->image)
    geometry_mask |= GDK_HINT_USER_POS;

  gtk_window_set_geometry_hints (GTK_WINDOW (widget), NULL,
                                 &geometry, geometry_mask);

  gimp_dialog_factory_set_has_min_size (GTK_WINDOW (widget), TRUE);
}


/*  public functions  */

void
gimp_image_window_set_active_display (GimpImageWindow *window,
                                      GimpDisplay     *display)
{
  GimpDisplayShell *active_shell;

  g_return_if_fail (GIMP_IS_IMAGE_WINDOW (window));
  g_return_if_fail (GIMP_IS_DISPLAY (display));

#if 0
  /* FIXME enable this when the display is a separate widget */
  if (display == window->active_display)
    return;

  if (window->active_display)
    {
      g_signal_handlers_disconnect_by_func (window->active_display,
                                            gimp_image_window_image_notify,
                                            window);

      active_shell = GIMP_DISPLAY_SHELL (window->active_display->shell);

      g_signal_handlers_disconnect_by_func (active_shell,
                                            gimp_image_window_shell_scaled,
                                            window);
      g_signal_handlers_disconnect_by_func (active_shell,
                                            gimp_image_window_shell_title_notify,
                                            window);
      g_signal_handlers_disconnect_by_func (active_shell,
                                            gimp_image_window_shell_status_notify,
                                            window);
      g_signal_handlers_disconnect_by_func (active_shell,
                                            gimp_image_window_shell_icon_notify,
                                            window);
    }

  window->active_display = display;
#endif

  g_signal_connect (window->active_display, "notify::image",
                    G_CALLBACK (gimp_image_window_image_notify),
                    window);

  active_shell = GIMP_DISPLAY_SHELL (window->active_display->shell);

  gimp_statusbar_set_shell (GIMP_STATUSBAR (window->statusbar), active_shell);

  g_signal_connect (active_shell, "scaled",
                    G_CALLBACK (gimp_image_window_shell_scaled),
                    window);
  /* FIXME: "title" later */
  g_signal_connect (active_shell, "notify::gimp-title",
                    G_CALLBACK (gimp_image_window_shell_title_notify),
                    window);
  g_signal_connect (active_shell, "notify::status",
                    G_CALLBACK (gimp_image_window_shell_status_notify),
                    window);
  /* FIXME: "icon" later */
  g_signal_connect (active_shell, "notify::gimp-icon",
                    G_CALLBACK (gimp_image_window_shell_icon_notify),
                    window);

  gimp_ui_manager_update (window->menubar_manager,
                          window->active_display);
}

GimpDisplay *
gimp_image_window_get_active_display (GimpImageWindow *window)
{
  g_return_val_if_fail (GIMP_IS_IMAGE_WINDOW (window), NULL);

  return window->active_display;
}

void
gimp_image_window_set_fullscreen (GimpImageWindow *window,
                                  gboolean         fullscreen)
{
  g_return_if_fail (GIMP_IS_IMAGE_WINDOW (window));

  if (fullscreen != gimp_image_window_get_fullscreen (window))
    {
      if (fullscreen)
        gtk_window_fullscreen (GTK_WINDOW (window));
      else
        gtk_window_unfullscreen (GTK_WINDOW (window));
    }
}

gboolean
gimp_image_window_get_fullscreen (GimpImageWindow *window)
{
  g_return_val_if_fail (GIMP_IS_IMAGE_WINDOW (window), FALSE);

  return (window->window_state & GDK_WINDOW_STATE_FULLSCREEN) != 0;
}


/*  private functions  */

static void
gimp_image_window_show_tooltip (GimpUIManager   *manager,
                                const gchar     *tooltip,
                                GimpImageWindow *window)
{
  gimp_statusbar_push (GIMP_STATUSBAR (window->statusbar), "menu-tooltip",
                       NULL, "%s", tooltip);
}

static void
gimp_image_window_hide_tooltip (GimpUIManager   *manager,
                                GimpImageWindow *window)
{
  gimp_statusbar_pop (GIMP_STATUSBAR (window->statusbar), "menu-tooltip");
}

static void
gimp_image_window_image_notify (GimpDisplay      *display,
                                const GParamSpec *pspec,
                                GimpImageWindow  *window)
{
  if (display->image)
    {
    }
  else
    {
      GimpSessionInfo *session_info;
      gint             width;
      gint             height;

      gtk_window_unfullscreen (GTK_WINDOW (window));

      /*  get the NIW size before adding the display to the dialog
       *  factory so the window's current size doesn't affect the
       *  stored session info entry.
       */
      session_info =
        gimp_dialog_factory_find_session_info (window->display_factory,
                                               "gimp-empty-image-window");

      if (session_info)
        {
          width  = gimp_session_info_get_width  (session_info);
          height = gimp_session_info_get_height (session_info);
        }
      else
        {
          width  = GTK_WIDGET (window)->allocation.width;
          height = GTK_WIDGET (window)->allocation.height;
        }

      gimp_dialog_factory_add_foreign (window->display_factory,
                                       "gimp-empty-image-window",
                                       GTK_WIDGET (window));

      gimp_statusbar_empty (GIMP_STATUSBAR (window->statusbar));

      gtk_window_unmaximize (GTK_WINDOW (window));
      gtk_window_resize (GTK_WINDOW (window), width, height);

      gimp_ui_manager_update (window->menubar_manager, display);
    }
}

static void
gimp_image_window_shell_scaled (GimpDisplayShell *shell,
                                GimpImageWindow  *window)
{
  /* update the <Image>/View/Zoom menu */
  gimp_ui_manager_update (window->menubar_manager,
                          shell->display);
}

static void
gimp_image_window_shell_title_notify (GimpDisplayShell *shell,
                                      const GParamSpec *pspec,
                                      GimpImageWindow  *window)
{
  gtk_window_set_title (GTK_WINDOW (window), shell->title);
}

static void
gimp_image_window_shell_status_notify (GimpDisplayShell *shell,
                                       const GParamSpec *pspec,
                                       GimpImageWindow  *window)
{
  gimp_statusbar_replace (GIMP_STATUSBAR (window->statusbar), "title",
                          NULL, "%s", shell->status);
}

static void
gimp_image_window_shell_icon_notify (GimpDisplayShell *shell,
                                     const GParamSpec *pspec,
                                     GimpImageWindow  *window)
{
  gtk_window_set_icon (GTK_WINDOW (window), shell->icon);
}