synfig-studio/trunk/src/gtkmm/dock_history.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file dock_history.cpp
   3 **      \brief Template File
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007, 2008 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "dock_history.h"
  34 #include "app.h"
  35
  36
  37
  38 #include <gtkmm/scrolledwindow.h>
  39 #include <cassert>
  40 #include "instance.h"
  41 #include <sigc++/signal.h>
  42 #include <sigc++/hide.h>
  43 #include <sigc++/slot.h>
  44 #include <synfigapp/action.h>
  45 #include "historytreestore.h"
  46
  47 #include "general.h"
  48
  49 #endif
  50
  51 /* === U S I N G =========================================================== */
  52
  53 using namespace std;
  54 using namespace etl;
  55 using namespace synfig;
  56 using namespace studio;
  57
  58 /* === M A C R O S ========================================================= */
  59 #define COLUMNID_JUMP           (787584)
  60 #define ColumnID        int
  61
  62 /* === G L O B A L S ======================================================= */
  63
  64 /* === P R O C E D U R E S ================================================= */
  65
  66 /* === M E T H O D S ======================================================= */
  67
  68 Dock_History::Dock_History():
  69         Dock_CanvasSpecific("history",_("History"),Gtk::StockID("gtk-undo")),
  70         action_group(Gtk::ActionGroup::create())
  71 {
  72         App::signal_instance_deleted().connect(sigc::mem_fun(*this,&studio::Dock_History::delete_instance));
  73         App::signal_instance_selected().connect(sigc::mem_fun(*this,&studio::Dock_History::set_selected_instance_signal));
  74
  75         action_group->add(Gtk::Action::create(
  76                 "clear-undo",
  77                 Gtk::StockID("synfig-clear_undo"),
  78                 _("Clear Undo Stack"),
  79                 _("Clear the undo stack")
  80         ),
  81                 sigc::mem_fun(
  82                         *this,
  83                         &Dock_History::clear_undo
  84                 )
  85         );
  86         action_group->add(Gtk::Action::create(
  87                 "clear-redo",
  88                 Gtk::StockID("synfig-clear_redo"),
  89                 _("Clear Redo Stack"),
  90                 _("Clear the redo stack")
  91         ),
  92                 sigc::mem_fun(
  93                         *this,
  94                         &Dock_History::clear_redo
  95                 )
  96         );
  97         action_group->add(Gtk::Action::create(
  98                 "undo",
  99                 Gtk::StockID("gtk-undo"),
 100                 _("Undo"),
 101                 _("Undo the previous action")
 102         ),
 103                 sigc::ptr_fun(studio::App::undo)
 104         );
 105         action_group->add(Gtk::Action::create(
 106                 "redo",
 107                 Gtk::StockID("gtk-redo"),
 108                 _("Redo"),
 109                 _("Redo the previously undone action")
 110         ),
 111                 sigc::ptr_fun(studio::App::redo)
 112         );
 113
 114         action_group->add( Gtk::Action::create("toolbar-history", _("History")) );
 115         App::ui_manager()->insert_action_group(action_group);
 116
 117         Glib::ustring ui_info =
 118         "<ui>"
 119         "       <toolbar action='toolbar-history'>"
 120         "       <toolitem action='undo' />"
 121         "       <toolitem action='redo' />"
 122         "       <toolitem action='clear-undo' />"
 123         "       <toolitem action='clear-redo' />"
 124         "       </toolbar>"
 125         "</ui>"
 126         ;
 127
 128         App::ui_manager()->add_ui_from_string(ui_info);
 129
 130         action_group->set_sensitive(false);
 131
 132         set_toolbar(*dynamic_cast<Gtk::Toolbar*>(App::ui_manager()->get_widget("/toolbar-history")));
 133         add(*create_action_tree());
 134
 135         /*
 136         add_button(
 137                 Gtk::StockID("synfig-clear_undo"),
 138                 _("Clear the UNDO Stack")
 139         )->signal_clicked().connect(
 140                 sigc::mem_fun(
 141                         *this,
 142                         &Dock_History::clear_undo
 143                 )
 144         );
 145         add_button(
 146                 Gtk::StockID("synfig-clear_redo"),
 147                 _("Clear the REDO Stack")
 148         )->signal_clicked().connect(
 149                 sigc::mem_fun(
 150                         *this,
 151                         &Dock_History::clear_redo
 152                 )
 153         );
 154         */
 155 }
 156
 157 Dock_History::~Dock_History()
 158 {
 159 }
 160
 161 void
 162 Dock_History::init_instance_vfunc(etl::loose_handle<Instance> instance)
 163 {
 164         instance->signal_undo_redo_status_changed().connect(
 165                 sigc::mem_fun(*this,&Dock_History::update_undo_redo)
 166         );
 167 }
 168
 169 Gtk::Widget*
 170 Dock_History::create_action_tree()
 171 {
 172         studio::HistoryTreeStore::Model history_tree_model;
 173         action_tree=manage(new class Gtk::TreeView());
 174         {
 175                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column("") );
 176
 177                 Gtk::CellRendererToggle* toggle_cr = Gtk::manage( new Gtk::CellRendererToggle() );
 178                 toggle_cr->signal_toggled().connect(sigc::mem_fun(*this, &studio::Dock_History::on_action_toggle) );
 179
 180                 column->pack_start(*toggle_cr); //false = don't expand.
 181                 column->add_attribute(toggle_cr->property_active(),history_tree_model.is_active);
 182                 column->set_resizable();
 183                 column->set_clickable();
 184
 185                 action_tree->append_column(*column);
 186         }
 187         /*{
 188                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Canvas")) );
 189                 Gtk::CellRendererText *text_cr=Gtk::manage(new Gtk::CellRendererText());
 190                 text_cr->property_foreground()=Glib::ustring("#7f7f7f");
 191
 192                 column->pack_start(*text_cr);
 193                 column->add_attribute(text_cr->property_text(),history_tree_model.canvas_id);
 194                 column->add_attribute(text_cr->property_foreground_set(),history_tree_model.is_redo);
 195
 196                 action_tree->append_column(*column);
 197         }*/
 198         {
 199                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Jump")) );
 200
 201                 Gtk::CellRendererText* cell_renderer_jump=Gtk::manage(new Gtk::CellRendererText());
 202                 column->pack_start(*cell_renderer_jump,true);
 203
 204                 cell_renderer_jump->property_text()=_("(JMP)");
 205                 cell_renderer_jump->property_foreground()="#003a7f";
 206
 207                 column->set_resizable();
 208                 column->set_clickable();
 209
 210                 column->set_sort_column(COLUMNID_JUMP);
 211
 212                 action_tree->append_column(*column);
 213                 //column->clicked();
 214         }
 215         {
 216                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Action")) );
 217
 218                 Gtk::CellRendererText *text_cr=Gtk::manage(new Gtk::CellRendererText());
 219                 text_cr->property_foreground()=Glib::ustring("#7f7f7f");
 220
 221
 222
 223                 //column->pack_start(history_tree_model.icon, false); //false = don't expand.
 224                 column->pack_start(*text_cr);
 225                 column->add_attribute(text_cr->property_text(),history_tree_model.name);
 226                 column->add_attribute(text_cr->property_foreground_set(),history_tree_model.is_redo);
 227
 228                 action_tree->append_column(*column);
 229         }
 230
 231         action_tree->set_enable_search(true);
 232         action_tree->set_search_column(history_tree_model.name);
 233         action_tree->set_search_equal_func(sigc::ptr_fun(&studio::HistoryTreeStore::search_func));
 234
 235         action_tree->set_rules_hint();
 236 //      action_tree->signal_row_activated().connect(sigc::mem_fun(*this,&Dock_History::on_row_activate));
 237         action_tree->signal_event().connect(sigc::mem_fun(*this,&Dock_History::on_action_event));
 238 //      action_tree->add_events(Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
 239 //      action_tree->add_events(Gdk::BUTTON1_MOTION_MASK);
 240         action_tree->show();
 241
 242         Gtk::ScrolledWindow *scrolledwindow = manage(new class Gtk::ScrolledWindow());
 243         scrolledwindow->set_flags(Gtk::CAN_FOCUS);
 244         scrolledwindow->set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
 245         scrolledwindow->add(*action_tree);
 246         scrolledwindow->set_shadow_type(Gtk::SHADOW_ETCHED_IN);
 247         scrolledwindow->show_all();
 248
 249 /*      {
 250                 Gtk::Widget& widget(*action_tree);
 251                 Pango::FontDescription font(widget.get_modifier_style()->get_font());
 252                 font.set_size(Pango::SCALE*5);
 253                 widget.get_modifier_style()->set_font(font);
 254                 widget.modify_font(font);
 255         }
 256 */
 257         return scrolledwindow;
 258 }
 259
 260 void
 261 Dock_History::clear_undo()
 262 {
 263         if(selected_instance && App::dialog_yes_no(_("Clear History"), _("You will not be able to undo any changes that you have made!\nAre you sure you want to clear the undo stack?")))
 264         {
 265                 selected_instance->clear_undo_stack();
 266         }
 267 }
 268
 269 void
 270 Dock_History::clear_redo()
 271 {
 272         if(selected_instance && App::dialog_yes_no(_("Clear History"), _("You will not be able to redo any changes that you have made!\nAre you sure you want to clear the redo stack?")))
 273         {
 274                 selected_instance->clear_redo_stack();
 275         }
 276 }
 277
 278 void
 279 Dock_History::update_undo_redo()
 280 {
 281         etl::handle<Instance> instance=App::get_selected_instance();
 282         if(instance)
 283         {
 284                 action_group->get_action("undo")->set_sensitive(instance->get_undo_status());
 285                 action_group->get_action("clear-undo")->set_sensitive(instance->get_undo_status());
 286                 action_group->get_action("redo")->set_sensitive(instance->get_redo_status());
 287                 action_group->get_action("clear-redo")->set_sensitive(instance->get_redo_status());
 288         }
 289 }
 290
 291 void
 292 Dock_History::on_undo_tree_changed()
 293 {
 294         Gtk::TreeModel::Children children(selected_instance->history_tree_store()->children());
 295
 296         if (!children.size())
 297                 return;
 298
 299         studio::HistoryTreeStore::Model model;
 300
 301         Gtk::TreeModel::Children::iterator iter, prev = children.end();
 302         for (iter = children.begin(); iter != children.end(); prev = iter++)
 303                 if ((*iter)[model.is_redo])
 304                 {
 305                         if (prev == children.end())
 306                                 action_tree->get_selection()->unselect_all();
 307                         else
 308                         {
 309                                 action_tree->scroll_to_row(Gtk::TreePath(prev), 0.5);
 310                                 action_tree->get_selection()->select(prev);
 311                         }
 312                         return;
 313                 }
 314
 315         action_tree->scroll_to_row(Gtk::TreePath(prev), 0.5);
 316         action_tree->get_selection()->select(prev);
 317 }
 318
 319 void
 320 Dock_History::set_selected_instance_(etl::handle<studio::Instance> instance)
 321 {
 322         if(studio::App::shutdown_in_progress)
 323                 return;
 324
 325         if (on_undo_tree_changed_connection)
 326                 on_undo_tree_changed_connection.disconnect();
 327
 328         selected_instance=instance;
 329         if(instance)
 330         {
 331                 on_undo_tree_changed_connection = selected_instance->history_tree_store()->signal_undo_tree_changed().connect(
 332                         sigc::mem_fun(*this,&Dock_History::on_undo_tree_changed));
 333
 334                 action_tree->set_model(instance->history_tree_store());
 335                 action_tree->show();
 336                 update_undo_redo();
 337                 action_group->set_sensitive(true);
 338         }
 339         else
 340         {
 341                 action_tree->set_model(Glib::RefPtr< Gtk::TreeModel >());
 342                 action_tree->hide();
 343                 action_group->set_sensitive(false);
 344         }
 345 }
 346
 347 void
 348 Dock_History::set_selected_instance_signal(etl::handle<studio::Instance> x)
 349 {
 350         set_selected_instance(x);
 351 }
 352
 353 void
 354 Dock_History::set_selected_instance(etl::loose_handle<studio::Instance> x)
 355 {
 356         if(studio::App::shutdown_in_progress)
 357                 return;
 358
 359         // if it's already selected, don't select it again
 360         if (x==selected_instance)
 361                 return;
 362
 363         std::list<etl::handle<studio::Instance> >::iterator iter;
 364
 365         set_selected_instance_(x);
 366 }
 367
 368 void
 369 Dock_History::delete_instance(etl::handle<studio::Instance> instance)
 370 {
 371         if(studio::App::shutdown_in_progress)
 372                 return;
 373
 374         if(selected_instance==instance)
 375         {
 376                 set_selected_instance(0);
 377         }
 378 }
 379
 380 bool
 381 Dock_History::on_action_event(GdkEvent *event)
 382 {
 383         studio::HistoryTreeStore::Model model;
 384     switch(event->type)
 385     {
 386         case GDK_BUTTON_PRESS:
 387         case GDK_2BUTTON_PRESS:
 388                 {
 389                         Gtk::TreeModel::Path path;
 390                         Gtk::TreeViewColumn *column;
 391                         int cell_x, cell_y;
 392                         if(!action_tree->get_path_at_pos(
 393                                 int(event->button.x),int(event->button.y),      // x, y
 394                                 path, // TreeModel::Path&
 395                                 column, //TreeViewColumn*&
 396                                 cell_x,cell_y //int&cell_x,int&cell_y
 397                                 )
 398                         ) break;
 399                         const Gtk::TreeRow row = *(action_tree->get_model()->get_iter(path));
 400
 401                         //signal_user_click()(event->button.button,row,(ColumnID)column->get_sort_column_id());
 402                         if((ColumnID)column->get_sort_column_id()==COLUMNID_JUMP)
 403                         {
 404                                 etl::handle<synfigapp::Action::Undoable> action(row[model.action]);
 405                                 try{
 406                                 if((bool)row[model.is_undo])
 407                                 {
 408                                         while(get_selected_instance()->undo_action_stack().size() && get_selected_instance()->undo_action_stack().front()!=action)
 409                                                 if(get_selected_instance()->undo()==false)
 410                                                         throw int();
 411                                 }
 412                                 else if((bool)row[model.is_redo])
 413                                 {
 414                                         while(get_selected_instance()->redo_action_stack().size() && get_selected_instance()->undo_action_stack().front()!=action)
 415                                                 if(get_selected_instance()->redo()==false)
 416                                                         throw int();
 417                                 }
 418                                 }
 419                                 catch(int)
 420                                 {
 421                                         return true;
 422                                 }
 423                         }
 424                 }
 425
 426         case GDK_BUTTON_RELEASE:
 427                 break;
 428         default:
 429                 break;
 430         }
 431         return false;
 432 }
 433
 434 void
 435 Dock_History::on_action_toggle(const Glib::ustring& path_string)
 436 {
 437         studio::HistoryTreeStore::Model history_tree_model;
 438
 439         Gtk::TreePath path(path_string);
 440
 441         const Gtk::TreeRow row = *(selected_instance->history_tree_store()->get_iter(path));
 442
 443         handle<synfigapp::Action::Undoable> action=row[history_tree_model.action];
 444
 445         selected_instance->synfigapp::Instance::set_action_status(action,!action->is_active());
 446 }