#include <SnappingToolBar.h>

Inheritance diagram for SnappingToolBar:

Collaboration diagram for SnappingToolBar:

Public Member Functions
	SnappingToolBar (AudacityProject &project)

virtual	~SnappingToolBar ()

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

static const SnappingToolBar &	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	OnSnapModeChanged ()

Private Attributes
wxWeakRef< wxCheckBox >	mSnapModeCheckBox

wxWeakRef< wxComboCtrl >	mSnapToCombo

Observer::Subscription	mSnappingModeChangedSubscription

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 30 of file SnappingToolBar.h.

Constructor & Destructor Documentation

◆ SnappingToolBar()

SnappingToolBar::SnappingToolBar ( AudacityProject & project )

Definition at line 244 of file SnappingToolBar.cpp.

    : ToolBar(project, XO("Snapping"), ID())
    , mSnappingModeChangedSubscription(ProjectSnap::Get(mProject).Subscribe(
         [this](auto settings)
         {
            if (mSnapModeCheckBox)
               mSnapModeCheckBox->SetValue(
                  settings.newSnapMode != SnapMode::SNAP_OFF);
 
            if (mSnapToCombo)
               mSnapToCombo->Enable(settings.newSnapMode != SnapMode::SNAP_OFF);
         }))
{
#ifdef __WXGTK__
   const auto height = 2 * toolbarSingle;
   SetMinSize({ -1, height });
   SetMaxSize({ -1, height });
#endif
}

References mSnapModeCheckBox, mSnapToCombo, settings(), and SNAP_OFF.

Here is the call graph for this function:

◆ ~SnappingToolBar()

SnappingToolBar::~SnappingToolBar ( )

virtual

Definition at line 264 of file SnappingToolBar.cpp.

265{

266}

Member Function Documentation

◆ Create()

void SnappingToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 289 of file SnappingToolBar.cpp.

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

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

Here is the call graph for this function:

◆ DefaultDockID()

ToolBar::DockID SnappingToolBar::DefaultDockID ( ) const

overridevirtual

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

Reimplemented from ToolBar.

Definition at line 273 of file SnappingToolBar.cpp.

{
   return BotDockID;
}

References ToolBar::BotDockID.

◆ EnableDisableButtons()

void SnappingToolBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 48 of file SnappingToolBar.h.

48{};

◆ Get() [1/2]

SnappingToolBar & SnappingToolBar::Get ( AudacityProject & project )

static

Definition at line 278 of file SnappingToolBar.cpp.

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

static

Definition at line 284 of file SnappingToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier SnappingToolBar::ID ( )

static

Definition at line 239 of file SnappingToolBar.cpp.

