libs/gtkmm2ext/tabbable.cc

   1 /*
   2     Copyright (C) 2015 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <gtkmm/action.h>
  21 #include <gtkmm/notebook.h>
  22 #include <gtkmm/window.h>
  23 #include <gtkmm/stock.h>
  24
  25 #include "gtkmm2ext/tabbable.h"
  26 #include "gtkmm2ext/gtk_ui.h"
  27 #include "gtkmm2ext/utils.h"
  28 #include "gtkmm2ext/visibility_tracker.h"
  29
  30 #include "pbd/stacktrace.h"
  31
  32 #include "i18n.h"
  33
  34 using namespace Gtkmm2ext;
  35 using namespace Gtk;
  36 using std::string;
  37
  38 Tabbable::Tabbable (Widget& w, const string& name)
  39         : WindowProxy (name)
  40         , _contents (w)
  41         , _parent_notebook (0)
  42         , tab_requested_by_state (true)
  43 {
  44 }
  45
  46 Tabbable::~Tabbable ()
  47 {
  48         if (_window) {
  49                 delete _window;
  50                 _window = 0;
  51         }
  52 }
  53
  54 void
  55 Tabbable::add_to_notebook (Notebook& notebook, const string& tab_title)
  56 {
  57         _parent_notebook = &notebook;
  58
  59         if (tab_requested_by_state) {
  60                 attach ();
  61         }
  62 }
  63
  64 Window*
  65 Tabbable::use_own_window (bool and_pack_it)
  66 {
  67         Gtk::Window* win = get (true);
  68
  69         if (and_pack_it) {
  70                 Gtk::Container* parent = _contents.get_parent();
  71                 if (parent) {
  72                         parent->remove (_contents);
  73                 }
  74                 _own_notebook.append_page (_contents);
  75         }
  76
  77         return win;
  78
  79 }
  80
  81 bool
  82 Tabbable::window_visible () const
  83 {
  84         if (!_window) {
  85                 return false;
  86         }
  87
  88         return _window->is_visible();
  89 }
  90
  91 Window*
  92 Tabbable::get (bool create)
  93 {
  94         if (_window) {
  95                 return _window;
  96         }
  97
  98         if (!create) {
  99                 return 0;
 100         }
 101
 102         /* From here on, we're creating the window
 103          */
 104
 105         if ((_window = new Window (WINDOW_TOPLEVEL)) == 0) {
 106                 return 0;
 107         }
 108
 109         _window->add (_own_notebook);
 110         _own_notebook.show ();
 111         _own_notebook.set_show_tabs (false);
 112
 113         _window->signal_map().connect (sigc::mem_fun (*this, &Tabbable::window_mapped));
 114         _window->signal_unmap().connect (sigc::mem_fun (*this, &Tabbable::window_unmapped));
 115
 116         /* do other window-related setup */
 117
 118         setup ();
 119
 120         /* window should be ready for derived classes to do something with it */
 121
 122         return _window;
 123 }
 124
 125 void
 126 Tabbable::show_own_window (bool and_pack_it)
 127 {
 128         Gtk::Widget* parent = _contents.get_parent();
 129         Gtk::Allocation alloc;
 130
 131         if (parent) {
 132                 alloc = parent->get_allocation();
 133         }
 134
 135         (void) use_own_window (and_pack_it);
 136
 137         if (parent) {
 138                 _window->set_default_size (alloc.get_width(), alloc.get_height());
 139         }
 140
 141         tab_requested_by_state = false;
 142
 143         _window->show_all ();
 144         _window->present ();
 145 }
 146
 147 Gtk::Notebook*
 148 Tabbable::tab_root_drop ()
 149 {
 150         /* This is called after a drop of a tab onto the root window. Its
 151          * responsibility xois to return the notebook that this Tabbable's
 152          * contents should be packed into before the drop handling is
 153          * completed. It is not responsible for actually taking care of this
 154          * packing.
 155          */
 156
 157         show_own_window (false);
 158         return &_own_notebook;
 159 }
 160
 161 void
 162 Tabbable::show_window ()
 163 {
 164         make_visible ();
 165
 166         if (_window && (current_toplevel() == _window)) {
 167                 if (!_visible) { /* was hidden, update status */
 168                         set_pos_and_size ();
 169                 }
 170         }
 171 }
 172
 173 void
 174 Tabbable::make_visible ()
 175 {
 176         if (_window && (current_toplevel() == _window)) {
 177                 _window->present ();
 178         } else {
 179
 180                 if (!tab_requested_by_state) {
 181                         show_own_window (true);
 182                 } else {
 183                         show_tab ();
 184                 }
 185         }
 186 }
 187
 188 void
 189 Tabbable::make_invisible ()
 190 {
 191         if (_window && (current_toplevel() == _window)) {
 192                 _window->hide ();
 193         } else {
 194                 hide_tab ();
 195         }
 196 }
 197
 198 void
 199 Tabbable::detach ()
 200 {
 201         show_own_window (true);
 202 }
 203
 204 void
 205 Tabbable::attach ()
 206 {
 207         if (!_parent_notebook) {
 208                 return;
 209         }
 210
 211         if (tabbed()) {
 212                 /* already tabbed */
 213                 return;
 214         }
 215
 216
 217         if (_window && current_toplevel() == _window) {
 218                 /* unpack Tabbable from parent, put it back in the main tabbed
 219                  * notebook
 220                  */
 221
 222                 save_pos_and_size ();
 223
 224                 _contents.get_parent()->remove (_contents);
 225
 226                 /* leave the window around */
 227
 228                 _window->hide ();
 229         }
 230
 231         _parent_notebook->append_page (_contents);
 232         _parent_notebook->set_tab_detachable (_contents);
 233         _parent_notebook->set_tab_reorderable (_contents);
 234         _parent_notebook->set_current_page (_parent_notebook->page_num (_contents));
 235
 236         /* have to force this on, which is semantically correct, since
 237          * the user has effectively asked for it.
 238          */
 239
 240         tab_requested_by_state = true;
 241         StateChange (*this);
 242 }
 243
 244 bool
 245 Tabbable::delete_event_handler (GdkEventAny *ev)
 246 {
 247         _window->hide();
 248
 249         return true;
 250 }
 251
 252 bool
 253 Tabbable::tabbed () const
 254 {
 255         if (_window && (current_toplevel() == _window)) {
 256                 return false;
 257         }
 258
 259         if (_parent_notebook && (_parent_notebook->page_num (_contents) >= 0)) {
 260                 return true;
 261         }
 262
 263         return false;
 264 }
 265
 266 void
 267 Tabbable::hide_tab ()
 268 {
 269         if (tabbed()) {
 270                 _parent_notebook->remove_page (_contents);
 271                 StateChange (*this);
 272         }
 273 }
 274
 275 void
 276 Tabbable::show_tab ()
 277 {
 278         if (!window_visible() && _parent_notebook) {
 279                 if (_contents.get_parent() == 0) {
 280                         tab_requested_by_state = true;
 281                         add_to_notebook (*_parent_notebook, _tab_title);
 282                 }
 283                 _parent_notebook->set_current_page (_parent_notebook->page_num (_contents));
 284         }
 285 }
 286
 287 Gtk::Window*
 288 Tabbable::current_toplevel () const
 289 {
 290         return dynamic_cast<Gtk::Window*> (contents().get_toplevel());
 291 }
 292
 293 string
 294 Tabbable::xml_node_name()
 295 {
 296         return WindowProxy::xml_node_name();
 297 }
 298
 299 bool
 300 Tabbable::tabbed_by_default() const
 301 {
 302         return tab_requested_by_state;
 303 }
 304
 305 XMLNode&
 306 Tabbable::get_state()
 307 {
 308         XMLNode& node (WindowProxy::get_state());
 309
 310         node.add_property (X_("tabbed"),  tabbed() ? X_("yes") : X_("no"));
 311
 312         return node;
 313 }
 314
 315 int
 316 Tabbable::set_state (const XMLNode& node, int version)
 317 {
 318         int ret;
 319
 320         if ((ret = WindowProxy::set_state (node, version)) != 0) {
 321                 return ret;
 322         }
 323
 324         if (_visible) {
 325                 show_own_window (true);
 326         }
 327
 328         XMLNodeList children = node.children ();
 329         XMLNode* window_node = node.child ("Window");
 330
 331         if (window_node) {
 332                 const XMLProperty* prop = window_node->property (X_("tabbed"));
 333                 if (prop) {
 334                         tab_requested_by_state = PBD::string_is_affirmative (prop->value());
 335                 }
 336         }
 337
 338         if (!_visible) {
 339                 if (tab_requested_by_state) {
 340                         attach ();
 341                 } else {
 342                         /* this does nothing if not tabbed */
 343                         hide_tab ();
 344                 }
 345         }
 346
 347         return ret;
 348 }
 349
 350 void
 351 Tabbable::window_mapped ()
 352 {
 353         StateChange (*this);
 354 }
 355
 356 void
 357 Tabbable::window_unmapped ()
 358 {
 359         StateChange (*this);
 360 }
 361