#include <ShareAudioToolbar.h>

Inheritance diagram for cloud::ShareAudioToolbar:

Collaboration diagram for cloud::ShareAudioToolbar:

Public Member Functions
	ShareAudioToolbar (AudacityProject &project)

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

static const ShareAudioToolbar &	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 Types
enum	{ ID_SHARE_AUDIO_BUTTON = 14000 , BUTTON_COUNT }

Private Member Functions
void	Create (wxWindow *parent) override

void	RegenerateTooltips () override

void	Populate () override

void	Repaint (wxDC *dc) override

void	EnableDisableButtons () override

void	ReCreateButtons () override

void	MakeShareAudioButton ()

void	ArrangeButtons ()

void	DestroySizer ()

Private Attributes
AButton *	mShareAudioButton {}

wxBoxSizer *	mSizer {}

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 19 of file ShareAudioToolbar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
ID_SHARE_AUDIO_BUTTON
BUTTON_COUNT

Definition at line 46 of file ShareAudioToolbar.h.

   {
      ID_SHARE_AUDIO_BUTTON = 14000,
      BUTTON_COUNT,
   };

Constructor & Destructor Documentation

◆ ShareAudioToolbar()

cloud::ShareAudioToolbar::ShareAudioToolbar ( AudacityProject & project )

explicit

Definition at line 43 of file ShareAudioToolbar.cpp.

    : ToolBar(project, XO("Share Audio"), ID())
{
}

◆ ~ShareAudioToolbar()

cloud::ShareAudioToolbar::~ShareAudioToolbar ( )

override

Definition at line 48 of file ShareAudioToolbar.cpp.

49{

50}

Member Function Documentation

◆ ArrangeButtons()

void cloud::ShareAudioToolbar::ArrangeButtons ( )

private

Definition at line 185 of file ShareAudioToolbar.cpp.

{
   // (Re)allocate the button sizer
   DestroySizer();
 
   Add((mSizer = safenew wxBoxSizer(wxHORIZONTAL)), 1, wxEXPAND);
   mSizer->Add(mShareAudioButton, 1, wxEXPAND);
 
   // Layout the sizer
   mSizer->Layout();
 
   // Layout the toolbar
   Layout();
 
   const auto height = 2 * toolbarSingle;
   SetMinSize({ std::max(76, GetSizer()->GetMinSize().GetWidth()), height });
   SetMaxSize({ -1, height });
}

References ToolBar::Add(), DestroySizer(), ToolBar::GetSizer(), mShareAudioButton, mSizer, safenew, and toolbarSingle.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void cloud::ShareAudioToolbar::Create ( wxWindow * parent )

overrideprivatevirtual

Reimplemented from ToolBar.

Definition at line 64 of file ShareAudioToolbar.cpp.

{
   ToolBar::Create(parent);
 
   // Simulate a size event to set initial meter placement/size
   wxSizeEvent event(GetSize(), GetId());
   event.SetEventObject(this);
   GetEventHandler()->ProcessEvent(event);
}

References ToolBar::Create().

Here is the call graph for this function:

◆ DestroySizer()

void cloud::ShareAudioToolbar::DestroySizer ( )

private

Definition at line 204 of file ShareAudioToolbar.cpp.

{
   if (mSizer == nullptr)
      return;
 
   Detach(mSizer);
 
   std::unique_ptr<wxSizer> { mSizer }; // DELETE it
   mSizer = nullptr;
}

References ToolBar::Detach(), and mSizer.

Referenced by ArrangeButtons(), and ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableDisableButtons()

void cloud::ShareAudioToolbar::EnableDisableButtons ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 124 of file ShareAudioToolbar.cpp.

{
   auto gAudioIO = AudioIOBase::Get();
 
   const bool audioStreamActive = gAudioIO &&
      gAudioIO->IsStreamActive() && !gAudioIO->IsMonitoring();
 
   bool hasAudio = false;
 
   for (const auto& track : TrackList::Get(mProject).Any<PlayableTrack>())
   {
      if (track->GetStartTime() != track->GetEndTime())
      {
         hasAudio = true;
         break;
      }
   }
 
   mShareAudioButton->SetEnabled(hasAudio && !audioStreamActive);
}

References AudioIOBase::Get(), TrackList::Get(), ToolBar::mProject, mShareAudioButton, and AButton::SetEnabled().

Referenced by ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

ShareAudioToolbar & cloud::ShareAudioToolbar::Get ( AudacityProject & project )

static

Definition at line 52 of file ShareAudioToolbar.cpp.

