libs/ardour/ardour/session_object.h

   1 /*
   2     Copyright (C) 2000-2007 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/session_handle.h"
  28
  29 namespace ARDOUR {
  30
  31 class Session;
  32
  33 /** A named object associated with a Session. Objects derived from this class are
  34     expected to be destroyed before the session calls drop_references().
  35  */
  36
  37 class SessionObject : public SessionHandleRef, public PBD::StatefulDestructible
  38 {
  39   public:
  40         SessionObject (Session& session, const std::string& name)
  41                 : SessionHandleRef (session)
  42                 , _name(name)
  43         {}
  44
  45         Session&           session() const { return _session; }
  46         const std::string& name()    const { return _name; }
  47
  48         virtual bool set_name (const std::string& str) {
  49                 if (_name != str) {
  50                         _name = str;
  51                         NameChanged();
  52                 }
  53                 return true;
  54         }
  55
  56         PBD::Signal0<void> NameChanged;
  57
  58   protected:
  59         std::string _name;
  60 };
  61
  62 } // namespace ARDOUR
  63
  64 #endif /*__ardour_io_h__ */