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

#include <SelectionBar.h>

Inheritance diagram for SelectionBar:

Collaboration diagram for SelectionBar:

Public Member Functions
	SelectionBar (AudacityProject &project)

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 NumericFormatSymbol &format)

void	SetRate (double rate)

void	SetListener (SelectionBarListener *l)

void	RegenerateTooltips () override

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

virtual	~ToolBar ()

bool	AcceptsFocus () const override

virtual void	SetToDefaultSize ()

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

int	GetType ()

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const TranslatableString &label)

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 ()

wxSize	GetSmartDockedSize ()

virtual void	ResizingDone ()

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 TranslatableString &name=XO("Panel"))

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

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

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

Static Public Member Functions
static SelectionBar &	Get (AudacityProject &project)

static const SelectionBar &	Get (const AudacityProject &project)

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 (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)

static void	MakeButtonBackgroundsSmall ()

static void	MakeButtonBackgroundsLarge ()

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

NumericTextCtrl *	AddTime (const TranslatableString &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	OnIdle (wxIdleEvent &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 { 0 }

int	mLastSelectionMode { 0 }

NumericTextCtrl *	mStartTime

NumericTextCtrl *	mCenterTime

NumericTextCtrl *	mLengthTime

NumericTextCtrl *	mEndTime

NumericTextCtrl *	mAudioTime

wxChoice *	mChoice

wxStaticText *	mProxy

wxComboBox *	mRateBox

wxChoice *	mSnapTo

wxWindow *	mRateText

wxString	mLastValidText

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

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

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 Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

	PrefsListener ()

virtual	~PrefsListener ()

Static Protected Member Functions inherited from ToolBar
static void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

Static Protected Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Protected Attributes inherited from ToolBar
AudacityProject &	mProject

TranslatableString	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 45 of file SelectionBar.h.

Constructor & Destructor Documentation

◆ SelectionBar()

SelectionBar::SelectionBar ( AudacityProject & project )

Definition at line 110 of file SelectionBar.cpp.

 : ToolBar(project, SelectionBarID, XO("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) QualitySettings::DefaultSampleRate.Read();
  
    // Selection mode of 0 means showing 'start' and 'end' only.
    mSelectionMode = gPrefs->ReadLong(wxT("/SelectionToolbarMode"),  0);
 }

References QualitySettings::DefaultSampleRate, gPrefs, and Read().

Here is the call graph for this function:

◆ ~SelectionBar()

SelectionBar::~SelectionBar ( )

virtual

Definition at line 133 of file SelectionBar.cpp.

134 {

135 }

Member Function Documentation

◆ AddTime()

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

private

Definition at line 167 of file SelectionBar.cpp.

                                                              {
    auto formatName = mListener ? mListener->AS_GetSelectionFormat()
       : NumericFormatSymbol{};
    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;
 }

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

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddTitle()

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

private

Definition at line 155 of file SelectionBar.cpp.

                                                        {
    const auto translated = Title.Translation();
    auStaticText * pTitle = safenew auStaticText(this, translated );
    pTitle->SetBackgroundColour( theTheme.Colour( clrMedium ));
    pTitle->SetForegroundColour( theTheme.Colour( clrTrackPanelText ) );
    pSizer->Add( pTitle, 0, wxEXPAND | wxALIGN_CENTER_VERTICAL | wxRIGHT, 5 );
  
    return pTitle;
 }

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

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddVLine()

void SelectionBar::AddVLine ( wxSizer * pSizer )

private

Definition at line 178 of file SelectionBar.cpp.

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

References safenew, and toolbarSingle.

Referenced by Populate().

Here is the caller graph for this function:

◆ Create()

void SelectionBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 148 of file SelectionBar.cpp.

 {
    ToolBar::Create(parent);
    UpdatePrefs();
 }

References ToolBar::Create(), and UpdatePrefs().

Here is the call graph for this function:

◆ EnableDisableButtons()

void SelectionBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 58 of file SelectionBar.h.

58 {};

◆ Get() [1/2]

SelectionBar & SelectionBar::Get ( AudacityProject & project )

static

Definition at line 137 of file SelectionBar.cpp.

 {
    auto &toolManager = ToolManager::Get( project );
    return *static_cast<SelectionBar*>( toolManager.GetToolBar(SelectionBarID) );
 }

References ToolManager::Get(), and SelectionBarID.

Referenced by ProjectFileManager::AddImportedTracks(), SetProjectCommand::Apply(), ProjectSelectionManager::AS_SetRate(), ProjectSelectionManager::AS_SetSelectionFormat(), ProjectSelectionManager::AS_SetSnapTo(), Get(), AUPImportFileHandle::Import(), ProjectManager::New(), ProjectFileManager::OpenProjectFile(), and ProjectSettings::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 143 of file SelectionBar.cpp.

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

References Get().

Here is the call graph for this function:

◆ ModifySelection()

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

private

Definition at line 412 of file SelectionBar.cpp.

 {
    // 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 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:
       mEnd = mStart+mLength;
       mCenter = (mStart+mEnd)/2.0;
       break;
  
    case EndTimeID + 4 * LengthTimeID:
       if( mEnd - mLength < 0 )
          mEnd += (mLength - mEnd);
    case EndTimeID * 4 + LengthTimeID:
       if( mEnd - mLength < 0)
          mLength -= (mLength - mEnd);
       mStart = mEnd - mLength;
       mCenter = (mStart+mEnd)/2.0;
       break;
  
    case LengthTimeID + 4 * CenterTimeID:
       if( mCenter - (mLength / 2) < 0 )
          mLength = (mCenter * 2);
    case LengthTimeID * 4 + CenterTimeID:
       if( mCenter - (mLength / 2) < 0 )
          mCenter = (mLength / 2);
       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");
    }
  
    // Refresh the controls now
    ValuesToControls();
  
    // Places the start-end markers on the track panel.
    mListener->AS_ModifySelection(mStart, mEnd, done);
 }

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

Referenced by OnChangedTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCaptureKey()

void SelectionBar::OnCaptureKey ( wxCommandEvent & event )

private

Definition at line 775 of file SelectionBar.cpp.

 {
    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();
 }

References mRateText.

◆ OnChangedTime()

void SelectionBar::OnChangedTime ( wxCommandEvent & evt )

private

Definition at line 493 of file SelectionBar.cpp.

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

References ModifySelection().

Here is the call graph for this function:

◆ OnChoice()

void SelectionBar::OnChoice ( wxCommandEvent & event )

private

Definition at line 585 of file SelectionBar.cpp.

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

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

Here is the call graph for this function:

◆ OnFocus()

void SelectionBar::OnFocus ( wxFocusEvent & event )

private

Definition at line 770 of file SelectionBar.cpp.

 {
    KeyboardCapture::OnFocus( *this, event );
 }

References KeyboardCapture::OnFocus().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnIdle()

void SelectionBar::OnIdle ( wxIdleEvent & evt )

private

Definition at line 592 of file SelectionBar.cpp.

 {
    evt.Skip();
    auto &project = mProject;
    const auto &selectedRegion = ViewInfo::Get( project ).selectedRegion;
  
    double audioTime;
  
    auto &projectAudioIO = ProjectAudioIO::Get( project );
    if ( projectAudioIO.IsAudioActive() ){
       auto gAudioIO = AudioIO::Get();
       audioTime = gAudioIO->GetStreamTime();
    }
    else {
       const auto &playRegion = ViewInfo::Get( project ).playRegion;
       audioTime = playRegion.GetStart();
    }
  
    SetTimes(selectedRegion.t0(), selectedRegion.t1(), audioTime);
 }

References AudioIO::Get(), ViewInfo::Get(), ProjectAudioIO::Get(), PlayRegion::GetStart(), ToolBar::mProject, ViewInfo::playRegion, ViewInfo::selectedRegion, and SetTimes().

Here is the call graph for this function:

◆ OnRate()

void SelectionBar::OnRate ( wxCommandEvent & event )

private

Definition at line 736 of file SelectionBar.cpp.

 {
    auto value = mRateBox->GetValue();
  
    if (value.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);
  
       mLastValidText = value;
    }
    else
    {
       // Bug 2497 - Undo paste into text box if it's not numeric
       mRateBox->SetValue(mLastValidText);
    }
 }

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

Here is the call graph for this function:

◆ OnSize()

void SelectionBar::OnSize ( wxSizeEvent & evt )

private

Definition at line 403 of file SelectionBar.cpp.

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

◆ OnSnapTo()

void SelectionBar::OnSnapTo ( wxCommandEvent & event )

private

Definition at line 807 of file SelectionBar.cpp.

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

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

Here is the call graph for this function:

◆ OnUpdate()

void SelectionBar::OnUpdate ( wxCommandEvent & evt )

private

Definition at line 499 of file SelectionBar.cpp.

 {
    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);
  
    auto format = NumericTextCtrl::LookupFormat(NumericConverter::TIME, evt.GetString());
  
    // Save format name before recreating the controls so they resize properly
    if (mStartTime)
    {
       if (mListener)
          mListener->AS_SetSelectionFormat(format);
    }
  
    // ReCreateButtons() will get rid of our sizers and controls
    // so reset pointers first.
    for( i=0;i<5;i++)
       *Ctrls[i]=NULL;
  
    mChoice = NULL;
    mRateBox = NULL;
    mRateText = NULL;
    mSnapTo = NULL;
  
    ToolBar::ReCreateButtons();
  
    ValuesToControls();
  
    for( i=0;i<5;i++)
       if( *Ctrls[i] )
          (*Ctrls[i])->SetFormatName( format );
  
    if( iFocus >=0 )
       if( *Ctrls[iFocus] )
          (*Ctrls[iFocus])->SetFocus();
  
    RegenerateTooltips();
  
    Updated();
 }

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

