TrackPanelAx Class Reference

Helper to TrackPanel to give accessibility. More...

#include <TrackPanelAx.h>

Collaboration diagram for TrackPanelAx:

Public Types
using	RectangleFinder = std::function< wxRect(Track &) >

Public Member Functions
	TrackPanelAx (AudacityProject &project)
virtual	~TrackPanelAx ()
void	SetFinder (const RectangleFinder &finder)
std::shared_ptr< Track >	GetFocus ()
std::shared_ptr< Track >	SetFocus (std::shared_ptr< Track > track={})
bool	IsFocused (const Track *track)
void	Updated ()
void	MessageForScreenReader (const TranslatableString &message)
wxWindow *	GetWindow () const
void	SetWindow (wxWindow *window)

Private Member Functions
TrackList &	GetTracks ()
int	TrackNum (const std::shared_ptr< Track > &track)
std::shared_ptr< Track >	FindTrack (int num)

Private Attributes
AudacityProject &	mProject
wxWindow *	mWindow {}
RectangleFinder	mFinder
std::weak_ptr< Track >	mFocusedTrack
int	mNumFocusedTrack
wxString	mMessage
bool	mTrackName
int	mMessageCount

Detailed Description

Helper to TrackPanel to give accessibility.

Definition at line 35 of file TrackPanelAx.h.

Member Typedef Documentation

RectangleFinder

using TrackPanelAx::RectangleFinder = std::function< wxRect( Track& ) >

Definition at line 44 of file TrackPanelAx.h.

Constructor & Destructor Documentation

TrackPanelAx()

TrackPanelAx::TrackPanelAx

(

AudacityProject &

project

)

Definition at line 38 of file TrackPanelAx.cpp.

   :
#if wxUSE_ACCESSIBILITY
     WindowAccessible( nullptr ) // window pointer must be set after construction
   ,
#endif
     mProject{ project }
{
   mTrackName = true;
   mMessageCount = 0;
   mNumFocusedTrack = 0;
}

References mMessageCount, mNumFocusedTrack, and mTrackName.

~TrackPanelAx()

TrackPanelAx::~TrackPanelAx ( )

virtual

Definition at line 51 of file TrackPanelAx.cpp.

{
}

Member Function Documentation

FindTrack()

std::shared_ptr< Track > TrackPanelAx::FindTrack ( int  num )

private

Definition at line 190 of file TrackPanelAx.cpp.

{
   int ndx = 0;
 
   for ( auto t : GetTracks().Leaders() )
   {
      ndx++;
      if( ndx == num )
         return t->SharedPointer();
   }
 
   return {};
}

References GetTracks().

Referenced by GetFocus().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFocus()

std::shared_ptr< Track > TrackPanelAx::GetFocus

(

)

Definition at line 64 of file TrackPanelAx.cpp.

{
   auto focusedTrack = mFocusedTrack.lock();
   if( !focusedTrack ) {
      if (mNumFocusedTrack >=1) {
         // This prevents the focus from being unnecessarily set to track 1
         // when effects are applied. (Applying an effect can change
         // the pointers of the selected tracks.)
         focusedTrack = FindTrack(mNumFocusedTrack);
      }
      if (!focusedTrack) {
         focusedTrack =
            Track::SharedPointer( *GetTracks().Any().first );
         // only call SetFocus if the focus has changed to avoid
         // unnecessary focus events
         if (focusedTrack) 
            focusedTrack = SetFocus();
      }
   }
 
   if( !TrackNum( focusedTrack ) )
   {
      mFocusedTrack.reset();
      return {};
   }
 
   return( focusedTrack );
}

References FindTrack(), GetTracks(), mFocusedTrack, mNumFocusedTrack, SetFocus(), Track::SharedPointer(), and TrackNum().

Referenced by MessageForScreenReader(), and Updated().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTracks()

TrackList & TrackPanelAx::GetTracks ( )

private

Definition at line 55 of file TrackPanelAx.cpp.

