TrackPanelAx Class Reference

Helper to TrackPanel to give accessibility. More...

#include <TrackPanelAx.h>

Inheritance diagram for TrackPanelAx:

Collaboration diagram for TrackPanelAx:

Classes
struct	Adapter

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

Public Member Functions
	TrackPanelAx (std::weak_ptr< Viewport > wViewport, std::weak_ptr< TrackFocus > wFocus, RectangleFinder finder)
	~TrackPanelAx () override
void	Updated ()
void	MessageForScreenReader (const TranslatableString &message) override
wxWindow *	GetWindow () const
void	SetWindow (wxWindow *window)
Public Member Functions inherited from TrackFocusCallbacks
virtual	~TrackFocusCallbacks ()
virtual void	MessageForScreenReader (const TranslatableString &message)=0
virtual void	BeginChangeFocus ()=0
virtual void	EndChangeFocus (const std::shared_ptr< Track > &track)=0
virtual void	UpdateAccessibility ()=0

Private Member Functions
void	BeginChangeFocus () override
void	EndChangeFocus (const std::shared_ptr< Track > &track) override
void	UpdateAccessibility () override

Private Attributes
std::weak_ptr< Viewport >	mwViewport
std::weak_ptr< TrackFocus >	mwFocus
wxWindow *	mWindow {}
RectangleFinder	mFinder
wxString	mMessage
int	mMessageCount { 0 }
bool	mTrackName { true }

Detailed Description

Helper to TrackPanel to give accessibility.

Definition at line 28 of file TrackPanelAx.h.

Member Typedef Documentation

RectangleFinder

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

Definition at line 50 of file TrackPanelAx.h.

Constructor & Destructor Documentation

TrackPanelAx()

TrackPanelAx::TrackPanelAx	(	std::weak_ptr< Viewport >	wViewport,
		std::weak_ptr< TrackFocus >	wFocus,
		RectangleFinder	finder
	)

Definition at line 63 of file TrackPanelAx.cpp.

   :
#if wxUSE_ACCESSIBILITY
   // window pointer must be set after construction
     WindowAccessible(nullptr),
#endif
     mwViewport{ move(wViewport) },
     mwFocus{ move(wFocus) }
   , mFinder{ move(finder) }
{
}

~TrackPanelAx()

TrackPanelAx::~TrackPanelAx ( )

override

Definition at line 76 of file TrackPanelAx.cpp.

{
}

Member Function Documentation

BeginChangeFocus()

void TrackPanelAx::BeginChangeFocus ( )

overrideprivatevirtual

Implements TrackFocusCallbacks.

Definition at line 80 of file TrackPanelAx.cpp.

{
   mTrackName = true;
#if wxUSE_ACCESSIBILITY
   auto pFocus = mwFocus.lock();
   if (!pFocus)
      return;
   
   auto focusedTrack = pFocus->PeekFocus();
   if (focusedTrack && !focusedTrack->GetSelected()) {
      NotifyEvent( wxACC_EVENT_OBJECT_SELECTIONREMOVE,
                   GetWindow(),
                   wxOBJID_CLIENT,
                   pFocus->TrackNum(focusedTrack));
   }
#endif
}

References GetWindow(), mTrackName, and mwFocus.

Here is the call graph for this function:

EndChangeFocus()

void TrackPanelAx::EndChangeFocus ( const std::shared_ptr< Track > &  track )

overrideprivatevirtual

Implements TrackFocusCallbacks.

Definition at line 98 of file TrackPanelAx.cpp.

