205 lines
6.2 KiB
C++
205 lines
6.2 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
TrackPanelAx.h
|
|
|
|
Leland Lucius
|
|
|
|
**********************************************************************/
|
|
|
|
#ifndef __AUDACITY_TRACK_PANEL_ACCESSIBILITY__
|
|
#define __AUDACITY_TRACK_PANEL_ACCESSIBILITY__
|
|
|
|
|
|
|
|
#include <functional>
|
|
#include <memory>
|
|
|
|
#include <wx/event.h> // to declare custom event types
|
|
#include <wx/setup.h> // for wxUSE_* macros
|
|
|
|
#include <wx/string.h> // member variable
|
|
|
|
#if wxUSE_ACCESSIBILITY
|
|
#include "widgets/WindowAccessible.h" // to inherit
|
|
#endif
|
|
|
|
#include "ClientData.h" // to inherit
|
|
|
|
class wxRect;
|
|
|
|
class AudacityProject;
|
|
class Track;
|
|
class TrackList;
|
|
|
|
// An event sent to the project
|
|
wxDECLARE_EXPORTED_EVENT(AUDACITY_DLL_API,
|
|
EVT_TRACK_FOCUS_CHANGE, wxCommandEvent);
|
|
|
|
class TrackPanelAx final
|
|
#if wxUSE_ACCESSIBILITY
|
|
: public WindowAccessible
|
|
#endif
|
|
{
|
|
public:
|
|
TrackPanelAx(AudacityProject &project);
|
|
virtual ~ TrackPanelAx();
|
|
|
|
using RectangleFinder = std::function< wxRect( Track& ) >;
|
|
void SetFinder( const RectangleFinder &finder ) { mFinder = finder; }
|
|
|
|
// Returns currently focused track or first one if none focused
|
|
std::shared_ptr<Track> GetFocus();
|
|
|
|
// Changes focus to a specified track
|
|
// Return is the actual focused track, which may be different from
|
|
// the argument when that is null
|
|
std::shared_ptr<Track> SetFocus( std::shared_ptr<Track> track = {} );
|
|
|
|
// Returns TRUE if passed track has the focus
|
|
bool IsFocused( const Track *track );
|
|
|
|
// Called to signal changes to a track
|
|
void Updated();
|
|
|
|
void MessageForScreenReader(const TranslatableString& message);
|
|
|
|
#if wxUSE_ACCESSIBILITY
|
|
// Retrieves the address of an IDispatch interface for the specified child.
|
|
// All objects must support this property.
|
|
wxAccStatus GetChild(int childId, wxAccessible** child) override;
|
|
|
|
// Gets the number of children.
|
|
wxAccStatus GetChildCount(int* childCount) override;
|
|
|
|
// Gets the default action for this object (0) or > 0 (the action for a child).
|
|
// Return wxACC_OK even if there is no action. actionName is the action, or the empty
|
|
// string if there is no action.
|
|
// The retrieved string describes the action that is performed on an object,
|
|
// not what the object does as a result. For example, a toolbar button that prints
|
|
// a document has a default action of "Press" rather than "Prints the current document."
|
|
wxAccStatus GetDefaultAction(int childId, wxString *actionName) override;
|
|
|
|
// Returns the description for this object or a child.
|
|
wxAccStatus GetDescription(int childId, wxString *description) override;
|
|
|
|
// Gets the window with the keyboard focus.
|
|
// If childId is 0 and child is NULL, no object in
|
|
// this subhierarchy has the focus.
|
|
// If this object has the focus, child should be 'this'.
|
|
wxAccStatus GetFocus(int *childId, wxAccessible **child) override;
|
|
|
|
// Returns help text for this object or a child, similar to tooltip text.
|
|
wxAccStatus GetHelpText(int childId, wxString *helpText) override;
|
|
|
|
// Returns the keyboard shortcut for this object or child.
|
|
// Return e.g. ALT+K
|
|
wxAccStatus GetKeyboardShortcut(int childId, wxString *shortcut) override;
|
|
|
|
// Returns the rectangle for this object (id = 0) or a child element (id > 0).
|
|
// rect is in screen coordinates.
|
|
wxAccStatus GetLocation(wxRect& rect, int elementId) override;
|
|
|
|
// Gets the name of the specified object.
|
|
wxAccStatus GetName(int childId, wxString *name) override;
|
|
|
|
// Returns a role constant.
|
|
wxAccStatus GetRole(int childId, wxAccRole *role) override;
|
|
|
|
// Gets a variant representing the selected children
|
|
// of this object.
|
|
// Acceptable values:
|
|
// - a null variant (IsNull() returns TRUE)
|
|
// - a list variant (GetType() == wxT("list"))
|
|
// - an integer representing the selected child element,
|
|
// or 0 if this object is selected (GetType() == wxT("long"))
|
|
// - a "void*" pointer to a wxAccessible child object
|
|
wxAccStatus GetSelections(wxVariant *selections) override;
|
|
|
|
// Returns a state constant.
|
|
wxAccStatus GetState(int childId, long* state) override;
|
|
|
|
// Returns a localized string representing the value for the object
|
|
// or child.
|
|
wxAccStatus GetValue(int childId, wxString* strValue) override;
|
|
|
|
// Navigates from fromId to toId/toObject
|
|
wxAccStatus Navigate(wxNavDir navDir, int fromId, int* toId, wxAccessible** toObject) override;
|
|
|
|
// Modify focus or selection
|
|
wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags) override;
|
|
#else
|
|
wxWindow *GetWindow() const { return mWindow; }
|
|
void SetWindow( wxWindow *window ) { mWindow = window; }
|
|
#endif
|
|
|
|
private:
|
|
|
|
TrackList &GetTracks();
|
|
int TrackNum( const std::shared_ptr<Track> &track );
|
|
std::shared_ptr<Track> FindTrack( int num );
|
|
|
|
AudacityProject &mProject;
|
|
|
|
#if !wxUSE_ACCESSIBILITY
|
|
wxWindow *mWindow{};
|
|
#endif
|
|
|
|
RectangleFinder mFinder;
|
|
|
|
std::weak_ptr<Track> mFocusedTrack;
|
|
int mNumFocusedTrack;
|
|
|
|
wxString mMessage;
|
|
bool mTrackName;
|
|
int mMessageCount;
|
|
};
|
|
|
|
class AUDACITY_DLL_API TrackFocus final
|
|
: public ClientData::Base
|
|
{
|
|
public:
|
|
static TrackFocus &Get( AudacityProject &project );
|
|
static const TrackFocus &Get( const AudacityProject &project );
|
|
|
|
explicit TrackFocus( AudacityProject &project );
|
|
~TrackFocus() override;
|
|
|
|
TrackFocus( const TrackFocus & ) PROHIBITED;
|
|
TrackFocus& operator=( const TrackFocus & ) PROHIBITED;
|
|
|
|
// Report the currently focused track, which may be null, otherwise is
|
|
// a leader track
|
|
// This function is not const, because it may have a side effect of setting
|
|
// a focus if none was already set
|
|
Track *Get();
|
|
|
|
// Set the track focus to a given track or to null
|
|
void Set( Track *pTrack );
|
|
|
|
// Not equivalent to pTrack == this->Get(): may return true also for
|
|
// other channels than the leader
|
|
// As with Get(), this is not const
|
|
bool IsFocused( const Track *pTrack );
|
|
|
|
void SetAccessible( wxWindow &owner,
|
|
std::unique_ptr< TrackPanelAx > pAccessible );
|
|
|
|
void MessageForScreenReader(const TranslatableString& message);
|
|
|
|
void UpdateAccessibility();
|
|
|
|
private:
|
|
|
|
AudacityProject &mProject;
|
|
|
|
#if wxUSE_ACCESSIBILITY
|
|
TrackPanelAx *mAx{};
|
|
#else
|
|
std::unique_ptr<TrackPanelAx> mAx;
|
|
#endif
|
|
};
|
|
|
|
#endif // __AUDACITY_TRACK_PANEL_ACCESSIBILITY__
|