#include <TimeSignatureToolBar.h>

Inheritance diagram for TimeSignatureToolBar:

Collaboration diagram for TimeSignatureToolBar:

Public Member Functions
	TimeSignatureToolBar (AudacityProject &project)

virtual	~TimeSignatureToolBar ()

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	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 TimeSignatureToolBar &	Get (AudacityProject &project)

static const TimeSignatureToolBar &	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
void	OnSize (wxSizeEvent &evt)

void	OnAudioIOEvent (const AudioIOEvent &event)

void	AddTitle (const TranslatableString &Title, wxSizer *pSizer, int flags=wxEXPAND\|wxRIGHT, int border=5, double fontMultiplier=1.0)

Private Attributes
Observer::Subscription	mTimeSignatureChangedSubscription

Observer::Subscription	mPlaybackStateChangedSubscription

wxWeakRef< SpinControl >	mTempoControl

wxWeakRef< SpinControl >	mUpperSignatureControl

wxWeakRef< wxComboBox >	mLowerSignatureControl

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

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

Definition at line 32 of file TimeSignatureToolBar.h.

Constructor & Destructor Documentation

◆ TimeSignatureToolBar()

TimeSignatureToolBar::TimeSignatureToolBar ( AudacityProject & project )

Definition at line 57 of file TimeSignatureToolBar.cpp.

    : ToolBar(project, XO("Time Signature"), ID())
    , mTimeSignatureChangedSubscription(ProjectTimeSignature::Get(mProject).Subscribe(
            [this](auto settings)
            {
               if (mTempoControl)
                  mTempoControl->SetValue(settings.newTempo);
 
               if (mUpperSignatureControl)
                  mUpperSignatureControl->SetValue(
                     settings.newUpperTimeSignature);
 
               if (mLowerSignatureControl)
                  mLowerSignatureControl->SetValue(
                     wxString::Format("%d", settings.newLowerTimeSignature));
            }))
    , mPlaybackStateChangedSubscription(AudioIO::Get()->Subscribe(*this, &TimeSignatureToolBar::OnAudioIOEvent))
{
}

References mLowerSignatureControl, mTempoControl, mUpperSignatureControl, and settings().

Here is the call graph for this function:

◆ ~TimeSignatureToolBar()

TimeSignatureToolBar::~TimeSignatureToolBar ( )

virtualdefault

Member Function Documentation

◆ AddTitle()

void TimeSignatureToolBar::AddTitle	(	const TranslatableString &	Title,
		wxSizer *	pSizer,
		int	flags = `wxEXPAND \| wxRIGHT`,
		int	border = `5`,
		double	fontMultiplier = `1.0`
	)

private

Definition at line 252 of file TimeSignatureToolBar.cpp.

{
   const auto translated = Title.Translation();
 
   auStaticText* pTitle = safenew auStaticText(this, translated);
 
   pTitle->SetBackgroundColour(theTheme.Colour(clrMedium));
   pTitle->SetForegroundColour(theTheme.Colour(clrTrackPanelText));
   pTitle->ScaleFont(fontMultiplier);
 
   pSizer->Add(pTitle, 0, flags, border);
}

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

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void TimeSignatureToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 100 of file TimeSignatureToolBar.cpp.

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

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

Here is the call graph for this function:

◆ DefaultDockID()

ToolBar::DockID TimeSignatureToolBar::DefaultDockID ( ) const

overridevirtual

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

Reimplemented from ToolBar.

Definition at line 84 of file TimeSignatureToolBar.cpp.

{
   return BotDockID;
}

References ToolBar::BotDockID.

◆ EnableDisableButtons()

void TimeSignatureToolBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 51 of file TimeSignatureToolBar.h.

51{};

◆ Get() [1/2]

TimeSignatureToolBar & TimeSignatureToolBar::Get ( AudacityProject & project )

static

Definition at line 89 of file TimeSignatureToolBar.cpp.

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

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

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 95 of file TimeSignatureToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier TimeSignatureToolBar::ID ( )

static

Definition at line 52 of file TimeSignatureToolBar.cpp.

