SyncLock.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
@file SyncLock.cpp
@brief Defines groupings of tracks that should keep contents synchronized
 
Paul Licameli split from Track.cpp
 
**********************************************************************/
#ifndef __AUDACITY_SYNC_LOCK__
#define __AUDACITY_SYNC_LOCK__
 
#include "Prefs.h"
#include "Track.h" // for TrackIterRange
#include "AttachedVirtualFunction.h"
#include "Observer.h"
 
struct SyncLockChangeMessage{ const bool on; };
 
class TRACK_SELECTION_API SyncLockState final
   : public ClientData::Base
   , public Observer::Publisher<SyncLockChangeMessage>
{
public:
   static SyncLockState &Get( AudacityProject &project );
   static const SyncLockState &Get( const AudacityProject &project );
   explicit SyncLockState( AudacityProject &project );
   SyncLockState( const SyncLockState & ) = delete;
   SyncLockState &operator=( const SyncLockState & ) = delete;
 
   bool IsSyncLocked() const;
   void SetSyncLock(bool flag);
 
private:
   AudacityProject &mProject;
   bool mIsSyncLocked{ false };
};
 
class TRACK_SELECTION_API SyncLock {
public:
   static bool IsSyncLockSelected(const Track &track);
 
 
   static bool IsSyncLockSelectedP(const Track *pTrack)
   { return pTrack && IsSyncLockSelected(*pTrack); }
 
   static bool IsSelectedOrSyncLockSelected(const Track &track);
 
 
   static bool IsSelectedOrSyncLockSelectedP(const Track *pTrack)
   { return pTrack && IsSelectedOrSyncLockSelected(*pTrack); }
 
   static TrackIterRange<Track> Group(Track &track);
 
   static TrackIterRange<const Track> Group(const Track &track)
   {
      return Group(const_cast<Track&>(track)).Filter<const Track>();
   }
};
 
enum class SyncLockPolicy {
   Isolated, 
   Grouped, 
   EndSeparator, 
};
 
struct GetSyncLockPolicyTag;
 
using GetSyncLockPolicy =
AttachedVirtualFunction<
   GetSyncLockPolicyTag,
   SyncLockPolicy,
   const Track
>;
DECLARE_EXPORTED_ATTACHED_VIRTUAL(TRACK_SELECTION_API, GetSyncLockPolicy);
 
extern TRACK_SELECTION_API BoolSetting SyncLockTracks;
 
#endif