TrackFocus Class Reference

#include <TrackPanelAx.h>

Inheritance diagram for TrackFocus:

Collaboration diagram for TrackFocus:

Public Member Functions
	TrackFocus (AudacityProject &project)
	~TrackFocus () override
	TrackFocus (const TrackFocus &) PROHIBITED
TrackFocus &	operator= (const TrackFocus &) PROHIBITED
Track *	Get ()
void	Set (Track *pTrack)
bool	IsFocused (const Track *pTrack)
void	SetAccessible (wxWindow &owner, std::unique_ptr< TrackPanelAx > pAccessible)
void	MessageForScreenReader (const TranslatableString &message)
void	UpdateAccessibility ()
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< TrackFocusChangeMessage >
	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 TrackFocus &	Get (AudacityProject &project)
static const TrackFocus &	Get (const AudacityProject &project)

Private Attributes
friend	TrackPanelAx
AudacityProject &	mProject
std::unique_ptr< TrackPanelAx >	mAx

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

Detailed Description

Definition at line 156 of file TrackPanelAx.h.

Constructor & Destructor Documentation

TrackFocus() [1/2]

TrackFocus::TrackFocus ( AudacityProject &  project )

explicit

Definition at line 741 of file TrackPanelAx.cpp.

   : mProject{ project }
{
}

~TrackFocus()

TrackFocus::~TrackFocus ( )

override

Definition at line 746 of file TrackPanelAx.cpp.

{
}

TrackFocus() [2/2]

TrackFocus::TrackFocus

(

const TrackFocus &

)

Member Function Documentation

Get() [1/3]

Track * TrackFocus::Get

(

)

Definition at line 750 of file TrackPanelAx.cpp.

{
   if (mAx)
      return mAx->GetFocus().get();
   return nullptr;
}

References mAx.