Referenced by SetSelectionFormat(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void SelectionBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 185 of file SelectionBar.cpp.

 {
    SetBackgroundColour( theTheme.Colour( clrMedium  ) );
  
    mStartTime = mEndTime = mLengthTime = mCenterTime = mAudioTime = nullptr;
  
    // 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.
    wxFlexGridSizer *mainSizer = safenew wxFlexGridSizer(SIZER_COLS, 1, 1);
    Add(mainSizer, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 5);
  
    // Top row (mostly labels)
    wxColour clrText =  theTheme.Colour( clrTrackPanelText );
    wxColour clrText2 = *wxBLUE;
    auStaticText *rateLabel = AddTitle( XO("Project Rate (Hz)"), mainSizer );
    AddVLine( mainSizer );
    auStaticText *snapLabel = AddTitle( XO("Snap-To"), mainSizer );
    AddVLine( mainSizer );
 #ifdef TIME_IN_SELECT_TOOLBAR
    AddTitle( XO("Audio Position"), mainSizer );
    AddVLine( mainSizer );
 #endif
  
    {
       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
       mainSizer->Add(mChoice, 0, wxEXPAND | wxALIGN_TOP | wxRIGHT, 6);
    }
  
    // Bottom row, (mostly time controls)
    mRateBox = safenew wxComboBox(this, RateID,
                              wxT(""),
                              wxDefaultPosition, wxDefaultSize);
 #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.size(); 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);
  
    mainSizer->Add(mRateBox, 0, wxEXPAND | wxALIGN_TOP | wxRIGHT, 5);
  
    AddVLine( mainSizer );
  
    mSnapTo = safenew wxChoice(this, SnapToID,
       wxDefaultPosition, wxDefaultSize,
       transform_container< wxArrayStringEx >(
          SnapManager::GetSnapLabels(),
          std::mem_fn( &TranslatableString::Translation ) ) );
  
 #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);
  
    mainSizer->Add(mSnapTo, 0, wxEXPAND | wxALIGN_TOP | wxRIGHT, 5);
  
    AddVLine( mainSizer );
  
 #ifdef TIME_IN_SELECT_TOOLBAR
    mAudioTime = AddTime( XO("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 screen reader users, who use TAB 
    // a lot in navigation.
    // More about the bug here:
    // https://forums.wxwidgets.org/viewtopic.php?t=41120
    AddVLine( mainSizer );
 #endif
  
    {
       auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
  
       mStartTime  = AddTime( XO("Start"), StartTimeID, hSizer.get() );
       mLengthTime = AddTime( XO("Length"), LengthTimeID, hSizer.get() );
       mCenterTime = AddTime( XO("Center"), CenterTimeID, hSizer.get() );
       mEndTime    = AddTime( XO("End"), EndTimeID, hSizer.get() );
       mainSizer->Add(hSizer.release(), 0, wxALIGN_TOP | wxRIGHT, 0);
    }
  
 #if defined(__WXGTK3__)
    // Nothing special
 #elif defined(__WXGTK__)
    // Ensure the font fits inside (hopefully)
    wxFont font = mChoice->GetFont();
    font.Scale((double) toolbarSingle / mChoice->GetSize().GetHeight());
  
    rateLabel->SetFont(font);
    snapLabel->SetFont(font);
    mChoice->SetFont(font);
    mRateBox->SetFont(font);
    mRateText->SetFont(font);
    mSnapTo->SetFont(font);
 #endif
  
    // Make sure they are fully expanded to the longest item
    mChoice->SetMinSize(wxSize(mChoice->GetBestSize().x, toolbarSingle));
    mRateBox->SetMinSize(wxSize(mRateBox->GetBestSize().x, toolbarSingle));
    mSnapTo->SetMinSize(wxSize(mSnapTo->GetBestSize().x, toolbarSingle));
  
    mChoice->MoveBeforeInTabOrder( mStartTime );
    // This shows/hides controls.
    // Do this before layout so that we are sized right.
    SetSelectionMode(mSelectionMode);
    mainSizer->Layout();
    RegenerateTooltips();
    Layout();
 }

References _, ToolBar::Add(), AddTime(), AddTitle(), AddVLine(), SelectionBarListener::AS_GetSnapTo(), AudioTimeID, CenterTimeID, ChoiceID, ThemeBase::Colour(), EndTimeID, 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, toolbarSingle, TranslatableString::Translation(), UpdateRates(), and XO.

Here is the call graph for this function:

◆ RegenerateTooltips()

void SelectionBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 390 of file SelectionBar.cpp.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void SelectionBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 57 of file SelectionBar.h.

57 {};

◆ SelectionModeUpdated()

void SelectionBar::SelectionModeUpdated ( )

private

Definition at line 613 of file SelectionBar.cpp.

 {
    // 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();
 }

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

Referenced by OnChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDrivers()

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

private

Definition at line 549 of file SelectionBar.cpp.

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

References mCenterTime, mDrive1, mDrive2, mEndTime, mLengthTime, mStartTime, wxPanelWrapper::SetName(), StartTimeID, and XO.

Referenced by ModifySelection(), and SetSelectionMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetListener()

void SelectionBar::SetListener ( SelectionBarListener * l )

Definition at line 382 of file SelectionBar.cpp.

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

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

Referenced by ProjectManager::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRate()

void SelectionBar::SetRate ( double rate )

Definition at line 720 of file SelectionBar.cpp.

 {
    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 );
    }
 }

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

Referenced by ProjectFileManager::AddImportedTracks(), ProjectSelectionManager::AS_SetRate(), ProjectFileManager::OpenProjectFile(), and SetListener().

Here is the caller graph for this function:

◆ SetSelectionFormat()

void SelectionBar::SetSelectionFormat ( const NumericFormatSymbol & format )

Definition at line 707 of file SelectionBar.cpp.

 {
    bool changed =
       mStartTime->SetFormatString(mStartTime->GetBuiltinFormat(format));
  
    // Test first whether changed, to avoid infinite recursion from OnUpdate
    if ( changed ) {
       wxCommandEvent e;
       e.SetString(format.Internal());
       OnUpdate(e);
    }
 }

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

Referenced by ProjectSelectionManager::AS_SetSelectionFormat(), and SetListener().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSelectionMode()

void SelectionBar::SetSelectionMode ( int mode )

private

Definition at line 630 of file SelectionBar.cpp.

 {
    // 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 );
 }

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

Referenced by OnChoice(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSnapTo()

void SelectionBar::SetSnapTo ( int snap )

Definition at line 702 of file SelectionBar.cpp.

 {
    mSnapTo->SetSelection(snap);
 }

References mSnapTo.

Referenced by ProjectSelectionManager::AS_SetSnapTo(), and SetListener().

Here is the caller graph for this function:

◆ SetTimes()

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

Definition at line 686 of file SelectionBar.cpp.

 {
    if ( start != mStart || end != mEnd || audio != mAudio
       || mLastSelectionMode != mSelectionMode
    ) {
       mStart = start;
       mEnd = end;
       mLength = end-start;
       mCenter = (end+start)/2.0;
       mAudio = audio;
       mLastSelectionMode = mSelectionMode;
  
       ValuesToControls();
    }
 }

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

Referenced by OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowHideControls()

void SelectionBar::ShowHideControls ( int mode )

private

Definition at line 657 of file SelectionBar.cpp.

 {
    // 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 );
          (*Ctrls[i])->Refresh();
       }
    }
 }

