NotifyingSelectedRegion Class Reference

#include <ViewInfo.h>

Inheritance diagram for NotifyingSelectedRegion:

Collaboration diagram for NotifyingSelectedRegion:

Public Member Functions
double	t0 () const
double	t1 () const
double	f0 () const
double	f1 () const
double	fc () const
bool	isPoint () const
double	duration () const
void	WriteXMLAttributes (XMLWriter &xmlFile, const char *legacyT0Name, const char *legacyT1Name) const
	operator const SelectedRegion & () const
NotifyingSelectedRegion &	operator= (const SelectedRegion &other)
bool	setTimes (double t0, double t1)
bool	setT0 (double t, bool maySwap=true)
bool	setT1 (double t, bool maySwap=true)
void	collapseToT0 ()
void	collapseToT1 ()
void	move (double delta)
bool	setFrequencies (double f0, double f1)
bool	setF0 (double f, bool maySwap=true)
bool	setF1 (double f, bool maySwap=true)
Public Member Functions inherited from Observer::Publisher< NotifyingSelectedRegionMessage >
	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 XMLMethodRegistryBase::Mutators< NotifyingSelectedRegion >	Mutators (const char *legacyT0Name, const char *legacyT1Name)
	Return some information used for deserialization purposes by ViewInfo. More...

Private Member Functions
void	Notify (bool delayed=false)

Private Attributes
SelectedRegion	mRegion

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

Detailed Description

Definition at line 29 of file ViewInfo.h.

Member Function Documentation

collapseToT0()

void NotifyingSelectedRegion::collapseToT0

(

)

Definition at line 81 of file ViewInfo.cpp.

{
   if ( mRegion.t0() !=  mRegion.t1() ) {
      mRegion.collapseToT0();
      Notify();
   }
}

References SelectedRegion::collapseToT0(), mRegion, Notify(), SelectedRegion::t0(), and SelectedRegion::t1().

Referenced by SelectActions::Handler::OnSelectNone().

Here is the call graph for this function:

Here is the caller graph for this function:

collapseToT1()

void NotifyingSelectedRegion::collapseToT1

(

)

Definition at line 89 of file ViewInfo.cpp.

{
   if ( mRegion.t0() !=  mRegion.t1() ) {
      mRegion.collapseToT1();
      Notify();
   }
}

References SelectedRegion::collapseToT1(), mRegion, Notify(), SelectedRegion::t0(), and SelectedRegion::t1().

Here is the call graph for this function:

duration()

double NotifyingSelectedRegion::duration ( ) const

inline

Definition at line 41 of file ViewInfo.h.

{ return mRegion.duration(); }

Referenced by EffectBase::DoEffect(), and anonymous_namespace{EditMenus.cpp}::OnDelete().

Here is the caller graph for this function:

f0()

double NotifyingSelectedRegion::f0 ( ) const

inline

Definition at line 37 of file ViewInfo.h.

{ return mRegion.f0(); }

Referenced by anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), EffectBase::DoEffect(), SelectHandle::MoveSnappingFreqSelection(), anonymous_namespace{SpectrumView.cpp}::Handler::OnToggleSpectralSelection(), and setFrequencies().

Here is the caller graph for this function:

f1()

double NotifyingSelectedRegion::f1 ( ) const

inline

Definition at line 38 of file ViewInfo.h.

{ return mRegion.f1(); }

Referenced by anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), EffectBase::DoEffect(), SelectHandle::MoveSnappingFreqSelection(), setFrequencies(), and SelectHandle::SnapCenterOnce().

Here is the caller graph for this function:

fc()

double NotifyingSelectedRegion::fc ( ) const

inline

Definition at line 39 of file ViewInfo.h.

{ return mRegion.fc(); }

Referenced by anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), and SelectHandle::SnapCenterOnce().

Here is the caller graph for this function:

isPoint()

bool NotifyingSelectedRegion::isPoint ( ) const

inline

Definition at line 40 of file ViewInfo.h.

{ return mRegion.isPoint(); }

Referenced by anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), SelectUtilities::DoSelectSomething(), TranscriptionToolBar::EnableDisableButtons(), ExportUtils::HasSelectedAudio(), EffectUIHost::OnApply(), and TimeSelectedPred().

