Add actions (add to group, ,remove from group, export, un-export, set layer descripti...
[synfig.git] / synfig-studio / src / gtkmm / keyframetree.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file keyframetree.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) 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 "keyframetree.h"
34 #include "cellrenderer_time.h"
35 #include <gtkmm/treemodelsort.h>
36 #include <ETL/misc>
37
38 #include "general.h"
39
40 #endif
41
42 /* === U S I N G =========================================================== */
43
44 using namespace std;
45 using namespace etl;
46 using namespace synfig;
47 using namespace studio;
48
49 /* === M A C R O S ========================================================= */
50
51 /* === G L O B A L S ======================================================= */
52
53 /* === P R O C E D U R E S ================================================= */
54
55 /* === M E T H O D S ======================================================= */
56
57 KeyframeTree::KeyframeTree()
58 {
59         const KeyframeTreeStore::Model model;
60
61         {
62                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Time")) );
63
64                 cell_renderer_time = Gtk::manage( new CellRenderer_Time() );
65                 column->pack_start(*cell_renderer_time,true);
66                 column->add_attribute(cell_renderer_time->property_time(), model.time);
67                 cell_renderer_time->signal_edited().connect(sigc::mem_fun(*this,&studio::KeyframeTree::on_edited_time));
68
69                 column->set_reorderable();
70                 column->set_resizable();
71                 column->set_clickable();
72                 column->set_sort_column(model.time);
73
74                 append_column(*column);
75         }
76         {
77                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Length")) );
78
79                 cell_renderer_time_delta = Gtk::manage( new CellRenderer_Time() );
80                 column->pack_start(*cell_renderer_time_delta,true);
81                 column->add_attribute(cell_renderer_time_delta->property_time(), model.time_delta);
82                 cell_renderer_time_delta->signal_edited().connect(sigc::mem_fun(*this,&studio::KeyframeTree::on_edited_time_delta));
83
84                 column->set_reorderable();
85                 column->set_resizable();
86                 column->set_clickable(false);
87                 // column->set_sort_column(model.time_delta);
88
89                 append_column(*column);
90         }
91         {
92                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Jump")) );
93
94                 Gtk::CellRendererText* cell_renderer_jump=Gtk::manage(new Gtk::CellRendererText());
95                 column->pack_start(*cell_renderer_jump,true);
96                 cell_renderer_jump->property_text()=_("(JMP)");
97                 cell_renderer_jump->property_foreground()="#003a7f";
98
99                 column->set_reorderable();
100                 column->set_resizable();
101                 column->set_clickable(false);
102                 column->set_sort_column(COLUMNID_JUMP); // without this, (JMP) needs a double click?!
103
104                 append_column(*column);
105         }
106         // append_column_editable(_("Description"),model.description);
107         {
108                 Gtk::TreeView::Column* column = Gtk::manage( new Gtk::TreeView::Column(_("Description")) );
109
110                 cell_renderer_description=Gtk::manage(new Gtk::CellRendererText());
111                 column->pack_start(*cell_renderer_description,true);
112                 column->add_attribute(cell_renderer_description->property_text(), model.description);
113                 cell_renderer_description->signal_edited().connect(sigc::mem_fun(*this,&studio::KeyframeTree::on_edited_description));
114
115                 column->set_reorderable();
116                 column->set_resizable();
117                 column->set_clickable();
118                 column->set_sort_column(model.description);
119
120                 append_column(*column);
121         }
122
123         set_enable_search(true);
124         set_search_column(model.description);
125
126         // This makes things easier to read.
127         set_rules_hint();
128
129         // Make us more sensitive to several events
130         add_events(Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
131 }
132
133 KeyframeTree::~KeyframeTree()
134 {
135         if (getenv("SYNFIG_DEBUG_DESTRUCTORS"))
136                 synfig::info("KeyframeTree::~KeyframeTree(): Deleted");
137 }
138
139 void
140 KeyframeTree::on_rend_desc_changed()
141 {
142         cell_renderer_time->property_fps().set_value(keyframe_tree_store_->canvas_interface()->get_canvas()->rend_desc().get_frame_rate());
143         queue_draw();
144 }
145
146 void
147 KeyframeTree::set_model(Glib::RefPtr<KeyframeTreeStore> keyframe_tree_store)
148 {
149         keyframe_tree_store_=keyframe_tree_store;
150         KeyframeTreeStore::Model model;
151
152         if(true)
153         {
154                 Glib::RefPtr<Gtk::TreeModelSort> sorted_store(Gtk::TreeModelSort::create(keyframe_tree_store_));
155                 sorted_store->set_default_sort_func(sigc::ptr_fun(&studio::KeyframeTreeStore::time_sorter));
156                 sorted_store->set_sort_func(model.time,                 sigc::ptr_fun(&studio::KeyframeTreeStore::time_sorter));
157                 sorted_store->set_sort_func(model.description,  sigc::ptr_fun(&studio::KeyframeTreeStore::description_sorter));
158                 Gtk::TreeView::set_model(sorted_store);
159         }
160         else
161                 Gtk::TreeView::set_model(keyframe_tree_store);
162
163         keyframe_tree_store_->canvas_interface()->signal_rend_desc_changed().connect(
164                 sigc::mem_fun(
165                         *this,
166                         &studio::KeyframeTree::on_rend_desc_changed
167                 )
168         );
169         cell_renderer_time->property_fps().set_value(keyframe_tree_store_->canvas_interface()->get_canvas()->rend_desc().get_frame_rate());
170         cell_renderer_time_delta->property_fps().set_value(keyframe_tree_store_->canvas_interface()->get_canvas()->rend_desc().get_frame_rate());
171 }
172
173 void
174 KeyframeTree::set_editable(bool x)
175 {
176         editable_=x;
177
178         if(editable_)
179         {
180                 cell_renderer_time->property_editable()=true;
181                 cell_renderer_time_delta->property_editable()=true;
182                 cell_renderer_description->property_editable()=true;
183         }
184         else
185         {
186                 cell_renderer_time->property_editable()=false;
187                 cell_renderer_time_delta->property_editable()=false;
188                 cell_renderer_description->property_editable()=false;
189         }
190 }
191
192 void
193 KeyframeTree::on_edited_time(const Glib::ustring&path_string,synfig::Time time)
194 {
195         Gtk::TreePath path(path_string);
196
197         const Gtk::TreeRow row(*(get_model()->get_iter(path)));
198
199         synfig::Keyframe keyframe(row[model.keyframe]);
200         if(time!=keyframe.get_time())
201         {
202                 row[model.time]=time;
203                 //keyframe.set_time(time);
204                 //signal_edited_time()(keyframe,time);
205                 //signal_edited()(keyframe);
206         }
207 }
208
209 void
210 KeyframeTree::on_edited_time_delta(const Glib::ustring&path_string,synfig::Time time)
211 {
212         Gtk::TreePath path(path_string);
213
214         const Gtk::TreeRow row(*(get_model()->get_iter(path)));
215
216         if(row)row[model.time_delta]=time;
217 }
218
219 void
220 KeyframeTree::on_edited_description(const Glib::ustring&path_string,const Glib::ustring &desc)
221 {
222         Gtk::TreePath path(path_string);
223
224         const Gtk::TreeRow row = *(get_model()->get_iter(path));
225
226         const synfig::String description(desc);
227         synfig::Keyframe keyframe(row[model.keyframe]);
228         if(description!=keyframe.get_description())
229         {
230                 row[model.description]=desc;
231                 keyframe.set_description(description);
232                 signal_edited_description()(keyframe,description);
233                 signal_edited()(keyframe);
234         }
235 }
236
237 bool
238 KeyframeTree::on_event(GdkEvent *event)
239 {
240     switch(event->type)
241     {
242         case GDK_BUTTON_PRESS:
243                 {
244                         Gtk::TreeModel::Path path;
245                         Gtk::TreeViewColumn *column;
246                         int cell_x, cell_y;
247                         int wx(round_to_int(event->button.x)),wy(round_to_int(event->button.y));
248                         //tree_to_widget_coords (,, wx, wy);
249                         if(!get_path_at_pos(
250                                 wx,wy,  // x, y
251                                 path, // TreeModel::Path&
252                                 column, //TreeViewColumn*&
253                                 cell_x,cell_y //int&cell_x,int&cell_y
254                                 )
255                         ) break;
256                         const Gtk::TreeRow row = *(get_model()->get_iter(path));
257
258                         signal_user_click()(event->button.button,row,(ColumnID)column->get_sort_column_id());
259                         if((ColumnID)column->get_sort_column_id()==COLUMNID_JUMP)
260                         {
261                                 keyframe_tree_store_->canvas_interface()->set_time(row[model.time]);
262                         }
263                 }
264                 break;
265         case GDK_2BUTTON_PRESS:
266                 {
267                         Gtk::TreeModel::Path path;
268                         Gtk::TreeViewColumn *column;
269                         int cell_x, cell_y;
270                         if(!get_path_at_pos(
271                                 int(event->button.x),int(event->button.y),      // x, y
272                                 path, // TreeModel::Path&
273                                 column, //TreeViewColumn*&
274                                 cell_x,cell_y //int&cell_x,int&cell_y
275                                 )
276                         ) break;
277                         const Gtk::TreeRow row = *(get_model()->get_iter(path));
278
279                         {
280                                 keyframe_tree_store_->canvas_interface()->set_time(row[model.time]);
281                                 return true;
282                         }
283                 }
284                 break;
285
286         case GDK_BUTTON_RELEASE:
287                 break;
288         default:
289                 break;
290         }
291         return false;
292 }