References mCenterTime, mEndTime, mLengthTime, and mStartTime.

Referenced by SetSelectionMode().

Here is the caller graph for this function:

◆ UpdatePrefs()

void SelectionBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 351 of file SelectionBar.cpp.

 {
    // 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 sample rate in existing ones.
  
    // This will only change the selection mode during a "Reset Configuration"
    // action since the read value will be the same during a normal preferences
    // update.
    mSelectionMode = gPrefs->ReadLong(wxT("/SelectionToolbarMode"),  0);
  
    // This will only change the time format during a "Reset Configuration"
    // action since the read value will be the same during a normal preferences
    // update.
    wxCommandEvent e;
    e.SetString(NumericTextCtrl::LookupFormat(
                NumericConverter::TIME,
                gPrefs->Read(wxT("/SelectionFormat"), wxT(""))).Internal());
    OnUpdate(e);
  
    // Set label to pull in language change
    SetLabel(XO("Selection"));
  
    RegenerateTooltips();
    // Give base class a chance
    ToolBar::UpdatePrefs();
 }

References gPrefs, Internal, NumericConverter::LookupFormat(), mSelectionMode, OnUpdate(), RegenerateTooltips(), ToolBar::SetLabel(), NumericConverter::TIME, ToolBar::UpdatePrefs(), and XO.

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateRates()

