(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 Types
enum class	SelectionMode { StartEnd , StartLength , LengthEnd , LengthCenter }

Public Types inherited from ToolBar
enum	DockID { TopDockID = 1 , BotDockID = 2 }
	Identifies one of the docking areas for toolbars. More...

using	Holder = wxWindowPtr< ToolBar >

Public Member Functions
	SelectionBar (AudacityProject &project)

virtual	~SelectionBar ()

bool	ShownByDefault () const override
	Whether the toolbar should be shown by default. Default implementation returns true. More...

DockID	DefaultDockID () const override
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

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)

void	SetSelectionFormat (const NumericFormatID &format)

void	RegenerateTooltips () override

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

virtual	~ToolBar ()

virtual bool	ShownByDefault () const
	Whether the toolbar should be shown by default. Default implementation returns true. More...

virtual bool	HideAfterReset () const
	Default implementation returns false. More...

virtual DockID	DefaultDockID () const
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

virtual void	SetToDefaultSize ()

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

virtual void	RegenerateTooltips ()=0

int	GetIndex () const
	Get a value used for computing cascading positions of undocked bars. More...

void	SetIndex (int index)
	Set a value used for computing cascading positions of undocked bars. More...

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

Identifier	GetSection ()

ToolDock *	GetDock ()

void	SetPreferredNeighbors (Identifier left, Identifier top={})

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

std::pair< Identifier, Identifier >	PreferredNeighbors () const noexcept
	Defaults to (NoBarID, NoBarId) More...

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

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 AButton *	MakeButton (ToolBar *parent, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, bool processdownevents, const TranslatableString &label)

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
AButton *	MakeSetupButton ()

void	AddTitle (const TranslatableString &Title, wxSizer *pSizer)

void	AddTime (int id, wxSizer *pSizer)

void	AddSelectionSetupButton (wxSizer *pSizer)

void	SetSelectionMode (SelectionMode mode)

void	ValuesToControls ()

void	OnUpdate (wxCommandEvent &evt)

void	OnFocus (wxFocusEvent &event)

void	OnCaptureKey (wxCommandEvent &event)

void	OnSize (wxSizeEvent &evt)

void	OnIdle (wxIdleEvent &evt)

void	ModifySelection (int driver, bool done=false)

void	SelectionModeUpdated ()

void	UpdateTimeControlsFormat (const NumericFormatID &format)

void	FitToTimeControls ()

void	OnFormatsChanged (struct ProjectNumericFormatsEvent)

Private Attributes
double	mRate

double	mStart

double	mEnd

double	mLength

double	mCenter

SelectionMode	mSelectionMode {}

SelectionMode	mLastSelectionMode {}

std::array< NumericTextCtrl *, 2 >	mTimeControls {}

AButton *	mSetupButton {}

Observer::Subscription	mFormatChangedToFitValueSubscription [2]

wxString	mLastValidText

const Observer::Subscription	mFormatsSubscription

Additional Inherited Members
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	Populate ()=0

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

virtual void	UpdatePrefs ()=0

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

static void	MakeMacRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

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

Identifier	mSection

int	mIndex {0}

Detailed Description

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

Definition at line 37 of file SelectionBar.h.

Member Enumeration Documentation

◆ SelectionMode

enum class SelectionBar::SelectionMode

strong

Enumerator
StartEnd
StartLength
LengthEnd
LengthCenter

Definition at line 40 of file SelectionBar.h.

   {
      StartEnd,
      StartLength,
      LengthEnd,
      LengthCenter 
   };

Constructor & Destructor Documentation

◆ SelectionBar()

SelectionBar::SelectionBar ( AudacityProject & project )

Definition at line 129 of file SelectionBar.cpp.

: ToolBar(project, XO("Selection"), ID()),
  mRate(0.0),
  mStart(0.0), mEnd(0.0), mLength(0.0), mCenter(0.0),
  mFormatsSubscription{ ProjectNumericFormats::Get(project).Subscribe(
     *this, &SelectionBar::OnFormatsChanged) }
{
   // 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 = ProjectRate::Get(project).GetRate();
 
   // Selection mode of 0 means showing 'start' and 'end' only.
   mSelectionMode = ReadSelectionMode();
}

References ProjectRate::Get(), ProjectRate::GetRate(), mRate, mSelectionMode, project, and anonymous_namespace{SelectionBar.cpp}::ReadSelectionMode().