{
   return TrackList::Get( mProject );
}

References TrackList::Get(), and mProject.

Referenced by FindTrack(), GetFocus(), IsFocused(), SetFocus(), and TrackNum().

Here is the call graph for this function:

Here is the caller graph for this function:

GetWindow()

wxWindow * TrackPanelAx::GetWindow ( ) const

inline

Definition at line 128 of file TrackPanelAx.h.

{ return mWindow; }

References mWindow.

Referenced by MessageForScreenReader(), SetFocus(), and Updated().

Here is the caller graph for this function:

IsFocused()

bool TrackPanelAx::IsFocused

(

const Track *

track

)

Definition at line 155 of file TrackPanelAx.cpp.

{
   auto focusedTrack = mFocusedTrack.lock();
   if( !focusedTrack )
      focusedTrack = SetFocus();
 
   // Remap track pointer if there are outstanding pending updates
   auto origTrack =
      GetTracks().FindById( track->GetId() );
   if (origTrack)
      track = origTrack;
 
   return focusedTrack
      ? TrackList::Channels(focusedTrack.get()).contains(track)
      : !track;
}

References TrackList::Channels(), TrackList::FindById(), Track::GetId(), GetTracks(), mFocusedTrack, and SetFocus().

Here is the call graph for this function:

MessageForScreenReader()

void TrackPanelAx::MessageForScreenReader

(

const TranslatableString &

message

)

Definition at line 224 of file TrackPanelAx.cpp.

{
#if wxUSE_ACCESSIBILITY
   if (GetWindow() == wxWindow::FindFocus())
   {
      auto t = GetFocus();
      int childId = t ? TrackNum(t) : 0;
 
      mMessage = message.Translation();
 
      // append \a alternatively, so that the string is never the same as the previous string.
      // This ensures that screen readers read it.
      if (mMessageCount % 2 == 0)
         mMessage.Append('\a');
      mMessageCount++;
 
      mTrackName = false;
      NotifyEvent(wxACC_EVENT_OBJECT_NAMECHANGE,
               GetWindow(),
               wxOBJID_CLIENT,
               childId);
   }
 
#endif
}

References BasicUI::FindFocus(), GetFocus(), GetWindow(), mMessage, mMessageCount, mTrackName, TrackNum(), and TranslatableString::Translation().

Here is the call graph for this function:

SetFinder()

void TrackPanelAx::SetFinder ( const RectangleFinder &  finder )

inline

Definition at line 45 of file TrackPanelAx.h.

{ mFinder = finder; }

References mFinder.

SetFocus()

std::shared_ptr< Track > TrackPanelAx::SetFocus

(

std::shared_ptr< Track >

track = {}

)

Definition at line 94 of file TrackPanelAx.cpp.

{
   mTrackName = true;
 
#if wxUSE_ACCESSIBILITY
 
   auto focusedTrack = mFocusedTrack.lock();
   if( focusedTrack && !focusedTrack->GetSelected() )
   {
      NotifyEvent( wxACC_EVENT_OBJECT_SELECTIONREMOVE,
                   GetWindow(),
                   wxOBJID_CLIENT,
                   TrackNum( focusedTrack ) );
   }
#endif
 
   if( !track )
      track = Track::SharedPointer( *GetTracks().Any().begin() );
 
   if ( mFocusedTrack.lock() != track ) {
      mFocusedTrack = track;
      BasicUI::CallAfter([wFocus = TrackFocus::Get(mProject).weak_from_this()]{
         if (auto pFocus = wFocus.lock())
            pFocus->Publish({});
      });
   }
   mNumFocusedTrack = TrackNum(track);
 
#if wxUSE_ACCESSIBILITY
   if( track )
   {
      if (GetWindow() == wxWindow::FindFocus())
      {
         NotifyEvent( wxACC_EVENT_OBJECT_FOCUS,
                      GetWindow(),
                      wxOBJID_CLIENT,
                      mNumFocusedTrack );
      }
 
      if( track->GetSelected() )
      {
         NotifyEvent( wxACC_EVENT_OBJECT_SELECTION,
                      GetWindow(),
                      wxOBJID_CLIENT,
                      mNumFocusedTrack );
      }
   }
   else
   {
      NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
         GetWindow(),
         wxOBJID_CLIENT,
         wxACC_SELF);
   }
 