Here is the caller graph for this function:

move()

void NotifyingSelectedRegion::move

(

double

delta

)

Definition at line 97 of file ViewInfo.cpp.

{
   if (delta != 0) {
      mRegion.move( delta );
      Notify();
   }
}

References SelectedRegion::move(), mRegion, and Notify().

Referenced by TimeShiftHandle::DoSlideVertical().

Here is the call graph for this function:

Here is the caller graph for this function:

Mutators()

XMLMethodRegistryBase::Mutators< NotifyingSelectedRegion > NotifyingSelectedRegion::Mutators ( const char *  legacyT0Name, const char *  legacyT1Name  )

static

Return some information used for deserialization purposes by ViewInfo.

Definition at line 24 of file ViewInfo.cpp.

{
   XMLMethodRegistryBase::Mutators<NotifyingSelectedRegion> results;
   // Get serialization methods of contained SelectedRegion, and wrap each
   for (auto &delegate: SelectedRegion::Mutators(legacyT0Name, legacyT1Name)) {
      results.emplace_back(
         delegate.first,
         [fn = std::move(delegate.second)](auto &region, auto value) {
            fn( region.mRegion, value );
            region.Notify( true );
         }
      );
   }
   return results;
}

References fn, and SelectedRegion::Mutators().

Here is the call graph for this function:

Notify()

void NotifyingSelectedRegion::Notify ( bool  delayed = false )

private

Definition at line 135 of file ViewInfo.cpp.

{
   if (delayed)
      BasicUI::CallAfter([This = wxWeakRef(this)]{
         if (This)
            This->Publish({});
      });
   else
      Publish({});
}

References BasicUI::CallAfter(), and Observer::Publisher< NotifyingSelectedRegionMessage >::Publish().

Referenced by collapseToT0(), collapseToT1(), move(), setF0(), setF1(), setFrequencies(), setT0(), setT1(), and setTimes().

Here is the call graph for this function:

Here is the caller graph for this function:

operator const SelectedRegion &()

NotifyingSelectedRegion::operator const SelectedRegion & ( ) const

inline

Definition at line 56 of file ViewInfo.h.

{ return mRegion; }

operator=()

NotifyingSelectedRegion & NotifyingSelectedRegion::operator=

(

const SelectedRegion &

other

)

Definition at line 41 of file ViewInfo.cpp.

{
   if ( mRegion != other ) {
      mRegion = other;
      Notify();
   }
   return *this;
}

setF0()

bool NotifyingSelectedRegion::setF0	(	double	f,
		bool	maySwap = true
	)

Definition at line 115 of file ViewInfo.cpp.

{
   bool result = false;
   if ( mRegion.f0() != f ) {
      result = mRegion.setF0( f, maySwap );
      Notify();
   }
   return result;
}

References SelectedRegion::f0(), mRegion, Notify(), and SelectedRegion::setF0().

Referenced by SelectHandle::AdjustFreqSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

setF1()

bool NotifyingSelectedRegion::setF1	(	double	f,
		bool	maySwap = true
	)

Definition at line 125 of file ViewInfo.cpp.

{
   bool result = false;
   if ( mRegion.f1() != f ) {
      result = mRegion.setF1( f, maySwap );
      Notify();
   }
   return result;
}

References SelectedRegion::f1(), mRegion, Notify(), and SelectedRegion::setF1().

Referenced by SelectHandle::AdjustFreqSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

setFrequencies()

bool NotifyingSelectedRegion::setFrequencies	(	double	f0,
		double	f1
	)

Definition at line 105 of file ViewInfo.cpp.

{
   bool result = false;
   if ( mRegion.f0() != f0 || mRegion.f1() != f1 ) {
      result = mRegion.setFrequencies( f0, f1 );
      Notify();
   }
   return result;
}

References SelectedRegion::f0(), f0(), SelectedRegion::f1(), f1(), mRegion, Notify(), and SelectedRegion::setFrequencies().

Referenced by SelectHandle::AdjustFreqSelection(), SelectHandle::MoveSnappingFreqSelection(), SelectHandle::SnapCenterOnce(), and SelectHandle::StartFreqSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

setT0()

bool NotifyingSelectedRegion::setT0	(	double	t,
		bool	maySwap = true
	)