void SelectionBar::UpdateRates ( )

private

Definition at line 759 of file SelectionBar.cpp.

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

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

Referenced by Populate().

Here is the caller graph for this function:

◆ ValuesToControls()

void SelectionBar::ValuesToControls ( )

private

Definition at line 675 of file SelectionBar.cpp.

 {
    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] );
 }

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

Referenced by ModifySelection(), OnUpdate(), and SetTimes().

Here is the caller graph for this function:

Member Data Documentation

◆ mAudio

double SelectionBar::mAudio

private

Definition at line 95 of file SelectionBar.h.

Referenced by SetTimes(), and ValuesToControls().

◆ mAudioTime

NumericTextCtrl* SelectionBar::mAudioTime

private

Definition at line 109 of file SelectionBar.h.

Referenced by OnRate(), OnUpdate(), Populate(), SetRate(), and ValuesToControls().

◆ mCenter

double SelectionBar::mCenter

private

Definition at line 95 of file SelectionBar.h.

Referenced by ModifySelection(), SetTimes(), and ValuesToControls().

◆ mCenterTime

NumericTextCtrl* SelectionBar::mCenterTime

private

Definition at line 106 of file SelectionBar.h.

Referenced by ModifySelection(), OnRate(), OnUpdate(), Populate(), SetDrivers(), SetRate(), ShowHideControls(), and ValuesToControls().