#endif
 
   return track;
}

References PackedArray::begin(), BasicUI::CallAfter(), BasicUI::FindFocus(), TrackFocus::Get(), GetTracks(), GetWindow(), mFocusedTrack, mNumFocusedTrack, mProject, mTrackName, Track::SharedPointer(), and TrackNum().

Referenced by GetFocus(), and IsFocused().

Here is the call graph for this function:

Here is the caller graph for this function:

SetWindow()

void TrackPanelAx::SetWindow ( wxWindow *  window )

inline

Definition at line 129 of file TrackPanelAx.h.

{ mWindow = window; }

References mWindow.

TrackNum()

int TrackPanelAx::TrackNum ( const std::shared_ptr< Track > &  track )

private

Definition at line 172 of file TrackPanelAx.cpp.

{
   // Find 1-based position of the target in the visible tracks, or 0 if not
   // found
   int ndx = 0;
 
   for ( auto t : GetTracks().Leaders() )
   {
      ndx++;
      if( t == target.get() )
      {
         return ndx;
      }
   }
 
   return 0;
}

References GetTracks().

Referenced by GetFocus(), MessageForScreenReader(), SetFocus(), and Updated().

Here is the call graph for this function:

Here is the caller graph for this function:

Updated()

void TrackPanelAx::Updated

(

)

Definition at line 204 of file TrackPanelAx.cpp.

{
#if wxUSE_ACCESSIBILITY
   auto t = GetFocus();
   mTrackName = true;
 
   // The object_focus event is only needed by Window-Eyes
   // and can be removed when we cease to support this screen reader.
   NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
               GetWindow(),
               wxOBJID_CLIENT,
               TrackNum(t));
 
   NotifyEvent(wxACC_EVENT_OBJECT_NAMECHANGE,
      GetWindow(),
      wxOBJID_CLIENT,
      TrackNum(t));
#endif
}

References GetFocus(), GetWindow(), mTrackName, and TrackNum().

Here is the call graph for this function:

Member Data Documentation

mFinder

RectangleFinder TrackPanelAx::mFinder

private

Definition at line 144 of file TrackPanelAx.h.

Referenced by SetFinder().

mFocusedTrack

std::weak_ptr<Track> TrackPanelAx::mFocusedTrack

private

Definition at line 146 of file TrackPanelAx.h.

Referenced by GetFocus(), IsFocused(), and SetFocus().

mMessage

wxString TrackPanelAx::mMessage

private

Definition at line 149 of file TrackPanelAx.h.

Referenced by MessageForScreenReader().

mMessageCount

int TrackPanelAx::mMessageCount

private

Definition at line 151 of file TrackPanelAx.h.

Referenced by MessageForScreenReader(), and TrackPanelAx().

mNumFocusedTrack

int TrackPanelAx::mNumFocusedTrack

private

Definition at line 147 of file TrackPanelAx.h.

Referenced by GetFocus(), SetFocus(), and TrackPanelAx().

mProject

AudacityProject& TrackPanelAx::mProject

private

Definition at line 138 of file TrackPanelAx.h.

Referenced by GetTracks(), and SetFocus().

mTrackName

bool TrackPanelAx::mTrackName

private

Definition at line 150 of file TrackPanelAx.h.

Referenced by MessageForScreenReader(), SetFocus(), TrackPanelAx(), and Updated().

mWindow

wxWindow* TrackPanelAx::mWindow {}

private

Definition at line 141 of file TrackPanelAx.h.

Referenced by GetWindow(), and SetWindow().

---

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

• TrackPanelAx.h
• TrackPanelAx.cpp