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 "../commands/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 "ImageManipulation.h"
54#include "Menus.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("Scrub"), {}, wxT("Control") },
545 { wxT("Device"), wxT("Scrub"), wxT("Control") },
546
547 // Hidden by default in top dock
548 { wxT("CombinedMeter"), {}, {} },
549
550 // Bottom dock
551 { wxT("TimeSignature"), {}, {}, },
552 { wxT("Snapping"), wxT("TimeSignature"), {}, },
553 { wxT("Time"), wxT("Snapping"), {} },
554 { wxT("Selection"), wxT("Time"), {} },
555
556// DA: Transcription Toolbar not docked, by default.
557#ifdef EXPERIMENTAL_DA
558 { wxT("Transcription"), {}, {} },
559#else
560 { wxT("Transcription"), wxT("Selection"), {} },
561#endif
562
563 // Hidden by default in bottom dock
564 { wxT("SpectralSelection"), {}, {} },
566
567// Static member function.
569{
570 auto &project = context.project;
571 auto &toolManager = ToolManager::Get( project );
572
573 toolManager.Reset();
575}
576
577
579{
580 // Disconnect all docked bars
581 for ( const auto &entry : DefaultConfigTable )
582 {
583 const auto &ndx = entry.barID;
584 ToolBar *bar = GetToolBar(ndx);
585 if (!bar)
586 continue;
587
589 (entry.rightOf == Identifier{}) ? nullptr : GetToolBar(entry.rightOf),
590 (entry.below == Identifier{}) ? nullptr : GetToolBar(entry.below)
591 };
592
593 bar->SetSize( 20,20 );
594
595 wxWindow *floater;
596 ToolDock *dock;
597 bool expose = true;
598
599 // Disconnect the bar
600 if( bar->IsDocked() )
601 {
602 bar->GetDock()->Undock( bar );
603 floater = NULL;
604 }
605 else
606 {
607 floater = bar->GetParent();
608 }
609
610 // Decide which dock.
611 dock = (bar->DefaultDockID() == ToolBar::TopDockID)
612 ? mTopDock : mBotDock;
613
614 // PRL: Destroy the tool frame before recreating buttons.
615 // This fixes some subtle sizing problems on macOs.
616 bar->Reparent( dock );
617 //OK (and good) to DELETE floater, as bar is no longer in it.
618 if( floater )
619 floater->Destroy();
620
621 // Recreate bar buttons (and resize it)
622 bar->SetToDefaultSize();
623 bar->ReCreateButtons();
625
626#if 0
627 if( bar->IsResizable() )
628 {
629 bar->SetSize(bar->GetBestFittingSize());
630 }
631#endif
632
633 // Hide some bars.
634 expose = bar->ShownByDefault() || bar->HideAfterReset();
635
636 // Next condition will always (?) be true, as the reset configuration is
637 // with no floating toolbars.
638 if( dock != NULL )
639 {
640 // when we dock, we reparent, so bar is no longer a child of floater.
641 dock->Dock( bar, false, position );
642 Expose( bar->GetSection(), expose );
643 }
644 else
645 {
646 // The (tool)bar has a dragger window round it, the floater.
647 // in turn floater will have mParent (the entire App) as its
648 // parent.
649
650 // Maybe construct a NEW floater
651 // this happens if we have just been bounced out of a dock.
652 if( floater == NULL ) {
653 wxASSERT(mParent);
654 floater = safenew ToolFrame( mParent, this, bar, wxPoint(-1,-1) );
655 bar->Reparent( floater );
656 }
657
658 // This bar is undocked and invisible.
659 // We are doing a reset toolbars, so even the invisible undocked bars should
660 // be moved somewhere sensible. Put bar near center of window.
661 // If there were multiple hidden toobars the * 10 adjustment means
662 // they won't overlap too much.
663 floater->CentreOnParent( );
664 const auto index = bar->GetIndex();
665 floater->Move(
666 floater->GetPosition() + wxSize{ index * 10 - 200, index * 10 });
667 bar->SetDocked( NULL, false );
668 Expose( bar->GetSection(), false );
669 }
670 }
671
672 ForEach([this](auto bar){
673 if (bar && bar->HideAfterReset())
674 Expose(bar->GetSection(), false);
675 });
676 // TODO:??
677 // If audio was playing, we stopped the VU meters,
678 // It would be nice to show them again, but hardly essential as
679 // they will show up again on the next play.
680 // SetVUMeters(AudacityProject *p);
681 Updated();
682}
683
685{
686 ForEach([](auto bar){
687 if (bar)
688 bar->RegenerateTooltips();
689 });
690}
691
692int ToolManager::FilterEvent(wxEvent &event)
693{
694 // Snoop the global event stream for changes of focused window. Remember
695 // the last one of our own that is not a grabber.
696
697 if (event.GetEventType() == wxEVT_KILL_FOCUS) {
698 auto &focusEvent = static_cast<wxFocusEvent&>(event);
699 auto window = focusEvent.GetWindow();
700 auto top = wxGetTopLevelParent(window);
701 if(auto toolFrame = dynamic_cast<ToolFrame*>(top))
702 top = toolFrame->GetParent();
703 // window is that which will GET the focus
704 if ( window &&
705 !dynamic_cast<Grabber*>( window ) &&
706 !dynamic_cast<ToolFrame*>( window ) &&
707 top == FindProjectFrame( mParent ) )
708 // Note this is a dangle-proof wxWindowRef:
709 mLastFocus = window;
710 }
711
712 return Event_Skip;
713}
714
715//
716// Read the toolbar states
717//
719{
720 std::vector<Identifier> unordered[ DockCount ];
721 std::vector<ToolBar*> dockedAndHidden;
722 std::map<Identifier, bool> show;
723 std::map<Identifier, int> width;
724 std::map<Identifier, int> height;
725 int x, y;
726 int dock;
727 bool someFound { false };
728
729#if defined(__WXMAC__)
730 // Disable window animation
731 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
732#endif
733
734 // Change to the bar root
735 auto toolbarsGroup = gPrefs->BeginGroup("/GUI/ToolBars");
736
737 ToolBarConfiguration::Legacy topLegacy, botLegacy;
738
739 int vMajor, vMinor, vMicro;
740 GetPreferencesVersion(vMajor, vMinor, vMicro);
741 bool useLegacyDock = false;
742 // note that vMajor, vMinor, and vMicro will all be zero if either it's a new audacity.cfg file
743 // or the version is less than 1.3.13 (when there were no version keys according to the comments in
744 // InitPreferences()). So for new audacity.cfg
745 // file useLegacyDock will be true, but this doesn't matter as there are no Dock or DockV2 keys in the file yet.
746 if (vMajor <= 1 ||
747 (vMajor == 2 && (vMinor <= 1 || (vMinor == 2 && vMicro <= 1)))) // version <= 2.2.1
748 useLegacyDock = true;
749
750
751 // Load and apply settings for each bar
752 ForEach([&](ToolBar *bar){
753 //wxPoint Center = mParent->GetPosition() + (mParent->GetSize() * 0.33);
754 //wxPoint Center(
755 // wxSystemSettings::GetMetric( wxSYS_SCREEN_X ) /2 ,
756 // wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) /2 );
757
758 // Change to the bar subkey
759 auto ndx = bar->GetSection();
760 auto barGroup = gPrefs->BeginGroup(ndx.GET());
761
762 const bool bShownByDefault = bar->ShownByDefault();
763 const int defaultDock = bar->DefaultDockID();
764
765 // Read in all the settings
766
767 if (useLegacyDock)
768 gPrefs->Read( wxT("Dock"), &dock, -1); // legacy version of DockV2
769 else
770 gPrefs->Read( wxT("DockV2"), &dock, -1);
771
772 const bool found = (dock != -1);
773 if (found)
774 someFound = true;
775 if (!found)
776 dock = defaultDock;
777
778 ToolDock *d;
780 switch(dock)
781 {
782 case TopDockID: d = mTopDock; pLegacy = &topLegacy; break;
783 case BotDockID: d = mBotDock; pLegacy = &botLegacy; break;
784 default: d = nullptr; pLegacy = nullptr; break;
785 }
786
787 bool ordered = ToolBarConfiguration::Read(
788 d ? &d->GetConfiguration() : nullptr,
789 pLegacy,
790 bar, show[ ndx ], bShownByDefault)
791 && found;
792
793 gPrefs->Read( wxT("X"), &x, -1 );
794 gPrefs->Read( wxT("Y"), &y, -1 );
795 gPrefs->Read( wxT("W"), &width[ ndx ], -1 );
796 gPrefs->Read( wxT("H"), &height[ ndx ], -1 );
797
798 bar->SetVisible( show[ ndx ] );
799
800 // Docked or floating?
801 if( dock )
802 {
803 // Default to top dock if the ID isn't valid
804 if( dock < NoDockID || dock > DockCount ) {
805 dock = TopDockID;
806 }
807
808 // Create the bar with the correct parent
809 if( dock == TopDockID )
810 {
811 bar->Create( mTopDock );
812 }
813 else
814 {
815 bar->Create( mBotDock );
816 }
817
818 // Set the width and height
819 if( width[ ndx ] != -1 && height[ ndx ] != -1 )
820 {
821 wxSize sz( width[ ndx ], height[ ndx ] );
822 bar->SetSize( sz );
823 bar->ResizingDone();
824 }
825
826 // Set the width
827 if( width[ ndx ] >= bar->GetSize().x )
828 {
829 wxSize sz( width[ ndx ], bar->GetSize().y );
830 bar->SetSize( sz );
831 bar->Layout();
832 }
833
834 // make a note of docked and hidden toolbars
835 if (!show[ndx])
836 dockedAndHidden.push_back(bar);
837
838 if (!ordered)
839 {
840 // These must go at the end
841 unordered[ dock - 1 ].push_back( ndx );
842 }
843 }
844 else
845 {
846 // Create the bar (with the top dock being temporary parent)
847 bar->Create( mTopDock );
848
849 // Construct a NEW floater
850 wxASSERT(mParent);
851 ToolFrame *f = safenew ToolFrame( mParent, this, bar, wxPoint( x, y ) );
852
853 // Set the width and height
854 if( width[ ndx ] != -1 && height[ ndx ] != -1 )
855 {
856 wxSize sz( width[ ndx ], height[ ndx ] );
857 f->SetSizeHints( sz );
858 f->SetSize( sz );
859 f->Layout();
860 if( (x!=-1) && (y!=-1) )
861 bar->SetPositioned();
862 }
863
864 // Required on Linux Xfce
865 wxSize msz(width[ndx],height[ndx]-1);
866 bar->GetParent()->SetMinSize(msz);
867
868 // Inform toolbar of change
869 bar->SetDocked( NULL, false );
870
871 // Show or hide it
872 Expose( bar->GetSection(), show[ ndx ] );
873 }
874 });
875
876 mTopDock->GetConfiguration().PostRead(topLegacy);
877 mBotDock->GetConfiguration().PostRead(botLegacy);
878
879 // Add all toolbars to their target dock
880 for( dock = 0; dock < DockCount; dock++ )
881 {
882 ToolDock *d = ( dock + 1 == TopDockID ? mTopDock : mBotDock );
883
884 d->LoadConfig();
885
886 // Add all unordered toolbars
887 for( int ord = 0; ord < (int) unordered[ dock ].size(); ord++ )
888 {
889 ToolBar *t = mBars[unordered[dock][ord]].get();
890
891 // Dock it
892 d->Dock( t, false );
893
894 // Show or hide the bar
895 Expose( t->GetSection(), show[ t->GetSection() ] );
896 }
897 }
898
899 // hidden docked toolbars
900 for (auto bar : dockedAndHidden) {
901 bar->SetVisible(false );
902 bar->GetDock()->Dock(bar, false);
903 bar->Expose(false);
904 }
905
906 toolbarsGroup.Reset();
907
908#if defined(__WXMAC__)
909 // Reinstate original transition
910 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
911#endif
912
913 // Setup the neighbors according to the
914 // default config
915
916 for (const auto& entry : DefaultConfigTable)
917 {
918 const auto &ndx = entry.barID;
919 const auto bar = GetToolBar(ndx);
920 bar->SetPreferredNeighbors(entry.rightOf, entry.below);
921 }
922
923 if (!someFound)
924 Reset();
925}
926
927//
928// Save the toolbar states
929//
931{
932 if( !gPrefs )
933 {
934 return;
935 }
936
937 auto toolbarsGroup = gPrefs->BeginGroup("/GUI/ToolBars");
938
939 // Save state of each bar
940 ForEach([this](ToolBar *bar){
941 // Change to the bar subkey
942 auto sectionGroup = gPrefs->BeginGroup(bar->GetSection().GET());
943
944 // Search both docks for toolbar order
945 bool to = mTopDock->GetConfiguration().Contains( bar );
946 bool bo = mBotDock->GetConfiguration().Contains( bar );
947
948 // Save
949 // Note that DockV2 was introduced in 2.2.2 to fix bug #1554. Dock is retained so that
950 // the toolbar layout is not changed when opening a version before 2.2.2, and in particular
951 // its value is compatible with versions 2.1.3 to 2.2.1 which have this bug.
952 ToolDock* dock = bar->GetDock(); // dock for both shown and hidden toolbars
953 gPrefs->Write( wxT("DockV2"), static_cast<int>(dock == mTopDock ? TopDockID : dock == mBotDock ? BotDockID : NoDockID ));
954
955 gPrefs->Write( wxT("Dock"), static_cast<int>( to ? TopDockID : bo ? BotDockID : NoDockID));
956
957 dock = to ? mTopDock : bo ? mBotDock : nullptr; // dock for shown toolbars
959 (dock ? &dock->GetConfiguration() : nullptr, bar);
960
961 wxPoint pos( -1, -1 );
962 wxSize sz = bar->GetSize();
963 if( !bar->IsDocked() && bar->IsPositioned() )
964 {
965 pos = bar->GetParent()->GetPosition();
966 sz = bar->GetParent()->GetSize();
967 }
968 gPrefs->Write( wxT("X"), pos.x );
969 gPrefs->Write( wxT("Y"), pos.y );
970 gPrefs->Write( wxT("W"), sz.x );
971 gPrefs->Write( wxT("H"), sz.y );
972 });
973 gPrefs->Flush();
974}
975
976//
977// Return a pointer to the specified toolbar or nullptr
978//
980{
981 auto end = mBars.end(), iter = mBars.find(type);
982 return (iter == end) ? nullptr : iter->second.get();
983}
984
985//
986// Return a pointer to the top dock
987//
989{
990 return mTopDock;
991}
992
994{
995 return mTopDock;
996}
997
998//
999// Return a pointer to the bottom dock
1000//
1002{
1003 return mBotDock;
1004}
1005
1007{
1008 return mBotDock;
1009}
1010
1011//
1012// Queues an EVT_TOOLBAR_UPDATED command event to notify any
1013// interest parties of an updated toolbar or dock layout
1014//
1016{
1017 // Queue an update event
1018 wxCommandEvent e( EVT_TOOLBAR_UPDATED );
1019 GetProjectFrame( *mParent ).GetEventHandler()->AddPendingEvent( e );
1020}
1021
1022//
1023// Return docked state of specified toolbar
1024//
1026{
1027 if (auto pBar = GetToolBar(type))
1028 return pBar->IsDocked();
1029 return false;
1030}
1031
1032//
1033// Returns the visibility of the specified toolbar
1034//
1036{
1037 if (auto pBar = GetToolBar(type))
1038 return pBar->IsVisible();
1039 return false;
1040
1041#if 0
1042 // If toolbar is floating
1043 if( !t->IsDocked() )
1044 {
1045 // Must return state of floater window
1046 return t->GetParent()->IsShown();
1047 }
1048
1049 // Return state of docked toolbar
1050 return t->IsShown();
1051#endif
1052}
1053
1054//
1055// Toggles the visible/hidden state of a toolbar
1056//
1058{
1059 Expose( type, !mBars[type]->IsVisible() );
1060 Updated();
1061}
1062
1063//
1064// Set the visible/hidden state of a toolbar
1065//
1066void ToolManager::Expose( Identifier type, bool show )
1067{
1068 ToolBar *t = mBars[type].get();
1069
1070 // Handle docked and floaters differently
1071 if( t->IsDocked() )
1072 {
1073 t->GetDock()->Expose( t->GetSection(), show );
1074 }
1075 else
1076 {
1077 t->Expose( show );
1078 }
1079}
1080
1081//
1082// Ask both docks to (re)layout their bars
1083//
1085{
1086 // Update the layout
1087 if (mTopDock)
1088 {
1090 }
1091
1092 if (mBotDock)
1093 {
1095 }
1096}
1097
1098//
1099// Handle toolbar dragging
1100//
1101void ToolManager::OnMouse( wxMouseEvent & event )
1102{
1103 // Go ahead and set the event to propagate
1104 event.Skip();
1105
1106 // Can't do anything if we're not dragging. This also prevents
1107 // us from intercepting events that don't belong to us from the
1108 // parent since we're Connect()ed to a couple.
1109 if( !mClicked )
1110 {
1111 return;
1112 }
1113
1114#if defined(__WXMAC__)
1115 // Disable window animation
1116 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
1117#endif
1118
1119 // Retrieve the event position
1120 wxPoint pos =
1121 ( (wxWindow *)event.GetEventObject() )->ClientToScreen( event.GetPosition() ) - mDragOffset;
1122
1123
1124 if( !event.LeftIsDown() )
1125 {
1126 // Button was released...finish the drag
1127 // Transition the bar to a dock
1128 if (!mDidDrag) {
1129 if (mPrevDock)
1131 DoneDragging();
1132 return;
1133 }
1134 else if( mDragDock && !event.ShiftDown() )
1135 {
1136 // Trip over...everyone ashore that's going ashore...
1138 Updated();
1140
1141 // Done with the floater
1142 mDragWindow->Destroy();
1143 mDragWindow = nullptr;
1144 mDragBar->Refresh(false);
1145 }
1146 else
1147 {
1148 // Calling SetDocked() to force the grabber button to popup
1149 mDragBar->SetDocked( NULL, false );
1150 }
1151
1152 DoneDragging();
1153 }
1154 else if( event.Dragging() && pos != mLastPos )
1155 {
1156 if (!mDidDrag) {
1157 // Must set the bar afloat if it's currently docked
1158 mDidDrag = true;
1159 wxPoint mp = event.GetPosition();
1160 mp = GetProjectFrame( *mParent ).ClientToScreen(mp);
1161 if (!mDragWindow) {
1162 // We no longer have control
1163 if (mPrevDock)
1165 UndockBar(mp);
1166 // Rearrange the remaining toolbars before trying to re-insert this one.
1168 }
1169 }
1170
1171 // Make toolbar follow the mouse
1172 mDragWindow->Move( pos );
1173
1174 // Remember to prevent excessive movement
1175 mLastPos = pos;
1176
1177 // Calc the top dock hittest rectangle
1178 wxRect tr = mTopDock->GetRect();
1179 tr.SetBottom( tr.GetBottom() + 10 );
1180 tr.SetPosition( mTopDock->GetParent()->ClientToScreen( tr.GetPosition() ) );
1181
1182 // Calc the bottom dock hittest rectangle
1183 wxRect br = mBotDock->GetRect();
1184 br.SetTop( br.GetTop() - 10 );
1185 br.SetBottom( br.GetBottom() + 20 );
1186 br.SetPosition( mBotDock->GetParent()->ClientToScreen( br.GetPosition() ) );
1187
1188
1189 // Add half the bar height. We could use the actual bar height, but that would be confusing as a
1190 // bar removed at a place might not dock back there if just let go.
1191 // Also add 5 pixels in horizontal direction, so that a click without a move (or a very small move)
1192 // lands back where we started.
1193 pos += wxPoint( 5, 20 );
1194
1195
1196 // To find which dock, rather than test against pos, test against the whole dragger rect.
1197 // This means it is enough to overlap the dock to dock with it.
1198 wxRect barRect = mDragWindow->GetRect();
1199 ToolDock *dock = NULL;
1200 if( tr.Intersects( barRect ) )
1201 dock = mTopDock;
1202 else if( br.Intersects( barRect ) )
1203 dock = mBotDock;
1204
1205 // Looks like we have a winner...
1206 if( dock )
1207 {
1208 wxPoint p;
1209 wxRect r;
1210
1211 // Calculate where the bar would be placed
1212 mDragBefore = dock->PositionBar( mDragBar, pos, r );
1213
1214 // If different than the last time, the indicator must be moved
1215 if( r != mBarPos )
1216 {
1217 wxRect dr = dock->GetRect();
1218
1219 // Hide the indicator before changing the shape
1220 mIndicator->Hide();
1221
1222 // Decide which direction the arrow should point
1223 if( r.GetTop() >= dr.GetHeight() )
1224 {
1225 const auto &box = mDown->GetBox();
1226 p.x = dr.GetLeft() + ( dr.GetWidth() / 2 )
1227 - (box.GetWidth() / 2);
1228 p.y = dr.GetBottom() - box.GetHeight();
1229 mCurrent = mDown.get();
1230 }
1231 else
1232 {
1233 // r is the rectangle of the toolbar being dragged.
1234 // A tall undocked toolbar will become at most 2 tbs
1235 // high when docked, so the triangular drop indicator
1236 // needs to use that height, h, not the bar height
1237 // for calculating where to be drawn.
1238 const int tbs = toolbarSingle + toolbarGap;
1239 int h = wxMin(r.GetHeight(), 2*tbs-1);
1240 p.x = dr.GetLeft() + r.GetLeft();
1241 p.y = dr.GetTop() + r.GetTop() +
1242 ( ( h - mLeft->GetBox().GetHeight() ) / 2 );
1243 mCurrent = mLeft.get();
1244 }
1245
1246 // Change the shape while hidden and then show it if okay
1247 mIndicator->SetShape( *mCurrent );
1248 if( !event.ShiftDown() )
1249 {
1250 mIndicator->Show();
1251 mIndicator->Update();
1252 }
1253
1254 // Move it into position
1255 // LL: Do this after the Show() since KDE doesn't move the window
1256 // if it's not shown. (Do it outside if the previous IF as well)
1257 mIndicator->Move( dock->GetParent()->ClientToScreen( p ) );
1258
1259 // Remember for next go round
1260 mBarPos = r;
1261 }
1262 }
1263 else
1264 {
1265 // Hide the indicator if it's still shown
1266 if( mBarPos.x != -1 )
1267 {
1268 // Hide any
1269 mIndicator->Hide();
1270 mBarPos.x = -1;
1271 mBarPos.y = -1;
1272 }
1273 }
1274
1275 // Remember to which dock the drag bar belongs.
1276 mDragDock = dock;
1277 }
1278
1279#if defined(__WXMAC__)
1280 // Reinstate original transition
1281 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
1282#endif
1283}
1284
1285//
1286// Deal with NEW capture lost event
1287//
1288void ToolManager::OnCaptureLost( wxMouseCaptureLostEvent & event )
1289{
1290 // Can't do anything if we're not dragging. This also prevents
1291 // us from intercepting events that don't belong to us from the
1292 // parent since we're Connect()ed to a couple.
1293 if( !mDragWindow )
1294 {
1295 event.Skip();
1296 return;
1297 }
1298
1299 // Simulate button up
1300 wxMouseEvent e(wxEVT_LEFT_UP);
1301 e.SetEventObject(mParent);
1302 OnMouse(e);
1303}
1304
1306{
1308}
1309
1310//
1311// Watch for shift key changes
1312//
1313void ToolManager::OnTimer( wxTimerEvent & event )
1314{
1315 // Go ahead and set the event to propagate
1316 event.Skip();
1317
1318 // Can't do anything if we're not dragging. This also prevents
1319 // us from intercepting events that don't belong to us from the
1320 // parent since we're Connect()ed to a couple.
1321 if( !mDragWindow )
1322 {
1323 return;
1324 }
1325
1326 bool state = wxGetKeyState( WXK_SHIFT );
1327 if( mLastState != state )
1328 {
1329 mLastState = state;
1330
1331#if defined(__WXMAC__)
1332 // Disable window animation
1333 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
1334#endif
1335
1336 mIndicator->Show( !state );
1337
1338#if defined(__WXMAC__)
1339 // Disable window animation
1340 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
1341#endif
1342 }
1343
1344 return;
1345}
1346
1347//
1348// Handle Indicator paint events
1349//
1350// Really only needed for the Mac since SetBackgroundColour()
1351// doesn't seem to work with shaped frames.
1352//
1353void ToolManager::OnIndicatorPaint( wxPaintEvent & event )
1354{
1355 // TODO: Better to use a bitmap than a triangular region.
1356 wxWindow *w = (wxWindow *)event.GetEventObject();
1357 wxPaintDC dc( w );
1358 // TODO: Better (faster) to use the existing spare brush.
1359 wxBrush brush( theTheme.Colour( clrTrackPanelText ) );
1360 dc.SetBackground( brush );
1361 dc.Clear();
1362}
1363
1364//
1365// Handle Indicator creation event
1366//
1367// Without this, the initial Indicator window will be a solid blue square
1368// until the next time it changes.
1369//
1370void ToolManager::OnIndicatorCreate( wxWindowCreateEvent & event )
1371{
1372#if defined(__WXGTK__)
1373 mIndicator->SetShape( *mCurrent );
1374#endif
1375 event.Skip();
1376}
1377
1378void ToolManager::UndockBar( wxPoint mp )
1379{
1380#if defined(__WXMAC__)
1381 // Disable window animation
1382 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
1383#endif
1384
1385 // Adjust the starting position
1386 mp -= mDragOffset;
1387
1388 // Inform toolbar of change
1389 mDragBar->SetDocked( NULL, true );
1391
1392 // Construct a NEW floater
1393 wxASSERT(mParent);
1395 mDragWindow->SetLayoutDirection(wxLayout_LeftToRight);
1396 // Make sure the ferry is visible
1397 mDragWindow->Show();
1398
1399 // Notify parent of change
1400 Updated();
1401
1402#if defined(__WXMAC__)
1403 // Reinstate original transition
1404 wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
1405#endif
1406}
1407
1408//
1409// Transition a toolbar from float to dragging
1410//
1412{
1413 // No need to propagate any further
1414 event.Skip( false );
1415
1416 if(event.IsEscaping())
1417 return HandleEscapeKey();
1418
1419 // Remember which bar we're dragging
1420 mDragBar = GetToolBar(event.BarId());
1421
1422 // Remember state, in case of ESCape key later
1423 if (mDragBar->IsDocked()) {
1424 mPrevDock = dynamic_cast<ToolDock*>(mDragBar->GetParent());
1425 wxASSERT(mPrevDock);
1428 }
1429 else
1430 mPrevPosition = mDragBar->GetParent()->GetPosition();
1431
1432 // Calculate the drag offset
1433 wxPoint mp = event.GetPosition();
1434 mDragOffset = mp -
1435 mDragBar->GetParent()->ClientToScreen( mDragBar->GetPosition() ) +
1436 wxPoint( 1, 1 );
1437
1438 mClicked = true;
1439 if( mPrevDock )
1440 {
1441 mDragWindow = nullptr;
1442 }
1443 else
1444 {
1445 mDragWindow = (ToolFrame *) mDragBar->GetParent();
1446 }
1447
1448 // We want all mouse events from this point on
1449 auto &window = GetProjectFrame( *mParent );
1450 if( !window.HasCapture() )
1451 window.CaptureMouse();
1452
1453 // Start monitoring shift key changes
1454 mLastState = wxGetKeyState( WXK_SHIFT );
1455 mTimer.Start( 100 );
1456}
1457
1458
1460{
1461 if (mDragBar) {
1462 if(mPrevDock) {
1463 // Sheriff John Stone,
1464 // Why don't you leave me alone?
1465 // Well, I feel so break up
1466 // I want to go home.
1468 mPrevDock->Dock( mDragBar, true, mPrevSlot );
1469 Updated();
1470
1471 // Done with the floater
1473 mDragWindow->Destroy();
1474 mDragWindow = nullptr;
1475 mDragBar->Refresh(false);
1476 }
1477 else {
1478 // Floater remains, and returns to where it begain
1479 auto parent = mDragBar->GetParent();
1480 parent->SetPosition(mPrevPosition);
1481 mDragBar->SetDocked(NULL, false);
1482 }
1483
1484 DoneDragging();
1485 }
1486}
1487
1489{
1490 // Done dragging - ensure grabber button isn't pushed
1491 if( mDragBar )
1492 {
1493 mDragBar->SetDocked( mDragBar->GetDock(), false );
1494 }
1495
1496 // Release capture
1497 auto &window = GetProjectFrame( *mParent );
1498 if( window.HasCapture() )
1499 {
1500 window.ReleaseMouse();
1501 }
1502
1503 // Hide the indicator
1504 mIndicator->Hide();
1505
1506 mDragWindow = NULL;
1507 mDragDock = NULL;
1508 mDragBar = NULL;
1509 mPrevDock = NULL;
1512 mLastPos.x = mBarPos.x = -1;
1513 mLastPos.y = mBarPos.y = -1;
1514 mTimer.Stop();
1515 mDidDrag = false;
1516 mClicked = false;
1517
1518 RestoreFocus();
1519}
1520
1522{
1523 if (mLastFocus) {
1524 auto temp1 = AButton::TemporarilyAllowFocus();
1525 auto temp2 = ASlider::TemporarilyAllowFocus();
1527 mLastFocus->SetFocus();
1528 return true;
1529 }
1530 return false;
1531}
1532
1534{
1535 for (auto pProject : AllProjects{}) {
1536 auto &project = *pProject;
1538 }
1539}
1540
1541#include "../commands/CommandManager.h"
1543{
1544 // Refreshes can occur during shutdown and the toolmanager may already
1545 // be deleted, so protect against it.
1546 auto &toolManager = ToolManager::Get( project );
1547
1548 // Now, go through each toolbar, and call EnableDisableButtons()
1549 toolManager.ForEach([](auto bar){
1550 if (bar)
1551 bar->EnableDisableButtons();
1552 });
1553
1554 // These don't really belong here, but it's easier and especially so for
1555 // the Edit toolbar and the sync-lock menu item.
1556 bool active = SyncLockTracks.Read();
1558
1560}
1561
1563 Identifier id, const CommandID &name, const TranslatableString &label_in,
1564 const Registry::OrderingHint &hint,
1565 std::vector< Identifier > excludeIDs
1566) : mId{ id }
1567 , mAttachedItem{
1568 Registry::Placement{ wxT("View/Other/Toolbars/Toolbars/Other"), hint },
1569 ( MenuTable::FinderScope(
1571 { return *this; } ),
1572 MenuTable::Command( name, label_in,
1576 auto &toolManager = ToolManager::Get( project );
1577 return toolManager.IsVisible( id ); } ) ) ) }
1578 , mExcludeIds{ std::move( excludeIDs ) }
1579{}
1580
1582{
1583 auto &project = context.project;
1584 auto &toolManager = ToolManager::Get( project );
1585
1586 if( !toolManager.IsVisible( mId ) )
1587 {
1588 for ( const auto excludedID : mExcludeIds )
1589 toolManager.Expose( excludedID, false );
1590 }
1591
1592 toolManager.ShowHide(mId);
1594}
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
EVT_COMMAND(wxID_ANY, EVT_FREQUENCYTEXTCTRL_UPDATED, LabelDialog::OnFreqUpdate) LabelDialog
Definition: LabelDialog.cpp:89
#define safenew
Definition: MemoryX.h:10
audacity::BasicSettings * gPrefs
Definition: Prefs.cpp:68
void GetPreferencesVersion(int &vMajor, int &vMinor, int &vMicro)
Definition: Prefs.cpp:210
static ProjectFileIORegistry::AttributeWriterEntry entry
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
#define toolbarSingle
Definition: ToolBar.h:59
#define toolbarGap
Definition: ToolBar.h:64
@ ToolBarFloatMargin
Definition: ToolBar.h:67
@ 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:1894
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
void UpdateCheckmarks(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 MenuManager & Get(AudacityProject &project)
Definition: Menus.cpp:69
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:205
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:190
ToolFrame(AudacityProject *parent, ToolManager *manager, ToolBar *bar, wxPoint pos)
Definition: ToolManager.cpp:73
wxSize mOrigSize
Definition: ToolManager.h:236
ToolBar * mBar
Definition: ToolManager.h:234
void OnMotion(wxMouseEvent &event)
wxSize mMinSize
Definition: ToolManager.h:235
ToolManager * mManager
Definition: ToolManager.h:233
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:198
void OnToolBarUpdate(wxCommandEvent &event)
void OnKeyDown(wxKeyEvent &event)
class ToolManager
Definition: ToolManager.h:56
static ToolManager & Get(AudacityProject &project)
void OnIndicatorCreate(wxWindowCreateEvent &event)
bool IsDocked(Identifier type) const
bool mLastState
Definition: ToolManager.h:158
ToolDock * GetBotDock()
void OnMenuUpdate(struct MenuUpdateMessage)
ToolBar * mDragBar
Definition: ToolManager.h:145
static void OnResetToolBars(const CommandContext &context)
void OnGrabber(GrabberEvent &event)
void ReadConfig()
void OnCaptureLost(wxMouseCaptureLostEvent &event)
ToolDock * mTopDock
Definition: ToolManager.h:164
void OnTimer(wxTimerEvent &event)
void Expose(Identifier type, bool show)
bool mTransition
Definition: ToolManager.h:161
void ShowHide(Identifier type)
std::map< Identifier, ToolBar::Holder > mBars
map not unordered_map, for the promise made by ForEach
Definition: ToolManager.h:168
void CreateWindows()
wxPoint mPrevPosition
Definition: ToolManager.h:170
wxTimer mTimer
Definition: ToolManager.h:157
ToolDock * GetTopDock()
ToolFrame * mDragWindow
Definition: ToolManager.h:143
void WriteConfig()
int FilterEvent(wxEvent &event) override
std::unique_ptr< wxRegion > mLeft
Definition: ToolManager.h:154
void RegenerateTooltips()
void UndockBar(wxPoint mp)
Observer::Subscription mMenuManagerSubscription
Definition: ToolManager.h:139
void LayoutToolBars()
void Destroy()
AudacityProject * mParent
Definition: ToolManager.h:140
void OnIndicatorPaint(wxPaintEvent &event)
void HandleEscapeKey()
ToolBarConfiguration mPrevConfiguration
Definition: ToolManager.h:174
std::unique_ptr< wxRegion > mDown
Definition: ToolManager.h:154
ToolDock * mPrevDock
Definition: ToolManager.h:171
static void ModifyToolbarMenus(AudacityProject &project)
ToolBarConfiguration::Position mPrevSlot
Definition: ToolManager.h:173
void DoneDragging()
void ForEach(F &&fun)
Visit bars, lexicographically by their textual ids.
Definition: ToolManager.h:103
ToolDock * mDragDock
Definition: ToolManager.h:144
void OnMouse(wxMouseEvent &event)
ToolBarConfiguration::Position mDragBefore
Definition: ToolManager.h:147
bool RestoreFocus()
Destroy_ptr< wxFrame > FramePtr
Definition: ToolManager.h:152
wxRegion * mCurrent
Definition: ToolManager.h:155
wxRect mBarPos
Definition: ToolManager.h:150
ToolDock * mBotDock
Definition: ToolManager.h:165
static void ModifyAllProjectToolbarMenus()
wxWindowRef mLastFocus
Definition: ToolManager.h:141
ToolManager(AudacityProject *parent)
ToolBar * GetToolBar(const Identifier &type) const
wxPoint mDragOffset
Definition: ToolManager.h:146
FramePtr mIndicator
Definition: ToolManager.h:153
wxPoint mLastPos
Definition: ToolManager.h:149
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
auto end(const Ptr< Type, BaseDeleter > &p)
Enables range-for.
Definition: PackedArray.h:159
Definition: Menus.h:35
static RegisteredToolbarFactory factory
void OnShowToolBar(const CommandContext &context)
const std::vector< Identifier > mExcludeIds
Definition: ToolManager.h:259
const Identifier mId
Definition: ToolManager.h:257
AttachedToolBarMenuItem(Identifier id, const CommandID &name, const TranslatableString &label_in, const Registry::OrderingHint &hint={}, std::vector< Identifier > excludeIds={})
Options && CheckTest(const CheckFn &fn) &&
Identifier rightOf
Identifier barID
Identifier below
Sent when menus update (such as for changing enablement of items)
Definition: Menus.h:74
static const Functions & GetFactories()
Definition: ToolBar.cpp:1047