(not quite a Toolbar) at foot of screen for setting and viewing the selection range. More...

#include <SelectionBar.h>

Inheritance diagram for SelectionBar:

Public Member Functions
	SelectionBar ()

virtual	~SelectionBar ()

void	Create (wxWindow *parent) override

void	Populate () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	UpdatePrefs () override

void	SetTimes (double start, double end, double audio)

void	SetSnapTo (int)

void	SetSelectionFormat (const NumericFormatId &format)

void	SetRate (double rate)

void	SetListener (SelectionBarListener *l)

void	RegenerateTooltips () override

Public Member Functions inherited from ToolBar
	ToolBar (int type, const wxString &label, const wxString &section, bool resizable=false)

virtual	~ToolBar ()

bool	AcceptsFocus () const override

void	SetToDefaultSize ()

virtual void	ReCreateButtons ()

int	GetType ()

wxString	GetTitle ()

wxString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const wxString &label) override

virtual void	SetDocked (ToolDock *dock, bool pushed)

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

virtual int	GetInitialWidth ()
	Resizable toolbars should implement these. More...

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const wxString &name=_("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const wxString &name=_("Panel"))

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&...args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
auStaticText *	AddTitle (const wxString &Title, wxSizer *pSizer)

NumericTextCtrl *	AddTime (const wxString Name, int id, wxSizer *pSizer)

void	AddVLine (wxSizer *pSizer)

void	SetSelectionMode (int mode)

void	ShowHideControls (int mode)

void	SetDrivers (int driver1, int driver2)

void	ValuesToControls ()

void	OnUpdate (wxCommandEvent &evt)

void	OnChangedTime (wxCommandEvent &evt)

void	OnRate (wxCommandEvent &event)

void	OnSnapTo (wxCommandEvent &event)

void	OnChoice (wxCommandEvent &event)

void	OnFocus (wxFocusEvent &event)

void	OnCaptureKey (wxCommandEvent &event)

void	OnSize (wxSizeEvent &evt)

void	ModifySelection (int newDriver, bool done=false)

void	UpdateRates ()

void	SelectionModeUpdated ()

Private Attributes
SelectionBarListener *	mListener

double	mRate

double	mStart

double	mEnd

double	mLength

double	mCenter

double	mAudio

int	mDrive1

int	mDrive2

int	mSelectionMode

NumericTextCtrl *	mStartTime

NumericTextCtrl *	mCenterTime

NumericTextCtrl *	mLengthTime

NumericTextCtrl *	mEndTime

NumericTextCtrl *	mAudioTime

wxChoice *	mChoice

wxStaticText *	mProxy

wxComboBox *	mRateBox

wxChoice *	mSnapTo

wxWindow *	mRateText

Additional Inherited Members
Public Types inherited from ToolBar
using	Holder = Destroy_ptr< ToolBar >

Static Public Member Functions inherited from ToolBar
static AButton *	MakeButton (wxWindow *parent, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxWindowID id, wxPoint placement, bool processdownevents, wxSize size)

static void	MakeAlternateImages (AButton &button, int idx, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxSize size)

static void	SetButtonToolTip (AButton &button, const TranslatedInternalString commands[], size_t nCommands)

Protected Member Functions inherited from ToolBar
void	SetButton (bool down, AButton *button)

void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

void	MakeButtonBackgroundsLarge ()

void	MakeButtonBackgroundsSmall ()

wxBoxSizer *	GetSizer ()

void	Add (wxWindow window, int proportion=0, int flag=wxALIGN_TOP, int border=0, wxObject userData=NULL)

void	Add (wxSizer sizer, int proportion=0, int flag=0, int border=0, wxObject userData=NULL)

void	Add (int width, int height, int proportion=0, int flag=0, int border=0, wxObject *userData=NULL)

void	AddSpacer (int size=14)

void	AddStretchSpacer (int prop=1)

void	Detach (wxWindow *window)

void	Detach (wxSizer *sizer)

void	Updated ()

int	GetResizeGrabberWidth ()
	Returns the width in pixels of the resizer element. More...

virtual void	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

Protected Attributes inherited from ToolBar
wxString	mLabel

wxString	mSection

int	mType

Detailed Description

(not quite a Toolbar) at foot of screen for setting and viewing the selection range.

Definition at line 44 of file SelectionBar.h.

Constructor & Destructor Documentation

SelectionBar::SelectionBar ( )

Definition at line 103 of file SelectionBar.cpp.

References AudioIO::GetOptimalSupportedSampleRate(), and gPrefs.

 : ToolBar(SelectionBarID, _("Selection"), wxT("Selection")),
   mListener(NULL), mRate(0.0),
   mStart(0.0), mEnd(0.0), mLength(0.0), mCenter(0.0), mAudio(0.0),
   mDrive1( StartTimeID), mDrive2( EndTimeID ),
   mSelectionMode(0),
   mStartTime(NULL), mCenterTime(NULL), mLengthTime(NULL), mEndTime(NULL),
   mAudioTime(NULL),
   mChoice(NULL)
 {
    // Make sure we have a valid rate as the NumericTextCtrl()s
    // created in Populate()
    // depend on it.  Otherwise, division-by-zero floating point exceptions
    // will occur.
    // Refer to bug #462 for a scenario where the division-by-zero causes
    // Audacity to fail.
    // We expect mRate to be set from the project later.
    mRate = (double) gPrefs->Read(wxT("/SamplingRate/DefaultProjectSampleRate"),
       AudioIO::GetOptimalSupportedSampleRate());
 
    // Selection mode of 0 means showing 'start' and 'end' only.
    mSelectionMode = gPrefs->ReadLong(wxT("/SelectionToolbarMode"),  0);
 }

SelectionBar::~SelectionBar ( )

virtual

Definition at line 127 of file SelectionBar.cpp.

128 {

129 }

Member Function Documentation

NumericTextCtrl * SelectionBar::AddTime	(	const wxString	Name,
		int	id,
		wxSizer *	pSizer
	)

private

Definition at line 146 of file SelectionBar.cpp.

References SelectionBarListener::AS_GetSelectionFormat(), mListener, mRate, safenew, and NumericConverter::TIME.

Referenced by Populate().

                                                                                       {
    auto formatName = mListener ? mListener->AS_GetSelectionFormat()
       : NumericFormatId{};
    auto pCtrl = safenew NumericTextCtrl(
       this, id, NumericConverter::TIME, formatName, 0.0, mRate);
    pCtrl->SetName(Name);
    pSizer->Add(pCtrl, 0, wxALIGN_TOP | wxRIGHT, 5);
    return pCtrl;
 }

auStaticText * SelectionBar::AddTitle	(	const wxString &	Title,
		wxSizer *	pSizer
	)

private

Definition at line 137 of file SelectionBar.cpp.

References ThemeBase::Colour(), safenew, and theTheme.

Referenced by Populate().

                                                                                {
    auStaticText * pTitle = safenew auStaticText(this, Title );
    pTitle->SetBackgroundColour( theTheme.Colour( clrMedium ));
    pTitle->SetForegroundColour( theTheme.Colour( clrTrackPanelText ) );
    pSizer->Add( pTitle,0, wxALIGN_CENTER_VERTICAL | wxRIGHT,  (Title.Length() == 1 ) ? 0:5);
    return pTitle;
 }

void SelectionBar::AddVLine ( wxSizer * pSizer )

private

Definition at line 156 of file SelectionBar.cpp.

References safenew, and toolbarSingle.

Referenced by Populate().

                                               {
    pSizer->Add(safenew wxStaticLine(this, -1, wxDefaultPosition,
                                    wxSize(1, toolbarSingle-10),
                                    wxLI_VERTICAL),
                   0,  wxALIGN_CENTER_VERTICAL | wxRIGHT, 5);
 }

void SelectionBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 131 of file SelectionBar.cpp.

References ToolBar::Create().

 {
    ToolBar::Create(parent);
 }

void SelectionBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 54 of file SelectionBar.h.

54 {};

void SelectionBar::ModifySelection	(	int	newDriver,
		bool	done = `false`
	)

private

Definition at line 394 of file SelectionBar.cpp.

References SelectionBarListener::AS_ModifySelection(), CenterTimeID, EndTimeID, NumericConverter::GetValue(), LengthTimeID, mCenter, mCenterTime, mDrive1, mDrive2, mEnd, mEndTime, mLength, mLengthTime, mListener, mStart, mStartTime, SetDrivers(), and StartTimeID.

Referenced by OnChangedTime().

 {
    // If the user moved to a different control, then update which
    // two controls drive the others.
    if( newDriver != mDrive2 )
       SetDrivers( mDrive2, newDriver);
 
    // Only update a value if user typed something in.
    // The reason is the controls may be less accurate than 
    // the values.
    if( newDriver == StartTimeID )
       mStart = mStartTime->GetValue();
    if( newDriver == EndTimeID )
       mEnd = mEndTime->GetValue();
    if( newDriver == LengthTimeID )
       mLength = mLengthTime->GetValue();
    if( newDriver == CenterTimeID )
       mCenter = mCenterTime->GetValue();
 
    // There are four controls, and two constraints, which are:
    //    mid = (start+end)/2
    //    length = (end-start)
    // Therefore we can select any two controls as 'drivers' of
    // the other two.
    // Here we compute 'i' which combines the identity of the two 
    // driving controls, to use it as an index.
    // The order of the two drivers generally does not matter much,
    // except that we have want:
    //    start < end
    // and preserve that by adjusting the least dominant driving
    // control.
    int i = mDrive1 + 4 * mDrive2;
    switch(i){
    case StartTimeID + 4 * EndTimeID:
       if( mEnd < mStart )
          mStart = mEnd;
    case StartTimeID * 4 + EndTimeID:
       if( mStart > mEnd )
          mEnd = mStart;
       mLength = mEnd - mStart;
       mCenter = (mStart+mEnd)/2.0;
       break;
    case StartTimeID + 4 * LengthTimeID:
    case StartTimeID * 4 + LengthTimeID:
       if( mLength < 0 )
          mLength = 0;
       mEnd = mStart+mLength;
       mCenter = (mStart+mEnd)/2.0;
       break;
    case StartTimeID + 4 * CenterTimeID:
       if( mCenter < mStart )
          mCenter = mStart;
    case StartTimeID * 4 + CenterTimeID:
       if( mStart > mCenter )
          mStart = mCenter;
       mEnd = mCenter * 2 - mStart;
       mLength = mStart - mEnd;
       break;
    case EndTimeID + 4 * LengthTimeID:
    case EndTimeID * 4 + LengthTimeID:
       if( mLength < 0 )
          mLength = 0;
       mStart = mEnd - mLength;
       mCenter = (mStart+mEnd)/2.0;
       break;
    case EndTimeID + 4 * CenterTimeID:
       if( mCenter > mEnd )
          mCenter = mEnd;
    case EndTimeID * 4 + CenterTimeID:
       if( mEnd < mCenter )
          mEnd = mCenter;
       mStart = mCenter * 2.0 - mEnd;
       mLength = mEnd - mStart;
       break;
    case LengthTimeID + 4 * CenterTimeID:
    case LengthTimeID * 4 + CenterTimeID:
       if( mLength < 0 )
          mLength = 0;
       mStart = mCenter - mLength/2.0;
       mEnd = mCenter + mLength/2.0;
       break;
    default:
       // The above should cover all legal combinations of two distinct controls.
       wxFAIL_MSG( "Illegal sequence of selection changes");
    }
 
    // Places the start-end mrkers on the track panel.
    mListener->AS_ModifySelection(mStart, mEnd, done);
 }

void SelectionBar::OnCaptureKey ( wxCommandEvent & event )

private

Definition at line 714 of file SelectionBar.cpp.

References mRateText.

 {
    wxKeyEvent *kevent = (wxKeyEvent *)event.GetEventObject();
    wxWindow *w = FindFocus();
    int keyCode = kevent->GetKeyCode();
 
    // Convert numeric keypad entries.
    if ((keyCode >= WXK_NUMPAD0) && (keyCode <= WXK_NUMPAD9)) {
       keyCode -= WXK_NUMPAD0 - '0';
    }
 
    if (keyCode >= '0' && keyCode <= '9') {
       return;
    }
 
    // UP/DOWN/LEFT/RIGHT for mRateText
    if (w == mRateText) {
       switch (keyCode)
       {
          case WXK_LEFT:
          case WXK_RIGHT:
          case WXK_UP:
          case WXK_DOWN:
          case WXK_DELETE:
          case WXK_BACK:
             return;
       }
    }
 
    event.Skip();
 }

void SelectionBar::OnChangedTime ( wxCommandEvent & evt )

private

Definition at line 484 of file SelectionBar.cpp.

References ModifySelection().

 {
    ModifySelection(event.GetId(), event.GetInt() != 0);
 }

void SelectionBar::OnChoice ( wxCommandEvent & event )

private

Definition at line 558 of file SelectionBar.cpp.

References mChoice, SelectionModeUpdated(), and SetSelectionMode().

 {
    int mode = mChoice->GetSelection();
    SetSelectionMode( mode );
    SelectionModeUpdated();
 }

void SelectionBar::OnFocus ( wxFocusEvent & event )

private

Definition at line 701 of file SelectionBar.cpp.

References AudacityProject::CaptureKeyboard(), and AudacityProject::ReleaseKeyboard().

Referenced by Populate().

 {
    if (event.GetEventType() == wxEVT_KILL_FOCUS) {
       AudacityProject::ReleaseKeyboard(this);
    }
    else {
       AudacityProject::CaptureKeyboard(this);
    }
 
    Refresh(false);
    event.Skip();
 }

void SelectionBar::OnRate ( wxCommandEvent & event )

private

Definition at line 677 of file SelectionBar.cpp.

References SelectionBarListener::AS_SetRate(), mAudioTime, mCenterTime, mEndTime, mLengthTime, mListener, mRate, mRateBox, and mStartTime.

 {
    if (mRateBox->GetValue().ToDouble(&mRate) && // is a numeric value
          (mRate != 0.0))
    {
       NumericTextCtrl ** Ctrls[5] = { &mStartTime, &mEndTime, &mLengthTime, &mCenterTime, &mAudioTime };
       int i;
       for(i=0;i<5;i++)
          if( *Ctrls[i] )
             (*Ctrls[i])->SetSampleRate( mRate );
       if (mListener) mListener->AS_SetRate(mRate);
    }
 }

void SelectionBar::OnSize ( wxSizeEvent & evt )

private

Definition at line 385 of file SelectionBar.cpp.

 {
    Refresh( true );
 
    evt.Skip();
 }

void SelectionBar::OnSnapTo ( wxCommandEvent & event )

private

Definition at line 746 of file SelectionBar.cpp.

References SelectionBarListener::AS_SetSnapTo(), mListener, and mSnapTo.

 {
    mListener->AS_SetSnapTo(mSnapTo->GetSelection());
 }

void SelectionBar::OnUpdate ( wxCommandEvent & evt )

private

Definition at line 490 of file SelectionBar.cpp.

References SelectionBarListener::AS_SetSelectionFormat(), format, NumericConverter::GetBuiltinFormat(), NumericConverter::GetBuiltinName(), mAudioTime, mCenterTime, mEndTime, mLengthTime, mListener, mRateBox, mRateText, mStartTime, ToolBar::ReCreateButtons(), RegenerateTooltips(), ToolBar::Updated(), and ValuesToControls().

Referenced by SetSelectionFormat(), and UpdatePrefs().

 {
    int index = evt.GetInt();
    wxWindow *w = FindFocus();
    NumericTextCtrl ** Ctrls[5] = { &mStartTime, &mEndTime, &mLengthTime, &mCenterTime, &mAudioTime };
    int i;
    int iFocus = -1;
    for(i=0;i<5;i++)
       if( w == *Ctrls[i] )
          iFocus = i;
 
    evt.Skip(false);
 
    // Save format name before recreating the controls so they resize properly
    {
       auto format = mStartTime->GetBuiltinName(index);
       mListener->AS_SetSelectionFormat(format);
    }
 
    RegenerateTooltips();
 
    // ToolBar::ReCreateButtons() will get rid of our sizers and controls
    // so reset pointers first.
    for( i=0;i<5;i++)
       *Ctrls[i]=NULL;
 
    mRateBox = NULL;
    mRateText = NULL;
 
    ToolBar::ReCreateButtons();
 
    ValuesToControls();
 
    auto format = mStartTime->GetBuiltinFormat(index);
    for( i=0;i<5;i++)
       (*Ctrls[i])->SetFormatString( format );
 
    if( iFocus >=0 )
       (*Ctrls[iFocus])->SetFocus();
    Updated();
 }

void SelectionBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 163 of file SelectionBar.cpp.

References _(), ToolBar::Add(), AddTime(), AddTitle(), AddVLine(), SelectionBarListener::AS_GetSnapTo(), AudioTimeID, CenterTimeID, ChoiceID, ThemeBase::Colour(), EndTimeID, ToolBar::GetSizer(), SnapManager::GetSnapLabels(), LengthTimeID, mAudioTime, mCenterTime, mChoice, mEndTime, mLengthTime, mListener, mRate, mRateBox, mRateText, mSelectionMode, mSnapTo, mStartTime, numbers, OnFocus(), RateID, RegenerateTooltips(), safenew, SetSelectionMode(), SIZER_COLS, SNAP_OFF, SnapToID, StartTimeID, theTheme, and UpdateRates().

 {
    SetBackgroundColour( theTheme.Colour( clrMedium  ) );
 
    mStartTime = mEndTime = mLengthTime = mCenterTime = mAudioTime = nullptr;
 
    // This will be inherited by all children:
    SetFont(wxFont(
 #ifdef __WXMAC__
                   12
 #else
                   9
 #endif
                   ,
                   wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL));
 
    wxFlexGridSizer *mainSizer;
 
    /* we don't actually need a control yet, but we want to use its methods
     * to do some look-ups, so we'll have to create one. We can't make the
     * look-ups static because they depend on translations which are done at
     * runtime */
 
    // Outer sizer has space top and left.
    // Inner sizers have space on right only.
    // This choice makes for a nice border and internal spacing and places clear responsibility
    // on each sizer as to what spacings it creates.
    Add((mainSizer = safenew wxFlexGridSizer(SIZER_COLS, 1, 1)), 0, wxALIGN_TOP | wxLEFT | wxTOP, 5);
 
    // Top row (mostly labels)
    wxColour clrText =  theTheme.Colour( clrTrackPanelText );
    wxColour clrText2 = *wxBLUE;
    AddTitle( _("Project Rate (Hz)"), mainSizer );
    AddVLine( mainSizer );
    AddTitle( _("Snap-To"), mainSizer );
    AddVLine( mainSizer );
    AddTitle( _("Audio Position"), mainSizer );
    AddVLine( mainSizer );
 
    {
       const wxString choices[4] = {
          _("Start and End of Selection"),
          _("Start and Length of Selection"),
          _("Length and End of Selection"),
          _("Length and Center of Selection"),
       };
       mChoice = safenew wxChoice
          (this, ChoiceID, wxDefaultPosition, wxDefaultSize, 4, choices,
           0, wxDefaultValidator, _("Show"));
       mChoice->SetSelection(0);
 #if wxUSE_ACCESSIBILITY
       // so that name can be set on a standard control
       mChoice->SetAccessible(safenew WindowAccessible(mChoice));
 #endif
 #ifdef __WXGTK__
       // Combo boxes are taller on Linux, and if we don't do the following, the selection toolbar will
       // be three units high.
       wxSize sz = mChoice->GetBestSize();
       sz.SetHeight( sz.y-4);
       mChoice->SetMinSize( sz );
 #endif
       mainSizer->Add(mChoice, 0, wxALIGN_TOP | wxEXPAND | wxRIGHT, 6);
    }
 
    // Botton row, (mostly time controls)
    mRateBox = safenew wxComboBox(this, RateID,
                              wxT(""),
                              wxDefaultPosition, wxSize(80, -1));
 #if wxUSE_ACCESSIBILITY
    // so that name can be set on a standard control
    mRateBox->SetAccessible(safenew WindowAccessible(mRateBox));
 #endif
    mRateBox->SetName(_("Project Rate (Hz)"));
    //mRateBox->SetForegroundColour( clrText2 );
    wxTextValidator vld(wxFILTER_INCLUDE_CHAR_LIST);
    vld.SetIncludes(wxArrayString(10, numbers));
    mRateBox->SetValidator(vld);
    mRateBox->SetValue(wxString::Format(wxT("%d"), (int)mRate));
    UpdateRates(); // Must be done _after_ setting value on mRateBox!
 
    // We need to capture the SetFocus and KillFocus events to set up
    // for keyboard capture.  On Windows and GTK it's easy since the
    // combobox is presented as one control to hook into.
    mRateText = mRateBox;
 
 #if defined(__WXMAC__)
    // The Mac uses a standard wxTextCtrl for the edit portion and that's
    // the control that gets the focus events.  So we have to find the
    // textctrl.
    wxWindowList kids = mRateBox->GetChildren();
    for (unsigned int i = 0; i < kids.GetCount(); i++) {
       wxClassInfo *ci = kids[i]->GetClassInfo();
       if (ci->IsKindOf(CLASSINFO(wxTextCtrl))) {
          mRateText = kids[i];
          break;
       }
    }
 #endif
 
    mRateText->Bind(wxEVT_SET_FOCUS,
                       &SelectionBar::OnFocus,
                       this);
    mRateText->Bind(wxEVT_KILL_FOCUS,
                       &SelectionBar::OnFocus,
                       this);
 
 #ifdef __WXGTK__
    // Combo boxes are taller on Linux, and if we don't do the following, the selection toolbar will
    // be three units high.
    wxSize sz = mRateBox->GetBestSize();
    sz.SetHeight( sz.y-4);
    mRateBox->SetMinSize( sz );
 #endif
 
    mainSizer->Add(mRateBox, 0, wxALIGN_TOP | wxRIGHT, 5);
    AddVLine( mainSizer );
 
    mSnapTo = safenew wxChoice(this, SnapToID,
                           wxDefaultPosition, wxDefaultSize,
                           SnapManager::GetSnapLabels());
 
 #ifdef __WXGTK__
    // Combo boxes are taller on Linux, and if we don't do the following, the selection toolbar will
    // be three units high.
    sz = mSnapTo->GetBestSize();
    sz.SetHeight( sz.y-4);
    mSnapTo->SetMinSize( sz );
 #endif
 
    mainSizer->Add(mSnapTo,
                   0, wxALIGN_TOP | wxRIGHT, 5);
 #if wxUSE_ACCESSIBILITY
    // so that name can be set on a standard control
    mSnapTo->SetAccessible(safenew WindowAccessible(mSnapTo));
 #endif
    mSnapTo->SetName(_("Snap To"));
    //mSnapTo->SetForegroundColour( clrText2 );
    mSnapTo->SetSelection(mListener ? mListener->AS_GetSnapTo() : SNAP_OFF);
 
    mSnapTo->Bind(wxEVT_SET_FOCUS,
                     &SelectionBar::OnFocus,
                     this);
    mSnapTo->Bind(wxEVT_KILL_FOCUS,
                     &SelectionBar::OnFocus,
                     this);
 
    AddVLine( mainSizer );
 
    mAudioTime = AddTime(_("Audio Position"), AudioTimeID, mainSizer );
    // This vertical line is NOT just for decoration!
    // It works around a wxWidgets-on-Windows RadioButton bug, where tabbing
    // into the radiobutton group jumps to selecting the first item in the 
    // group even if some other item had been selected.
    // It is an important bug to work around for sceen reader users, who use TAB 
    // a lot in navigation.
    // More about the bug here:
    // https://forums.wxwidgets.org/viewtopic.php?t=41120
    AddVLine( mainSizer );
 
    {
       auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
 
       mStartTime  = AddTime(_("Start"), StartTimeID, hSizer.get() );
       mLengthTime = AddTime(_("Length"), LengthTimeID, hSizer.get() );
       mCenterTime = AddTime(_("Center"), CenterTimeID, hSizer.get() );
       mEndTime    = AddTime(_("End"), EndTimeID, hSizer.get() );
       mainSizer->Add(hSizer.release(), 0, wxALIGN_TOP | wxRIGHT, 0);
    }
 
    mChoice->MoveBeforeInTabOrder( mStartTime );
    // This shows/hides controls.
    // Do this before layout so that we are sized right.
    SetSelectionMode(mSelectionMode);
    mainSizer->Layout();
    RegenerateTooltips();
    Layout();
 
    SetMinSize( GetSizer()->GetMinSize() );
 }

void SelectionBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 372 of file SelectionBar.cpp.

References _(), SelectionBarListener::AS_GetSelectionFormat(), mListener, and mSnapTo.

Referenced by OnUpdate(), Populate(), and UpdatePrefs().

 {
 #if wxUSE_TOOLTIPS
    auto formatName =
       mListener
          ? mListener->AS_GetSelectionFormat()
          : NumericFormatId{};
    mSnapTo->SetToolTip(
       wxString::Format(
          _("Snap Clicks/Selections to %s"), formatName.Translation() ));
 #endif
 }

void SelectionBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 53 of file SelectionBar.h.

53 {};

void SelectionBar::SelectionModeUpdated ( )

private

Definition at line 565 of file SelectionBar.cpp.

References gPrefs, mSelectionMode, and ToolBar::Updated().

Referenced by OnChoice().

 {
    // We just changed the mode.  Remember it.
    gPrefs->Write(wxT("/SelectionToolbarMode"), mSelectionMode);
    gPrefs->Flush();
 
    wxSize sz = GetMinSize();
    sz.SetWidth( 10 );
    SetMinSize( sz );
    Fit();
    Layout();
    Updated();
 }

void SelectionBar::SetDrivers	(	int	driver1,
		int	driver2
	)

private

Definition at line 534 of file SelectionBar.cpp.

References _(), mCenterTime, mDrive1, mDrive2, mEndTime, mLengthTime, mStartTime, and StartTimeID.

Referenced by ModifySelection(), and SetSelectionMode().

 {
    mDrive1 = driver1;
    mDrive2 = driver2;
 
    NumericTextCtrl ** Ctrls[4] = { &mStartTime, &mCenterTime, &mLengthTime, &mEndTime};
    wxString Text[4] = { _("Start"), _("Center"), _("Length"),  _("End")  };
 
    for(int i=0;i<4;i++){
       int id = i + StartTimeID;
       int fixed = (( id == mDrive2 )?mDrive1:mDrive2)-StartTimeID;
 
       wxString Temp = Text[i];
       // i18n-hint: %s is replaced e.g by 'Length', to indicate that it will be calculated from other parameters.
       wxString Format = ( (id!=mDrive1) && (id!=mDrive2 ) ) ? _("%s - driven") : "%s";
       wxString Title= wxString::Format( Format, Temp );
       // i18n-hint: %s1 is replaced e.g by 'Length', %s2 e.g by 'Center'.
       wxString VoiceOverText = wxString::Format(_("Selection %s. %s won't change."), Temp, Text[fixed]);
       if( *Ctrls[i] ){
          (*Ctrls[i])->SetName( Temp );
       }
    }
 }

void SelectionBar::SetListener ( SelectionBarListener * l )

Definition at line 364 of file SelectionBar.cpp.

References SelectionBarListener::AS_GetRate(), SelectionBarListener::AS_GetSelectionFormat(), SelectionBarListener::AS_GetSnapTo(), mListener, SetRate(), SetSelectionFormat(), and SetSnapTo().

 {
    mListener = l;
    SetRate(mListener->AS_GetRate());
    SetSnapTo(mListener->AS_GetSnapTo());
    SetSelectionFormat(mListener->AS_GetSelectionFormat());
 };

void SelectionBar::SetRate ( double rate )

Definition at line 661 of file SelectionBar.cpp.

References mAudioTime, mCenterTime, mEndTime, mLengthTime, mRate, mRateBox, and mStartTime.

Referenced by AudacityProject::AddImportedTracks(), SetProjectCommand::Apply(), AudacityProject::HandleXMLTag(), and SetListener().

 {
    if (rate != mRate) {
       // if the rate is actually being changed
       mRate = rate;   // update the stored rate
       mRateBox->SetValue(wxString::Format(wxT("%d"), (int)rate));
 
       // update the TimeTextCtrls if they exist
       NumericTextCtrl ** Ctrls[5] = { &mStartTime, &mEndTime, &mLengthTime, &mCenterTime, &mAudioTime };
       int i;
       for(i=0;i<5;i++)
          if( *Ctrls[i] )
             (*Ctrls[i])->SetSampleRate( rate );
    }
 }

void SelectionBar::SetSelectionFormat ( const NumericFormatId & format )

Definition at line 652 of file SelectionBar.cpp.

References NumericConverter::GetBuiltinFormat(), NumericConverter::GetFormatIndex(), mStartTime, OnUpdate(), and NumericTextCtrl::SetFormatString().

Referenced by SetListener(), and AudacityProject::SetSelectionFormat().

 {
    mStartTime->SetFormatString(mStartTime->GetBuiltinFormat(format));
 
    wxCommandEvent e;
    e.SetInt(mStartTime->GetFormatIndex());
    OnUpdate(e);
 }

void SelectionBar::SetSelectionMode ( int mode )

private

Definition at line 582 of file SelectionBar.cpp.

References CenterTimeID, EndTimeID, LengthTimeID, mChoice, mSelectionMode, SetDrivers(), ShowHideControls(), and StartTimeID.

Referenced by OnChoice(), and Populate().

 {
    // Only modes 0 to 3 are now supported,
    // so fix up a mode that could have come from the config.
    const int maxMode = 3;
 
    if( mode > maxMode )
       mode = 0;
    if( mode < 0 )
       mode = 0;
    mSelectionMode = mode;
    mChoice->SetSelection( mode ); 
 
    // First decide which two controls drive the others...
    // For example the last option is with all controls shown, and in that mode we 
    // initially have start and end driving.
    int Drive2[] = { StartTimeID, StartTimeID,  LengthTimeID, LengthTimeID, 
                     StartTimeID, StartTimeID,  StartTimeID,  StartTimeID};
    int Drive1[] = { EndTimeID,   LengthTimeID, EndTimeID,    CenterTimeID, 
                     EndTimeID,   LengthTimeID, EndTimeID,    EndTimeID};
 
    SetDrivers( Drive1[mode], Drive2[mode] );
    // Then show/hide the relevant controls.
    ShowHideControls( mode );
 }

void SelectionBar::SetSnapTo ( int snap )

Definition at line 647 of file SelectionBar.cpp.

References mSnapTo.

Referenced by SetListener(), and AudacityProject::SetSnapTo().

 {
    mSnapTo->SetSelection(snap);
 }

void SelectionBar::SetTimes	(	double	start,
		double	end,
		double	audio
	)

Definition at line 636 of file SelectionBar.cpp.

References mAudio, mCenter, mEnd, mLength, mStart, and ValuesToControls().

Referenced by AudacityProject::TP_DisplaySelection().

 {
    mStart = start;
    mEnd = end;
    mLength = end-start;
    mCenter = (end+start)/2.0;
    mAudio = audio;
 
    ValuesToControls();
 }

void SelectionBar::ShowHideControls ( int mode )

private

Definition at line 609 of file SelectionBar.cpp.

References mCenterTime, mEndTime, mLengthTime, and mStartTime.

Referenced by SetSelectionMode().

 {
    // The bits in these say which controls are visible.
    int masks[8]= { 
       9, 5, 12, 6, // 2 items shown
       13, 7, 11,// 3 items shown
       15};
    int mask = masks[mode];
 
    NumericTextCtrl ** Ctrls[4]  = { &mStartTime,  &mCenterTime,  &mLengthTime,  &mEndTime};
    for(int i=0;i<4;i++){
       if( *Ctrls[i]) 
          (*Ctrls[i])->Show( (mask & (1<<i))!=0 );
    }
 }

void SelectionBar::UpdatePrefs ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 343 of file SelectionBar.cpp.

References _(), NumericConverter::GetFormatIndex(), mStartTime, OnUpdate(), RegenerateTooltips(), ToolBar::SetLabel(), and ToolBar::UpdatePrefs().

 {
    // The project rate is no longer driven from here.
    // When preferences change, the Project learns about it too.
    // If necessary we can drive the SelectionBar mRate via the Project
    // calling our SetRate().
    // As of 13-Sep-2018, changes to the sample rate pref will only affect 
    // creation of new projects, not the smaple rate in existing ones.
 
    wxCommandEvent e;
    e.SetInt(mStartTime->GetFormatIndex());
    OnUpdate(e);
 
    // Set label to pull in language change
    SetLabel(_("Selection"));
 
    RegenerateTooltips();
    // Give base class a chance
    ToolBar::UpdatePrefs();
 }

void SelectionBar::UpdateRates ( )

private

Definition at line 691 of file SelectionBar.cpp.

References mRateBox, AudioIO::NumStandardRates, and AudioIO::StandardRates.

Referenced by Populate().

 {
    wxString oldValue = mRateBox->GetValue();
    mRateBox->Clear();
    for (int i = 0; i < AudioIO::NumStandardRates; i++) {
       mRateBox->Append(wxString::Format(wxT("%d"), AudioIO::StandardRates[i]));
    }
    mRateBox->SetValue(oldValue);
 }

void SelectionBar::ValuesToControls ( )

private

Definition at line 625 of file SelectionBar.cpp.

References mAudio, mAudioTime, mCenter, mCenterTime, mEnd, mEndTime, mLength, mLengthTime, mStart, and mStartTime.

Referenced by OnUpdate(), and SetTimes().

 {
    NumericTextCtrl ** Ctrls[5] = { &mStartTime, &mEndTime, &mLengthTime, &mCenterTime, &mAudioTime };
    double Values[5] = {mStart, mEnd, mLength, mCenter, mAudio };
    int i;
    for(i=0;i<5;i++)
       if( *Ctrls[i] )
          (*Ctrls[i])->SetValue( Values[i] );
 }