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"
26 #include <boost/shared_ptr.hpp>
31 #include "ardour/session_metadata.h"
34 typedef boost::shared_ptr<MetadataField> MetadataPtr;
36 /// Wraps a metadata field to be used in a GUI
39 MetadataField (std::string const & field_name);
40 virtual ~MetadataField();
41 virtual MetadataPtr copy () = 0;
43 virtual void save_data (ARDOUR::SessionMetadata & data) const = 0;
44 virtual void load_data (ARDOUR::SessionMetadata const & data) = 0;
46 virtual std::string name() { return _name; }
47 virtual std::string value() { return _value; }
49 /// Get widget containing name of field
50 virtual Gtk::Widget & name_widget () = 0;
51 /// Get label containing value of field
52 virtual Gtk::Widget & value_widget () = 0;
53 /// Get widget for editing value
54 virtual Gtk::Widget & edit_widget () = 0;
60 /// MetadataField that contains text
61 class TextMetadataField : public MetadataField {
63 typedef std::string (ARDOUR::SessionMetadata::*Getter) () const;
64 typedef void (ARDOUR::SessionMetadata::*Setter) (std::string const &);
66 TextMetadataField (Getter getter, Setter setter, std::string const & field_name, guint width = 50);
69 void save_data (ARDOUR::SessionMetadata & data) const;
70 void load_data (ARDOUR::SessionMetadata const & data);
72 Gtk::Widget & name_widget ();
73 Gtk::Widget & value_widget ();
74 Gtk::Widget & edit_widget ();
82 Gtk::Label* value_label;
88 /// MetadataField that accepts only numbers
89 class NumberMetadataField : public MetadataField {
91 typedef uint32_t (ARDOUR::SessionMetadata::*Getter) () const;
92 typedef void (ARDOUR::SessionMetadata::*Setter) (uint32_t);
94 NumberMetadataField (Getter getter, Setter setter, std::string const & field_name, guint numbers, guint width = 50);
97 void save_data (ARDOUR::SessionMetadata & data) const;
98 void load_data (ARDOUR::SessionMetadata const & data);
100 Gtk::Widget & name_widget ();
101 Gtk::Widget & value_widget ();
102 Gtk::Widget & edit_widget ();
104 void update_value ();
105 std::string uint_to_str (uint32_t i) const;
106 uint32_t str_to_uint (std::string const & str) const;
112 Gtk::Label* value_label;
119 /// Interface for MetadataFields
120 class SessionMetadataSet : public ARDOUR::SessionHandlePtr {
122 SessionMetadataSet (std::string const & name);
123 virtual ~SessionMetadataSet () {};
125 void add_data_field (MetadataPtr field);
127 /// allows loading extra data into data sets (for importing etc.)
128 virtual void load_extra_data (ARDOUR::SessionMetadata const & /*data*/) { }
129 /// Saves data to session
130 virtual void save_data () = 0;
132 virtual Gtk::Widget & get_widget () = 0;
133 virtual Gtk::Widget & get_tab_widget () = 0;
136 typedef std::list<MetadataPtr> DataList;
141 /// Contains MetadataFields for editing
142 class SessionMetadataSetEditable : public SessionMetadataSet {
144 SessionMetadataSetEditable (std::string const & name);
146 Gtk::Widget & get_widget () { return vbox; }
147 Gtk::Widget & get_tab_widget ();
149 /// Sets session and loads data
150 void set_session (ARDOUR::Session * s);
151 /// Saves from MetadataFields into data
157 Gtk::Label tab_widget;
160 /// Contains MetadataFields for importing
161 class SessionMetadataSetImportable : public SessionMetadataSet {
163 SessionMetadataSetImportable (std::string const & name);
165 Gtk::Widget & get_widget () { return tree_view; }
166 Gtk::Widget & get_tab_widget ();
167 Gtk::Widget & get_select_all_widget ();
169 /// Loads importable data from data
170 void load_extra_data (ARDOUR::SessionMetadata const & data);
171 /// Saves from importable data (see load_data) to session_data
175 DataList & session_list; // References MetadataSet::list
176 DataList import_list;
178 struct Columns : public Gtk::TreeModel::ColumnRecord
181 Gtk::TreeModelColumn<std::string> field;
182 Gtk::TreeModelColumn<std::string> values;
183 Gtk::TreeModelColumn<bool> import;
184 Gtk::TreeModelColumn<MetadataPtr> data;
186 Columns() { add (field); add (values); add (import); add (data); }
189 Glib::RefPtr<Gtk::ListStore> tree;
191 Gtk::TreeView tree_view;
193 Gtk::Label tab_widget;
194 Gtk::CheckButton select_all_check;
197 void selection_changed (std::string const & path);
200 /// Metadata dialog interface
202 * The DataSets are initalized in this class so that all
203 * Dialogs have the same sets of data in the same order.
205 template <typename DataSet>
206 class SessionMetadataDialog : public ArdourDialog
209 SessionMetadataDialog (std::string const & name);
212 void init_data ( bool skip_user = false );
213 void load_extra_data (ARDOUR::SessionMetadata const & data);
216 virtual void init_gui () = 0;
217 virtual void save_and_close ();
218 virtual void end_dialog ();
220 void warn_user (std::string const & string);
222 typedef std::list<Gtk::Widget *> WidgetList;
223 typedef boost::shared_ptr<WidgetList> WidgetListPtr;
224 typedef Gtk::Widget & (DataSet::*WidgetFunc) ();
226 /// Returns list of widgets gathered by calling f for each data set
227 WidgetListPtr get_custom_widgets (WidgetFunc f);
229 /// Adds a widget to the table (vertical stacking) with automatic spacing
230 void add_widget (Gtk::Widget & widget);
232 Gtk::Notebook notebook;
235 void init_user_data ();
236 void init_track_data ();
237 void init_album_data ();
238 void init_people_data ();
239 void init_school_data ();
241 typedef boost::shared_ptr<SessionMetadataSet> DataSetPtr;
242 typedef std::list<DataSetPtr> DataSetList;
243 DataSetList data_list;
245 Gtk::Button * save_button;
246 Gtk::Button * cancel_button;
249 class SessionMetadataEditor : public SessionMetadataDialog<SessionMetadataSetEditable> {
251 SessionMetadataEditor ();
252 ~SessionMetadataEditor ();
258 class SessionMetadataImporter : public SessionMetadataDialog<SessionMetadataSetImportable> {
260 SessionMetadataImporter ();
261 ~SessionMetadataImporter ();
267 // Select all from -widget
268 Gtk::HBox selection_hbox;
269 Gtk::Label selection_label;