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/treemodel.h>
38 #include <gtkmm/treeview.h>
40 #include <boost/shared_ptr.hpp>
45 #include "ardour/session_metadata.h"
48 typedef boost::shared_ptr<MetadataField> MetadataPtr;
50 /// Wraps a metadata field to be used in a GUI
54 MetadataField (std::string const & field_name);
55 virtual ~MetadataField();
56 virtual MetadataPtr copy () = 0;
58 virtual void save_data (ARDOUR::SessionMetadata & data) const = 0;
59 virtual void load_data (ARDOUR::SessionMetadata const & data) = 0;
61 virtual std::string name() { return _name; }
62 virtual std::string value() { return _value; }
64 /// Get widget containing name of field
65 virtual Gtk::Widget & name_widget () = 0;
66 /// Get label containing value of field
67 virtual Gtk::Widget & value_widget () = 0;
68 /// Get widget for editing value
69 virtual Gtk::Widget & edit_widget () = 0;
75 /// MetadataField that contains text
76 class TextMetadataField : public MetadataField
79 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
80 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
82 TextMetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 50);
85 void save_data (ARDOUR::SessionMetadata & data) const;
86 void load_data (ARDOUR::SessionMetadata const & data);
88 Gtk::Widget & name_widget ();
89 Gtk::Widget & value_widget ();
90 Gtk::Widget & edit_widget ();
98 Gtk::Label* value_label;
104 /// MetadataField that accepts only numbers
105 class NumberMetadataField : public MetadataField
108 typedef uint32_t (ARDOUR::SessionMetadata::*Getter) () const;
109 typedef void (ARDOUR::SessionMetadata::*Setter) (uint32_t);
111 NumberMetadataField (Getter getter, Setter setter, std::string const & field_name, guint numbers, guint width = 50);
114 void save_data (ARDOUR::SessionMetadata & data) const;
115 void load_data (ARDOUR::SessionMetadata const & data);
117 Gtk::Widget & name_widget ();
118 Gtk::Widget & value_widget ();
119 Gtk::Widget & edit_widget ();
121 void update_value ();
122 std::string uint_to_str (uint32_t i) const;
123 uint32_t str_to_uint (std::string const & str) const;
129 Gtk::Label* value_label;
136 /// MetadataField that accepts EAN-13 data only
137 class EAN13MetadataField : public MetadataField
140 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
141 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
143 EAN13MetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 13);
146 void save_data (ARDOUR::SessionMetadata & data) const;
147 void load_data (ARDOUR::SessionMetadata const & data);
149 Gtk::Widget & name_widget ();
150 Gtk::Widget & value_widget ();
151 Gtk::Widget & edit_widget ();
153 Gtk::Label* status_label;
154 void update_status ();
156 void update_value ();
157 std::string numeric_string (std::string const & str) const;
163 Gtk::Label* value_label;
169 /// Interface for MetadataFields
170 class SessionMetadataSet : public ARDOUR::SessionHandlePtr
173 SessionMetadataSet (std::string const & name);
174 virtual ~SessionMetadataSet () {};
176 void add_data_field (MetadataPtr field);
178 /// allows loading extra data into data sets (for importing etc.)
179 virtual void load_extra_data (ARDOUR::SessionMetadata const & /*data*/) { }
180 /// Saves data to session
181 virtual void save_data () = 0;
183 virtual Gtk::Widget & get_widget () = 0;
184 virtual Gtk::Widget & get_tab_widget () = 0;
187 typedef std::list<MetadataPtr> DataList;
192 /// Contains MetadataFields for editing
193 class SessionMetadataSetEditable : public SessionMetadataSet
196 SessionMetadataSetEditable (std::string const & name);
198 Gtk::Widget & get_widget () { return vbox; }
199 Gtk::Widget & get_tab_widget ();
201 /// Sets session and loads data
202 void set_session (ARDOUR::Session * s);
203 /// Saves from MetadataFields into data
209 Gtk::Label tab_widget;
212 /// Contains MetadataFields for importing
213 class SessionMetadataSetImportable : public SessionMetadataSet
216 SessionMetadataSetImportable (std::string const & name);
218 Gtk::Widget & get_widget () { return tree_view; }
219 Gtk::Widget & get_tab_widget ();
220 Gtk::Widget & get_select_all_widget ();
222 /// Loads importable data from data
223 void load_extra_data (ARDOUR::SessionMetadata const & data);
224 /// Saves from importable data (see load_data) to session_data
228 DataList & session_list; // References MetadataSet::list
229 DataList import_list;
231 struct Columns : public Gtk::TreeModel::ColumnRecord
234 Gtk::TreeModelColumn<std::string> field;
235 Gtk::TreeModelColumn<std::string> values;
236 Gtk::TreeModelColumn<bool> import;
237 Gtk::TreeModelColumn<MetadataPtr> data;
239 Columns() { add (field); add (values); add (import); add (data); }
242 Glib::RefPtr<Gtk::ListStore> tree;
244 Gtk::TreeView tree_view;
246 Gtk::Label tab_widget;
247 Gtk::CheckButton select_all_check;
250 void selection_changed (std::string const & path);
253 /// Metadata dialog interface
255 * The DataSets are initalized in this class so that all
256 * Dialogs have the same sets of data in the same order.
258 template <typename DataSet>
259 class SessionMetadataDialog : public ArdourDialog
262 SessionMetadataDialog (std::string const & name);
265 void init_data ( bool skip_user = false );
266 void load_extra_data (ARDOUR::SessionMetadata const & data);
269 virtual void init_gui () = 0;
270 virtual void save_and_close ();
271 virtual void end_dialog ();
273 void warn_user (std::string const & string);
275 typedef std::list<Gtk::Widget *> WidgetList;
276 typedef boost::shared_ptr<WidgetList> WidgetListPtr;
277 typedef Gtk::Widget & (DataSet::*WidgetFunc) ();
279 /// Returns list of widgets gathered by calling f for each data set
280 WidgetListPtr get_custom_widgets (WidgetFunc f);
282 /// Adds a widget to the table (vertical stacking) with automatic spacing
283 void add_widget (Gtk::Widget & widget);
285 Gtk::Notebook notebook;
288 void init_user_data ();
289 void init_track_data ();
290 void init_album_data ();
291 void init_people_data ();
292 void init_school_data ();
294 typedef boost::shared_ptr<SessionMetadataSet> DataSetPtr;
295 typedef std::list<DataSetPtr> DataSetList;
296 DataSetList data_list;
298 Gtk::Button * save_button;
299 Gtk::Button * cancel_button;
302 class SessionMetadataEditor : public SessionMetadataDialog<SessionMetadataSetEditable>
305 SessionMetadataEditor ();
306 ~SessionMetadataEditor ();
312 class SessionMetadataImporter : public SessionMetadataDialog<SessionMetadataSetImportable> {
314 SessionMetadataImporter ();
315 ~SessionMetadataImporter ();
321 // Select all from -widget
322 Gtk::HBox selection_hbox;
323 Gtk::Label selection_label;