Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
CutCopyPasteToolBar Class Referencefinal

A ToolBar that has the cut, copy and paste buttons on it. More...

#include <CutCopyPasteToolBar.h>

Inheritance diagram for CutCopyPasteToolBar:
[legend]
Collaboration diagram for CutCopyPasteToolBar:
[legend]

Public Member Functions

 CutCopyPasteToolBar (AudacityProject &project)
 
virtual ~CutCopyPasteToolBar ()
 
bool ShownByDefault () const override
 Whether the toolbar should be shown by default. Default implementation returns true. More...
 
bool HideAfterReset () const override
 Default implementation returns false. More...
 
void Create (wxWindow *parent) override
 
void OnButton (wxCommandEvent &event)
 
void Populate () override
 
void Repaint (wxDC *WXUNUSED(dc)) override
 
void EnableDisableButtons () override
 
void UpdatePrefs () 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 ()
 
ToolDockGetDock ()
 
void SetPreferredNeighbors (Identifier left, Identifier top={})
 
void SetLabel (const TranslatableString &label)
 
virtual void SetDocked (ToolDock *dock, bool pushed)
 
std::pair< Identifier, IdentifierPreferredNeighbors () 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
 
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
 
wxTabTraversalWrapperoperator= (wxTabTraversalWrapper &&)=delete
 

Static Public Member Functions

static Identifier ID ()
 