Here is the call graph for this function:

◆ ~SelectionBar()

SelectionBar::~SelectionBar ( )

virtual

Definition at line 149 of file SelectionBar.cpp.

150{

151}

Member Function Documentation

◆ AddSelectionSetupButton()

void SelectionBar::AddSelectionSetupButton ( wxSizer * pSizer )

private

Definition at line 239 of file SelectionBar.cpp.

{
   auto setupBtn = MakeSetupButton();
 
   auto showMenu = [this, setupBtn]()
   {
      static const wxString choices[4] = {
         _("Start and End of Selection"),
         _("Start and Length of Selection"),
         _("Length and End of Selection"),
         _("Length and Center of Selection"),
      };
 
      wxMenu menu;
      int selectionMode {};
      for (auto& choice : choices)
      {
         auto subMenu = menu.AppendRadioItem(wxID_ANY, choice);
 
         if (static_cast<SelectionMode>(selectionMode) == mSelectionMode)
            subMenu->Check();
 
         menu.Bind(
            wxEVT_MENU,
            [this, selectionMode](auto& evt)
            {
               SetSelectionMode(static_cast<SelectionMode>(selectionMode));
               SelectionModeUpdated();
            },
            subMenu->GetId());
 
         ++selectionMode;
      }
 
      menu.Bind(wxEVT_MENU_CLOSE, [setupBtn](auto&) { setupBtn->PopUp(); });
 
      BasicMenu::Handle { &menu }.Popup(wxWidgetsWindowPlacement { setupBtn });
   };
 
   setupBtn->Bind(wxEVT_BUTTON, [this, showMenu](auto&) { showMenu(); });
   pSizer->Add(setupBtn, 0, wxALIGN_RIGHT | wxBOTTOM | wxRIGHT, 5);
 
   mSetupButton = setupBtn;
}

References _, MakeSetupButton(), mSelectionMode, mSetupButton, BasicMenu::Handle::Popup(), SelectionModeUpdated(), and SetSelectionMode().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddTime()

void SelectionBar::AddTime	(	int	id,
		wxSizer *	pSizer
	)

private

Definition at line 213 of file SelectionBar.cpp.

{
   auto &formats = ProjectNumericFormats::Get(mProject);
   auto formatName = formats.GetSelectionFormat();
   auto pCtrl = safenew NumericTextCtrl(FormatterContext::ProjectContext(mProject),
      this, id, NumericConverterType_TIME(), formatName, 0.0);
 
   pCtrl->Bind(
      wxEVT_TEXT,
      [this, id](auto& evt) { ModifySelection(id, evt.GetInt() != 0); });
 
   pSizer->Add(pCtrl, 0, wxALIGN_TOP | wxRIGHT, 5);
 
   mTimeControls[id] = pCtrl;
 
   mFormatChangedToFitValueSubscription[id] = pCtrl->Subscribe(
      [this, id](const auto& msg)
      {
         auto altCtrl = mTimeControls[id == 0 ? 1 : 0];
         if (altCtrl != nullptr)
            altCtrl->UpdateFormatToFit(msg.value);
 
         FitToTimeControls();
      });
}

References FitToTimeControls(), ProjectNumericFormats::Get(), id, mFormatChangedToFitValueSubscription, ModifySelection(), ToolBar::mProject, mTimeControls, NumericConverterType_TIME(), FormatterContext::ProjectContext(), and safenew.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddTitle()

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

private

Definition at line 203 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 | wxRIGHT, 5 );
}

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

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void SelectionBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 174 of file SelectionBar.cpp.

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

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

Here is the call graph for this function:

◆ DefaultDockID()

ToolBar::DockID SelectionBar::DefaultDockID ( ) const

overridevirtual

Which dock the toolbar defaults into. Default implementation chooses the top dock.

Reimplemented from ToolBar.

Definition at line 158 of file SelectionBar.cpp.

{
   return BotDockID;
}

References ToolBar::BotDockID.

◆ EnableDisableButtons()

void SelectionBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 63 of file SelectionBar.h.

63{};

◆ FitToTimeControls()

void SelectionBar::FitToTimeControls ( )

private

Definition at line 642 of file SelectionBar.cpp.

{
   wxSize sz = GetMinSize();
   sz.SetWidth(10);
   SetMinSize(sz);
   Fit();
   Layout();
   Updated();
}

References ToolBar::Updated().

Referenced by AddTime(), and SelectionModeUpdated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

