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"
30 #include <boost/shared_ptr.hpp>
35 #include "ardour/session_metadata.h"
38 typedef boost::shared_ptr<MetadataField> MetadataPtr;
40 /// Wraps a metadata field to be used in a GUI
43 MetadataField (std::string const & field_name);
44 virtual ~MetadataField();
45 virtual MetadataPtr copy () = 0;
47 virtual void save_data (ARDOUR::SessionMetadata & data) const = 0;
48 virtual void load_data (ARDOUR::SessionMetadata const & data) = 0;
50 virtual std::string name() { return _name; }
51 virtual std::string value() { return _value; }
53 /// Get widget containing name of field
54 virtual Gtk::Widget & name_widget () = 0;
55 /// Get label containing value of field
56 virtual Gtk::Widget & value_widget () = 0;
57 /// Get widget for editing value
58 virtual Gtk::Widget & edit_widget () = 0;
64 /// MetadataField that contains text
65 class TextMetadataField : public MetadataField {
67 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
68 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
70 TextMetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 50);
73 void save_data (ARDOUR::SessionMetadata & data) const;
74 void load_data (ARDOUR::SessionMetadata const & data);
76 Gtk::Widget & name_widget ();
77 Gtk::Widget & value_widget ();
78 Gtk::Widget & edit_widget ();
86 Gtk::Label* value_label;
92 /// MetadataField that accepts only numbers
93 class NumberMetadataField : public MetadataField {
95 typedef uint32_t (ARDOUR::SessionMetadata::*Getter) () const;
96 typedef void (ARDOUR::SessionMetadata::*Setter) (uint32_t);
98 NumberMetadataField (Getter getter, Setter setter, std::string const & field_name, guint numbers, guint width = 50);
101 void save_data (ARDOUR::SessionMetadata & data) const;
102 void load_data (ARDOUR::SessionMetadata const & data);
104 Gtk::Widget & name_widget ();
105 Gtk::Widget & value_widget ();
106 Gtk::Widget & edit_widget ();
108 void update_value ();
109 std::string uint_to_str (uint32_t i) const;
110 uint32_t str_to_uint (std::string const & str) const;
116 Gtk::Label* value_label;
123 /// MetadataField that accepts EAN-13 data only
124 class EAN13MetadataField : public MetadataField {
126 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
127 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
129 EAN13MetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 13);
132 void save_data (ARDOUR::SessionMetadata & data) const;
133 void load_data (ARDOUR::SessionMetadata const & data);
135 Gtk::Widget & name_widget ();
136 Gtk::Widget & value_widget ();
137 Gtk::Widget & edit_widget ();
139 Gtk::Label* status_label;
140 void update_status ();
142 void update_value ();
143 std::string numeric_string (std::string const & str) const;
149 Gtk::Label* value_label;
155 /// Interface for MetadataFields
156 class SessionMetadataSet : public ARDOUR::SessionHandlePtr {
158 SessionMetadataSet (std::string const & name);
159 virtual ~SessionMetadataSet () {};
161 void add_data_field (MetadataPtr field);
163 /// allows loading extra data into data sets (for importing etc.)
164 virtual void load_extra_data (ARDOUR::SessionMetadata const & /*data*/) { }
165 /// Saves data to session
166 virtual void save_data () = 0;
168 virtual Gtk::Widget & get_widget () = 0;
169 virtual Gtk::Widget & get_tab_widget () = 0;
172 typedef std::list<MetadataPtr> DataList;
177 /// Contains MetadataFields for editing
178 class SessionMetadataSetEditable : public SessionMetadataSet {
180 SessionMetadataSetEditable (std::string const & name);
182 Gtk::Widget & get_widget () { return vbox; }
183 Gtk::Widget & get_tab_widget ();
185 /// Sets session and loads data
186 void set_session (ARDOUR::Session * s);
187 /// Saves from MetadataFields into data
193 Gtk::Label tab_widget;
196 /// Contains MetadataFields for importing
197 class SessionMetadataSetImportable : public SessionMetadataSet {
199 SessionMetadataSetImportable (std::string const & name);
201 Gtk::Widget & get_widget () { return tree_view; }
202 Gtk::Widget & get_tab_widget ();
203 Gtk::Widget & get_select_all_widget ();
205 /// Loads importable data from data
206 void load_extra_data (ARDOUR::SessionMetadata const & data);
207 /// Saves from importable data (see load_data) to session_data
211 DataList & session_list; // References MetadataSet::list
212 DataList import_list;
214 struct Columns : public Gtk::TreeModel::ColumnRecord
217 Gtk::TreeModelColumn<std::string> field;
218 Gtk::TreeModelColumn<std::string> values;
219 Gtk::TreeModelColumn<bool> import;
220 Gtk::TreeModelColumn<MetadataPtr> data;
222 Columns() { add (field); add (values); add (import); add (data); }
225 Glib::RefPtr<Gtk::ListStore> tree;
227 Gtk::TreeView tree_view;
229 Gtk::Label tab_widget;
230 Gtk::CheckButton select_all_check;
233 void selection_changed (std::string const & path);
236 /// Metadata dialog interface
238 * The DataSets are initalized in this class so that all
239 * Dialogs have the same sets of data in the same order.
241 template <typename DataSet>
242 class SessionMetadataDialog : public ArdourDialog
245 SessionMetadataDialog (std::string const & name);
248 void init_data ( bool skip_user = false );
249 void load_extra_data (ARDOUR::SessionMetadata const & data);
252 virtual void init_gui () = 0;
253 virtual void save_and_close ();
254 virtual void end_dialog ();
256 void warn_user (std::string const & string);
258 typedef std::list<Gtk::Widget *> WidgetList;
259 typedef boost::shared_ptr<WidgetList> WidgetListPtr;
260 typedef Gtk::Widget & (DataSet::*WidgetFunc) ();
262 /// Returns list of widgets gathered by calling f for each data set
263 WidgetListPtr get_custom_widgets (WidgetFunc f);
265 /// Adds a widget to the table (vertical stacking) with automatic spacing
266 void add_widget (Gtk::Widget & widget);
268 Gtk::Notebook notebook;
271 void init_user_data ();
272 void init_track_data ();
273 void init_album_data ();
274 void init_people_data ();
275 void init_school_data ();
277 typedef boost::shared_ptr<SessionMetadataSet> DataSetPtr;
278 typedef std::list<DataSetPtr> DataSetList;
279 DataSetList data_list;
281 Gtk::Button * save_button;
282 Gtk::Button * cancel_button;
285 class SessionMetadataEditor : public SessionMetadataDialog<SessionMetadataSetEditable> {
287 SessionMetadataEditor ();
288 ~SessionMetadataEditor ();
294 class SessionMetadataImporter : public SessionMetadataDialog<SessionMetadataSetImportable> {
296 SessionMetadataImporter ();
297 ~SessionMetadataImporter ();
303 // Select all from -widget
304 Gtk::HBox selection_hbox;
305 Gtk::Label selection_label;