Documentation for target_scanline.h
[synfig.git] / synfig-studio / src / gui / docks / 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 "docks/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 "trees/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("action_group_dock_history"))
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                 "clear-undo-and-redo",
99                 Gtk::Stock::CLEAR,
100                 _("Clear Undo and Redo Stacks"),
101                 _("Clear the undo and redo stacks")
102         ),
103                 sigc::mem_fun(
104                         *this,
105                         &Dock_History::clear_undo_and_redo
106                 )
107         );
108         action_group->add(Gtk::Action::create(
109                 "undo",
110                 Gtk::StockID("gtk-undo"),
111                 _("Undo"),
112                 _("Undo the previous action")
113         ),
114                 sigc::ptr_fun(studio::App::undo)
115         );
116         action_group->add(Gtk::Action::create(
117                 "redo",
118                 Gtk::StockID("gtk-redo"),
119                 _("Redo"),
120                 _("Redo the previously undone action")
121         ),
122                 sigc::ptr_fun(studio::App::redo)
123         );
124
125         action_group->add( Gtk::Action::create("toolbar-history", _("History")) );
126         App::ui_manager()->insert_action_group(action_group);
127
128         Glib::ustring ui_info =
129         "<ui>"
130         "       <toolbar action='toolbar-history'>"
131         "       <toolitem action='undo' />"
132         "       <toolitem action='redo' />"
133         "       <toolitem action='clear-undo' />"
134         "       <toolitem action='clear-redo' />"
135         "       <toolitem action='clear-undo-and-redo' />"
136         "       </toolbar>"
137         "</ui>"
138         ;
139
140         App::ui_manager()->add_ui_from_string(ui_info);
141
142         action_group->set_sensitive(false);
143
144         set_toolbar(*dynamic_cast<Gtk::Toolbar*>(App::ui_manager()->get_widget("/toolbar-history")));
145         add(*create_action_tree());
146 }
147
148 Dock_History::~Dock_History()
149 {
150 }
151
152 void
153 Dock_History::init_instance_vfunc(etl::loose_handle<Instance> instance)
154 {
155         instance->signal_undo_redo_status_changed().connect(
156                 sigc::mem_fun(*this,&Dock_History::update_undo_redo)
157         );
158 }
159
160 Gtk::Widget*
161 Dock_History::create_action_tree()
162 {
163         studio::HistoryTreeStore::Model history_tree_model;
164         action_tree=manage(new class Gtk::TreeView());
165         {
166                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column("") );
167
168                 Gtk::CellRendererToggle* toggle_cr = Gtk::manage( new Gtk::CellRendererToggle() );
169                 toggle_cr->signal_toggled().connect(sigc::mem_fun(*this, &studio::Dock_History::on_action_toggle) );
170
171                 column->pack_start(*toggle_cr); //false = don't expand.
172                 column->add_attribute(toggle_cr->property_active(),history_tree_model.is_active);
173                 column->set_resizable();
174                 column->set_clickable();
175
176                 action_tree->append_column(*column);
177         }
178         /*{
179                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Canvas")) );
180                 Gtk::CellRendererText *text_cr=Gtk::manage(new Gtk::CellRendererText());
181                 text_cr->property_foreground()=Glib::ustring("#7f7f7f");
182
183                 column->pack_start(*text_cr);
184                 column->add_attribute(text_cr->property_text(),history_tree_model.canvas_id);
185                 column->add_attribute(text_cr->property_foreground_set(),history_tree_model.is_redo);
186
187                 action_tree->append_column(*column);
188         }*/
189         {
190                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Jump")) );
191
192                 Gtk::CellRendererText* cell_renderer_jump=Gtk::manage(new Gtk::CellRendererText());
193                 column->pack_start(*cell_renderer_jump,true);
194
195                 cell_renderer_jump->property_text()=_("(JMP)");
196                 cell_renderer_jump->property_foreground()="#003a7f";
197
198                 column->set_resizable();
199                 column->set_clickable();
200
201                 column->set_sort_column(COLUMNID_JUMP);
202
203                 action_tree->append_column(*column);
204                 //column->clicked();
205         }
206         {
207                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Action")) );
208
209                 Gtk::CellRendererText *text_cr=Gtk::manage(new Gtk::CellRendererText());
210                 text_cr->property_foreground()=Glib::ustring("#7f7f7f");
211
212
213
214                 //column->pack_start(history_tree_model.icon, false); //false = don't expand.
215                 column->pack_start(*text_cr);
216                 column->add_attribute(text_cr->property_text(),history_tree_model.name);
217                 column->add_attribute(text_cr->property_foreground_set(),history_tree_model.is_redo);
218
219                 action_tree->append_column(*column);
220         }
221
222         action_tree->set_enable_search(true);
223         action_tree->set_search_column(history_tree_model.name);
224         action_tree->set_search_equal_func(sigc::ptr_fun(&studio::HistoryTreeStore::search_func));
225
226         action_tree->set_rules_hint();
227 //      action_tree->signal_row_activated().connect(sigc::mem_fun(*this,&Dock_History::on_row_activate));
228         action_tree->signal_event().connect(sigc::mem_fun(*this,&Dock_History::on_action_event));
229 //      action_tree->add_events(Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
230 //      action_tree->add_events(Gdk::BUTTON1_MOTION_MASK);
231         action_tree->show();
232
233         Gtk::ScrolledWindow *scrolledwindow = manage(new class Gtk::ScrolledWindow());
234         scrolledwindow->set_flags(Gtk::CAN_FOCUS);
235         scrolledwindow->set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
236         scrolledwindow->add(*action_tree);
237         scrolledwindow->set_shadow_type(Gtk::SHADOW_ETCHED_IN);
238         scrolledwindow->show_all();
239
240 /*      {
241                 Gtk::Widget& widget(*action_tree);
242                 Pango::FontDescription font(widget.get_modifier_style()->get_font());
243                 font.set_size(Pango::SCALE*5);
244                 widget.get_modifier_style()->set_font(font);
245                 widget.modify_font(font);
246         }
247 */
248         return scrolledwindow;
249 }
250
251 void
252 Dock_History::clear_undo()
253 {
254         if(selected_instance && App::dialog_yes_no(_("Clear History"),
255                         _("You will not be able to undo any changes that you have made!\nAre you sure you want to clear the undo stack?")))
256                 selected_instance->clear_undo_stack();
257 }
258
259 void
260 Dock_History::clear_redo()
261 {
262         if(selected_instance && App::dialog_yes_no(_("Clear History"),
263                         _("You will not be able to redo any changes that you have made!\nAre you sure you want to clear the redo stack?")))
264                 selected_instance->clear_redo_stack();
265 }
266
267 void
268 Dock_History::clear_undo_and_redo()
269 {
270         if(selected_instance && App::dialog_yes_no(_("Clear History"),
271                         _("You will not be able to undo or redo any changes that you have made!\nAre you sure you want to clear the undo and redo stacks?")))
272         {
273                 selected_instance->clear_undo_stack();
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                 action_group->get_action("clear-undo-and-redo")->set_sensitive(instance->get_undo_status() || instance->get_redo_status());
289         }
290 }
291
292 void
293 Dock_History::on_undo_tree_changed()
294 {
295         Gtk::TreeModel::Children children(selected_instance->history_tree_store()->children());
296
297         if (!children.size())
298                 return;
299
300         studio::HistoryTreeStore::Model model;
301
302         Gtk::TreeModel::Children::iterator iter, prev = children.end();
303         for (iter = children.begin(); iter != children.end(); prev = iter++)
304                 if ((*iter)[model.is_redo])
305                 {
306                         if (prev == children.end())
307                                 action_tree->get_selection()->unselect_all();
308                         else
309                         {
310                                 action_tree->scroll_to_row(Gtk::TreePath(prev), 0.5);
311                                 action_tree->get_selection()->select(prev);
312                         }
313                         return;
314                 }
315
316         action_tree->scroll_to_row(Gtk::TreePath(prev), 0.5);
317         action_tree->get_selection()->select(prev);
318 }
319
320 void
321 Dock_History::set_selected_instance_(etl::handle<studio::Instance> instance)
322 {
323         if(studio::App::shutdown_in_progress)
324                 return;
325
326         if (on_undo_tree_changed_connection)
327                 on_undo_tree_changed_connection.disconnect();
328
329         selected_instance=instance;
330         if(instance)
331         {
332                 on_undo_tree_changed_connection = selected_instance->history_tree_store()->signal_undo_tree_changed().connect(
333                         sigc::mem_fun(*this,&Dock_History::on_undo_tree_changed));
334
335                 action_tree->set_model(instance->history_tree_store());
336                 action_tree->show();
337                 update_undo_redo();
338                 action_group->set_sensitive(true);
339         }
340         else
341         {
342                 action_tree->set_model(Glib::RefPtr< Gtk::TreeModel >());
343                 action_tree->hide();
344                 action_group->set_sensitive(false);
345         }
346 }
347
348 void
349 Dock_History::set_selected_instance_signal(etl::handle<studio::Instance> x)
350 {
351         set_selected_instance(x);
352 }
353
354 void
355 Dock_History::set_selected_instance(etl::loose_handle<studio::Instance> x)
356 {
357         if(studio::App::shutdown_in_progress)
358                 return;
359
360         // if it's already selected, don't select it again
361         if (x==selected_instance)
362                 return;
363
364         std::list<etl::handle<studio::Instance> >::iterator iter;
365
366         set_selected_instance_(x);
367 }
368
369 void
370 Dock_History::delete_instance(etl::handle<studio::Instance> instance)
371 {
372         if(studio::App::shutdown_in_progress)
373                 return;
374
375         if(selected_instance==instance)
376         {
377                 set_selected_instance(0);
378         }
379 }
380
381 bool
382 Dock_History::on_action_event(GdkEvent *event)
383 {
384         studio::HistoryTreeStore::Model model;
385     switch(event->type)
386     {
387         case GDK_BUTTON_PRESS:
388         case GDK_2BUTTON_PRESS:
389                 {
390                         Gtk::TreeModel::Path path;
391                         Gtk::TreeViewColumn *column;
392                         int cell_x, cell_y;
393                         if(!action_tree->get_path_at_pos(
394                                 int(event->button.x),int(event->button.y),      // x, y
395                                 path, // TreeModel::Path&
396                                 column, //TreeViewColumn*&
397                                 cell_x,cell_y //int&cell_x,int&cell_y
398                                 )
399                         ) break;
400                         const Gtk::TreeRow row = *(action_tree->get_model()->get_iter(path));
401
402                         //signal_user_click()(event->button.button,row,(ColumnID)column->get_sort_column_id());
403                         if((ColumnID)column->get_sort_column_id()==COLUMNID_JUMP)
404                         {
405                                 etl::handle<synfigapp::Action::Undoable> action(row[model.action]);
406                                 try{
407                                 if((bool)row[model.is_undo])
408                                 {
409                                         while(get_selected_instance()->undo_action_stack().size() && get_selected_instance()->undo_action_stack().front()!=action)
410                                                 if(get_selected_instance()->undo()==false)
411                                                         throw int();
412                                 }
413                                 else if((bool)row[model.is_redo])
414                                 {
415                                         while(get_selected_instance()->redo_action_stack().size() && get_selected_instance()->undo_action_stack().front()!=action)
416                                                 if(get_selected_instance()->redo()==false)
417                                                         throw int();
418                                 }
419                                 }
420                                 catch(int)
421                                 {
422                                         return true;
423                                 }
424                         }
425                 }
426
427         case GDK_BUTTON_RELEASE:
428                 break;
429         default:
430                 break;
431         }
432         return false;
433 }
434
435 void
436 Dock_History::on_action_toggle(const Glib::ustring& path_string)
437 {
438         studio::HistoryTreeStore::Model history_tree_model;
439
440         Gtk::TreePath path(path_string);
441
442         const Gtk::TreeRow row = *(selected_instance->history_tree_store()->get_iter(path));
443
444         handle<synfigapp::Action::Undoable> action=row[history_tree_model.action];
445
446         selected_instance->synfigapp::Instance::set_action_status(action,!action->is_active());
447 }