SelectionBar & SelectionBar::Get ( AudacityProject & project )

static

Definition at line 163 of file SelectionBar.cpp.

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

References ToolManager::Get(), ID(), and project.

Referenced by Get(), 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 169 of file SelectionBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier SelectionBar::ID ( )

static

Definition at line 124 of file SelectionBar.cpp.

{
   return wxT("Selection");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeSetupButton()

AButton * SelectionBar::MakeSetupButton ( )

private

Definition at line 180 of file SelectionBar.cpp.

{
   wxImage up = theTheme.Image(bmpRecoloredUpSmall);
   up.Rescale(20, 20, wxIMAGE_QUALITY_HIGH);
   wxImage down = theTheme.Image(bmpRecoloredDownSmall);
   down.Rescale(20, 20, wxIMAGE_QUALITY_HIGH);
   wxImage hiliteUp = theTheme.Image(bmpRecoloredUpHiliteSmall);
   hiliteUp.Rescale(20, 20, wxIMAGE_QUALITY_HIGH);
   wxImage hiliteDown = theTheme.Image(bmpRecoloredHiliteSmall);
   hiliteDown.Rescale(20, 20, wxIMAGE_QUALITY_HIGH);
 
   auto btn = safenew AButton(
      this, wxID_ANY, wxDefaultPosition, wxSize { 20, 20 }, up, hiliteUp, down,
      hiliteDown, up, false);
 
   btn->SetButtonType(AButton::FrameButton);
   btn->SetIcon(theTheme.Image(bmpCogwheel));
   btn->SetLabel({});
   btn->SetName(XO("Selection Toolbar Setup").Translation());
 
   return btn;
}

References AButton::FrameButton, ThemeBase::Image(), safenew, AButton::SetButtonType(), theTheme, wxImage(), and XO().

Referenced by AddSelectionSetupButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ModifySelection()

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

private

Definition at line 362 of file SelectionBar.cpp.

{
   // Only update a value if user typed something in.
   // The reason is the controls may be less accurate than
   // the values.
   double start = mStart;
   double end = mEnd;
   double center = mCenter;
   double length = mLength;
   
   if (driver == 0)
   {
      if (
         mSelectionMode == SelectionMode::StartEnd ||
         mSelectionMode == SelectionMode::StartLength)
         start = mTimeControls[0]->GetValue();
      else if (
         mSelectionMode == SelectionMode::LengthCenter ||
         mSelectionMode == SelectionMode::LengthEnd)
         length = mTimeControls[0]->GetValue();
      else
         wxFAIL_MSG("Unexpected selection mode");
   }
   else if (driver == 1)
   {
      if (
         mSelectionMode == SelectionMode::StartEnd ||
         mSelectionMode == SelectionMode::LengthEnd)
         end = mTimeControls[1]->GetValue();
      else if (mSelectionMode == SelectionMode::StartLength)
         length = mTimeControls[1]->GetValue();
      else if (mSelectionMode == SelectionMode::LengthCenter)
         center = mTimeControls[1]->GetValue();
      else
         wxFAIL_MSG("Unexpected selection mode");
   }
   else
   {
      wxFAIL_MSG("Illegal selection driver");
   }
 
   switch (mSelectionMode)
   {
   case SelectionBar::SelectionMode::StartEnd:
      if (driver == 0 && end < start)
         end = start;
      else if (driver == 1 && start > end)
         start = end;
      break;
   case SelectionBar::SelectionMode::StartLength:
      // Nothing can go wrong here
      end = start + length;
      break;
   case SelectionBar::SelectionMode::LengthEnd:
      start = end - length;
 
      if (start < 0)
      {
         // Length is set by user
         if (driver == 0)
            end -= start;
         
         start = 0;
      }
      break;
   case SelectionBar::SelectionMode::LengthCenter:
      start = center - length / 2.0;
 
      if (start < 0)
      {
         // Length is set by user
         if (driver == 0)
            center = length / 2.0;
         else
         // Center is set by user
            length = center * 2.0;
 
         start = 0;
      }
      
      end = center + length / 2.0;
      break;
   default:
      break;
   }
 
   // Places the start-end markers on the track panel.
   auto &manager = ProjectSelectionManager::Get(mProject);
   manager.ModifySelection(start, end, done);
}

References details::end(), ProjectSelectionManager::Get(), LengthCenter, LengthEnd, manager, mCenter, mEnd, mLength, ToolBar::mProject, mSelectionMode, mStart, mTimeControls, StartEnd, and StartLength.

Referenced by AddTime().

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 604 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;
   }
 
   event.Skip();
}