{
   auto& toolManager = ToolManager::Get(project);
   return *static_cast<ShareAudioToolbar*>(
      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 ShareAudioToolbar & cloud::ShareAudioToolbar::Get ( const AudacityProject & project )

static

Definition at line 59 of file ShareAudioToolbar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier cloud::ShareAudioToolbar::ID ( )

static

Definition at line 38 of file ShareAudioToolbar.cpp.

{
   return wxT("Share Audio");
}

References wxT().

Referenced by Get(), and RegenerateTooltips().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeShareAudioButton()

void cloud::ShareAudioToolbar::MakeShareAudioButton ( )

private

Definition at line 159 of file ShareAudioToolbar.cpp.

{
   mShareAudioButton = safenew AButton(this, ID_SHARE_AUDIO_BUTTON);
   //i18n-hint: Share audio button text, keep as short as possible
   mShareAudioButton->SetLabel(XO("Share Audio"));
   mShareAudioButton->SetButtonType(AButton::FrameButton);
   mShareAudioButton->SetImages(
      theTheme.Image(bmpRecoloredUpSmall),
      theTheme.Image(bmpRecoloredUpHiliteSmall),
      theTheme.Image(bmpRecoloredDownSmall),
      theTheme.Image(bmpRecoloredHiliteSmall),
      theTheme.Image(bmpRecoloredUpSmall));
   mShareAudioButton->SetIcon(theTheme.Image(bmpShareAudio));
   mShareAudioButton->SetForegroundColour(theTheme.Colour(clrTrackPanelText));
 
   mShareAudioButton->Bind(
      wxEVT_BUTTON,
      [this](auto)
      {
         audiocom::ShareAudioDialog dlg(mProject, &ProjectWindow::Get(mProject));
         dlg.ShowModal();
 
         mShareAudioButton->PopUp();
      });
}

References ThemeBase::Colour(), AButton::FrameButton, ProjectWindow::Get(), ID_SHARE_AUDIO_BUTTON, ThemeBase::Image(), ToolBar::mProject, mShareAudioButton, AButton::PopUp(), safenew, AButton::SetButtonType(), AButton::SetIcon(), AButton::SetImages(), AButton::SetLabel(), theTheme, and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void cloud::ShareAudioToolbar::Populate ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 97 of file ShareAudioToolbar.cpp.

{
   MakeButtonBackgroundsSmall();
   SetBackgroundColour(theTheme.Colour(clrMedium));
   MakeShareAudioButton();
 
#if wxUSE_TOOLTIPS
   RegenerateTooltips();
   wxToolTip::Enable(true);
   wxToolTip::SetDelay(1000);
#endif
 
   // Set default order and mode
   ArrangeButtons();
}

References ArrangeButtons(), ThemeBase::Colour(), ToolBar::MakeButtonBackgroundsSmall(), MakeShareAudioButton(), RegenerateTooltips(), and theTheme.

Here is the call graph for this function:

◆ ReCreateButtons()

void cloud::ShareAudioToolbar::ReCreateButtons ( )

overrideprivatevirtual

Reimplemented from ToolBar.

Definition at line 145 of file ShareAudioToolbar.cpp.

{
   // ToolBar::ReCreateButtons() will get rid of its sizer and
   // since we've attached our sizer to it, ours will get deleted too
   // so clean ours up first.
   DestroySizer();
 
   ToolBar::ReCreateButtons();
 
   EnableDisableButtons();
 
   RegenerateTooltips();
}

References DestroySizer(), EnableDisableButtons(), ToolBar::ReCreateButtons(), and RegenerateTooltips().

Here is the call graph for this function:

◆ RegenerateTooltips()

void cloud::ShareAudioToolbar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 74 of file ShareAudioToolbar.cpp.

{
#if wxUSE_TOOLTIPS
   for (long iWinID = ID_SHARE_AUDIO_BUTTON; iWinID < BUTTON_COUNT; iWinID++)
   {
      auto pCtrl = static_cast<AButton*>(this->FindWindow(iWinID));
      CommandID name;
      switch (iWinID)
      {
      case ID_SHARE_AUDIO_BUTTON:
         name = ID();
         break;
      }
 
      std::vector<ComponentInterfaceSymbol> commands(
         1u, { name, Verbatim(pCtrl->GetLabel()) });
 
      ToolBar::SetButtonToolTip(
         mProject, *pCtrl, commands.data(), commands.size());
   }
#endif
}

References BUTTON_COUNT, ID(), ID_SHARE_AUDIO_BUTTON, ToolBar::mProject, name, ToolBar::SetButtonToolTip(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), and Verbatim().

Referenced by Populate(), and ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void cloud::ShareAudioToolbar::Repaint ( wxDC * dc )

overrideprivatevirtual

Implements ToolBar.

Definition at line 113 of file ShareAudioToolbar.cpp.

{
#ifndef USE_AQUA_THEME
   const auto s = mSizer->GetSize();
   const auto p = mSizer->GetPosition();
 
   wxRect bevelRect(p.x, p.y, s.GetWidth() - 1, s.GetHeight() - 1);
   AColor::Bevel(*dc, true, bevelRect);
#endif
}

References AColor::Bevel(), and mSizer.

Here is the call graph for this function:

Member Data Documentation

◆ mShareAudioButton

AButton* cloud::ShareAudioToolbar::mShareAudioButton {}

private

Definition at line 43 of file ShareAudioToolbar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), and MakeShareAudioButton().

◆ mSizer

wxBoxSizer* cloud::ShareAudioToolbar::mSizer {}

private

Definition at line 44 of file ShareAudioToolbar.h.

Referenced by ArrangeButtons(), DestroySizer(), and Repaint().

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ShareAudioToolbar()

◆ ~ShareAudioToolbar()

Member Function Documentation

◆ ArrangeButtons()

◆ Create()

◆ DestroySizer()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ MakeShareAudioButton()

◆ Populate()

◆ ReCreateButtons()

◆ RegenerateTooltips()

◆ Repaint()

Member Data Documentation

◆ mShareAudioButton

◆ mSizer