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 /// Interface for MetadataFields
124 class SessionMetadataSet : public ARDOUR::SessionHandlePtr {
126 SessionMetadataSet (std::string const & name);
127 virtual ~SessionMetadataSet () {};
129 void add_data_field (MetadataPtr field);
131 /// allows loading extra data into data sets (for importing etc.)
132 virtual void load_extra_data (ARDOUR::SessionMetadata const & /*data*/) { }
133 /// Saves data to session
134 virtual void save_data () = 0;
136 virtual Gtk::Widget & get_widget () = 0;
137 virtual Gtk::Widget & get_tab_widget () = 0;
140 typedef std::list<MetadataPtr> DataList;
145 /// Contains MetadataFields for editing
146 class SessionMetadataSetEditable : public SessionMetadataSet {
148 SessionMetadataSetEditable (std::string const & name);
150 Gtk::Widget & get_widget () { return vbox; }
151 Gtk::Widget & get_tab_widget ();
153 /// Sets session and loads data
154 void set_session (ARDOUR::Session * s);
155 /// Saves from MetadataFields into data
161 Gtk::Label tab_widget;
164 /// Contains MetadataFields for importing
165 class SessionMetadataSetImportable : public SessionMetadataSet {
167 SessionMetadataSetImportable (std::string const & name);
169 Gtk::Widget & get_widget () { return tree_view; }
170 Gtk::Widget & get_tab_widget ();
171 Gtk::Widget & get_select_all_widget ();
173 /// Loads importable data from data
174 void load_extra_data (ARDOUR::SessionMetadata const & data);
175 /// Saves from importable data (see load_data) to session_data
179 DataList & session_list; // References MetadataSet::list
180 DataList import_list;
182 struct Columns : public Gtk::TreeModel::ColumnRecord
185 Gtk::TreeModelColumn<std::string> field;
186 Gtk::TreeModelColumn<std::string> values;
187 Gtk::TreeModelColumn<bool> import;
188 Gtk::TreeModelColumn<MetadataPtr> data;
190 Columns() { add (field); add (values); add (import); add (data); }
193 Glib::RefPtr<Gtk::ListStore> tree;
195 Gtk::TreeView tree_view;
197 Gtk::Label tab_widget;
198 Gtk::CheckButton select_all_check;
201 void selection_changed (std::string const & path);
204 /// Metadata dialog interface
206 * The DataSets are initalized in this class so that all
207 * Dialogs have the same sets of data in the same order.
209 template <typename DataSet>
210 class SessionMetadataDialog : public ArdourDialog
213 SessionMetadataDialog (std::string const & name);
216 void init_data ( bool skip_user = false );
217 void load_extra_data (ARDOUR::SessionMetadata const & data);
220 virtual void init_gui () = 0;
221 virtual void save_and_close ();
222 virtual void end_dialog ();
224 void warn_user (std::string const & string);
226 typedef std::list<Gtk::Widget *> WidgetList;
227 typedef boost::shared_ptr<WidgetList> WidgetListPtr;
228 typedef Gtk::Widget & (DataSet::*WidgetFunc) ();
230 /// Returns list of widgets gathered by calling f for each data set
231 WidgetListPtr get_custom_widgets (WidgetFunc f);
233 /// Adds a widget to the table (vertical stacking) with automatic spacing
234 void add_widget (Gtk::Widget & widget);
236 Gtk::Notebook notebook;
239 void init_user_data ();
240 void init_track_data ();
241 void init_album_data ();
242 void init_people_data ();
243 void init_school_data ();
245 typedef boost::shared_ptr<SessionMetadataSet> DataSetPtr;
246 typedef std::list<DataSetPtr> DataSetList;
247 DataSetList data_list;
249 Gtk::Button * save_button;
250 Gtk::Button * cancel_button;
253 class SessionMetadataEditor : public SessionMetadataDialog<SessionMetadataSetEditable> {
255 SessionMetadataEditor ();
256 ~SessionMetadataEditor ();
262 class SessionMetadataImporter : public SessionMetadataDialog<SessionMetadataSetImportable> {
264 SessionMetadataImporter ();
265 ~SessionMetadataImporter ();
271 // Select all from -widget
272 Gtk::HBox selection_hbox;
273 Gtk::Label selection_label;