src/ui/widget/dock.cpp

   1 /**
   2  * \brief A desktop dock pane to dock dialogs.
   3  *
   4  * Author:
   5  *   Gustav Broberg <broberg@kth.se>
   6  *
   7  * Copyright (C) 2007 Authors
   8  *
   9  * Released under GNU GPL.  Read the file 'COPYING' for more information.
  10  */
  11
  12 #include "inkscape.h"
  13 #include "prefs-utils.h"
  14 #include "desktop.h"
  15
  16 #include "dock.h"
  17
  18 #include <gtkmm/adjustment.h>
  19
  20 namespace Inkscape {
  21 namespace UI {
  22 namespace Widget {
  23
  24 namespace {
  25
  26 void hideCallback(GtkObject *object, gpointer dock_ptr)
  27 {
  28     g_return_if_fail( dock_ptr != NULL );
  29
  30     Dock *dock = (Dock *)dock_ptr;
  31     dock->hide();
  32 }
  33
  34 void unhideCallback(GtkObject *object, gpointer dock_ptr)
  35 {
  36     g_return_if_fail( dock_ptr != NULL );
  37
  38     Dock *dock = (Dock *)dock_ptr;
  39     dock->show();
  40 }
  41
  42 }
  43
  44 const int Dock::_default_empty_width = 0;
  45 const int Dock::_default_dock_bar_width = 36;
  46
  47
  48 Dock::Dock(Gtk::Orientation orientation)
  49     : _gdl_dock (GDL_DOCK (gdl_dock_new())),
  50       _gdl_dock_bar (GDL_DOCK_BAR (gdl_dock_bar_new(GDL_DOCK(_gdl_dock)))),
  51       _scrolled_window (Gtk::manage(new Gtk::ScrolledWindow))
  52 {
  53     gdl_dock_bar_set_orientation(_gdl_dock_bar, static_cast<GtkOrientation>(orientation));
  54
  55     switch (orientation) {
  56         case Gtk::ORIENTATION_VERTICAL:
  57             _dock_box = Gtk::manage(new Gtk::HBox());
  58             _paned = Gtk::manage(new Gtk::VPaned());
  59             break;
  60         case Gtk::ORIENTATION_HORIZONTAL:
  61             _dock_box = Gtk::manage(new Gtk::VBox());
  62             _paned = Gtk::manage(new Gtk::HPaned());
  63     }
  64
  65     _scrolled_window->add(*_dock_box);
  66     _scrolled_window->set_policy(Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
  67
  68     _paned->pack1(*Glib::wrap(GTK_WIDGET(_gdl_dock)), false, false);
  69     _paned->pack2(_filler, true, false);
  70
  71     _dock_box->pack_start(*_paned, Gtk::PACK_EXPAND_WIDGET);
  72     _dock_box->pack_end(*Gtk::manage(Glib::wrap(GTK_WIDGET(_gdl_dock_bar))), Gtk::PACK_SHRINK);
  73     _dock_box->get_parent()->set_resize_mode(Gtk::RESIZE_PARENT);
  74
  75     _scrolled_window->set_size_request(0);
  76
  77     GdlSwitcherStyle gdl_switcher_style =
  78         static_cast<GdlSwitcherStyle>(prefs_get_int_attribute_limited("options.dock", "switcherstyle",
  79                                                                       GDL_SWITCHER_STYLE_BOTH, 0, 4));
  80
  81     g_object_set (GDL_DOCK_OBJECT(_gdl_dock)->master,
  82                   "switcher-style", gdl_switcher_style,
  83                   "expand-direction", GDL_DOCK_EXPANSION_DIRECTION_DOWN,
  84                   NULL);
  85
  86     GdlDockBarStyle gdl_dock_bar_style =
  87         static_cast<GdlDockBarStyle>(prefs_get_int_attribute_limited("options.dock", "dockbarstyle",
  88                                                                      GDL_DOCK_BAR_BOTH, 0, 3));
  89
  90     gdl_dock_bar_set_style(_gdl_dock_bar, gdl_dock_bar_style);
  91
  92     g_signal_connect(G_OBJECT(INKSCAPE), "dialogs_hide", G_CALLBACK(hideCallback), (void *)this);
  93     g_signal_connect(G_OBJECT(INKSCAPE), "dialogs_unhide", G_CALLBACK(unhideCallback), (void *)this);
  94
  95     g_signal_connect(_paned->gobj(), "button-press-event", G_CALLBACK(_on_paned_button_event), (void *)this);
  96     g_signal_connect(_paned->gobj(), "button-release-event", G_CALLBACK(_on_paned_button_event), (void *)this);
  97
  98     signal_layout_changed().connect(sigc::mem_fun(*this, &Inkscape::UI::Widget::Dock::_onLayoutChanged));
  99 }
 100
 101 Dock::~Dock()
 102 {
 103     g_free(_gdl_dock);
 104     g_free(_gdl_dock_bar);
 105 }
 106
 107 void
 108 Dock::addItem(DockItem& item, DockItem::Placement placement)
 109 {
 110     _dock_items.push_back(&item);
 111     gdl_dock_add_item(_gdl_dock, GDL_DOCK_ITEM(item.gobj()), (GdlDockPlacement)placement);
 112
 113     // FIXME: This is a hack to prevent the dock from expanding the main window, this can't be done
 114     // initially as the paned doesn't exist.
 115     if (Gtk::Paned *paned = getParentPaned())
 116         paned->set_resize_mode(Gtk::RESIZE_QUEUE);
 117 }
 118
 119 Gtk::Widget&
 120 Dock::getWidget()
 121 {
 122      return *_scrolled_window;
 123 }
 124
 125 Gtk::Paned *
 126 Dock::getParentPaned()
 127 {
 128     g_return_val_if_fail(_dock_box, 0);
 129     Gtk::Container *parent = getWidget().get_parent();
 130     return (parent != 0 ? dynamic_cast<Gtk::Paned *>(parent) : 0);
 131 }
 132
 133
 134 Gtk::Paned *
 135 Dock::getPaned()
 136 {
 137     return _paned;
 138 }
 139
 140 GtkWidget *
 141 Dock::getGdlWidget()
 142 {
 143     return GTK_WIDGET(_gdl_dock);
 144 }
 145
 146 bool
 147 Dock::isEmpty() const
 148 {
 149     std::list<const DockItem *>::const_iterator
 150         i = _dock_items.begin(),
 151         e = _dock_items.end();
 152
 153     for (; i != e; ++i)
 154         if ((*i)->getState() == DockItem::DOCKED_STATE)
 155             return false;
 156
 157     return true;
 158 }
 159
 160 bool
 161 Dock::hasIconifiedItems() const
 162 {
 163     std::list<const DockItem *>::const_iterator
 164         i = _dock_items.begin(),
 165         e = _dock_items.end();
 166
 167     for (; i != e; ++i)
 168         if ((*i)->isIconified())
 169             return true;
 170
 171     return false;
 172 }
 173
 174 void
 175 Dock::hide()
 176 {
 177     getWidget().hide();
 178 }
 179
 180 void
 181 Dock::show()
 182 {
 183     getWidget().show();
 184 }
 185
 186 void
 187 Dock::toggleDockable(int width, int height)
 188 {
 189     static int prev_horizontal_position, prev_vertical_position;
 190
 191     Gtk::Paned *parent_paned = getParentPaned();
 192
 193     if (width > 0 && height > 0) {
 194         prev_horizontal_position = parent_paned->get_position();
 195         prev_vertical_position = _paned->get_position();
 196
 197         if (getWidget().get_width() < width)
 198             parent_paned->set_position(parent_paned->get_width() - width);
 199
 200         if (_paned->get_position() < height)
 201             _paned->set_position(height);
 202
 203     } else {
 204         parent_paned->set_position(prev_horizontal_position);
 205         _paned->set_position(prev_vertical_position);
 206     }
 207
 208 }
 209
 210 void
 211 Dock::scrollToItem(DockItem& item)
 212 {
 213     int item_x, item_y;
 214     item.getWidget().translate_coordinates(getWidget(), 0, 0, item_x, item_y);
 215
 216     int dock_height = getWidget().get_height(), item_height = item.getWidget().get_height();
 217     double vadjustment = _scrolled_window->get_vadjustment()->get_value();
 218
 219     if (item_y < 0)
 220         _scrolled_window->get_vadjustment()->set_value(vadjustment + item_y);
 221     else if (item_y + item_height > dock_height)
 222         _scrolled_window->get_vadjustment()->set_value(
 223             vadjustment + ((item_y + item_height) - dock_height));
 224 }
 225
 226 Glib::SignalProxy0<void>
 227 Dock::signal_layout_changed()
 228 {
 229     return Glib::SignalProxy0<void>(Glib::wrap(GTK_WIDGET(_gdl_dock)),
 230                                     &_signal_layout_changed_proxy);
 231 }
 232
 233 void
 234 Dock::_onLayoutChanged()
 235 {
 236     if (isEmpty()) {
 237         if (hasIconifiedItems())
 238             _scrolled_window->set_size_request(_default_dock_bar_width);
 239         else
 240             _scrolled_window->set_size_request(_default_empty_width);
 241
 242         getParentPaned()->set_position(INT_MAX);
 243     } else {
 244         // unset any forced size requests
 245         _paned->get_child1()->set_size_request(-1, -1);
 246         _scrolled_window->set_size_request(-1);
 247     }
 248 }
 249
 250 void
 251 Dock::_onPanedButtonEvent(GdkEventButton *event)
 252 {
 253     if (event->button == 1 && event->type == GDK_BUTTON_PRESS)
 254         /* unset size request when starting a drag */
 255         _paned->get_child1()->set_size_request(-1, -1);
 256 }
 257
 258 gboolean
 259 Dock::_on_paned_button_event(GtkWidget *widget, GdkEventButton *event, gpointer user_data)
 260 {
 261     if (Dock *dock = static_cast<Dock *>(user_data))
 262         dock->_onPanedButtonEvent(event);
 263
 264     return FALSE;
 265 }
 266
 267 const Glib::SignalProxyInfo
 268 Dock::_signal_layout_changed_proxy =
 269 {
 270     "layout-changed",
 271     (GCallback) &Glib::SignalProxyNormal::slot0_void_callback,
 272     (GCallback) &Glib::SignalProxyNormal::slot0_void_callback
 273 };
 274
 275
 276 } // namespace Widget
 277 } // namespace UI
 278 } // namespace Inkscape
 279
 280
 281 /*
 282   Local Variables:
 283   mode:c++
 284   c-file-style:"stroustrup"
 285   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 286   indent-tabs-mode:nil
 287   fill-column:99
 288   End:
 289 */
 290 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99