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 #include "pbd/properties.h"
  27
  28 #include "ardour/ardour.h"
  29 #include "ardour/session_handle.h"
  30
  31 #include "i18n.h"
  32
  33 namespace ARDOUR {
  34
  35 namespace Properties {
  36         extern PBD::PropertyDescriptor<std::string> name;
  37 }
  38
  39 class Session;
  40
  41 /** A named object associated with a Session. Objects derived from this class are
  42     expected to be destroyed before the session calls drop_references().
  43  */
  44
  45 class SessionObject : public SessionHandleRef, public PBD::StatefulDestructible
  46 {
  47   public:
  48         static void make_property_quarks ();
  49
  50         SessionObject (Session& session, const std::string& name)
  51                 : SessionHandleRef (session)
  52                 , _name (Properties::name, name)
  53         {
  54                 add_property (_name);
  55         }
  56
  57         Session&    session() const { return _session; }
  58         std::string name()    const { return _name; }
  59
  60         virtual bool set_name (const std::string& str) {
  61                 if (_name != str) {
  62                         _name = str;
  63                         PropertyChanged (PBD::PropertyChange (Properties::name));
  64                 }
  65                 return true;
  66         }
  67
  68   protected:
  69         PBD::Property<std::string> _name;
  70 };
  71
  72 } // namespace ARDOUR
  73
  74 #endif /*__ardour_io_h__ */