libs/ardour/ardour/session_object.h

   1 /*
   2     Copyright (C) 2000-2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_session_object_h__
  21 #define __ardour_session_object_h__
  22
  23 #include <string>
  24 #include "pbd/statefuldestructible.h"
  25 #include "pbd/signals.h"
  26
  27 #include "ardour/ardour.h"
  28 #include "ardour/session_handle.h"
  29
  30 #include "i18n.h"
  31
  32 namespace ARDOUR {
  33
  34 namespace Properties {
  35         extern PBD::PropertyDescriptor<std::string> name;
  36 }
  37
  38 class Session;
  39
  40 /** A named object associated with a Session. Objects derived from this class are
  41     expected to be destroyed before the session calls drop_references().
  42  */
  43
  44 class SessionObject : public SessionHandleRef, public PBD::StatefulDestructible
  45 {
  46   public:
  47         static void make_property_quarks ();
  48
  49         SessionObject (Session& session, const std::string& name)
  50                 : SessionHandleRef (session)
  51                 , _name (Properties::name, PBD::PropertyChange (0), name)
  52         {
  53                 add_property (_name);
  54         }
  55
  56         Session&    session() const { return _session; }
  57         std::string name()    const { return _name; }
  58
  59         PBD::PropertyChange set_property (const PBD::PropertyBase& prop);
  60
  61         virtual bool set_name (const std::string& str) {
  62                 if (_name != str) {
  63                         _name = str;
  64                         NameChanged();
  65                 }
  66                 return true;
  67         }
  68
  69         PBD::Signal0<void> NameChanged;
  70
  71   protected:
  72         PBD::Property<std::string> _name;
  73 };
  74
  75 } // namespace ARDOUR
  76
  77 #endif /*__ardour_io_h__ */