Audacity 3.2.0
ToolManager.cpp
Go to the documentation of this file.
1/**********************************************************************
2
3 Audacity: A Digital Audio Editor
4
5 ToolManager.cpp
6
7 Dominic Mazzoni
8 Shane T. Mueller
9 Leland Lucius
10
11 See ToolManager.h for details.
12
13*******************************************************************//*******************************************************************//**********************************************************************/
26
27
28#include "ToolManager.h"
29
30#include "CommandContext.h"
31
32// For compilers that support precompilation, includes "wx/wx.h".
33#include <wx/wxprec.h>
34
35#ifndef WX_PRECOMP
36#include <wx/dcclient.h>
37#include <wx/defs.h>
38#include <wx/frame.h>
39#include <wx/gdicmn.h>
40#include <wx/region.h>
41#include <wx/settings.h>
42#include <wx/sizer.h>
43#include <wx/sysopt.h>
44#include <wx/utils.h>
45#include <wx/window.h>
46#endif /* */
47
48#include <wx/minifram.h>
49#include <wx/popupwin.h>
50
51#include "AColor.h"
52#include "AllThemeResources.h"
53#include "CommandManager.h"
54#include "ImageManipulation.h"
55#include "Prefs.h"
56#include "Project.h"
57#include "ProjectWindows.h"
58#include "SyncLock.h"
59#include "widgets/AButton.h"
60#include "widgets/ASlider.h"
62#include "widgets/Grabber.h"
63
67#define sizerW 11
68
69//
70// Constructor
71//
73 ( AudacityProject *parent, ToolManager *manager, ToolBar *bar, wxPoint pos )
74 : wxFrame( FindProjectFrame( parent ),
75 bar->GetId(),
76 wxEmptyString,
77 pos,
78 wxDefaultSize,
79 wxNO_BORDER |
80 wxFRAME_NO_TASKBAR |
81#if !defined(__WXMAC__) // bug1358
82 wxFRAME_TOOL_WINDOW |
83#endif
84 wxFRAME_FLOAT_ON_PARENT )
85 , mParent{ parent }
86{
87 int width = bar->GetSize().x;
88 int border = 1;
89
90 // Save parameters
92 mBar = bar;
93
94 // Transfer the bar to the ferry
95 bar->Reparent(this);
96
97 // Bug 2120 (comment 6 residual): No need to set a minimum size
98 // if the toolbar is not resizable. On GTK, setting a minimum
99 // size will prevent the frame from shrinking if the toolbar gets
100 // reconfigured and needs to resize smaller.
101 if (bar->IsResizable())
102 {
103 SetMinSize(bar->GetDockedSize());
104 }
105
106 {
107 // We use a sizer to maintain proper spacing
108 auto s = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
109
110 // Add the bar to the sizer
111 s->Add(bar, 1, wxEXPAND | wxALL, border);
112
113 // Add space for the resize grabber
114 if (bar->IsResizable())
115 {
116 s->Add(sizerW, 1);
117 width += sizerW;
118 }
119
120 SetSize(width + 2 * ToolBarFloatMargin,
121 bar->GetDockedSize().y + 2 * ToolBarFloatMargin);
122
123 // Attach the sizer and resize the window to fit
124 SetSizer(s.release());
125 }
126
127 Layout();
128
129 // Inform toolbar of change
130 bar->SetDocked( NULL, true );
131
132 // Make sure resizable floaters don't get any smaller than initial size
133 if( bar->IsResizable() )
134 {
135 // Calc the minimum size of the frame
136 mMinSize = bar->GetMinSize() + ( GetSize() - bar->GetSize() );
137 }
138}
139
141{
142 if(HasCapture())
143 ReleaseMouse();
144}
145
147{
148 // Pass it on to the manager since it isn't in the handling hierarchy
149 mManager->ProcessEvent( event );
150}
151
152// The current size determines the min size for resizing...
153// the 'lock in' is at that aspect ratio.
155{
156 mBar = pBar;
157
158 wxSize sz = mBar->GetSize();
159 SetClientSize( sz );
160 int yDesiredMin = 26;
161 int y = sz.GetHeight();
162 if (y > yDesiredMin) {
163 sz.SetWidth((sz.GetWidth() * yDesiredMin) / y);
164 sz.SetHeight( yDesiredMin );
165 }
166 mMinSize = sz -wxSize( 10, 0);
167}
168
169void ToolFrame::OnToolBarUpdate( wxCommandEvent & event )
170{
171 // Resize floater window to exactly contain toolbar
172 // use actual size rather than minimum size.
173 if (mBar)
174 mBar->GetParent()->SetClientSize( mBar->GetSize() );// ->GetMinSize() );
175
176 // Allow it to propagate to our parent
177 event.Skip();
178}
179
180void ToolFrame::OnPaint( wxPaintEvent & WXUNUSED(event) )
181{
182 wxPaintDC dc( this );
183 wxSize sz = GetSize();
184 wxRect r;
185
186 dc.SetPen( theTheme.Colour( clrTrackPanelText ) );
187 dc.SetBackground( wxBrush( theTheme.Colour( clrMedium ) ) );
188 dc.Clear();
189 dc.SetBrush( *wxTRANSPARENT_BRUSH );
190 dc.DrawRectangle( 0, 0, sz.GetWidth(), sz.GetHeight() );
191
192 if( mBar && mBar->IsResizable() )
193 {
194 r.x = sz.x - sizerW - 2,
195 r.y = sz.y - sizerW - 2;
196 r.width = sizerW + 2;
197 r.height = sizerW + 2;
198
199 AColor::Line(dc, r.GetLeft(), r.GetBottom(), r.GetRight(), r.GetTop() );
200 AColor::Line(dc, r.GetLeft() + 3, r.GetBottom(), r.GetRight(), r.GetTop() + 3 );
201 AColor::Line(dc, r.GetLeft() + 6, r.GetBottom(), r.GetRight(), r.GetTop() + 6 );
202 AColor::Line(dc, r.GetLeft() + 9, r.GetBottom(), r.GetRight(), r.GetTop() + 9 );
203 }
204
205}
206
207void ToolFrame::OnMotion( wxMouseEvent & event )
208{
209 // Don't do anything if we're docked or not resizeable
210 if( !mBar || mBar->IsDocked() || !mBar->IsResizable() )
211 {
212 return;
213 }
214
215 // Retrieve the mouse position
216 wxPoint pos = ClientToScreen( event.GetPosition() );
217 if( HasCapture() && event.Dragging() )
218 {
219 wxRect rect = GetRect();
220
221 rect.SetBottomRight( pos );
222
223 // Keep it within max size, if specified
224 wxSize maxsz = mBar->GetMaxSize();
225 if (maxsz != wxDefaultSize)
226 {
227 if (maxsz.x != wxDefaultCoord && rect.width > maxsz.x)
228 {
229 rect.width = maxsz.x;
230 }
231 if (maxsz.y != wxDefaultCoord && rect.height > maxsz.y)
232 {
233 rect.height = maxsz.y;
234 }
235 }
236
237 if( rect.width < mMinSize.x )
238 {
239 rect.width = mMinSize.x;
240 }
241
242 if( rect.height < mMinSize.y )
243 {
244 rect.height = mMinSize.y;
245 }
246
247 Resize( rect.GetSize() );
248 }
249 else if( HasCapture() && event.LeftUp() )
250 {
251 ReleaseMouse();
252 }
253 else if( !HasCapture() )
254 {
255 wxRect rect = GetRect();
256 wxRect r;
257
258 r.x = rect.GetRight() - sizerW - 2,
259 r.y = rect.GetBottom() - sizerW - 2;
260 r.width = sizerW + 2;
261 r.height = sizerW + 2;
262
263 // Is left click within resize grabber?
264 if( r.Contains( pos ) && !event.Leaving() )
265 {
266 mOrigSize = GetSize();
267
268 SetCursor( wxCURSOR_SIZENWSE );
269 if( event.LeftDown() )
270 {
271 CaptureMouse();
272 }
273 }
274 else
275 {
276 SetCursor( wxCURSOR_ARROW );
277 }
278 }
279}
280
281void ToolFrame::OnCaptureLost( wxMouseCaptureLostEvent & WXUNUSED(event) )
282{
283 if( HasCapture() )
284 {
285 ReleaseMouse();
286 }
287}
288
289void ToolFrame::OnClose( wxCloseEvent & event )
290{
291 event.Veto();
292}
293
294void ToolFrame::OnKeyDown( wxKeyEvent &event )
295{
296 event.Skip();
297 if( HasCapture() && event.GetKeyCode() == WXK_ESCAPE ) {
298 Resize( mOrigSize );
299 ReleaseMouse();
300 }
301}
302
303void ToolFrame::Resize( const wxSize &size )
304{
305 SetMinSize( size );
306 SetSize( size );
307 Layout();
308 Refresh( false );
309}
310
312
313BEGIN_EVENT_TABLE( ToolFrame, wxFrame )
315 EVT_PAINT( ToolFrame::OnPaint )
316 EVT_MOUSE_EVENTS( ToolFrame::OnMotion )
317 EVT_MOUSE_CAPTURE_LOST( ToolFrame::OnCaptureLost )
318 EVT_CLOSE( ToolFrame::OnClose )
319 EVT_COMMAND( wxID_ANY, EVT_TOOLBAR_UPDATED, ToolFrame::OnToolBarUpdate )
320 EVT_KEY_DOWN( ToolFrame::OnKeyDown )
322
324
328
329BEGIN_EVENT_TABLE( ToolManager, wxEvtHandler )
330 EVT_GRABBER( wxID_ANY, ToolManager::OnGrabber )
331 EVT_TIMER( wxID_ANY, ToolManager::OnTimer )
333
334static const AudacityProject::AttachedObjects::RegisteredFactory key{
335 []( AudacityProject &parent ){
336 return std::make_shared< ToolManager >( &parent ); }
337};
338
340{
341 return project.AttachedObjects::Get< ToolManager >( key );
342}
343
345{
346 return Get( const_cast< AudacityProject & >( project ) );
347}
348
349//
350// Constructor
351//
353: wxEvtHandler()
354{
355 wxPoint pt[ 3 ];
356
357#if defined(__WXMAC__)
358 // Save original transition
359 mTransition = wxSystemOptions::GetOptionInt( wxMAC_WINDOW_PLAIN_TRANSITION );
360#endif
361
362 // Initialize everything
363 mParent = parent;
364 mLastPos.x = mBarPos.x = -1;
365 mLastPos.y = mBarPos.y = -1;
366 mDragWindow = NULL;
367 mDragDock = NULL;
368 mDragBar = NULL;
369
370 // Create the down arrow
371 pt[ 0 ].x = 0;
372 pt[ 0 ].y = 0;
373 pt[ 1 ].x = 9;
374 pt[ 1 ].y = 9;
375 pt[ 2 ].x = 18;
376 pt[ 2 ].y = 0;
377
378 // Create the shaped region
379 mDown = std::make_unique<wxRegion>( 3, &pt[0] );
380
381 // Create the down arrow
382 pt[ 0 ].x = 9;
383 pt[ 0 ].y = 0;
384 pt[ 1 ].x = 0;
385 pt[ 1 ].y = 9;
386 pt[ 2 ].x = 9;
387 pt[ 2 ].y = 18;
388
389 // Create the shaped region
390 mLeft = std::make_unique<wxRegion>( 3, &pt[0] );
391
392 // Create the indicator frame
393 // parent is null but FramePtr ensures destruction
394 mIndicator = FramePtr{ safenew wxFrame( NULL,
395 wxID_ANY,
396 wxEmptyString,
397 wxDefaultPosition,
398 wxSize( 32, 32 ),
399 wxFRAME_TOOL_WINDOW |
400 wxFRAME_SHAPED |
401 wxNO_BORDER |
402 wxFRAME_NO_TASKBAR |
403 wxSTAY_ON_TOP )
404 };
405
406 // Hook the creation event...only needed on GTK, but doesn't hurt for all
407 mIndicator->Bind( wxEVT_CREATE,
409 this );
410
411 // Hook the paint event...needed for all
412 mIndicator->Bind( wxEVT_PAINT,
414 this );
415
416 // It's a little shy
417 mIndicator->Hide();
418}
419
421{
422 auto parent = mParent;
423 auto &window = GetProjectFrame( *parent );
424
425 // Hook the parents mouse events...using the parent helps greatly
426 // under GTK
427 window.Bind( wxEVT_LEFT_UP,
429 this );
430 window.Bind( wxEVT_MOTION,
432 this );
433 window.Bind( wxEVT_MOUSE_CAPTURE_LOST,
435 this );
436
437 wxWindow *topDockParent = TopPanelHook::Call( window );
438 wxASSERT(topDockParent);
439
440 // Create the top and bottom docks
441 mTopDock = safenew ToolDock( this, topDockParent, TopDockID );
442 mBotDock = safenew ToolDock( this, &window, BotDockID );
443
444 // Create all of the toolbars
445 // All have the project as parent window
446 wxASSERT(parent);
447
448 for (const auto &factory : RegisteredToolbarFactory::GetFactories()) {
449 if (factory) {
450 auto bar = factory( *parent );
451 if (bar) {
452 auto &slot = mBars[bar->GetSection()];
453 if (slot) {
454 // Oh no, name collision of registered toolbars
455 assert(false);
456 bar->Destroy();
457 continue;
458 }
459 slot = std::move(bar);
460 }
461 }
462 else
463 wxASSERT( false );
464 }
465
467 ForEach([ii = 0](ToolBar *bar) mutable { bar->SetIndex(ii++); });
468
469 // We own the timer
470 mTimer.SetOwner( this );
471
472 // Process the toolbar config settings
473 ReadConfig();
474
475 wxEvtHandler::AddFilter(this);
476
479}
480
481//
482// Destructor
483//
484
486{
487 if ( mTopDock || mBotDock ) { // destroy at most once
488 wxEvtHandler::RemoveFilter(this);
489
490 // Save the toolbar states
491 WriteConfig();
492
493 // This function causes the toolbars to be destroyed, so
494 // clear the configuration of the ToolDocks which refer to
495 // these toolbars. This change was needed to stop Audacity
496 // crashing when running with Jaws on Windows 10 1703.
499
500 mTopDock = mBotDock = nullptr; // indicate that it has been destroyed
501
502 for (auto &pair : mBars)
503 pair.second.reset();
504
505 mIndicator.reset();
506 }
507}
508
510{
511 Destroy();
512}
513
514// This table describes the default configuration of the toolbars as
515// a "tree" and must be kept in pre-order traversal.
516
517// In fact this tree is more of a broom -- nothing properly branches except
518// at the root.
519
520// "Root" corresponds to left edge of the main window, and successive siblings
521// go from top to bottom. But in practice layout may wrap this abstract
522// configuration if the window size is narrow.
523
524static struct DefaultConfigEntry {
527 Identifier below; // preceding sibling
528} DefaultConfigTable [] = {
529 // Top dock row, may wrap
530 { wxT("Control"), {}, {} },
531 { wxT("Tools"), wxT("Control"), {} },
532 { wxT("Edit"), wxT("Tools"), {} },
533 { wxT("CutCopyPaste"), wxT("Edit"), {} },
534 { wxT("Audio Setup"), wxT("CutCopyPaste"), {} },
535#ifdef HAS_AUDIOCOM_UPLOAD
536 { wxT("Share Audio"), wxT("Audio Setup"), {} },
537 { wxT("RecordMeter"), wxT("Share Audio"), {} },
538#else
539 { wxT("RecordMeter"), wxT("Audio Setup"), {} },
540#endif
541 { wxT("PlayMeter"), wxT("RecordMeter"), {} },
542
543 // start another top dock row
544 { wxT("Device"), {}, wxT("Control") },
545
546 // Hidden by default in top dock
547 { wxT("CombinedMeter"), {}, {} },
548
549 // Bottom dock
550 { wxT("TimeSignature"), {}, {}, },
551 { wxT("Snapping"), wxT("TimeSignature"), {}, },
552 { wxT("Time"), wxT("Snapping"), {} },
553 { wxT("Selection"), wxT("Time"), {} },
554
555 { wxT("Transcription"), wxT("Selection"), {} },
556
557
558 // Hidden by default in bottom dock
559 { wxT("SpectralSelection"), {}, {} },
561
562// Static member function.
564{
565 auto &project = context.project;
566 auto &toolManager = ToolManager::Get( project );
567
568 toolManager.Reset();
570}
571
572
574{
575 // Disconnect all docked bars
576 for ( const auto &entry : DefaultConfigTable )
577 {
578 const auto &ndx = entry.barID;
579 ToolBar *bar = GetToolBar(ndx);
580 if (!bar)
581 continue;
582
584 (entry.rightOf == Identifier{}) ? nullptr : GetToolBar(entry.rightOf),
585 (entry.below == Identifier{}) ? nullptr : GetToolBar(entry.below)
586 };
587
588 bar->SetSize( 20,20 );
589
590 wxWindow *floater;
591 ToolDock *dock;
592 bool expose = true;
593
594 // Disconnect the bar
595 if( bar->IsDocked() )
596 {
597 bar->GetDock()->Undock( bar );
598 floater = NULL;
599 }
600 else
601 {
602 floater = bar->GetParent();
603 }
604
605 // Decide which dock.
606 dock = (bar->DefaultDockID() == ToolBar::TopDockID)
607 ? mTopDock : mBotDock;
608
609 // PRL: Destroy the tool frame before recreating buttons.
610 // This fixes some subtle sizing problems on macOs.
611 bar->Reparent( dock );
612 //OK (and good) to DELETE floater, as bar is no longer in it.
613 if( floater )
614 floater->Destroy();
615
616 // Recreate bar buttons (and resize it)
617 bar->SetToDefaultSize();
618 bar->ReCreateButtons();
620
621#if 0
622 if( bar->IsResizable() )
623 {
624 bar->SetSize(bar->GetBestFittingSize());
625 }
626#endif
627
628 // Hide some bars.
629 expose = bar->ShownByDefault() || bar->HideAfterReset();
630
631 // Next condition will always (?) be true, as the reset configuration is
632 // with no floating toolbars.
633 if( dock != NULL )
634 {
635 // when we dock, we reparent, so bar is no longer a child of floater.
636 dock->Dock( bar, false, position );
637 Expose( bar->GetSection(), expose );
638 }
639 else
640 {
641 // The (tool)bar has a dragger window round it, the floater.
642 // in turn floater will have mParent (the entire App) as its
643 // parent.
644
645 // Maybe construct a NEW floater
646 // this happens if we have just been bounced out of a dock.
647 if( floater == NULL ) {
648 wxASSERT(mParent);
649 floater = safenew ToolFrame( mParent, this, bar, wxPoint(-1,-1) );
650 bar->Reparent( floater );
651 }
652
653 // This bar is undocked and invisible.
654 // We are doing a reset toolbars, so even the invisible undocked bars should
655 // be moved somewhere sensible. Put bar near center of window.
656 // If there were multiple hidden toobars the * 10 adjustment means
657 // they won't overlap too much.
658 floater->CentreOnParent( );
659 const auto index = bar->GetIndex();
660 floater->Move(
661 floater->GetPosition() + wxSize{ index * 10 - 200, index * 10 });
662 bar->SetDocked( NULL, false );
663 Expose( bar->GetSection(), false );
664 }
665 }
666
667 ForEach([this](auto bar){
668 if (bar && bar->HideAfterReset())
669 Expose(bar->GetSection(), false);
670 });
671 // TODO:??
672 // If audio was playing, we stopped the VU meters,
673 // It would be nice to show them again, but hardly essential as
674 // they will show up again on the next play.
675 // SetVUMeters(AudacityProject *p);
676 Updated();
677}
678
680{
681 ForEach([](auto bar){
682 if (bar)
683 bar->RegenerateTooltips();
684 });
685}
686
687int ToolManager::FilterEvent(wxEvent &event)
688{
689 // Snoop the global event stream for changes of focused window. Remember
690 // the last one of our own that is not a grabber.
691
692 if (event.GetEventType() == wxEVT_KILL_FOCUS) {
693 auto &focusEvent = static_cast<wxFocusEvent&>(event);
694 auto window = focusEvent.GetWindow();
695 auto top = wxGetTopLevelParent(window);
696 if(auto toolFrame = dynamic_cast<ToolFrame*>(top))
697 top = toolFrame->GetParent();
698 // window is that which will GET the focus
699 if ( window &&
700 !dynamic_cast<Grabber*>( window ) &&
701 !dynamic_cast<ToolFrame*>( window ) &&
702 top == FindProjectFrame( mParent ) )
703 // Note this is a dangle-proof wxWindowRef:
704 mLastFocus = window;
705 }
706
707 return Event_Skip;
708}
709
710//
711// Read the toolbar states
712//
714{
715 std::vector<Identifier> unordered[ DockCount ];
716 std::vector<ToolBar*> dockedAndHidden;
717 std::map<Identifier, bool> show;
718 std::map<Identifier, int> width;
719 std::map<Identifier, int> height;
720 int x, y;
721 int dock;
722 bool someFound { false };
723
724#if defined(__WXMAC__)
725 // Disable window animation
726 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
727#endif
728
729 // Change to the bar root
730 auto toolbarsGroup = gPrefs->BeginGroup("/GUI/ToolBars");
731
732 ToolBarConfiguration::Legacy topLegacy, botLegacy;
733
734 int vMajor, vMinor, vMicro;
735 GetPreferencesVersion(vMajor, vMinor, vMicro);
736 bool useLegacyDock = false;
737 // note that vMajor, vMinor, and vMicro will all be zero if either it's a new audacity.cfg file
738 // or the version is less than 1.3.13 (when there were no version keys according to the comments in
739 // InitPreferences()). So for new audacity.cfg
740 // file useLegacyDock will be true, but this doesn't matter as there are no Dock or DockV2 keys in the file yet.
741 if (vMajor <= 1 ||
742 (vMajor == 2 && (vMinor <= 1 || (vMinor == 2 && vMicro <= 1)))) // version <= 2.2.1
743 useLegacyDock = true;
744
745
746 // Load and apply settings for each bar
747 ForEach([&](ToolBar *bar){
748 //wxPoint Center = mParent->GetPosition() + (mParent->GetSize() * 0.33);
749 //wxPoint Center(
750 // wxSystemSettings::GetMetric( wxSYS_SCREEN_X ) /2 ,
751 // wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) /2 );
752
753 // Change to the bar subkey
754 auto ndx = bar->GetSection();
755 auto barGroup = gPrefs->BeginGroup(ndx.GET());
756
757 const bool bShownByDefault = bar->ShownByDefault();
758 const int defaultDock = bar->DefaultDockID();
759
760 // Read in all the settings
761
762 if (useLegacyDock)
763 gPrefs->Read( wxT("Dock"), &dock, -1); // legacy version of DockV2
764 else
765 gPrefs->Read( wxT("DockV2"), &dock, -1);
766
767 const bool found = (dock != -1);
768 if (found)
769 someFound = true;
770 if (!found)
771 dock = defaultDock;
772
773 ToolDock *d;
775 switch(dock)
776 {
777 case TopDockID: d = mTopDock; pLegacy = &topLegacy; break;
778 case BotDockID: d = mBotDock; pLegacy = &botLegacy; break;
779 default: d = nullptr; pLegacy = nullptr; break;
780 }
781
782 bool ordered = ToolBarConfiguration::Read(
783 d ? &d->GetConfiguration() : nullptr,
784 pLegacy,
785 bar, show[ ndx ], bShownByDefault)
786 && found;
787
788 gPrefs->Read( wxT("X"), &x, -1 );
789 gPrefs->Read( wxT("Y"), &y, -1 );
790 gPrefs->Read( wxT("W"), &width[ ndx ], -1 );
791 gPrefs->Read( wxT("H"), &height[ ndx ], -1 );
792
793 bar->SetVisible( show[ ndx ] );
794
795 // Docked or floating?
796 if( dock )
797 {
798 // Default to top dock if the ID isn't valid
799 if( dock < NoDockID || dock > DockCount ) {
800 dock = TopDockID;
801 }
802
803 // Create the bar with the correct parent
804 if( dock == TopDockID )
805 {
806 bar->Create( mTopDock );
807 }
808 else
809 {
810 bar->Create( mBotDock );
811 }
812
813 // Set the width and height
814 if( width[ ndx ] != -1 && height[ ndx ] != -1 )
815 {
816 wxSize sz( width[ ndx ], height[ ndx ] );
817 bar->SetSize( sz );
818 bar->ResizingDone();
819 }
820
821 // Set the width
822 if( width[ ndx ] >= bar->GetSize().x )
823 {
824 wxSize sz( width[ ndx ], bar->GetSize().y );
825 bar->SetSize( sz );
826 bar->Layout();
827 }
828
829 // make a note of docked and hidden toolbars
830 if (!show[ndx])
831 dockedAndHidden.push_back(bar);
832
833 if (!ordered)
834 {
835 // These must go at the end
836 unordered[ dock - 1 ].push_back( ndx );
837 }
838 }
839 else
840 {
841 // Create the bar (with the top dock being temporary parent)
842 bar->Create( mTopDock );
843
844 // Construct a NEW floater
845 wxASSERT(mParent);
846 ToolFrame *f = safenew ToolFrame( mParent, this, bar, wxPoint( x, y ) );
847
848 // Set the width and height
849 if( width[ ndx ] != -1 && height[ ndx ] != -1 )
850 {
851 wxSize sz( width[ ndx ], height[ ndx ] );
852 f->SetSizeHints( sz );
853 f->SetSize( sz );
854 f->Layout();
855 if( (x!=-1) && (y!=-1) )
856 bar->SetPositioned();
857 }
858
859 // Required on Linux Xfce
860 wxSize msz(width[ndx],height[ndx]-1);
861 bar->GetParent()->SetMinSize(msz);
862
863 // Inform toolbar of change
864 bar->SetDocked( NULL, false );
865
866 // Show or hide it
867 Expose( bar->GetSection(), show[ ndx ] );
868 }
869 });
870
871 mTopDock->GetConfiguration().PostRead(topLegacy);
872 mBotDock->GetConfiguration().PostRead(botLegacy);
873
874 // Add all toolbars to their target dock
875 for( dock = 0; dock < DockCount; dock++ )
876 {
877 ToolDock *d = ( dock + 1 == TopDockID ? mTopDock : mBotDock );
878
879 d->LoadConfig();
880
881 // Add all unordered toolbars
882 for( int ord = 0; ord < (int) unordered[ dock ].size(); ord++ )
883 {
884 ToolBar *t = mBars[unordered[dock][ord]].get();
885
886 // Dock it
887 d->Dock( t, false );
888
889 // Show or hide the bar
890 Expose( t->GetSection(), show[ t->GetSection() ] );
891 }
892 }
893
894 // hidden docked toolbars
895 for (auto bar : dockedAndHidden) {
896 bar->SetVisible(false );
897 bar->GetDock()->Dock(bar, false);
898 bar->Expose(false);
899 }
900
901 toolbarsGroup.Reset();
902
903#if defined(__WXMAC__)
904 // Reinstate original transition
905 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
906#endif
907
908 // Setup the neighbors according to the
909 // default config
910
911 for (const auto& entry : DefaultConfigTable)
912 {
913 const auto &ndx = entry.barID;
914 const auto bar = GetToolBar(ndx);
915 bar->SetPreferredNeighbors(entry.rightOf, entry.below);
916 }
917
918 if (!someFound)
919 Reset();
920}
921
922//
923// Save the toolbar states
924//
926{
927 if( !gPrefs )
928 {
929 return;
930 }
931
932 auto toolbarsGroup = gPrefs->BeginGroup("/GUI/ToolBars");
933
934 // Save state of each bar
935 ForEach([this](ToolBar *bar){
936 // Change to the bar subkey
937 auto sectionGroup = gPrefs->BeginGroup(bar->GetSection().GET());
938
939 // Search both docks for toolbar order
940 bool to = mTopDock->GetConfiguration().Contains( bar );
941 bool bo = mBotDock->GetConfiguration().Contains( bar );
942
943 // Save
944 // Note that DockV2 was introduced in 2.2.2 to fix bug #1554. Dock is retained so that
945 // the toolbar layout is not changed when opening a version before 2.2.2, and in particular
946 // its value is compatible with versions 2.1.3 to 2.2.1 which have this bug.
947 ToolDock* dock = bar->GetDock(); // dock for both shown and hidden toolbars
948 gPrefs->Write( wxT("DockV2"), static_cast<int>(dock == mTopDock ? TopDockID : dock == mBotDock ? BotDockID : NoDockID ));
949
950 gPrefs->Write( wxT("Dock"), static_cast<int>( to ? TopDockID : bo ? BotDockID : NoDockID));
951
952 dock = to ? mTopDock : bo ? mBotDock : nullptr; // dock for shown toolbars
954 (dock ? &dock->GetConfiguration() : nullptr, bar);
955
956 wxPoint pos( -1, -1 );
957 wxSize sz = bar->GetSize();
958 if( !bar->IsDocked() && bar->IsPositioned() )
959 {
960 pos = bar->GetParent()->GetPosition();
961 sz = bar->GetParent()->GetSize();
962 }
963 gPrefs->Write( wxT("X"), pos.x );
964 gPrefs->Write( wxT("Y"), pos.y );
965 gPrefs->Write( wxT("W"), sz.x );
966 gPrefs->Write( wxT("H"), sz.y );
967 });
968 gPrefs->Flush();
969}
970
971//
972// Return a pointer to the specified toolbar or nullptr
973//
975{
976 auto end = mBars.end(), iter = mBars.find(type);
977 return (iter == end) ? nullptr : iter->second.get();
978}
979
980//
981// Return a pointer to the top dock
982//
984{
985 return mTopDock;
986}
987
989{
990 return mTopDock;
991}
992
993//
994// Return a pointer to the bottom dock
995//
997{
998 return mBotDock;
999}
1000
1002{
1003 return mBotDock;
1004}
1005
1006//
1007// Queues an EVT_TOOLBAR_UPDATED command event to notify any
1008// interest parties of an updated toolbar or dock layout
1009//
1011{
1012 // Queue an update event
1013 wxCommandEvent e( EVT_TOOLBAR_UPDATED );
1014 GetProjectFrame( *mParent ).GetEventHandler()->AddPendingEvent( e );
1015}
1016
1017//
1018// Return docked state of specified toolbar
1019//
1021{
1022 if (auto pBar = GetToolBar(type))
1023 return pBar->IsDocked();
1024 return false;
1025}
1026
1027//
1028// Returns the visibility of the specified toolbar
1029//
1031{
1032 if (auto pBar = GetToolBar(type))
1033 return pBar->IsVisible();
1034 return false;
1035
1036#if 0
1037 // If toolbar is floating
1038 if( !t->IsDocked() )
1039 {
1040 // Must return state of floater window
1041 return t->GetParent()->IsShown();
1042 }
1043
1044 // Return state of docked toolbar
1045 return t->IsShown();
1046#endif
1047}
1048
1049//
1050// Toggles the visible/hidden state of a toolbar
1051//
1053{
1054 Expose( type, !mBars[type]->IsVisible() );
1055 Updated();
1056}
1057
1058//
1059// Set the visible/hidden state of a toolbar
1060//
1061void ToolManager::Expose( Identifier type, bool show )
1062{
1063 ToolBar *t = mBars[type].get();
1064
1065 // Handle docked and floaters differently
1066 if( t->IsDocked() )
1067 {
1068 t->GetDock()->Expose( t->GetSection(), show );
1069 }
1070 else
1071 {
1072 t->Expose( show );
1073 }
1074}
1075
1076//
1077// Ask both docks to (re)layout their bars
1078//
1080{
1081 // Update the layout
1082 if (mTopDock)
1083 {
1085 }
1086
1087 if (mBotDock)
1088 {
1090 }
1091}
1092
1093//
1094// Handle toolbar dragging
1095//
1096void ToolManager::OnMouse( wxMouseEvent & event )
1097{
1098 // Go ahead and set the event to propagate
1099 event.Skip();
1100
1101 // Can't do anything if we're not dragging. This also prevents
1102 // us from intercepting events that don't belong to us from the
1103 // parent since we're Connect()ed to a couple.
1104 if( !mClicked )
1105 {
1106 return;
1107 }
1108
1109#if defined(__WXMAC__)
1110 // Disable window animation
1111 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
1112#endif
1113
1114 // Retrieve the event position
1115 wxPoint pos =
1116 ( (wxWindow *)event.GetEventObject() )->ClientToScreen( event.GetPosition() ) - mDragOffset;
1117
1118
1119 if( !event.LeftIsDown() )
1120 {
1121 // Button was released...finish the drag
1122 // Transition the bar to a dock
1123 if (!mDidDrag) {
1124 if (mPrevDock)
1126 DoneDragging();
1127 return;
1128 }
1129 else if( mDragDock && !event.ShiftDown() )
1130 {
1131 // Trip over...everyone ashore that's going ashore...
1133 Updated();
1135
1136 // Done with the floater
1137 mDragWindow->Destroy();
1138 mDragWindow = nullptr;
1139 mDragBar->Refresh(false);
1140 }
1141 else
1142 {
1143 // Calling SetDocked() to force the grabber button to popup
1144 mDragBar->SetDocked( NULL, false );
1145 }
1146
1147 DoneDragging();
1148 }
1149 else if( event.Dragging() && pos != mLastPos )
1150 {
1151 if (!mDidDrag) {
1152 // Must set the bar afloat if it's currently docked
1153 mDidDrag = true;
1154 wxPoint mp = event.GetPosition();
1155 mp = GetProjectFrame( *mParent ).ClientToScreen(mp);
1156 if (!mDragWindow) {
1157 // We no longer have control
1158 if (mPrevDock)
1160 UndockBar(mp);
1161 // Rearrange the remaining toolbars before trying to re-insert this one.
1163 }
1164 }
1165
1166 // Make toolbar follow the mouse
1167 mDragWindow->Move( pos );
1168
1169 // Remember to prevent excessive movement
1170 mLastPos = pos;
1171
1172 // Calc the top dock hittest rectangle
1173 wxRect tr = mTopDock->GetRect();
1174 tr.SetBottom( tr.GetBottom() + 10 );
1175 tr.SetPosition( mTopDock->GetParent()->ClientToScreen( tr.GetPosition() ) );
1176
1177 // Calc the bottom dock hittest rectangle
1178 wxRect br = mBotDock->GetRect();
1179 br.SetTop( br.GetTop() - 10 );
1180 br.SetBottom( br.GetBottom() + 20 );
1181 br.SetPosition( mBotDock->GetParent()->ClientToScreen( br.GetPosition() ) );
1182
1183
1184 // Add half the bar height. We could use the actual bar height, but that would be confusing as a
1185 // bar removed at a place might not dock back there if just let go.
1186 // Also add 5 pixels in horizontal direction, so that a click without a move (or a very small move)
1187 // lands back where we started.
1188 pos += wxPoint( 5, 20 );
1189
1190
1191 // To find which dock, rather than test against pos, test against the whole dragger rect.
1192 // This means it is enough to overlap the dock to dock with it.
1193 wxRect barRect = mDragWindow->GetRect();
1194 ToolDock *dock = NULL;
1195 if( tr.Intersects( barRect ) )
1196 dock = mTopDock;
1197 else if( br.Intersects( barRect ) )
1198 dock = mBotDock;
1199
1200 // Looks like we have a winner...
1201 if( dock )
1202 {
1203 wxPoint p;
1204 wxRect r;
1205
1206 // Calculate where the bar would be placed
1207 mDragBefore = dock->PositionBar( mDragBar, pos, r );
1208
1209 // If different than the last time, the indicator must be moved
1210 if( r != mBarPos )
1211 {
1212 wxRect dr = dock->GetRect();
1213
1214 // Hide the indicator before changing the shape
1215 mIndicator->Hide();
1216
1217 // Decide which direction the arrow should point
1218 if( r.GetTop() >= dr.GetHeight() )
1219 {
1220 const auto &box = mDown->GetBox();
1221 p.x = dr.GetLeft() + ( dr.GetWidth() / 2 )
1222 - (box.GetWidth() / 2);
1223 p.y = dr.GetBottom() - box.GetHeight();
1224 mCurrent = mDown.get();
1225 }
1226 else
1227 {
1228 // r is the rectangle of the toolbar being dragged.
1229 // A tall undocked toolbar will become at most 2 tbs
1230 // high when docked, so the triangular drop indicator
1231 // needs to use that height, h, not the bar height
1232 // for calculating where to be drawn.
1233 const int tbs = toolbarSingle + toolbarGap;
1234 int h = wxMin(r.GetHeight(), 2*tbs-1);
1235 p.x = dr.GetLeft() + r.GetLeft();
1236 p.y = dr.GetTop() + r.GetTop() +
1237 ( ( h - mLeft->GetBox().GetHeight() ) / 2 );
1238 mCurrent = mLeft.get();
1239 }
1240
1241 // Change the shape while hidden and then show it if okay
1242 mIndicator->SetShape( *mCurrent );
1243 if( !event.ShiftDown() )
1244 {
1245 mIndicator->Show();
1246 mIndicator->Update();
1247 }
1248
1249 // Move it into position
1250 // LL: Do this after the Show() since KDE doesn't move the window
1251 // if it's not shown. (Do it outside if the previous IF as well)
1252 mIndicator->Move( dock->GetParent()->ClientToScreen( p ) );
1253
1254 // Remember for next go round
1255 mBarPos = r;
1256 }
1257 }
1258 else
1259 {
1260 // Hide the indicator if it's still shown
1261 if( mBarPos.x != -1 )
1262 {
1263 // Hide any
1264 mIndicator->Hide();
1265 mBarPos.x = -1;
1266 mBarPos.y = -1;
1267 }
1268 }
1269
1270 // Remember to which dock the drag bar belongs.
1271 mDragDock = dock;
1272 }
1273
1274#if defined(__WXMAC__)
1275 // Reinstate original transition
1276 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
1277#endif
1278}
1279
1280//
1281// Deal with NEW capture lost event
1282//
1283void ToolManager::OnCaptureLost( wxMouseCaptureLostEvent & event )
1284{
1285 // Can't do anything if we're not dragging. This also prevents
1286 // us from intercepting events that don't belong to us from the
1287 // parent since we're Connect()ed to a couple.
1288 if( !mDragWindow )
1289 {
1290 event.Skip();
1291 return;
1292 }
1293
1294 // Simulate button up
1295 wxMouseEvent e(wxEVT_LEFT_UP);
1296 e.SetEventObject(mParent);
1297 OnMouse(e);
1298}
1299
1301{
1303}
1304
1305//
1306// Watch for shift key changes
1307//
1308void ToolManager::OnTimer( wxTimerEvent & event )
1309{
1310 // Go ahead and set the event to propagate
1311 event.Skip();
1312
1313 // Can't do anything if we're not dragging. This also prevents
1314 // us from intercepting events that don't belong to us from the
1315 // parent since we're Connect()ed to a couple.
1316 if( !mDragWindow )
1317 {
1318 return;
1319 }
1320
1321 bool state = wxGetKeyState( WXK_SHIFT );
1322 if( mLastState != state )
1323 {
1324 mLastState = state;
1325
1326#if defined(__WXMAC__)
1327 // Disable window animation
1328 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
1329#endif
1330
1331 mIndicator->Show( !state );
1332
1333#if defined(__WXMAC__)
1334 // Disable window animation
1335 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
1336#endif
1337 }
1338
1339 return;
1340}
1341
1342//
1343// Handle Indicator paint events
1344//
1345// Really only needed for the Mac since SetBackgroundColour()
1346// doesn't seem to work with shaped frames.
1347//
1348void ToolManager::OnIndicatorPaint( wxPaintEvent & event )
1349{
1350 // TODO: Better to use a bitmap than a triangular region.
1351 wxWindow *w = (wxWindow *)event.GetEventObject();
1352 wxPaintDC dc( w );
1353 // TODO: Better (faster) to use the existing spare brush.
1354 wxBrush brush( theTheme.Colour( clrTrackPanelText ) );
1355 dc.SetBackground( brush );
1356 dc.Clear();
1357}
1358
1359//
1360// Handle Indicator creation event
1361//
1362// Without this, the initial Indicator window will be a solid blue square
1363// until the next time it changes.
1364//
1365void ToolManager::OnIndicatorCreate( wxWindowCreateEvent & event )
1366{
1367#if defined(__WXGTK__)
1368 mIndicator->SetShape( *mCurrent );
1369#endif
1370 event.Skip();
1371}
1372
1373void ToolManager::UndockBar( wxPoint mp )
1374{
1375#if defined(__WXMAC__)
1376 // Disable window animation
1377 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
1378#endif
1379
1380 // Adjust the starting position
1381 mp -= mDragOffset;
1382
1383 // Inform toolbar of change
1384 mDragBar->SetDocked( NULL, true );
1386
1387 // Construct a NEW floater
1388 wxASSERT(mParent);
1390 mDragWindow->SetLayoutDirection(wxLayout_LeftToRight);
1391 // Make sure the ferry is visible
1392 mDragWindow->Show();
1393
1394 // Notify parent of change
1395 Updated();
1396
1397#if defined(__WXMAC__)
1398 // Reinstate original transition
1399 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
1400#endif
1401}
1402
1403//
1404// Transition a toolbar from float to dragging
1405//
1407{
1408 // No need to propagate any further
1409 event.Skip( false );
1410
1411 if(event.IsEscaping())
1412 return HandleEscapeKey();
1413
1414 // Remember which bar we're dragging
1415 mDragBar = GetToolBar(event.BarId());
1416
1417 // Remember state, in case of ESCape key later
1418 if (mDragBar->IsDocked()) {
1419 mPrevDock = dynamic_cast<ToolDock*>(mDragBar->GetParent());
1420 wxASSERT(mPrevDock);
1423 }
1424 else
1425 mPrevPosition = mDragBar->GetParent()->GetPosition();
1426
1427 // Calculate the drag offset
1428 wxPoint mp = event.GetPosition();
1429 mDragOffset = mp -
1430 mDragBar->GetParent()->ClientToScreen( mDragBar->GetPosition() ) +
1431 wxPoint( 1, 1 );
1432
1433 mClicked = true;
1434 if( mPrevDock )
1435 {
1436 mDragWindow = nullptr;
1437 }
1438 else
1439 {
1440 mDragWindow = (ToolFrame *) mDragBar->GetParent();
1441 }
1442
1443 // We want all mouse events from this point on
1444 auto &window = GetProjectFrame( *mParent );
1445 if( !window.HasCapture() )
1446 window.CaptureMouse();
1447
1448 // Start monitoring shift key changes
1449 mLastState = wxGetKeyState( WXK_SHIFT );
1450 mTimer.Start( 100 );
1451}
1452
1453
1455{
1456 if (mDragBar) {
1457 if(mPrevDock) {
1458 // Sheriff John Stone,
1459 // Why don't you leave me alone?
1460 // Well, I feel so break up
1461 // I want to go home.
1463 mPrevDock->Dock( mDragBar, true, mPrevSlot );
1464 Updated();
1465
1466 // Done with the floater
1468 mDragWindow->Destroy();
1469 mDragWindow = nullptr;
1470 mDragBar->Refresh(false);
1471 }
1472 else {
1473 // Floater remains, and returns to where it begain
1474 auto parent = mDragBar->GetParent();
1475 parent->SetPosition(mPrevPosition);
1476 mDragBar->SetDocked(NULL, false);
1477 }
1478
1479 DoneDragging();
1480 }
1481}
1482
1484{
1485 // Done dragging - ensure grabber button isn't pushed
1486 if( mDragBar )
1487 {
1488 mDragBar->SetDocked( mDragBar->GetDock(), false );
1489 }
1490
1491 // Release capture
1492 auto &window = GetProjectFrame( *mParent );
1493 if( window.HasCapture() )
1494 {
1495 window.ReleaseMouse();
1496 }
1497
1498 // Hide the indicator
1499 mIndicator->Hide();
1500
1501 mDragWindow = NULL;
1502 mDragDock = NULL;
1503 mDragBar = NULL;
1504 mPrevDock = NULL;
1507 mLastPos.x = mBarPos.x = -1;
1508 mLastPos.y = mBarPos.y = -1;
1509 mTimer.Stop();
1510 mDidDrag = false;
1511 mClicked = false;
1512
1513 RestoreFocus();
1514}
1515
1517{
1518 if (mLastFocus) {
1519 auto temp1 = AButton::TemporarilyAllowFocus();
1520 auto temp2 = ASlider::TemporarilyAllowFocus();
1522 mLastFocus->SetFocus();
1523 return true;
1524 }
1525 return false;
1526}
1527
1529{
1530 for (auto pProject : AllProjects{}) {
1531 auto &project = *pProject;
1533 }
1534}
1535
1536#include "CommandManager.h"
1538{
1539 // Refreshes can occur during shutdown and the toolmanager may already
1540 // be deleted, so protect against it.
1541 auto &toolManager = ToolManager::Get( project );
1542
1543 // Now, go through each toolbar, and call EnableDisableButtons()
1544 toolManager.ForEach([](auto bar){
1545 if (bar)
1546 bar->EnableDisableButtons();
1547 });
1548
1549 // These don't really belong here, but it's easier and especially so for
1550 // the Edit toolbar and the sync-lock menu item.
1551 bool active = SyncLockTracks.Read();
1553
1555}
1556
1557using namespace MenuRegistry;
1558
1560 Identifier id, const CommandID &name, const TranslatableString &label_in,
1561 const Registry::OrderingHint &hint,
1562 std::vector< Identifier > excludeIDs
1563) : mId{ id }
1564 , mAttachedItem{
1567 { return *this; } ),
1568 MenuRegistry::Command( name, label_in,
1572 auto &toolManager = ToolManager::Get( project );
1573 return toolManager.IsVisible( id ); } ) ) ),
1574 Registry::Placement{ wxT("View/Other/Toolbars/Toolbars/Other"), hint }
1575 }
1576 , mExcludeIds{ std::move( excludeIDs ) }
1577{}
1578
1580{
1581 auto &project = context.project;
1582 auto &toolManager = ToolManager::Get( project );
1583
1584 if( !toolManager.IsVisible( mId ) )
1585 {
1586 for ( const auto excludedID : mExcludeIds )
1587 toolManager.Expose( excludedID, false );
1588 }
1589
1590 toolManager.ShowHide(mId);
1592}
wxT("CloseDown"))
END_EVENT_TABLE()
constexpr CommandFlag AlwaysEnabledFlag
Definition: CommandFlag.h:34
wxEvtHandler CommandHandlerObject
const TranslatableString name
Definition: Distortion.cpp:76
#define EVT_GRABBER(id, fn)
Definition: Grabber.h:97
static ProjectFileIORegistry::AttributeWriterEntry entry
EVT_COMMAND(wxID_ANY, EVT_FREQUENCYTEXTCTRL_UPDATED, LabelDialog::OnFreqUpdate) LabelDialog
Definition: LabelDialog.cpp:89
#define safenew
Definition: MemoryX.h:9
audacity::BasicSettings * gPrefs
Definition: Prefs.cpp:68
void GetPreferencesVersion(int &vMajor, int &vMinor, int &vMicro)
Definition: Prefs.cpp:239
wxFrame * FindProjectFrame(AudacityProject *project)
Get a pointer to the window associated with a project, or null if the given pointer is null,...
AUDACITY_DLL_API wxFrame & GetProjectFrame(AudacityProject &project)
Get the top-level window associated with the project (as a wxFrame only, when you do not need to use ...
accessors for certain important windows associated with each project
static const AttachedProjectObjects::RegisteredFactory manager
BoolSetting SyncLockTracks
Definition: SyncLock.cpp:173
const auto project
THEME_API Theme theTheme
Definition: Theme.cpp:82
@ ToolBarFloatMargin
Definition: ToolBar.h:67
#define toolbarSingle
Definition: ToolBar.h:59
#define toolbarGap
Definition: ToolBar.h:64
@ BotDockID
Definition: ToolDock.h:44
@ DockCount
Definition: ToolDock.h:45
@ TopDockID
Definition: ToolDock.h:43
@ NoDockID
Definition: ToolDock.h:42
static const AudacityProject::AttachedObjects::RegisteredFactory key
Methods for ToolManager.
#define sizerW
Methods for ToolFrame.
Definition: ToolManager.cpp:67
IMPLEMENT_CLASS(ToolFrame, wxFrame)
static struct DefaultConfigEntry DefaultConfigTable[]
int id
static TempAllowFocus TemporarilyAllowFocus()
Definition: AButton.cpp:658
static void Line(wxDC &dc, wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
Definition: AColor.cpp:187
static TempAllowFocus TemporarilyAllowFocus()
Definition: ASlider.cpp:1892
The top-level handle to an Audacity project. It serves as a source of events that other objects can b...
Definition: Project.h:90
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
AudacityProject & project
static CommandManager & Get(AudacityProject &project)
static result_type Call(Arguments &&...arguments)
Null check of the installed function is done for you.
Grabber Class.
Definition: Grabber.h:48
bool IsEscaping() const
Definition: Grabber.h:75
Identifier BarId() const
Definition: Grabber.h:77
The widget to the left of a ToolBar that allows it to be dragged around to NEW positions.
Definition: Grabber.h:107
An explicitly nonlocalized string, not meant for the user to see.
Definition: Identifier.h:22
const wxString & GET() const
Explicit conversion to wxString, meant to be ugly-looking and demanding of a comment why it's correct...
Definition: Identifier.h:66
static TempAllowFocus TemporarilyAllowFocus()
Subscription Subscribe(Callback callback)
Connect a callback to the Publisher; later-connected are called earlier.
Definition: Observer.h:199
bool Read(T *pVar) const
overload of Read returning a boolean that is true if the value was previously defined *‍/
Definition: Prefs.h:207
void SetSyncLock(bool flag)
Definition: SyncLock.cpp:48
static SyncLockState & Get(AudacityProject &project)
Definition: SyncLock.cpp:26
wxColour & Colour(int iIndex)
static bool Read(ToolBarConfiguration *pConfiguration, Legacy *pLegacy, ToolBar *bar, bool &visible, bool defaultVisible)
Definition: ToolDock.cpp:281
static const Position UnspecifiedPosition
Definition: ToolDock.h:106
bool Contains(const ToolBar *bar) const
Definition: ToolDock.h:235
static void Write(const ToolBarConfiguration *pConfiguration, const ToolBar *bar)
Definition: ToolDock.cpp:355
void PostRead(Legacy &legacy)
Definition: ToolDock.cpp:334
Position Find(const ToolBar *bar) const
Definition: ToolDock.cpp:87
void Remove(const ToolBar *bar)
Definition: ToolDock.cpp:224
Works with ToolManager and ToolDock to provide a dockable window in which buttons can be placed.
Definition: ToolBar.h:74
void SetIndex(int index)
Set a value used for computing cascading positions of undocked bars.
Definition: ToolBar.h:114
virtual void EnableDisableButtons()=0
bool IsDocked() const
Definition: ToolBar.cpp:433
@ TopDockID
Definition: ToolBar.h:93
virtual void SetDocked(ToolDock *dock, bool pushed)
Definition: ToolBar.cpp:661
virtual void ReCreateButtons()
Definition: ToolBar.cpp:533
void SetVisible(bool bVisible)
Definition: ToolBar.cpp:446
bool IsResizable() const
Definition: ToolBar.cpp:425
int GetIndex() const
Get a value used for computing cascading positions of undocked bars.
Definition: ToolBar.h:112
virtual void ResizingDone()
Definition: ToolBar.h:197
ToolDock * GetDock()
Definition: ToolBar.cpp:647
bool IsPositioned()
Definition: ToolBar.h:138
void SetPositioned()
Definition: ToolBar.h:140
Identifier GetSection()
Definition: ToolBar.cpp:400
virtual bool Expose(bool show=true)
Definition: ToolBar.cpp:459
virtual void SetToDefaultSize()
Definition: ToolBar.cpp:513
virtual bool HideAfterReset() const
Default implementation returns false.
Definition: ToolBar.cpp:370
void SetPreferredNeighbors(Identifier left, Identifier top={})
Definition: ToolBar.cpp:652
virtual bool ShownByDefault() const
Whether the toolbar should be shown by default. Default implementation returns true.
Definition: ToolBar.cpp:365
virtual void Create(wxWindow *parent)
Definition: ToolBar.cpp:492
virtual wxSize GetDockedSize()
Definition: ToolBar.h:146
virtual DockID DefaultDockID() const
Which dock the toolbar defaults into. Default implementation chooses the top dock.
Definition: ToolBar.cpp:375
A dynamic panel where a ToolBar can be docked.
Definition: ToolDock.h:292
void Expose(Identifier type, bool show)
Definition: ToolDock.cpp:858
void Undock(ToolBar *bar)
Definition: ToolDock.cpp:426
void RestoreConfiguration(ToolBarConfiguration &backup)
Definition: ToolDock.cpp:848
void LoadConfig()
Definition: ToolDock.cpp:466
void WrapConfiguration(ToolBarConfiguration &backup)
Definition: ToolDock.cpp:841
ToolBarConfiguration & GetConfiguration()
Definition: ToolDock.h:311
ToolBarConfiguration::Position PositionBar(ToolBar *t, const wxPoint &pos, wxRect &rect)
Definition: ToolDock.cpp:744
void LayoutToolBars()
Definition: ToolDock.cpp:687
void Dock(ToolBar *bar, bool deflate, ToolBarConfiguration::Position ndx=ToolBarConfiguration::UnspecifiedPosition)
Definition: ToolDock.cpp:438
class ToolFrame
Definition: ToolManager.h:189
ToolFrame(AudacityProject *parent, ToolManager *manager, ToolBar *bar, wxPoint pos)
Definition: ToolManager.cpp:73
wxSize mOrigSize
Definition: ToolManager.h:235
ToolBar * mBar
Definition: ToolManager.h:233
void OnMotion(wxMouseEvent &event)
wxSize mMinSize
Definition: ToolManager.h:234
ToolManager * mManager
Definition: ToolManager.h:232
void Resize(const wxSize &size)
void OnClose(wxCloseEvent &event)
void OnGrabber(GrabberEvent &event)
void OnPaint(wxPaintEvent &WXUNUSED(event))
void OnCaptureLost(wxMouseCaptureLostEvent &WXUNUSED(event))
void LockInMinSize(ToolBar *pBar)
void ClearBar()
Definition: ToolManager.h:197
void OnToolBarUpdate(wxCommandEvent &event)
void OnKeyDown(wxKeyEvent &event)
class ToolManager
Definition: ToolManager.h:55
static ToolManager & Get(AudacityProject &project)
void OnIndicatorCreate(wxWindowCreateEvent &event)
bool IsDocked(Identifier type) const
bool mLastState
Definition: ToolManager.h:157
ToolDock * GetBotDock()
void OnMenuUpdate(struct MenuUpdateMessage)
ToolBar * mDragBar
Definition: ToolManager.h:144
static void OnResetToolBars(const CommandContext &context)
void OnGrabber(GrabberEvent &event)
void ReadConfig()
void OnCaptureLost(wxMouseCaptureLostEvent &event)
ToolDock * mTopDock
Definition: ToolManager.h:163
void OnTimer(wxTimerEvent &event)
void Expose(Identifier type, bool show)
bool mTransition
Definition: ToolManager.h:160
void ShowHide(Identifier type)
std::map< Identifier, ToolBar::Holder > mBars
map not unordered_map, for the promise made by ForEach
Definition: ToolManager.h:167
void CreateWindows()
wxPoint mPrevPosition
Definition: ToolManager.h:169
wxTimer mTimer
Definition: ToolManager.h:156
ToolDock * GetTopDock()
ToolFrame * mDragWindow
Definition: ToolManager.h:142
void WriteConfig()
int FilterEvent(wxEvent &event) override
std::unique_ptr< wxRegion > mLeft
Definition: ToolManager.h:153
void RegenerateTooltips()
void UndockBar(wxPoint mp)
Observer::Subscription mMenuManagerSubscription
Definition: ToolManager.h:138
void LayoutToolBars()
void Destroy()
AudacityProject * mParent
Definition: ToolManager.h:139
void OnIndicatorPaint(wxPaintEvent &event)
void HandleEscapeKey()
ToolBarConfiguration mPrevConfiguration
Definition: ToolManager.h:173
std::unique_ptr< wxRegion > mDown
Definition: ToolManager.h:153
ToolDock * mPrevDock
Definition: ToolManager.h:170
static void ModifyToolbarMenus(AudacityProject &project)
ToolBarConfiguration::Position mPrevSlot
Definition: ToolManager.h:172
void DoneDragging()
void ForEach(F &&fun)
Visit bars, lexicographically by their textual ids.
Definition: ToolManager.h:102
ToolDock * mDragDock
Definition: ToolManager.h:143
void OnMouse(wxMouseEvent &event)
ToolBarConfiguration::Position mDragBefore
Definition: ToolManager.h:146
bool RestoreFocus()
Destroy_ptr< wxFrame > FramePtr
Definition: ToolManager.h:151
wxRegion * mCurrent
Definition: ToolManager.h:154
wxRect mBarPos
Definition: ToolManager.h:149
ToolDock * mBotDock
Definition: ToolManager.h:164
static void ModifyAllProjectToolbarMenus()
wxWindowRef mLastFocus
Definition: ToolManager.h:140
ToolManager(AudacityProject *parent)
ToolBar * GetToolBar(const Identifier &type) const
wxPoint mDragOffset
Definition: ToolManager.h:145
FramePtr mIndicator
Definition: ToolManager.h:152
wxPoint mLastPos
Definition: ToolManager.h:148
bool IsVisible(Identifier type) const
Holds a msgid for the translation catalog; may also bind format arguments.
virtual bool Flush() noexcept=0
GroupScope BeginGroup(const wxString &prefix)
Appends a prefix to the current group or sets a new absolute path. Group that was set as current befo...
virtual bool Write(const wxString &key, bool value)=0
virtual bool Read(const wxString &key, bool *value) const =0
constexpr auto Command
Definition: MenuRegistry.h:456
auto end(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
Definition: PackedArray.h:159
static RegisteredToolbarFactory factory
void OnShowToolBar(const CommandContext &context)
const std::vector< Identifier > mExcludeIds
Definition: ToolManager.h:258
const Identifier mId
Definition: ToolManager.h:256
AttachedToolBarMenuItem(Identifier id, const CommandID &name, const TranslatableString &label_in, const Registry::OrderingHint &hint={}, std::vector< Identifier > excludeIds={})
Identifier rightOf
Identifier barID
Identifier below
Options && CheckTest(const CheckFn &fn) &&
Definition: MenuRegistry.h:74
Sent when menus update (such as for changing enablement of items)
static const Functions & GetFactories()
Definition: ToolBar.cpp:1047