Definition at line 61 of file ViewInfo.cpp.

{
   bool result = false;
   if ( mRegion.t0() != t ) {
      result = mRegion.setT0( t, maySwap );
      Notify();
   }
   return result;
}

References mRegion, Notify(), SelectedRegion::setT0(), and SelectedRegion::t0().

Here is the call graph for this function:

setT1()

bool NotifyingSelectedRegion::setT1	(	double	t,
		bool	maySwap = true
	)

Definition at line 71 of file ViewInfo.cpp.

{
   bool result = false;
   if ( mRegion.t1() != t ) {
      result = mRegion.setT1( t, maySwap );
      Notify();
   }
   return result;
}

References mRegion, Notify(), SelectedRegion::setT1(), and SelectedRegion::t1().

Here is the call graph for this function:

setTimes()

bool NotifyingSelectedRegion::setTimes	(	double	t0,
		double	t1
	)

Definition at line 51 of file ViewInfo.cpp.

{
   bool result = false;
   if ( mRegion.t0() != t0 || mRegion.t1() != t1 ) {
      result = mRegion.setTimes( t0, t1 );
      Notify();
   }
   return result;
}

References mRegion, Notify(), SelectedRegion::setTimes(), SelectedRegion::t0(), t0(), SelectedRegion::t1(), and t1().

Referenced by SelectHandle::AssignSelection(), CutlineHandle::Cancel(), Effect::Delegate(), EffectBase::DoEffect(), anonymous_namespace{SelectUtilities.cpp}::DoSelectTimeAndAudioTracks(), SelectUtilities::DoSelectTimeAndTracks(), anonymous_namespace{EditMenus.cpp}::OnPaste(), WaveChannelView::SelectNextClip(), and SelectionState::SelectTrackLength().

Here is the call graph for this function:

Here is the caller graph for this function:

t0()

double NotifyingSelectedRegion::t0 ( ) const

inline

Definition at line 35 of file ViewInfo.h.

{ return mRegion.t0(); }

Referenced by ExportCommand::Apply(), LabelTrackView::Char(), anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), EffectBase::DoEffect(), LabelTrackView::DoKeyDown(), LabelDialog::FindInitialRow(), anonymous_namespace{EditMenus.cpp}::FindSelection(), TranscriptionToolBar::GetSamples(), StretchHandle::GetT0(), NoteTrackShifter::HitTest(), WaveTrackShifter::HitTest(), LabelTrackShifter::HitTest(), ClipMoveState::Init(), LabelTrackView::KeyDown(), ProjectAudioManager::OnRecord(), TransportUtilities::RecordAndWait(), anonymous_namespace{WaveChannelView.cpp}::SelectedClip(), setTimes(), and SelectHandle::StartSnappingFreqSelection().

Here is the caller graph for this function:

t1()

double NotifyingSelectedRegion::t1 ( ) const

inline

Definition at line 36 of file ViewInfo.h.

{ return mRegion.t1(); }

Referenced by LabelTrackView::Char(), anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), EffectBase::DoEffect(), StretchHandle::GetT1(), NoteTrackShifter::HitTest(), WaveTrackShifter::HitTest(), LabelTrackShifter::HitTest(), ClipMoveState::Init(), LabelTrackView::KeyDown(), PerTrackEffect::ProcessPass(), anonymous_namespace{WaveChannelView.cpp}::SelectedClip(), setTimes(), and SelectHandle::StartSnappingFreqSelection().

Here is the caller graph for this function:

WriteXMLAttributes()

void NotifyingSelectedRegion::WriteXMLAttributes ( XMLWriter &  xmlFile, const char *  legacyT0Name, const char *  legacyT1Name  ) const

inline

Definition at line 45 of file ViewInfo.h.

   { mRegion.WriteXMLAttributes(xmlFile, legacyT0Name, legacyT1Name); }

Member Data Documentation

mRegion

SelectedRegion NotifyingSelectedRegion::mRegion

private

Definition at line 88 of file ViewInfo.h.

Referenced by collapseToT0(), collapseToT1(), move(), setF0(), setF1(), setFrequencies(), setT0(), setT1(), and setTimes().

---

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

• ViewInfo.h
• ViewInfo.cpp