References BasicUI::FindFocus().

Here is the call graph for this function:

◆ OnFocus()

void SelectionBar::OnFocus ( wxFocusEvent & event )

private

Definition at line 599 of file SelectionBar.cpp.

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

References KeyboardCapture::OnFocus().

Here is the call graph for this function:

◆ OnFormatsChanged()

void SelectionBar::OnFormatsChanged ( struct ProjectNumericFormatsEvent evt )

private

Definition at line 588 of file SelectionBar.cpp.

{
   auto &formats = ProjectNumericFormats::Get(mProject);
   switch (evt.type) {
   case ProjectNumericFormatsEvent::ChangedSelectionFormat:
      return SetSelectionFormat(formats.GetSelectionFormat());
   default:
      break;
   }
}

References ProjectNumericFormatsEvent::ChangedSelectionFormat, ProjectNumericFormats::Get(), ToolBar::mProject, SetSelectionFormat(), and ProjectNumericFormatsEvent::type.

Here is the call graph for this function:

◆ OnIdle()

void SelectionBar::OnIdle ( wxIdleEvent & evt )

private

Definition at line 496 of file SelectionBar.cpp.

{
   evt.Skip();
   const auto& selectedRegion = ViewInfo::Get(mProject).selectedRegion;
 
   SetTimes(selectedRegion.t0(), selectedRegion.t1());
}

References ViewInfo::Get(), ToolBar::mProject, ViewInfo::selectedRegion, and SetTimes().

Here is the call graph for this function:

◆ OnSize()

void SelectionBar::OnSize ( wxSizeEvent & evt )

private

Definition at line 353 of file SelectionBar.cpp.

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

◆ OnUpdate()

void SelectionBar::OnUpdate ( wxCommandEvent & evt )

private

Definition at line 454 of file SelectionBar.cpp.

{
   evt.Skip(false);
 
   wxWindow *w = FindFocus();
 
   auto focusedCtrlIt =
      std::find(mTimeControls.begin(), mTimeControls.end(), w);
 
   const auto focusedCtrlIdx =
      focusedCtrlIt != mTimeControls.end() ?
         std::distance(mTimeControls.begin(), focusedCtrlIt) :
         -1;
 
   auto format = evt.GetString();
 
   // Save format name before recreating the controls so they resize properly
   if (mTimeControls.front())
   {
      auto &formats = ProjectNumericFormats::Get(mProject);
      formats.SetSelectionFormat(format);
      // Then my Subscription is called
   }
 
   // ReCreateButtons() will get rid of our sizers and controls
   // so reset pointers first.
   std::fill(mTimeControls.begin(), mTimeControls.end(), nullptr);
 
   ToolBar::ReCreateButtons();
 
   ValuesToControls();
 
   UpdateTimeControlsFormat(format);
 
   if (focusedCtrlIdx >= 0 && mTimeControls[focusedCtrlIdx])
      mTimeControls[focusedCtrlIdx]->SetFocus();
 
   RegenerateTooltips();
 
   Updated();
}

References BasicUI::FindFocus(), anonymous_namespace{ExportPCM.cpp}::format, ProjectNumericFormats::Get(), ToolBar::mProject, mTimeControls, ToolBar::ReCreateButtons(), RegenerateTooltips(), ToolBar::Updated(), UpdateTimeControlsFormat(), 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 284 of file SelectionBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
 
   mTimeControls[0] = mTimeControls[1] = {};
 
   // 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(2, 1, 1);
   Add(mainSizer, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 5);
 
   AddTitle(XO("Selection"), mainSizer);
   AddTime(0, mainSizer);
   AddSelectionSetupButton(mainSizer);
   AddTime(1, mainSizer);
 
   mSetupButton->MoveBeforeInTabOrder(mTimeControls[0]);
 
   // Update the selection mode before the layout
   SetSelectionMode(mSelectionMode);
   mainSizer->Layout();
   RegenerateTooltips();
   Layout();
 
   CallAfter([this]{
      auto &formats = ProjectNumericFormats::Get(mProject);
      SetSelectionFormat(formats.GetSelectionFormat());
   });
 
}