{
#if wxUSE_ACCESSIBILITY
   auto pFocus = mwFocus.lock();
   if (!pFocus)
      return;
 
   if (track) {
      if (GetWindow() == wxWindow::FindFocus()) {
         NotifyEvent( wxACC_EVENT_OBJECT_FOCUS,
                      GetWindow(),
                      wxOBJID_CLIENT,
                      pFocus->NumFocusedTrack());
      }
 
      if (track->GetSelected()) {
         NotifyEvent( wxACC_EVENT_OBJECT_SELECTION,
                      GetWindow(),
                      wxOBJID_CLIENT,
                      pFocus->NumFocusedTrack());
      }
   }
   else {
      NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
         GetWindow(),
         wxOBJID_CLIENT,
         wxACC_SELF);
   }
 
#endif
}

References BasicUI::FindFocus(), GetWindow(), and mwFocus.

Here is the call graph for this function:

GetWindow()

wxWindow * TrackPanelAx::GetWindow ( ) const

inline

Definition at line 126 of file TrackPanelAx.h.

{ return mWindow; }

References mWindow.

Referenced by BeginChangeFocus(), EndChangeFocus(), MessageForScreenReader(), and Updated().

Here is the caller graph for this function:

MessageForScreenReader()

void TrackPanelAx::MessageForScreenReader ( const TranslatableString &  message )

overridevirtual

Implements TrackFocusCallbacks.

Definition at line 159 of file TrackPanelAx.cpp.

{
#if wxUSE_ACCESSIBILITY
   auto pFocus = mwFocus.lock();
   if (!pFocus)
      return;
 
   if (GetWindow() == wxWindow::FindFocus())
   {
      auto t = pFocus->GetFocus();
      int childId = t ? pFocus->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(), GetWindow(), mMessage, mMessageCount, mTrackName, mwFocus, and TranslatableString::Translation().

Here is the call graph for this function:

SetWindow()

void TrackPanelAx::SetWindow ( wxWindow *  window )

inline

Definition at line 127 of file TrackPanelAx.h.

{ mWindow = window; }

References mWindow.

UpdateAccessibility()

void TrackPanelAx::UpdateAccessibility ( )

overrideprivatevirtual

Implements TrackFocusCallbacks.

Definition at line 130 of file TrackPanelAx.cpp.

{
   Updated();
}

References Updated().

Here is the call graph for this function:

Updated()

void TrackPanelAx::Updated

(

)

Definition at line 135 of file TrackPanelAx.cpp.

{
#if wxUSE_ACCESSIBILITY
   auto pFocus = mwFocus.lock();
   if (!pFocus)
      return;
   
   auto t = pFocus->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,
               pFocus->TrackNum(t));
 
   NotifyEvent(wxACC_EVENT_OBJECT_NAMECHANGE,
      GetWindow(),
      wxOBJID_CLIENT,
      pFocus->TrackNum(t));
#endif
}

References GetWindow(), mTrackName, and mwFocus.

Referenced by UpdateAccessibility().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mFinder

RectangleFinder TrackPanelAx::mFinder

private

Definition at line 142 of file TrackPanelAx.h.

mMessage

wxString TrackPanelAx::mMessage

private

Definition at line 144 of file TrackPanelAx.h.

Referenced by MessageForScreenReader().

mMessageCount

int TrackPanelAx::mMessageCount { 0 }

private

Definition at line 145 of file TrackPanelAx.h.

Referenced by MessageForScreenReader().

mTrackName

bool TrackPanelAx::mTrackName { true }

private

Definition at line 146 of file TrackPanelAx.h.

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

mwFocus

std::weak_ptr<TrackFocus> TrackPanelAx::mwFocus

private

Definition at line 136 of file TrackPanelAx.h.

Referenced by BeginChangeFocus(), EndChangeFocus(), MessageForScreenReader(), and Updated().

mWindow

wxWindow* TrackPanelAx::mWindow {}

private

Definition at line 139 of file TrackPanelAx.h.

Referenced by GetWindow(), and SetWindow().

mwViewport

std::weak_ptr<Viewport> TrackPanelAx::mwViewport

private

Definition at line 135 of file TrackPanelAx.h.

---

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

• TrackPanelAx.h
• TrackPanelAx.cpp