ProjectSnap Class Reference

Project snapping settings. More...

#include <ProjectSnap.h>

Inheritance diagram for ProjectSnap:

Collaboration diagram for ProjectSnap:

Public Member Functions
	ProjectSnap (const AudacityProject &project)
	ProjectSnap (const ProjectSnap &)=delete
ProjectSnap &	operator= (const ProjectSnap &)=delete
void	SetSnapMode (SnapMode mode)
SnapMode	GetSnapMode () const
void	SetSnapTo (Identifier snap)
Identifier	GetSnapTo () const
SnapResult	SnapTime (double time) const
SnapResult	SingleStep (double time, bool upwards) const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< SnapChangedMessage >
	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 ProjectSnap &	Get (AudacityProject &project)
static const ProjectSnap &	Get (const AudacityProject &project)

Private Attributes
const AudacityProject &	mProject
SnapMode	mSnapMode { ReadSnapMode() }
Identifier	mSnapTo { ReadSnapTo() }

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

Detailed Description

Project snapping settings.

Definition at line 26 of file ProjectSnap.h.

Constructor & Destructor Documentation

ProjectSnap() [1/2]

ProjectSnap::ProjectSnap ( const AudacityProject &  project )

explicit

Definition at line 37 of file ProjectSnap.cpp.

    : mProject(project)
{}

ProjectSnap() [2/2]

ProjectSnap::ProjectSnap ( const ProjectSnap &  )

delete

Member Function Documentation

Get() [1/2]

ProjectSnap & ProjectSnap::Get ( AudacityProject &  project )

static

Definition at line 27 of file ProjectSnap.cpp.

{
   return project.AttachedObjects::Get<ProjectSnap>(sKey);
}

References project, and sKey.

Referenced by SnapManager::CondListAdd(), Get(), anonymous_namespace{SelectMenus.cpp}::GridMove(), AUPImportFileHandle::Import(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnComboKeyEvent(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), SnappingToolBar::OnSnapModeChanged(), SelectActions::Handler::OnSnapToNearest(), SelectActions::Handler::OnSnapToOff(), SelectActions::Handler::OnSnapToPrior(), SnappingToolBar::Populate(), anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange(), SnapManager::Reinit(), anonymous_namespace{SelectMenus.cpp}::SeekWhenAudioInactive(), SnapManager::Snap(), and ProjectSelectionManager::SnapSelection().

Here is the caller graph for this function:

Get() [2/2]

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

static

Definition at line 32 of file ProjectSnap.cpp.

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

References Get(), and project.

Here is the call graph for this function:

GetSnapMode()

SnapMode ProjectSnap::GetSnapMode

(

)

const

Definition at line 54 of file ProjectSnap.cpp.

{
   return mSnapMode;
}

References mSnapMode.

Referenced by SnappingToolBar::Populate().

Here is the caller graph for this function:

GetSnapTo()

Identifier ProjectSnap::GetSnapTo

(

)

const

Definition at line 72 of file ProjectSnap.cpp.

{
   return mSnapTo;
}

References mSnapTo.

operator=()

ProjectSnap & ProjectSnap::operator= ( const ProjectSnap &  )

delete

SetSnapMode()

void ProjectSnap::SetSnapMode

(

SnapMode

mode

)

Definition at line 41 of file ProjectSnap.cpp.

{
   if (mSnapMode != mode)
   {
      mSnapMode = mode;
      
      SnapModeSetting.WriteEnum(mSnapMode);
      gPrefs->Flush();
 
      Publish(SnapChangedMessage { mode, mSnapTo });
   }
}

References audacity::BasicSettings::Flush(), gPrefs, mSnapMode, mSnapTo, Observer::Publisher< SnapChangedMessage >::Publish(), and SnapModeSetting.

Referenced by AUPImportFileHandle::Import(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), SnappingToolBar::OnSnapModeChanged(), SelectActions::Handler::OnSnapToNearest(), SelectActions::Handler::OnSnapToOff(), SelectActions::Handler::OnSnapToPrior(), and anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

SetSnapTo()

void ProjectSnap::SetSnapTo

(

Identifier

snap

)

Definition at line 59 of file ProjectSnap.cpp.

{
   if (mSnapTo != snap)
   {
      mSnapTo = snap;
 
      SnapToSetting.Write(mSnapTo.GET());
      gPrefs->Flush();
 
      Publish(SnapChangedMessage { mSnapMode, snap });
   }
}

References audacity::BasicSettings::Flush(), Identifier::GET(), gPrefs, mSnapMode, mSnapTo, Observer::Publisher< SnapChangedMessage >::Publish(), SnapToSetting, and Setting< T >::Write().

Referenced by anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnComboKeyEvent(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup(), and anonymous_namespace{PluginMenus.cpp}::OnResetConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

SingleStep()

SnapResult ProjectSnap::SingleStep	(	double	time,
		bool	upwards
	)		const

Definition at line 85 of file ProjectSnap.cpp.

{
   if (mSnapMode == SnapMode::SNAP_OFF)
      return { time, false };
 
   return SnapFunctionsRegistry::SingleStep(mSnapTo, mProject, time, upwards);
}

References mProject, mSnapMode, mSnapTo, SnapFunctionsRegistry::SingleStep(), and SNAP_OFF.

Here is the call graph for this function:

SnapTime()

SnapResult ProjectSnap::SnapTime

(

double

time

)

const

Definition at line 77 of file ProjectSnap.cpp.

{
   if (mSnapMode == SnapMode::SNAP_OFF)
      return { time, false };
 
   return SnapFunctionsRegistry::Snap(mSnapTo, mProject, time, mSnapMode == SnapMode::SNAP_NEAREST);
}

References mProject, mSnapMode, mSnapTo, SnapFunctionsRegistry::Snap(), SNAP_NEAREST, and SNAP_OFF.

Referenced by SnapManager::CondListAdd(), and SnapManager::Snap().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mProject

const AudacityProject& ProjectSnap::mProject

private

Definition at line 48 of file ProjectSnap.h.

Referenced by SingleStep(), and SnapTime().

mSnapMode

SnapMode ProjectSnap::mSnapMode { ReadSnapMode() }

private

Definition at line 50 of file ProjectSnap.h.

Referenced by GetSnapMode(), SetSnapMode(), SetSnapTo(), SingleStep(), and SnapTime().

mSnapTo

Identifier ProjectSnap::mSnapTo { ReadSnapTo() }

private

Definition at line 51 of file ProjectSnap.h.

Referenced by GetSnapTo(), SetSnapMode(), SetSnapTo(), SingleStep(), and SnapTime().

---

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

• ProjectSnap.h
• ProjectSnap.cpp