References ToolBar::Add(), AddSelectionSetupButton(), AddTime(), AddTitle(), BasicUI::CallAfter(), ThemeBase::Colour(), ProjectNumericFormats::Get(), ToolBar::mProject, mSelectionMode, mSetupButton, mTimeControls, RegenerateTooltips(), safenew, SetSelectionFormat(), SetSelectionMode(), theTheme, and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void SelectionBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 349 of file SelectionBar.cpp.

350{

351}

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

Here is the caller graph for this function:

◆ Repaint()

void SelectionBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 62 of file SelectionBar.h.

62{};

◆ SelectionModeUpdated()

void SelectionBar::SelectionModeUpdated ( )

private

Definition at line 504 of file SelectionBar.cpp.

{
   // We just changed the mode.  Remember it.
   UpdateSelectionMode(mSelectionMode);
 
   FitToTimeControls();
}

References FitToTimeControls(), mSelectionMode, and anonymous_namespace{SelectionBar.cpp}::UpdateSelectionMode().

Referenced by AddSelectionSetupButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSelectionFormat()

void SelectionBar::SetSelectionFormat ( const NumericFormatID & format )

Definition at line 573 of file SelectionBar.cpp.

{
   if (mTimeControls.front() == nullptr)
      return;
 
   const bool changed = mTimeControls.front()->SetFormatName(format);
 
   // Test first whether changed, to avoid infinite recursion from OnUpdate
   if ( changed ) {
      wxCommandEvent e;
      e.SetString(format.GET());
      OnUpdate(e);
   }
}

References anonymous_namespace{ExportPCM.cpp}::format, mTimeControls, and OnUpdate().

