SyncLockState Class Reference

#include <SyncLock.h>

Inheritance diagram for SyncLockState:

Collaboration diagram for SyncLockState:

Public Member Functions
	SyncLockState (AudacityProject &project)
	SyncLockState (const SyncLockState &)=delete
SyncLockState &	operator= (const SyncLockState &)=delete
bool	IsSyncLocked () const
void	SetSyncLock (bool flag)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< SyncLockChangeMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static SyncLockState &	Get (AudacityProject &project)
static const SyncLockState &	Get (const AudacityProject &project)

Private Attributes
AudacityProject &	mProject
bool	mIsSyncLocked { false }

Additional Inherited Members
Public Types inherited from Observer::Publisher< SyncLockChangeMessage >
using	message_type = SyncLockChangeMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const SyncLockChangeMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< SyncLockChangeMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< SyncLockChangeMessage >
CallbackReturn	Publish (const SyncLockChangeMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 22 of file SyncLock.h.

Constructor & Destructor Documentation

SyncLockState() [1/2]

SyncLockState::SyncLockState ( AudacityProject &  project )

explicit

Definition at line 38 of file SyncLock.cpp.

   : mProject{project}
   , mIsSyncLocked(SyncLockTracks.Read())
{
}

SyncLockState() [2/2]

SyncLockState::SyncLockState ( const SyncLockState &  )

delete

Member Function Documentation

Get() [1/2]

SyncLockState & SyncLockState::Get ( AudacityProject &  project )

static

Definition at line 27 of file SyncLock.cpp.

{
   return project.AttachedObjects::Get< SyncLockState >(
      sSyncLockStateKey );
}

References project, and sSyncLockStateKey.

Referenced by SelectHandle::Click(), TimeShiftHandle::Click(), anonymous_namespace{ClipMenus.cpp}::DoClipLeftOrRight(), SelectUtilities::DoListSelection(), Get(), anonymous_namespace{LabelMenus.cpp}::GetTracksToEditByLabel(), IsNotSyncLockedFlag(), IsSyncLockedFlag(), SyncLock::IsSyncLockSelected(), ToolManager::ModifyToolbarMenus(), anonymous_namespace{EditMenus.cpp}::OnPaste(), TruncSilenceBase::ProcessIndependently(), StretchHandle::Release(), NoteTrackAffordanceHandle::SelectAt(), RateMenuTable::SetRate(), and TrackPanel::TrackPanel().

Here is the caller graph for this function:

Get() [2/2]

const SyncLockState & SyncLockState::Get ( const AudacityProject &  project )

static

Definition at line 33 of file SyncLock.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get(), and project.

Here is the call graph for this function:

IsSyncLocked()

bool SyncLockState::IsSyncLocked

(

)

const

Definition at line 44 of file SyncLock.cpp.

{
   return mIsSyncLocked;
}

References mIsSyncLocked.

Referenced by SelectHandle::Click(), TimeShiftHandle::Click(), anonymous_namespace{ClipMenus.cpp}::DoClipLeftOrRight(), SelectUtilities::DoListSelection(), anonymous_namespace{LabelMenus.cpp}::GetTracksToEditByLabel(), IsNotSyncLockedFlag(), IsSyncLockedFlag(), SyncLock::IsSyncLockSelected(), anonymous_namespace{EditMenus.cpp}::OnPaste(), TruncSilenceBase::ProcessIndependently(), StretchHandle::Release(), NoteTrackAffordanceHandle::SelectAt(), and RateMenuTable::SetRate().

Here is the caller graph for this function:

operator=()

SyncLockState & SyncLockState::operator= ( const SyncLockState &  )

delete

SetSyncLock()

void SyncLockState::SetSyncLock

(

bool

flag

)

Definition at line 49 of file SyncLock.cpp.

{
   if (flag != mIsSyncLocked) {
      mIsSyncLocked = flag;
      Publish({ flag });
   }
}

References flag, mIsSyncLocked, and Observer::Publisher< SyncLockChangeMessage >::Publish().

Referenced by ToolManager::ModifyToolbarMenus().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mIsSyncLocked

bool SyncLockState::mIsSyncLocked { false }

private

Definition at line 38 of file SyncLock.h.

Referenced by IsSyncLocked(), and SetSyncLock().

mProject

AudacityProject& SyncLockState::mProject

private

Definition at line 37 of file SyncLock.h.

---

The documentation for this class was generated from the following files:

• SyncLock.h
• SyncLock.cpp