Referenced by SetTrackStatusCommand::ApplyInner(), SelectHandle::Click(), LabelTrackView::DialogForLabelName(), anonymous_namespace{LabelMenus.cpp}::DoAddLabel(), anonymous_namespace{ClipMenus.cpp}::DoClipLeftOrRight(), anonymous_namespace{ClipMenus.cpp}::DoCursorClipBoundary(), EffectUI::DoEffect(), LabelTrackView::DoKeyDown(), SelectUtilities::DoListSelection(), anonymous_namespace{PluginMenus.cpp}::DoManageRealtimeEffectsSidePanel(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel(), anonymous_namespace{NavigationMenus.cpp}::DoNextTrack(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), ProjectAudioManager::DoRecord(), TrackUtilities::DoRemoveTrack(), TrackUtilities::DoRemoveTracks(), anonymous_namespace{ClipMenus.cpp}::DoSelectClip(), anonymous_namespace{ClipMenus.cpp}::DoSelectClipBoundary(), TrackUtilities::DoTrackMute(), TrackUtilities::DoTrackSolo(), anonymous_namespace{TrackPanel.cpp}::LabeledChannelGroup::Draw(), Get(), TrackPanel::GetFocusedCell(), anonymous_namespace{PluginMenus.cpp}::HasTrackFocusFlag(), LabelTrackView::IsValidIndex(), SelectHandle::MoveSnappingFreqSelection(), anonymous_namespace{WaveTrackAffordanceControls.cpp}::OnEditClipName(), NavigationActions::Handler::OnFirstTrack(), NavigationActions::Handler::OnLastTrack(), TrackPanel::OnMouseEvent(), anonymous_namespace{LabelMenus.cpp}::OnNewLabelTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewStereoTrack(), anonymous_namespace{TimeTrackMenuItems.cpp}::OnNewTimeTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewWaveTrack(), anonymous_namespace{LabelMenus.cpp}::OnPasteNewLabel(), anonymous_namespace{EditMenus.cpp}::OnRedo(), WaveTrackMenuTable::OnSwapChannels(), NavigationActions::Handler::OnToggle(), anonymous_namespace{TrackMenus.cpp}::OnTrackClose(), anonymous_namespace{TrackMenus.cpp}::OnTrackGain(), anonymous_namespace{TrackMenus.cpp}::OnTrackGainDec(), anonymous_namespace{TrackMenus.cpp}::OnTrackGainInc(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveBottom(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveDown(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveTop(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveUp(), anonymous_namespace{TrackMenus.cpp}::OnTrackMute(), anonymous_namespace{TrackMenus.cpp}::OnTrackPan(), anonymous_namespace{TrackMenus.cpp}::OnTrackPanLeft(), anonymous_namespace{TrackMenus.cpp}::OnTrackPanRight(), anonymous_namespace{TrackMenus.cpp}::OnTrackSolo(), anonymous_namespace{EditMenus.cpp}::OnUndo(), TrackPanel::OnUndoReset(), ProjectFileManager::OpenProjectFile(), TrackPanel::ProcessUIHandleResult(), RealtimeEffectPanel::RealtimeEffectPanel(), anonymous_namespace{WaveTrackAffordanceControls.cpp}::SelectedClipOfFocusedTrack(), WaveTrackView::SelectNextClip(), GetInfoCommand::SendTracks(), TrackPanelAx::SetFocus(), TrackPanel::SetFocusedCell(), MuteButtonHandle::Tip(), SoloButtonHandle::Tip(), EffectsButtonHandle::Tip(), MenuButtonHandle::Tip(), CloseButtonHandle::Tip(), TrackPanel::TrackPanel(), and ProjectWindow::ZoomAfterImport().

Get() [2/3]

TrackFocus & TrackFocus::Get ( AudacityProject &  project )

static

Definition at line 731 of file TrackPanelAx.cpp.

{
   return project.AttachedObjects::Get< TrackFocus >( key );
}

References key.

Referenced by TrackPanel::OnTrackListDeletion().

Here is the caller graph for this function:

Get() [3/3]

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

static

Definition at line 736 of file TrackPanelAx.cpp.

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

References Get().

Here is the call graph for this function:

IsFocused()

bool TrackFocus::IsFocused

(

const Track *

pTrack

)

Definition at line 765 of file TrackPanelAx.cpp.

{
   if (mAx)
      return mAx->IsFocused( pTrack );
   return false;
}

References mAx.

MessageForScreenReader()

void TrackFocus::MessageForScreenReader

(

const TranslatableString &

message

)

Definition at line 786 of file TrackPanelAx.cpp.

{
   if (mAx)
      mAx->MessageForScreenReader( message );
}

References mAx.

operator=()

TrackFocus & TrackFocus::operator=

(

const TrackFocus &

)

Set()

void TrackFocus::Set

(

Track *

pTrack

)

Definition at line 757 of file TrackPanelAx.cpp.

{
   if (mAx) {
      pTrack = *TrackList::Get( mProject ).FindLeader( pTrack );
      mAx->SetFocus( Track::SharedPointer( pTrack ) );
   }
}

References TrackList::FindLeader(), TrackList::Get(), mAx, mProject, and Track::SharedPointer().

Here is the call graph for this function:

SetAccessible()

void TrackFocus::SetAccessible	(	wxWindow &	owner,
		std::unique_ptr< TrackPanelAx >	pAccessible
	)

Definition at line 772 of file TrackPanelAx.cpp.

{
#if wxUSE_ACCESSIBILITY
   // wxWidgets owns the accessible object
   owner.SetAccessible(mAx = pAx.release());
#else
   // wxWidgets does not own the object, but we need to retain it
   mAx = std::move(pAx);
#endif
}

References mAx.

UpdateAccessibility()

void TrackFocus::UpdateAccessibility

(

)

Definition at line 792 of file TrackPanelAx.cpp.

{
   if (mAx)
      mAx->Updated();
}

References mAx.

Member Data Documentation

mAx

std::unique_ptr<TrackPanelAx> TrackFocus::mAx

private

Definition at line 200 of file TrackPanelAx.h.

Referenced by Get(), IsFocused(), MessageForScreenReader(), Set(), SetAccessible(), and UpdateAccessibility().

mProject

AudacityProject& TrackFocus::mProject

private

Definition at line 195 of file TrackPanelAx.h.

Referenced by Set().

TrackPanelAx

friend TrackFocus::TrackPanelAx

private

Definition at line 193 of file TrackPanelAx.h.

---

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

• TrackPanelAx.h
• TrackPanelAx.cpp