◆ mChoice

wxChoice* SelectionBar::mChoice

private

Definition at line 110 of file SelectionBar.h.

Referenced by OnChoice(), OnUpdate(), Populate(), and SetSelectionMode().

◆ mDrive1

int SelectionBar::mDrive1

private

Definition at line 99 of file SelectionBar.h.

Referenced by ModifySelection(), and SetDrivers().

◆ mDrive2

int SelectionBar::mDrive2

private

Definition at line 100 of file SelectionBar.h.

Referenced by ModifySelection(), and SetDrivers().

◆ mEnd

double SelectionBar::mEnd

private

Definition at line 95 of file SelectionBar.h.

Referenced by ModifySelection(), SetTimes(), and ValuesToControls().

◆ mEndTime

NumericTextCtrl* SelectionBar::mEndTime

private

Definition at line 108 of file SelectionBar.h.

Referenced by ModifySelection(), OnRate(), OnUpdate(), Populate(), SetDrivers(), SetRate(), ShowHideControls(), and ValuesToControls().

◆ mLastSelectionMode

int SelectionBar::mLastSelectionMode { 0 }

private

Definition at line 103 of file SelectionBar.h.

Referenced by SetTimes().

◆ mLastValidText

wxString SelectionBar::mLastValidText

private

Definition at line 116 of file SelectionBar.h.

