2 Copyright (C) 2008 Paul Davis
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the Free
7 Software Foundation; either version 2 of the License, or (at your option)
10 This program is distributed in the hope that it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __session_metadata_dialog_h__
21 #define __session_metadata_dialog_h__
23 #include "ardour_dialog.h"
29 #include <gtkmm/box.h>
30 #include <gtkmm/button.h>
31 #include <gtkmm/checkbutton.h>
32 #include <gtkmm/entry.h>
33 #include <gtkmm/label.h>
34 #include <gtkmm/liststore.h>
35 #include <gtkmm/notebook.h>
36 #include <gtkmm/table.h>
37 #include <gtkmm/textview.h>
38 #include <gtkmm/treemodel.h>
39 #include <gtkmm/treeview.h>
41 #include <boost/shared_ptr.hpp>
46 #include "ardour/session_metadata.h"
49 typedef boost::shared_ptr<MetadataField> MetadataPtr;
51 /// Wraps a metadata field to be used in a GUI
55 MetadataField (std::string const & field_name);
56 virtual ~MetadataField();
57 virtual MetadataPtr copy () = 0;
59 virtual void save_data (ARDOUR::SessionMetadata & data) const = 0;
60 virtual void load_data (ARDOUR::SessionMetadata const & data) = 0;
62 virtual std::string name() { return _name; }
63 virtual std::string value() { return _value; }
65 /// Get widget containing name of field
66 virtual Gtk::Widget & name_widget () = 0;
67 /// Get label containing value of field
68 virtual Gtk::Widget & value_widget () = 0;
69 /// Get widget for editing value
70 virtual Gtk::Widget & edit_widget () = 0;
76 /// MetadataField that contains text
77 class TextMetadataField : public MetadataField
80 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
81 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
83 TextMetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 50);
86 void save_data (ARDOUR::SessionMetadata & data) const;
87 void load_data (ARDOUR::SessionMetadata const & data);
89 Gtk::Widget & name_widget ();
90 Gtk::Widget & value_widget ();
91 Gtk::Widget & edit_widget ();
99 Gtk::Label* value_label;
105 /// MetadataField that contains longform text
106 class LongTextMetadataField : public TextMetadataField
109 LongTextMetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 50);
112 Gtk::Widget & edit_widget ();
114 void update_value ();
116 Gtk::TextView* tview;
119 /// MetadataField that accepts only numbers
120 class NumberMetadataField : public MetadataField
123 typedef uint32_t (ARDOUR::SessionMetadata::*Getter) () const;
124 typedef void (ARDOUR::SessionMetadata::*Setter) (uint32_t);
126 NumberMetadataField (Getter getter, Setter setter, std::string const & field_name, guint numbers, guint width = 50);
129 void save_data (ARDOUR::SessionMetadata & data) const;
130 void load_data (ARDOUR::SessionMetadata const & data);
132 Gtk::Widget & name_widget ();
133 Gtk::Widget & value_widget ();
134 Gtk::Widget & edit_widget ();
136 void update_value ();
137 std::string uint_to_str (uint32_t i) const;
138 uint32_t str_to_uint (std::string const & str) const;
144 Gtk::Label* value_label;
151 /// MetadataField that accepts EAN-13 data only
152 class EAN13MetadataField : public MetadataField
155 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
156 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
158 EAN13MetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 13);
161 void save_data (ARDOUR::SessionMetadata & data) const;
162 void load_data (ARDOUR::SessionMetadata const & data);
164 Gtk::Widget & name_widget ();
165 Gtk::Widget & value_widget ();
166 Gtk::Widget & edit_widget ();
168 Gtk::Label* status_label;
169 void update_status ();
171 void update_value ();
172 std::string numeric_string (std::string const & str) const;
178 Gtk::Label* value_label;
184 /// Interface for MetadataFields
185 class SessionMetadataSet : public ARDOUR::SessionHandlePtr
188 SessionMetadataSet (std::string const & name);
189 virtual ~SessionMetadataSet () {};
191 void add_data_field (MetadataPtr field);
193 /// allows loading extra data into data sets (for importing etc.)
194 virtual void load_extra_data (ARDOUR::SessionMetadata const & /*data*/) { }
195 /// Saves data to session
196 virtual void save_data () = 0;
198 virtual Gtk::Widget & get_widget () = 0;
199 virtual Gtk::Widget & get_tab_widget () = 0;
202 typedef std::list<MetadataPtr> DataList;
207 /// Contains MetadataFields for editing
208 class SessionMetadataSetEditable : public SessionMetadataSet
211 SessionMetadataSetEditable (std::string const & name);
213 Gtk::Widget & get_widget () { return vbox; }
214 Gtk::Widget & get_tab_widget ();
216 /// Sets session and loads data
217 void set_session (ARDOUR::Session * s);
218 /// Saves from MetadataFields into data
224 Gtk::Label tab_widget;
227 /// Contains MetadataFields for importing
228 class SessionMetadataSetImportable : public SessionMetadataSet
231 SessionMetadataSetImportable (std::string const & name);
233 Gtk::Widget & get_widget () { return tree_view; }
234 Gtk::Widget & get_tab_widget ();
235 Gtk::Widget & get_select_all_widget ();
237 /// Loads importable data from data
238 void load_extra_data (ARDOUR::SessionMetadata const & data);
239 /// Saves from importable data (see load_data) to session_data
243 DataList & session_list; // References MetadataSet::list
244 DataList import_list;
246 struct Columns : public Gtk::TreeModel::ColumnRecord
249 Gtk::TreeModelColumn<std::string> field;
250 Gtk::TreeModelColumn<std::string> values;
251 Gtk::TreeModelColumn<bool> import;
252 Gtk::TreeModelColumn<MetadataPtr> data;
254 Columns() { add (field); add (values); add (import); add (data); }
257 Glib::RefPtr<Gtk::ListStore> tree;
259 Gtk::TreeView tree_view;
261 Gtk::Label tab_widget;
262 Gtk::CheckButton select_all_check;
265 void selection_changed (std::string const & path);
268 /// Metadata dialog interface
270 * The DataSets are initalized in this class so that all
271 * Dialogs have the same sets of data in the same order.
273 template <typename DataSet>
274 class SessionMetadataDialog : public ArdourDialog
277 SessionMetadataDialog (std::string const & name);
280 void init_data ( bool skip_user = false );
281 void load_extra_data (ARDOUR::SessionMetadata const & data);
284 virtual void init_gui () = 0;
285 virtual void save_and_close ();
286 virtual void end_dialog ();
288 void warn_user (std::string const & string);
290 typedef std::list<Gtk::Widget *> WidgetList;
291 typedef boost::shared_ptr<WidgetList> WidgetListPtr;
292 typedef Gtk::Widget & (DataSet::*WidgetFunc) ();
294 /// Returns list of widgets gathered by calling f for each data set
295 WidgetListPtr get_custom_widgets (WidgetFunc f);
297 /// Adds a widget to the table (vertical stacking) with automatic spacing
298 void add_widget (Gtk::Widget & widget);
300 Gtk::Notebook notebook;
303 void init_user_data ();
304 void init_description_data ();
305 void init_track_data ();
306 void init_album_data ();
307 void init_people_data ();
308 void init_school_data ();
310 typedef boost::shared_ptr<SessionMetadataSet> DataSetPtr;
311 typedef std::list<DataSetPtr> DataSetList;
312 DataSetList data_list;
314 Gtk::Button * save_button;
315 Gtk::Button * cancel_button;
318 class SessionMetadataEditor : public SessionMetadataDialog<SessionMetadataSetEditable>
321 SessionMetadataEditor ();
322 ~SessionMetadataEditor ();
328 class SessionMetadataImporter : public SessionMetadataDialog<SessionMetadataSetImportable> {
330 SessionMetadataImporter ();
331 ~SessionMetadataImporter ();
337 // Select all from -widget
338 Gtk::HBox selection_hbox;
339 Gtk::Label selection_label;