Referenced by OnFormatsChanged(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSelectionMode()

void SelectionBar::SetSelectionMode ( SelectionMode mode )

private

Definition at line 515 of file SelectionBar.cpp.

{
   mSelectionMode = mode;
 
   // Update names and WindowIds for the screen readers
   auto& modeName = ModeNames[static_cast<size_t>(mode)];
 
   if (mTimeControls[0]) {
      mTimeControls[0]->SetName(modeName.first);
      mTimeControls[0]->SetId(WindowIDs.at(modeName.first));
   }
 
   if (mTimeControls[1]) {
      mTimeControls[1]->SetName(modeName.second);
      mTimeControls[1]->SetId(WindowIDs.at(modeName.second));
   }
 
   UpdateTimeControlsFormat(mTimeControls[0]->GetFormatName());
 
   ValuesToControls();
}

References anonymous_namespace{SelectionBar.cpp}::ModeNames, mSelectionMode, mTimeControls, UpdateTimeControlsFormat(), ValuesToControls(), and anonymous_namespace{SelectionBar.cpp}::WindowIDs.

Referenced by AddSelectionSetupButton(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTimes()

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

Definition at line 558 of file SelectionBar.cpp.

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

References details::end(), 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:

◆ ShownByDefault()

bool SelectionBar::ShownByDefault ( ) const

overridevirtual

Whether the toolbar should be shown by default. Default implementation returns true.

Reimplemented from ToolBar.

Definition at line 153 of file SelectionBar.cpp.

{
   return true;
}

◆ UpdatePrefs()

void SelectionBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 317 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 = ReadSelectionMode();
 
   // 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(NumericConverterFormats::Lookup(
               FormatterContext::ProjectContext(mProject),
               NumericConverterType_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, NumericConverterFormats::Lookup(), ToolBar::mProject, mSelectionMode, NumericConverterType_TIME(), OnUpdate(), FormatterContext::ProjectContext(), audacity::BasicSettings::Read(), anonymous_namespace{SelectionBar.cpp}::ReadSelectionMode(), RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), wxT(), and XO().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateTimeControlsFormat()

void SelectionBar::UpdateTimeControlsFormat ( const NumericFormatID & format )

private

Definition at line 622 of file SelectionBar.cpp.

{
   for (size_t controlIndex = 0; controlIndex < mTimeControls.size();
        ++controlIndex)
   {
      auto ctrl = mTimeControls[controlIndex];
 
      if (ctrl == nullptr)
         continue;
 
      const auto type =
         TimeConverterType[static_cast<size_t>(mSelectionMode)][controlIndex];
 
      ctrl->SetTypeAndFormatName(
         type, type != NumericConverterType_DURATION() ?
            format :
            NumericConverterFormats::GetBestDurationFormat(format));
   }
}

References anonymous_namespace{ExportPCM.cpp}::format, NumericConverterFormats::GetBestDurationFormat(), mSelectionMode, mTimeControls, NumericConverterType_DURATION(), and anonymous_namespace{SelectionBar.cpp}::TimeConverterType.

Referenced by OnUpdate(), and SetSelectionMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ValuesToControls()

void SelectionBar::ValuesToControls ( )

private

Definition at line 537 of file SelectionBar.cpp.

{
   const double valuePairs[4][2] = {
      { mStart, mEnd },
      { mStart, mLength },
      { mLength, mEnd },
      { mLength, mCenter } };
 
   const auto value = valuePairs[static_cast<size_t>(mSelectionMode)];
 
   size_t i = 0;
   for (auto ctrl : mTimeControls)
   {
      if (ctrl != nullptr)
         ctrl->SetValue(value[i]);
 
      i++;
   }
}

References mCenter, mEnd, mLength, mSelectionMode, mStart, and mTimeControls.

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

Here is the caller graph for this function:

Member Data Documentation

◆ mCenter

double SelectionBar::mCenter

private

Definition at line 98 of file SelectionBar.h.

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

◆ mEnd

double SelectionBar::mEnd

private

Definition at line 98 of file SelectionBar.h.

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

◆ mFormatChangedToFitValueSubscription

Observer::Subscription SelectionBar::mFormatChangedToFitValueSubscription[2]

private

Definition at line 106 of file SelectionBar.h.

Referenced by AddTime().

◆ mFormatsSubscription

const Observer::Subscription SelectionBar::mFormatsSubscription

private

Definition at line 109 of file SelectionBar.h.

◆ mLastSelectionMode

SelectionMode SelectionBar::mLastSelectionMode {}

private

Definition at line 101 of file SelectionBar.h.

Referenced by SetTimes().

◆ mLastValidText

wxString SelectionBar::mLastValidText

private

Definition at line 108 of file SelectionBar.h.

◆ mLength

double SelectionBar::mLength

private

Definition at line 98 of file SelectionBar.h.

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

◆ mRate

double SelectionBar::mRate

private

Definition at line 97 of file SelectionBar.h.

Referenced by SelectionBar().

◆ mSelectionMode

SelectionMode SelectionBar::mSelectionMode {}

private

Definition at line 100 of file SelectionBar.h.

Referenced by AddSelectionSetupButton(), ModifySelection(), Populate(), SelectionBar(), SelectionModeUpdated(), SetSelectionMode(), SetTimes(), UpdatePrefs(), UpdateTimeControlsFormat(), and ValuesToControls().

◆ mSetupButton

AButton* SelectionBar::mSetupButton {}

private

Definition at line 104 of file SelectionBar.h.

Referenced by AddSelectionSetupButton(), and Populate().

◆ mStart

double SelectionBar::mStart

private

Definition at line 98 of file SelectionBar.h.

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

◆ mTimeControls

std::array<NumericTextCtrl*, 2> SelectionBar::mTimeControls {}

private

Definition at line 103 of file SelectionBar.h.

Referenced by AddTime(), ModifySelection(), OnUpdate(), Populate(), SetSelectionFormat(), SetSelectionMode(), UpdateTimeControlsFormat(), and ValuesToControls().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SelectionMode

Constructor & Destructor Documentation

◆ SelectionBar()

◆ ~SelectionBar()

Member Function Documentation

◆ AddSelectionSetupButton()

◆ AddTime()

◆ AddTitle()

◆ Create()

◆ DefaultDockID()

◆ EnableDisableButtons()

◆ FitToTimeControls()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ MakeSetupButton()

◆ ModifySelection()

◆ OnCaptureKey()

◆ OnFocus()

◆ OnFormatsChanged()

◆ OnIdle()

◆ OnSize()

◆ OnUpdate()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ SelectionModeUpdated()

◆ SetSelectionFormat()

◆ SetSelectionMode()

◆ SetTimes()

◆ ShownByDefault()

◆ UpdatePrefs()

◆ UpdateTimeControlsFormat()

◆ ValuesToControls()

Member Data Documentation

◆ mCenter

◆ mEnd

◆ mFormatChangedToFitValueSubscription

◆ mFormatsSubscription

◆ mLastSelectionMode

◆ mLastValidText

◆ mLength

◆ mRate

◆ mSelectionMode

◆ mSetupButton

◆ mStart

◆ mTimeControls