{
   return wxT("TimeSignature");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnAudioIOEvent()

void TimeSignatureToolBar::OnAudioIOEvent ( const AudioIOEvent & event )

private

Definition at line 237 of file TimeSignatureToolBar.cpp.

{
   switch(event.type)
   {
   case AudioIOEvent::PLAYBACK:
   case AudioIOEvent::CAPTURE:
      {
         if(mTempoControl)
            mTempoControl->Enable(!event.on);
      } break;
   default: break;
   }
}

References AudioIOEvent::CAPTURE, mTempoControl, AudioIOEvent::on, AudioIOEvent::PLAYBACK, and AudioIOEvent::type.

◆ OnSize()

void TimeSignatureToolBar::OnSize ( wxSizeEvent & evt )

private

Definition at line 230 of file TimeSignatureToolBar.cpp.

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

◆ Populate()

void TimeSignatureToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 106 of file TimeSignatureToolBar.cpp.

{
#ifndef __WXGTK__
   const auto tempoSigSize = wxSize(60, -1);
   auto timeSigSize = wxSize(50, -1);
#else
   const auto tempoSigSize = wxSize(60, -1);
   auto timeSigSize = wxSize(60, -1);
#endif
 
   auto& projectTimeSignature = ProjectTimeSignature::Get(mProject);
 
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
 
   auto sizer = safenew wxFlexGridSizer(2, 5, 1);
   Add(sizer, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 5);
 
   AddTitle(XO("Tempo"), sizer);
   AddTitle(XO("Time Signature"), sizer);
 
   mTempoControl = safenew SpinControl(
      this, wxID_ANY, projectTimeSignature.GetTempo(), 1.0, 999.0, 1.0, true,
      wxDefaultPosition, tempoSigSize);
 
   mTempoControl->SetName(XO("Tempo"));
 
   sizer->Add(mTempoControl, 0, wxEXPAND | wxRIGHT, 5);
 
   auto tempoSizer = safenew wxBoxSizer(wxHORIZONTAL);
   sizer->Add(tempoSizer, 0, wxEXPAND | wxRIGHT, 5);
 
   mUpperSignatureControl = safenew SpinControl(
      this, wxID_ANY, projectTimeSignature.GetUpperTimeSignature(), 1.0, 128.0, 1.0, false,
      wxDefaultPosition, timeSigSize);
 
   mUpperSignatureControl->SetName(XO("Upper Time Signature"));
 
   tempoSizer->Add(mUpperSignatureControl, 0, wxEXPAND | wxRIGHT, 5);
 
   AddTitle(
      Verbatim(L"/"), tempoSizer, wxALIGN_CENTER_VERTICAL | wxRIGHT, 5, 1.5);
 
   timeSigSize.y = mUpperSignatureControl->GetSize().y;
 
   mLowerSignatureControl = safenew wxComboBox(
      this, wxID_ANY,
      wxString::Format(
         "%d", ProjectTimeSignature::Get(mProject).GetLowerTimeSignature()),
      wxDefaultPosition, timeSigSize,
      wxArrayStringEx { L"2", L"4", L"8", L"16", L"32", L"64" },
      wxCB_READONLY);
 
   mLowerSignatureControl->SetName(XO("Lower Time Signature").Translation());
 
   tempoSizer->Add(mLowerSignatureControl, 0, wxEXPAND | wxRIGHT, 5);
 
   mTempoControl->Bind(
      wxEVT_SPINCTRL,
      [this](auto)
      {
         const auto tempo = mTempoControl->GetValue();
 
         ProjectTimeSignature::Get(mProject).SetTempo(tempo);
 
         ProjectHistory::Get(mProject).PushState(
            XO("Tempo Changed"), XO("Tempo Changed"), UndoPush::CONSOLIDATE);
      });
 
   mUpperSignatureControl->Bind(
      wxEVT_SPINCTRL,
      [this](auto)
      {
         const auto upper = int(mUpperSignatureControl->GetValue());
 
         ProjectTimeSignature::Get(mProject).SetUpperTimeSignature(upper);
 
         ProjectHistory::Get(mProject).PushState(
            XO("Upper Time Signature Changed"),
            XO("Upper Time Signature Changed"), UndoPush::CONSOLIDATE);
      });
 
   mLowerSignatureControl->Bind(
      wxEVT_COMBOBOX,
      [this](auto)
      {
         long value;
 
         if (!mLowerSignatureControl->GetValue().ToLong(&value))
            return;
 
         ProjectTimeSignature::Get(mProject).SetLowerTimeSignature(value);
 
         ProjectHistory::Get(mProject).PushState(
            XO("Lower Time Signature Changed"),
            XO("Lower Time Signature Changed"), UndoPush::CONSOLIDATE);
      });
 
#if wxUSE_ACCESSIBILITY
   mTempoControl->SetAccessible(safenew WindowAccessible(mTempoControl));
   mUpperSignatureControl->SetAccessible(
      safenew WindowAccessible(mUpperSignatureControl));
   mLowerSignatureControl->SetAccessible(
      safenew WindowAccessible(mLowerSignatureControl));
#endif
 
   RegenerateTooltips();
   Fit();
   Layout();
}

References ToolBar::Add(), AddTitle(), ThemeBase::Colour(), CONSOLIDATE, ProjectTimeSignature::Get(), ProjectHistory::Get(), mLowerSignatureControl, ToolBar::mProject, mTempoControl, mUpperSignatureControl, ProjectHistory::PushState(), RegenerateTooltips(), safenew, ProjectTimeSignature::SetLowerTimeSignature(), ProjectTimeSignature::SetTempo(), ProjectTimeSignature::SetUpperTimeSignature(), theTheme, Verbatim(), and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void TimeSignatureToolBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 226 of file TimeSignatureToolBar.cpp.

227{

228}

Referenced by Populate(), and UpdatePrefs().

Here is the caller graph for this function:

◆ Repaint()

void TimeSignatureToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 50 of file TimeSignatureToolBar.h.

50{};

◆ ShownByDefault()

bool TimeSignatureToolBar::ShownByDefault ( ) const

overridevirtual

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

Reimplemented from ToolBar.

Definition at line 79 of file TimeSignatureToolBar.cpp.

{
   return true;
}

◆ UpdatePrefs()

void TimeSignatureToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 216 of file TimeSignatureToolBar.cpp.

{
   // Set label to pull in language change
   SetLabel(XO("Time Signature"));
 
   RegenerateTooltips();
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), and XO().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mLowerSignatureControl

wxWeakRef<wxComboBox> TimeSignatureToolBar::mLowerSignatureControl

private

Definition at line 71 of file TimeSignatureToolBar.h.

Referenced by Populate(), and TimeSignatureToolBar().

◆ mPlaybackStateChangedSubscription

Observer::Subscription TimeSignatureToolBar::mPlaybackStateChangedSubscription

private

Definition at line 67 of file TimeSignatureToolBar.h.

◆ mTempoControl

wxWeakRef<SpinControl> TimeSignatureToolBar::mTempoControl

private

Definition at line 69 of file TimeSignatureToolBar.h.

Referenced by OnAudioIOEvent(), Populate(), and TimeSignatureToolBar().

◆ mTimeSignatureChangedSubscription

Observer::Subscription TimeSignatureToolBar::mTimeSignatureChangedSubscription

private

Definition at line 66 of file TimeSignatureToolBar.h.

◆ mUpperSignatureControl

wxWeakRef<SpinControl> TimeSignatureToolBar::mUpperSignatureControl

private

Definition at line 70 of file TimeSignatureToolBar.h.

Referenced by Populate(), and TimeSignatureToolBar().

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

◆ TimeSignatureToolBar()

◆ ~TimeSignatureToolBar()

Member Function Documentation

◆ AddTitle()

◆ Create()

◆ DefaultDockID()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ OnAudioIOEvent()

◆ OnSize()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ ShownByDefault()

◆ UpdatePrefs()

Member Data Documentation

◆ mLowerSignatureControl

◆ mPlaybackStateChangedSubscription

◆ mTempoControl

◆ mTimeSignatureChangedSubscription

◆ mUpperSignatureControl