Referenced by OnRate().

◆ mLength

double SelectionBar::mLength

private

Definition at line 95 of file SelectionBar.h.

Referenced by ModifySelection(), SetTimes(), and ValuesToControls().

◆ mLengthTime

NumericTextCtrl* SelectionBar::mLengthTime

private

Definition at line 107 of file SelectionBar.h.

Referenced by ModifySelection(), OnRate(), OnUpdate(), Populate(), SetDrivers(), SetRate(), ShowHideControls(), and ValuesToControls().

◆ mListener

SelectionBarListener* SelectionBar::mListener

private

Definition at line 93 of file SelectionBar.h.

Referenced by AddTime(), ModifySelection(), OnRate(), OnSnapTo(), OnUpdate(), Populate(), RegenerateTooltips(), and SetListener().

◆ mProxy

wxStaticText* SelectionBar::mProxy

private

Definition at line 111 of file SelectionBar.h.

◆ mRate

double SelectionBar::mRate

private

Definition at line 94 of file SelectionBar.h.

Referenced by AddTime(), OnRate(), Populate(), and SetRate().

◆ mRateBox

wxComboBox* SelectionBar::mRateBox

private

Definition at line 112 of file SelectionBar.h.

Referenced by OnRate(), OnUpdate(), Populate(), SetRate(), and UpdateRates().

◆ mRateText

wxWindow* SelectionBar::mRateText

private

Definition at line 114 of file SelectionBar.h.

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

◆ mSelectionMode

int SelectionBar::mSelectionMode { 0 }

private

Definition at line 102 of file SelectionBar.h.

Referenced by Populate(), SelectionModeUpdated(), SetSelectionMode(), SetTimes(), and UpdatePrefs().

◆ mSnapTo

wxChoice* SelectionBar::mSnapTo

private

Definition at line 113 of file SelectionBar.h.

Referenced by OnSnapTo(), OnUpdate(), Populate(), RegenerateTooltips(), and SetSnapTo().

◆ mStart

double SelectionBar::mStart

private

Definition at line 95 of file SelectionBar.h.

Referenced by ModifySelection(), SetTimes(), and ValuesToControls().

◆ mStartTime

NumericTextCtrl* SelectionBar::mStartTime

private

Definition at line 105 of file SelectionBar.h.

Referenced by ModifySelection(), OnRate(), OnUpdate(), Populate(), SetDrivers(), SetRate(), SetSelectionFormat(), ShowHideControls(), and ValuesToControls().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectionBar()

◆ ~SelectionBar()

Member Function Documentation

◆ AddTime()

◆ AddTitle()

◆ AddVLine()

◆ Create()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ModifySelection()

◆ OnCaptureKey()

◆ OnChangedTime()

◆ OnChoice()

◆ OnFocus()

◆ OnIdle()

◆ OnRate()

◆ OnSize()

◆ OnSnapTo()

◆ OnUpdate()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ SelectionModeUpdated()

◆ SetDrivers()

◆ SetListener()

◆ SetRate()

◆ SetSelectionFormat()

◆ SetSelectionMode()

◆ SetSnapTo()

◆ SetTimes()

◆ ShowHideControls()

◆ UpdatePrefs()

◆ UpdateRates()

◆ ValuesToControls()

Member Data Documentation

◆ mAudio

◆ mAudioTime

◆ mCenter

◆ mCenterTime

◆ mChoice

◆ mDrive1

◆ mDrive2

◆ mEnd

◆ mEndTime

◆ mLastSelectionMode

◆ mLastValidText

◆ mLength

◆ mLengthTime

◆ mListener

◆ mProxy

◆ mRate

◆ mRateBox

◆ mRateText

◆ mSelectionMode

◆ mSnapTo

◆ mStart

◆ mStartTime