{
   return wxT("Snapping");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSize()

void SnappingToolBar::OnSize ( wxSizeEvent & evt )

private

Definition at line 406 of file SnappingToolBar.cpp.

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

◆ OnSnapModeChanged()

void SnappingToolBar::OnSnapModeChanged ( )

private

Definition at line 413 of file SnappingToolBar.cpp.

{
   const bool snapEnabled = mSnapModeCheckBox->GetValue();
 
   ProjectSnap::Get(mProject).SetSnapMode(
      snapEnabled ? SnapMode::SNAP_NEAREST : SnapMode::SNAP_OFF);
 
   mSnapToCombo->Enable(snapEnabled);
 
 
   // wxEVT_KILL_FOCUS is not always sent by wxWidgets.
   // Remove any selection from the combo box if we've disabled it.
   if (!snapEnabled)
      mSnapToCombo->SelectNone();
}

References ProjectSnap::Get(), ToolBar::mProject, mSnapModeCheckBox, mSnapToCombo, ProjectSnap::SetSnapMode(), SNAP_NEAREST, and SNAP_OFF.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void SnappingToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 295 of file SnappingToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
 
   auto sizer = safenew wxFlexGridSizer(1, 1, 1);
   Add(sizer, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 5);
 
   auto boxSizer = safenew wxBoxSizer(wxHORIZONTAL);
 
   mSnapModeCheckBox = safenew wxCheckBox(this, wxID_ANY, {});
 
   mSnapModeCheckBox->SetName(SnapLabel.Stripped().Translation());
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mSnapModeCheckBox->SetAccessible(
      safenew WindowAccessible(mSnapModeCheckBox));
#endif
 
   auto snapLabelCtrl = safenew auStaticText(this, SnapLabel.Translation());
 
   boxSizer->Add(mSnapModeCheckBox, 0, wxEXPAND, 0);
   boxSizer->Add(snapLabelCtrl, 0, wxEXPAND, 0);
 
   sizer->Add(boxSizer, 0, wxBOTTOM | wxRIGHT | wxEXPAND, 5);
 
   const bool snapEnabled =
      ProjectSnap::Get(mProject).GetSnapMode() != SnapMode::SNAP_OFF;
 
   mSnapModeCheckBox->SetValue(snapEnabled);
 
 
   mSnapToCombo = safenew wxComboCtrl(
      this, wxID_ANY, {}, wxDefaultPosition, wxDefaultSize /*, wxCB_READONLY*/);
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mSnapToCombo->GetTextCtrl()->SetAccessible(
      safenew WindowAccessible(mSnapToCombo->GetTextCtrl()));
#endif
 
   //mSnapToCombo->SetEditable(false);
   mSnapToCombo->SetPopupControl(safenew SnapModePopup(mProject));
   /* i18n-hint: combo box is the type of the control/widget */
   mSnapToCombo->GetTextCtrl()->SetName(XO("Snap to combo box").Translation());
   /* Narrator screen reader by default reads the accessibility name of the
   containing window, which by default is combobox, so set it to an empty string. */
   mSnapToCombo->SetLabel(wxT(""));
   mSnapToCombo->Enable(snapEnabled);
   mSnapToCombo->SetMinSize(wxSize(150, -1));
 
   sizer->Add(mSnapToCombo, 1, wxRIGHT | wxEXPAND, 5);
 
   mSnapModeCheckBox->Bind(
      wxEVT_CHECKBOX, [this](auto&) { OnSnapModeChanged(); });
 
   mSnapModeCheckBox->Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         const auto keyCode = evt.GetKeyCode();
 
         if (keyCode != WXK_NUMPAD_ENTER && keyCode != WXK_RETURN)
         {
            evt.Skip();
            return;
         }
 
         mSnapModeCheckBox->SetValue(!mSnapModeCheckBox->GetValue());
 
         OnSnapModeChanged();
      });
 
   mSnapModeCheckBox->Bind(
      wxEVT_SET_FOCUS,
      [snapLabelCtrl](auto&) { snapLabelCtrl->SetSelected(true); });
 
   mSnapModeCheckBox->Bind(
      wxEVT_KILL_FOCUS,
      [snapLabelCtrl](auto&) { snapLabelCtrl->SetSelected(false); });
 
   // When the focus is lost, clear out any text selection.
   // See https://github.com/audacity/audacity/issues/4427
   mSnapToCombo->Bind(
      wxEVT_KILL_FOCUS, [this](auto&) { mSnapToCombo->SelectNone(); });
 
   snapLabelCtrl->Bind(
      wxEVT_LEFT_UP,
      [this](auto&)
      {
         mSnapModeCheckBox->SetValue(!mSnapModeCheckBox->GetValue());
         OnSnapModeChanged();
      });
 
   RegenerateTooltips();
   Fit();
   Layout();
}

References ToolBar::Add(), ThemeBase::Colour(), ProjectSnap::Get(), ProjectSnap::GetSnapMode(), ToolBar::mProject, mSnapModeCheckBox, mSnapToCombo, OnSnapModeChanged(), RegenerateTooltips(), safenew, SNAP_OFF, anonymous_namespace{SnappingToolBar.cpp}::SnapLabel, TranslatableString::Stripped(), theTheme, TranslatableString::Translation(), wxT(), and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void SnappingToolBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 402 of file SnappingToolBar.cpp.

403{

404}

Referenced by Populate(), and UpdatePrefs().

Here is the caller graph for this function:

◆ Repaint()

void SnappingToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 47 of file SnappingToolBar.h.

47{};

◆ ShownByDefault()

bool SnappingToolBar::ShownByDefault ( ) const

overridevirtual

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

Reimplemented from ToolBar.

Definition at line 268 of file SnappingToolBar.cpp.

{
   return true;
}

◆ UpdatePrefs()

void SnappingToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 392 of file SnappingToolBar.cpp.

{
   // Set label to pull in language change
   SetLabel(XO("Snapping"));
 
   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

◆ mSnapModeCheckBox

wxWeakRef<wxCheckBox> SnappingToolBar::mSnapModeCheckBox

private

Definition at line 57 of file SnappingToolBar.h.

Referenced by OnSnapModeChanged(), Populate(), and SnappingToolBar().

◆ mSnappingModeChangedSubscription

Observer::Subscription SnappingToolBar::mSnappingModeChangedSubscription

private

Definition at line 60 of file SnappingToolBar.h.

◆ mSnapToCombo

wxWeakRef<wxComboCtrl> SnappingToolBar::mSnapToCombo

private

Definition at line 58 of file SnappingToolBar.h.

Referenced by OnSnapModeChanged(), Populate(), and SnappingToolBar().

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

◆ SnappingToolBar()

◆ ~SnappingToolBar()

Member Function Documentation

◆ Create()

◆ DefaultDockID()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ OnSize()

◆ OnSnapModeChanged()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ ShownByDefault()

◆ UpdatePrefs()

Member Data Documentation

◆ mSnapModeCheckBox

◆ mSnappingModeChangedSubscription

◆ mSnapToCombo