- Static Public Member Functions inherited from ToolBar
static AButtonMakeButton (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 AButtonMakeButton (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 AddButton (teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, const TranslatableString &label, bool toggle=false)
 
void RegenerateTooltips () override
 

Private Attributes

ToolBarButtons mButtons
 
wxGridSizer * mToolSizer
 

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
AudacityProjectmProject
 
TranslatableString mLabel
 
Identifier mSection
 
int mIndex {0}
 

Detailed Description

A ToolBar that has the cut, copy and paste buttons on it.

This class, which is a child of Toolbar, creates the window containing interfaces to cut/copy/paste functions that are otherwise only available through menus. The window can be embedded within a normal project window, or within a ToolBarFrame.

All of the controls in this window were custom-written for Audacity - they are not native controls on any platform - however, it is intended that the images could be easily replaced to allow "skinning" or just customization to match the look and feel of each platform.

Definition at line 26 of file CutCopyPasteToolBar.h.

Constructor & Destructor Documentation

◆ CutCopyPasteToolBar()

CutCopyPasteToolBar::CutCopyPasteToolBar ( AudacityProject project)

Definition at line 98 of file CutCopyPasteToolBar.cpp.

99: ToolBar(project, XO("Cut/Copy/Paste"), ID())
101{
102}
@ TBNumButtons
constexpr int first_TB_ID
static const ToolBarButtons::ButtonList CutCopyPasteToolbarButtonList
XO("Cut/Copy/Paste")
static Identifier ID()
ToolBar(AudacityProject &project, const TranslatableString &label, const Identifier &section, bool resizable=false)
Definition: ToolBar.cpp:328

◆ ~CutCopyPasteToolBar()

CutCopyPasteToolBar::~CutCopyPasteToolBar ( )
virtual

Definition at line 104 of file CutCopyPasteToolBar.cpp.

105{
106}

Member Function Documentation

◆ AddButton()

void CutCopyPasteToolBar::AddButton ( teBmps  eEnabledUp,
teBmps  eEnabledDown,
teBmps  eDisabled,
int  id,
const TranslatableString label,
bool  toggle = false 
)
private

Definition at line 124 of file CutCopyPasteToolBar.cpp.

127{
128 auto r = mButtons.CreateButton(eEnabledUp, eEnabledDown, eDisabled, id, label, toggle);
129 mToolSizer->Add(r);
130}
TranslatableString label
Definition: TagsEditor.cpp:164
AButton * CreateButton(teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, const TranslatableString &label, bool toggle=false)

References ToolBarButtons::CreateButton(), label, mButtons, and mToolSizer.

Referenced by Populate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Create()

void CutCopyPasteToolBar::Create ( wxWindow *  parent)
overridevirtual

Reimplemented from ToolBar.

Definition at line 118 of file CutCopyPasteToolBar.cpp.

119{
120 ToolBar::Create(parent);
121 UpdatePrefs();
122}
virtual void Create(wxWindow *parent)
Definition: ToolBar.cpp:492

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

Here is the call graph for this function:

◆ EnableDisableButtons()

void CutCopyPasteToolBar::EnableDisableButtons ( )
overridevirtual

Implements ToolBar.

Definition at line 172 of file CutCopyPasteToolBar.cpp.

173{
175}
void EnableDisableButtons()

References ToolBarButtons::EnableDisableButtons(), and mButtons.

Here is the call graph for this function:

◆ HideAfterReset()

bool CutCopyPasteToolBar::HideAfterReset ( ) const
overridevirtual

Default implementation returns false.

Reimplemented from ToolBar.

Definition at line 113 of file CutCopyPasteToolBar.cpp.

114{
115 return true;
116}

◆ ID()

static Identifier CutCopyPasteToolBar::ID ( )
static

◆ OnButton()

void CutCopyPasteToolBar::OnButton ( wxCommandEvent &  event)

Definition at line 177 of file CutCopyPasteToolBar.cpp.

178{
179 mButtons.OnButton(event);
180}
void OnButton(wxCommandEvent &event)

References mButtons, and ToolBarButtons::OnButton().

Here is the call graph for this function:

◆ Populate()

void CutCopyPasteToolBar::Populate ( )
overridevirtual

Implements ToolBar.

Definition at line 132 of file CutCopyPasteToolBar.cpp.

133{
134 SetBackgroundColour( theTheme.Colour( clrMedium ) );
136
137 Add(mToolSizer = safenew wxGridSizer(2, 2, 1, 1));
138
139 /* Buttons */
140 // Tooltips match menu entries.
141 // We previously had longer tooltips which were not more clear.
142 AddButton(bmpCut, bmpCut, bmpCutDisabled, TBCutID,
143 XO("Cut"));
144 AddButton(bmpCopy, bmpCopy, bmpCopyDisabled, TBCopyID,
145 XO("Copy"));
146 AddButton(bmpPaste, bmpPaste, bmpPasteDisabled, TBPasteID,
147 XO("Paste"));
148 AddButton(bmpDelete, bmpDelete, bmpDeleteDisabled, TBDeleteID,
149 XO("Delete"));
150
152
154}
@ TBDeleteID
#define safenew
Definition: MemoryX.h:10
THEME_API Theme theTheme
Definition: Theme.cpp:82
void AddButton(teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, const TranslatableString &label, bool toggle=false)
void RegenerateTooltips() override
wxColour & Colour(int iIndex)
void SetEnabled(int id, bool state)
void Add(wxWindow *window, int proportion=0, int flag=wxALIGN_TOP, int border=0, wxObject *userData=NULL)
Definition: ToolBar.cpp:709
static void MakeButtonBackgroundsSmall()
Definition: ToolBar.cpp:837

References ToolBar::Add(), AddButton(), ThemeBase::Colour(), ToolBar::MakeButtonBackgroundsSmall(), mButtons, mToolSizer, RegenerateTooltips(), safenew, ToolBarButtons::SetEnabled(), TBCopyID, TBCutID, TBDeleteID, TBPasteID, theTheme, and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void CutCopyPasteToolBar::RegenerateTooltips ( )
overrideprivatevirtual

Implements ToolBar.

Definition at line 167 of file CutCopyPasteToolBar.cpp.

168{
170}

References mButtons, and ToolBarButtons::RegenerateTooltips().

Referenced by Populate(), and UpdatePrefs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Repaint()

void CutCopyPasteToolBar::Repaint ( wxDC *  WXUNUSEDdc)
inlineoverride

Definition at line 43 of file CutCopyPasteToolBar.h.

43{};

◆ ShownByDefault()

bool CutCopyPasteToolBar::ShownByDefault ( ) const
overridevirtual

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

Reimplemented from ToolBar.

Definition at line 108 of file CutCopyPasteToolBar.cpp.

109{
110 return false;
111}

◆ UpdatePrefs()

void CutCopyPasteToolBar::UpdatePrefs ( )
overridevirtual

Implements PrefsListener.

Definition at line 156 of file CutCopyPasteToolBar.cpp.

157{
159
160 // Set label to pull in language change
161 SetLabel(XO("Cut/Copy/Paste"));
162
163 // Give base class a chance
165}
void SetLabel(const wxString &label) override
Definition: ToolBar.cpp:408
void UpdatePrefs() override
Definition: ToolBar.cpp:622

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

◆ mButtons

ToolBarButtons CutCopyPasteToolBar::mButtons
private

◆ mToolSizer

wxGridSizer* CutCopyPasteToolBar::mToolSizer
private

Definition at line 56 of file CutCopyPasteToolBar.h.

Referenced by AddButton(), and Populate().


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