ToolManager Class Reference

class ToolManager More...

#include <ToolManager.h>

Inheritance diagram for ToolManager:

Collaboration diagram for ToolManager:

Classes
struct	TopPanelHook

Public Member Functions
	ToolManager (AudacityProject *parent)
	ToolManager (const ToolManager &) PROHIBITED
ToolManager &	operator= (const ToolManager &) PROHIBITED
	~ToolManager ()
void	CreateWindows ()
void	LayoutToolBars ()
bool	IsDocked (Identifier type) const
bool	IsVisible (Identifier type) const
void	ShowHide (Identifier type)
void	Expose (Identifier type, bool show)
ToolBar *	GetToolBar (const Identifier &type) const
ToolDock *	GetTopDock ()
const ToolDock *	GetTopDock () const
ToolDock *	GetBotDock ()
const ToolDock *	GetBotDock () const
void	Reset ()
void	Destroy ()
void	RegenerateTooltips ()
int	FilterEvent (wxEvent &event) override
bool	RestoreFocus ()
template<typename F >
void	ForEach (F &&fun)
	Visit bars, lexicographically by their textual ids. More...
size_t	CountBars () const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static ToolManager &	Get (AudacityProject &project)
static const ToolManager &	Get (const AudacityProject &project)
static void	OnResetToolBars (const CommandContext &context)
static void	ModifyToolbarMenus (AudacityProject &project)
static void	ModifyAllProjectToolbarMenus ()

Private Types
using	FramePtr = Destroy_ptr< wxFrame >

Private Member Functions
ToolBar *	Float (ToolBar *t, wxPoint &pos)
void	OnMenuUpdate (struct MenuUpdateMessage)
void	OnTimer (wxTimerEvent &event)
void	OnMouse (wxMouseEvent &event)
void	OnCaptureLost (wxMouseCaptureLostEvent &event)
void	UndockBar (wxPoint mp)
void	OnGrabber (GrabberEvent &event)
void	HandleEscapeKey ()
void	DoneDragging ()
void	OnIndicatorCreate (wxWindowCreateEvent &event)
void	OnIndicatorPaint (wxPaintEvent &event)
void	ReadConfig ()
void	WriteConfig ()
void	Updated ()

Private Attributes
Observer::Subscription	mMenuManagerSubscription
AudacityProject *	mParent
wxWindowRef	mLastFocus {}
ToolFrame *	mDragWindow
ToolDock *	mDragDock
ToolBar *	mDragBar {}
wxPoint	mDragOffset
ToolBarConfiguration::Position	mDragBefore {}
wxPoint	mLastPos
wxRect	mBarPos
FramePtr	mIndicator
std::unique_ptr< wxRegion >	mLeft
std::unique_ptr< wxRegion >	mDown
wxRegion *	mCurrent
wxTimer	mTimer
bool	mLastState
bool	mTransition
ToolDock *	mTopDock {}
ToolDock *	mBotDock {}
std::map< Identifier, ToolBar::Holder >	mBars
	map not unordered_map, for the promise made by ForEach More...
wxPoint	mPrevPosition {}
ToolDock *	mPrevDock {}
ToolBarConfiguration::Position	mPrevSlot { ToolBarConfiguration::UnspecifiedPosition }
ToolBarConfiguration	mPrevConfiguration
bool	mDidDrag {}
bool	mClicked {}

Detailed Description

class ToolManager

Manages the ToolDocks and handles the dragging, floating, and docking of ToolBars.

Definition at line 52 of file ToolManager.h.

Member Typedef Documentation

FramePtr

using ToolManager::FramePtr = Destroy_ptr<wxFrame>

private

Definition at line 152 of file ToolManager.h.

Constructor & Destructor Documentation

ToolManager() [1/2]

ToolManager::ToolManager

(

AudacityProject *

parent

)

Definition at line 352 of file ToolManager.cpp.

: wxEvtHandler()
{
   wxPoint pt[ 3 ];
 
#if defined(__WXMAC__)
   // Save original transition
   mTransition = wxSystemOptions::GetOptionInt( wxMAC_WINDOW_PLAIN_TRANSITION );
#endif
 
   // Initialize everything
   mParent = parent;
   mLastPos.x = mBarPos.x = -1;
   mLastPos.y = mBarPos.y = -1;
   mDragWindow = NULL;
   mDragDock = NULL;
   mDragBar = NULL;
 
   // Create the down arrow
   pt[ 0 ].x = 0;
   pt[ 0 ].y = 0;
   pt[ 1 ].x = 9;
   pt[ 1 ].y = 9;
   pt[ 2 ].x = 18;
   pt[ 2 ].y = 0;
 
   // Create the shaped region
   mDown = std::make_unique<wxRegion>( 3, &pt[0] );
 
   // Create the down arrow
   pt[ 0 ].x = 9;
   pt[ 0 ].y = 0;
   pt[ 1 ].x = 0;
   pt[ 1 ].y = 9;
   pt[ 2 ].x = 9;
   pt[ 2 ].y = 18;
 
   // Create the shaped region
   mLeft = std::make_unique<wxRegion>( 3, &pt[0] );
 
   // Create the indicator frame
   // parent is null but FramePtr ensures destruction
   mIndicator = FramePtr{ safenew wxFrame( NULL,
                             wxID_ANY,
                             wxEmptyString,
                             wxDefaultPosition,
                             wxSize( 32, 32 ),
                             wxFRAME_TOOL_WINDOW |
                             wxFRAME_SHAPED |
                             wxNO_BORDER |
                             wxFRAME_NO_TASKBAR |
                             wxSTAY_ON_TOP )
   };
 
   // Hook the creation event...only needed on GTK, but doesn't hurt for all
   mIndicator->Bind( wxEVT_CREATE,
                        &ToolManager::OnIndicatorCreate,
                        this );
 
   // Hook the paint event...needed for all
   mIndicator->Bind( wxEVT_PAINT,
                        &ToolManager::OnIndicatorPaint,
                        this );
 
   // It's a little shy
   mIndicator->Hide();
}

References mBarPos, mDown, mDragBar, mDragDock, mDragWindow, mIndicator, mLastPos, mLeft, mParent, mTransition, OnIndicatorCreate(), OnIndicatorPaint(), and safenew.

Here is the call graph for this function:

ToolManager() [2/2]

ToolManager::ToolManager

(

const ToolManager &

)

~ToolManager()

ToolManager::~ToolManager

(

)

Definition at line 509 of file ToolManager.cpp.

{
   Destroy();
}

References Destroy().

Here is the call graph for this function:

Member Function Documentation

CountBars()

size_t ToolManager::CountBars ( ) const

inline

Definition at line 110 of file ToolManager.h.

   {
      return mBars.size();
   }

CreateWindows()

void ToolManager::CreateWindows

(

)

Assign (non-persistent!) sequential ids to the toolbars

Definition at line 420 of file ToolManager.cpp.

{
   auto parent = mParent;
   auto &window = GetProjectFrame( *parent );
 
   // Hook the parents mouse events...using the parent helps greatly
   // under GTK
   window.Bind( wxEVT_LEFT_UP,
                     &ToolManager::OnMouse,
                     this );
   window.Bind( wxEVT_MOTION,
                     &ToolManager::OnMouse,
                     this );
   window.Bind( wxEVT_MOUSE_CAPTURE_LOST,
                     &ToolManager::OnCaptureLost,
                     this );
 
   wxWindow *topDockParent = TopPanelHook::Call( window );
   wxASSERT(topDockParent);
 
   // Create the top and bottom docks
   mTopDock = safenew ToolDock( this, topDockParent, TopDockID );
   mBotDock = safenew ToolDock( this, &window, BotDockID );
 
   // Create all of the toolbars
   // All have the project as parent window
   wxASSERT(parent);
 
   for (const auto &factory : RegisteredToolbarFactory::GetFactories()) {
      if (factory) {
         auto bar = factory( *parent );
         if (bar) {
            auto &slot = mBars[bar->GetSection()];
            if (slot) {
               // Oh no, name collision of registered toolbars
               assert(false);
               bar->Destroy();
               continue;
            }
            slot = std::move(bar);
         }
      }
      else
         wxASSERT( false );
   }
 
   ForEach([ii = 0](ToolBar *bar) mutable { bar->SetIndex(ii++); });
 
   // We own the timer
   mTimer.SetOwner( this );
 
   // Process the toolbar config settings
   ReadConfig();
 
   wxEvtHandler::AddFilter(this);
 
   mMenuManagerSubscription = MenuManager::Get(*mParent)
      .Subscribe(*this, &ToolManager::OnMenuUpdate);
}

References BotDockID, GlobalHook< TopPanelHook, wxWindow *(wxWindow &) >::Call(), cloud::factory, ForEach(), MenuManager::Get(), RegisteredToolbarFactory::GetFactories(), GetProjectFrame(), mBars, mBotDock, mMenuManagerSubscription, mParent, mTimer, mTopDock, OnCaptureLost(), OnMenuUpdate(), OnMouse(), ReadConfig(), safenew, ToolBar::SetIndex(), Observer::Publisher< Message, NotifyAll >::Subscribe(), and TopDockID.

Referenced by InitProjectWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

Destroy()

void ToolManager::Destroy

(

)

Definition at line 485 of file ToolManager.cpp.

{
   if ( mTopDock || mBotDock ) { // destroy at most once
      wxEvtHandler::RemoveFilter(this);
 
      // Save the toolbar states
      WriteConfig();
 
      // This function causes the toolbars to be destroyed, so
      // clear the configuration of the ToolDocks which refer to
      // these toolbars. This change was needed to stop Audacity
      // crashing when running with Jaws on Windows 10 1703.
      mTopDock->GetConfiguration().Clear();
      mBotDock->GetConfiguration().Clear();
 
      mTopDock = mBotDock = nullptr; // indicate that it has been destroyed
 
      for (auto &pair : mBars)
         pair.second.reset();
 
      mIndicator.reset();
   }
}

References ToolBarConfiguration::Clear(), ToolDock::GetConfiguration(), mBars, mBotDock, mIndicator, mTopDock, and WriteConfig().

Referenced by ProjectManager::OnCloseWindow(), and ~ToolManager().

Here is the call graph for this function:

Here is the caller graph for this function:

DoneDragging()

void ToolManager::DoneDragging ( )

private

Definition at line 1504 of file ToolManager.cpp.

{
   // Done dragging - ensure grabber button isn't pushed
   if( mDragBar )
   {
      mDragBar->SetDocked( mDragBar->GetDock(), false );
   }
 
   // Release capture
   auto &window = GetProjectFrame( *mParent );
   if( window.HasCapture() )
   {
      window.ReleaseMouse();
   }
 
   // Hide the indicator
   mIndicator->Hide();
 
   mDragWindow = NULL;
   mDragDock = NULL;
   mDragBar = NULL;
   mPrevDock = NULL;
   mPrevSlot = { ToolBarConfiguration::UnspecifiedPosition };
   mPrevConfiguration.Clear();
   mLastPos.x = mBarPos.x = -1;
   mLastPos.y = mBarPos.y = -1;
   mTimer.Stop();
   mDidDrag = false;
   mClicked = false;
 
   RestoreFocus();
}

References ToolBarConfiguration::Clear(), ToolBar::GetDock(), GetProjectFrame(), mBarPos, mClicked, mDidDrag, mDragBar, mDragDock, mDragWindow, mIndicator, mLastPos, mParent, mPrevConfiguration, mPrevDock, mPrevSlot, mTimer, RestoreFocus(), ToolBar::SetDocked(), and ToolBarConfiguration::UnspecifiedPosition.

Referenced by HandleEscapeKey(), and OnMouse().

Here is the call graph for this function:

Here is the caller graph for this function:

Expose()

void ToolManager::Expose	(	Identifier	type,
		bool	show
	)

Definition at line 1082 of file ToolManager.cpp.

{
   ToolBar *t = mBars[type].get();
 
   // Handle docked and floaters differently
   if( t->IsDocked() )
   {
      t->GetDock()->Expose( t->GetSection(), show );
   }
   else
   {
      t->Expose( show );
   }
}

References ToolBar::Expose(), ToolDock::Expose(), ToolBar::GetDock(), ToolBar::GetSection(), ToolBar::IsDocked(), and mBars.

Referenced by ReadConfig(), Reset(), and ShowHide().

Here is the call graph for this function:

Here is the caller graph for this function:

FilterEvent()

int ToolManager::FilterEvent ( wxEvent &  event )

override

Definition at line 690 of file ToolManager.cpp.

{
   // Snoop the global event stream for changes of focused window.  Remember
   // the last one of our own that is not a grabber.
 
   if (event.GetEventType() == wxEVT_KILL_FOCUS) {
      auto &focusEvent = static_cast<wxFocusEvent&>(event);
      auto window = focusEvent.GetWindow();
      auto top = wxGetTopLevelParent(window);
      if(auto toolFrame = dynamic_cast<ToolFrame*>(top))
         top = toolFrame->GetParent();
      // window is that which will GET the focus
      if ( window &&
           !dynamic_cast<Grabber*>( window ) &&
           !dynamic_cast<ToolFrame*>( window ) &&
           top == FindProjectFrame( mParent ) )
         // Note this is a dangle-proof wxWindowRef:
         mLastFocus = window;
   }
 
   return Event_Skip;
}

References FindProjectFrame(), mLastFocus, and mParent.

Here is the call graph for this function:

Float()

ToolBar * ToolManager::Float ( ToolBar *  t, wxPoint &  pos  )

private

ForEach()

template<typename F >

void ToolManager::ForEach ( F &&  fun )

inline

Visit bars, lexicographically by their textual ids.

Definition at line 103 of file ToolManager.h.

   {
      std::for_each(std::begin(mBars), std::end(mBars), [&fun](auto &pair){
         fun(pair.second.get());
      });
   }

References PackedArray::begin(), and PackedArray::end().

Referenced by CreateWindows(), ScreenshotCommand::kCaptureWhatStrings(), ScreenshotBigDialog::PopulateOrExchange(), ReadConfig(), RegenerateTooltips(), Reset(), and WriteConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [1/2]

ToolManager & ToolManager::Get ( AudacityProject &  project )

static

Definition at line 339 of file ToolManager.cpp.

{
   return project.AttachedObjects::Get< ToolManager >( key );
}

References key.

Referenced by ScreenshotCommand::Apply(), ControlToolBar::Find(), cloud::ShareAudioToolbar::Get(), AudioSetupToolBar::Get(), ControlToolBar::Get(), DeviceToolBar::Get(), ScrubbingToolBar::Get(), SelectionBar::Get(), TimeToolBar::Get(), ToolsToolBar::Get(), TranscriptionToolBar::Get(), MeterToolBar::Get(), Get(), InitProjectWindow(), ScreenshotCommand::kCaptureWhatStrings(), ModifyToolbarMenus(), ProjectManager::New(), anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame(), ProjectWindow::OnActivate(), ProjectManager::OnCloseWindow(), anonymous_namespace{ExtraMenus.cpp}::OnFullScreen(), OnResetToolBars(), AttachedToolBarMenuItem::OnShowToolBar(), ProjectWindow::OnThemeChange(), ScreenshotBigDialog::PopulateOrExchange(), ProjectAudioManager::Stop(), and ProjectWindow::UpdateLayout().

Here is the caller graph for this function:

Get() [2/2]

const ToolManager & ToolManager::Get ( const AudacityProject &  project )

static

Definition at line 344 of file ToolManager.cpp.

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

References Get().

Here is the call graph for this function:

GetBotDock() [1/2]

ToolDock * ToolManager::GetBotDock

(

)

Definition at line 1017 of file ToolManager.cpp.

{
   return mBotDock;
}

References mBotDock.

GetBotDock() [2/2]

const ToolDock * ToolManager::GetBotDock

(

)

const

Definition at line 1022 of file ToolManager.cpp.

{
   return mBotDock;
}

References mBotDock.

GetToolBar()

ToolBar * ToolManager::GetToolBar

(

const Identifier &

type

)

const

Definition at line 995 of file ToolManager.cpp.

{
   auto end = mBars.end(), iter = mBars.find(type);
   return (iter == end) ? nullptr : iter->second.get();
}

References PackedArray::end(), and mBars.

Referenced by ScreenshotCommand::CaptureToolbar(), IsDocked(), IsVisible(), OnGrabber(), ReadConfig(), Reset(), and ProjectAudioManager::Stop().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTopDock() [1/2]

ToolDock * ToolManager::GetTopDock

(

)

Definition at line 1004 of file ToolManager.cpp.

{
   return mTopDock;
}

References mTopDock.

GetTopDock() [2/2]

const ToolDock * ToolManager::GetTopDock

(

)

const

Definition at line 1009 of file ToolManager.cpp.

{
   return mTopDock;
}

References mTopDock.

HandleEscapeKey()

void ToolManager::HandleEscapeKey ( )

private

Definition at line 1475 of file ToolManager.cpp.

{
   if (mDragBar) {
      if(mPrevDock) {
         // Sheriff John Stone,
         // Why don't you leave me alone?
         // Well, I feel so break up
         // I want to go home.
         mPrevDock->RestoreConfiguration(mPrevConfiguration);
         mPrevDock->Dock( mDragBar, true, mPrevSlot );
         Updated();
 
         // Done with the floater
         mDragWindow->ClearBar();
         mDragWindow->Destroy();
         mDragWindow = nullptr;
         mDragBar->Refresh(false);
      }
      else {
         // Floater remains, and returns to where it begain
         auto parent = mDragBar->GetParent();
         parent->SetPosition(mPrevPosition);
         mDragBar->SetDocked(NULL, false);
      }
 
      DoneDragging();
   }
}

References ToolFrame::ClearBar(), ToolDock::Dock(), DoneDragging(), mDragBar, mDragWindow, mPrevConfiguration, mPrevDock, mPrevPosition, mPrevSlot, ToolDock::RestoreConfiguration(), ToolBar::SetDocked(), and Updated().

Referenced by OnGrabber().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDocked()

bool ToolManager::IsDocked

(

Identifier

type

)

const

Definition at line 1041 of file ToolManager.cpp.

{
   if (auto pBar = GetToolBar(type))
      return pBar->IsDocked();
   return false;
}

References GetToolBar().

Here is the call graph for this function:

IsVisible()

bool ToolManager::IsVisible

(

Identifier

type

)

const

Definition at line 1051 of file ToolManager.cpp.

{
   if (auto pBar = GetToolBar(type))
      return pBar->IsVisible();
   return false;
 
#if 0
   // If toolbar is floating
   if( !t->IsDocked() )
   {
      // Must return state of floater window
      return t->GetParent()->IsShown();
   }
 
   // Return state of docked toolbar
   return t->IsShown();
#endif
}

References GetToolBar().

Referenced by ScreenshotCommand::CaptureToolbar(), and ShowHide().

Here is the call graph for this function:

Here is the caller graph for this function:

LayoutToolBars()

void ToolManager::LayoutToolBars

(

)

Definition at line 1100 of file ToolManager.cpp.

{
   // Update the layout
   if (mTopDock)
   {
      mTopDock->LayoutToolBars();
   }
 
   if (mBotDock)
   {
      mBotDock->LayoutToolBars();
   }
}

References ToolDock::LayoutToolBars(), mBotDock, and mTopDock.

Referenced by InitProjectWindow(), and OnMouse().

Here is the call graph for this function:

Here is the caller graph for this function:

ModifyAllProjectToolbarMenus()

void ToolManager::ModifyAllProjectToolbarMenus ( )

static

Definition at line 1549 of file ToolManager.cpp.

{
   for (auto pProject : AllProjects{}) {
      auto &project = *pProject;
      ModifyToolbarMenus(project);
   }
}

References ModifyToolbarMenus().

Referenced by anonymous_namespace{TrackMenus.cpp}::OnSyncLock(), anonymous_namespace{TransportMenus.cpp}::OnTogglePlayRecording(), anonymous_namespace{TransportMenus.cpp}::OnToggleSoundActivated(), anonymous_namespace{TransportMenus.cpp}::OnToggleSWPlaythrough(), anonymous_namespace{LabelMenus.cpp}::OnToggleTypeToCreateLabel(), and AdornedRulerPanel::TogglePinnedHead().

Here is the call graph for this function:

Here is the caller graph for this function:

ModifyToolbarMenus()

void ToolManager::ModifyToolbarMenus ( AudacityProject &  project )

static

Definition at line 1558 of file ToolManager.cpp.

{
   // Refreshes can occur during shutdown and the toolmanager may already
   // be deleted, so protect against it.
   auto &toolManager = ToolManager::Get( project );
 
   // Now, go through each toolbar, and call EnableDisableButtons()
   toolManager.ForEach([](auto bar){
      if (bar)
         bar->EnableDisableButtons();
   });
 
   // These don't really belong here, but it's easier and especially so for
   // the Edit toolbar and the sync-lock menu item.
   bool active = SyncLockTracks.Read();
   SyncLockState::Get(project).SetSyncLock(active);
 
   CommandManager::Get( project ).UpdateCheckmarks( project );
}

References SyncLockState::Get(), CommandManager::Get(), Get(), Setting< T >::Read(), SyncLockState::SetSyncLock(), SyncLockTracks, and CommandManager::UpdateCheckmarks().

Referenced by ModifyAllProjectToolbarMenus(), anonymous_namespace{ExtraMenus.cpp}::OnFullScreen(), OnMenuUpdate(), OnResetToolBars(), and AttachedToolBarMenuItem::OnShowToolBar().

Here is the call graph for this function:

Here is the caller graph for this function:

OnCaptureLost()

void ToolManager::OnCaptureLost ( wxMouseCaptureLostEvent &  event )

private

Definition at line 1304 of file ToolManager.cpp.

{
   // Can't do anything if we're not dragging.  This also prevents
   // us from intercepting events that don't belong to us from the
   // parent since we're Connect()ed to a couple.
   if( !mDragWindow )
   {
      event.Skip();
      return;
   }
 
   // Simulate button up
   wxMouseEvent e(wxEVT_LEFT_UP);
   e.SetEventObject(mParent);
   OnMouse(e);
}

References mDragWindow, mParent, and OnMouse().

Referenced by CreateWindows().

Here is the call graph for this function:

Here is the caller graph for this function:

OnGrabber()

void ToolManager::OnGrabber ( GrabberEvent &  event )

private

Definition at line 1427 of file ToolManager.cpp.

{
   // No need to propagate any further
   event.Skip( false );
 
   if(event.IsEscaping())
      return HandleEscapeKey();
 
   // Remember which bar we're dragging
   mDragBar = GetToolBar(event.BarId());
 
   // Remember state, in case of ESCape key later
   if (mDragBar->IsDocked()) {
      mPrevDock = dynamic_cast<ToolDock*>(mDragBar->GetParent());
      wxASSERT(mPrevDock);
      mPrevSlot = mPrevDock->GetConfiguration().Find(mDragBar);
      mPrevDock->WrapConfiguration(mPrevConfiguration);
   }
   else
      mPrevPosition = mDragBar->GetParent()->GetPosition();
 
   // Calculate the drag offset
   wxPoint mp = event.GetPosition();
   mDragOffset = mp -
                 mDragBar->GetParent()->ClientToScreen( mDragBar->GetPosition() ) +
      wxPoint( 1, 1 );
 
   mClicked = true;
   if( mPrevDock )
   {
      mDragWindow = nullptr;
   }
   else
   {
      mDragWindow = (ToolFrame *) mDragBar->GetParent();
   }
 
   // We want all mouse events from this point on
   auto &window = GetProjectFrame( *mParent );
   if( !window.HasCapture() )
      window.CaptureMouse();
 
   // Start monitoring shift key changes
   mLastState = wxGetKeyState( WXK_SHIFT );
   mTimer.Start( 100 );
}

References GrabberEvent::BarId(), ToolBarConfiguration::Find(), ToolDock::GetConfiguration(), GetProjectFrame(), GetToolBar(), HandleEscapeKey(), ToolBar::IsDocked(), GrabberEvent::IsEscaping(), mClicked, mDragBar, mDragOffset, mDragWindow, mLastState, mParent, mPrevConfiguration, mPrevDock, mPrevPosition, mPrevSlot, mTimer, and ToolDock::WrapConfiguration().

Here is the call graph for this function:

OnIndicatorCreate()

void ToolManager::OnIndicatorCreate ( wxWindowCreateEvent &  event )

private

Definition at line 1386 of file ToolManager.cpp.

{
#if defined(__WXGTK__)
   mIndicator->SetShape( *mCurrent );
#endif
   event.Skip();
}

References mCurrent, and mIndicator.

Referenced by ToolManager().

Here is the caller graph for this function:

OnIndicatorPaint()

void ToolManager::OnIndicatorPaint ( wxPaintEvent &  event )

private

Definition at line 1369 of file ToolManager.cpp.

{
   // TODO: Better to use a bitmap than a triangular region.
   wxWindow *w = (wxWindow *)event.GetEventObject();
   wxPaintDC dc( w );
   // TODO: Better (faster) to use the existing spare brush.
   wxBrush brush( theTheme.Colour( clrTrackPanelText ) );
   dc.SetBackground( brush );
   dc.Clear();
}

References ThemeBase::Colour(), and theTheme.

Referenced by ToolManager().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMenuUpdate()

void ToolManager::OnMenuUpdate ( struct MenuUpdateMessage  )

private

Definition at line 1321 of file ToolManager.cpp.

{
   ModifyToolbarMenus( *mParent );
}

References ModifyToolbarMenus(), and mParent.

Referenced by CreateWindows().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMouse()

void ToolManager::OnMouse ( wxMouseEvent &  event )

private

Definition at line 1117 of file ToolManager.cpp.

{
   // Go ahead and set the event to propagate
   event.Skip();
 
   // Can't do anything if we're not dragging.  This also prevents
   // us from intercepting events that don't belong to us from the
   // parent since we're Connect()ed to a couple.
   if( !mClicked )
   {
      return;
   }
 
#if defined(__WXMAC__)
   // Disable window animation
   wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
#endif
 
   // Retrieve the event position
   wxPoint pos =
      ( (wxWindow *)event.GetEventObject() )->ClientToScreen( event.GetPosition() ) - mDragOffset;
 
 
   if( !event.LeftIsDown() )
   {
      // Button was released...finish the drag
      // Transition the bar to a dock
      if (!mDidDrag) {
         if (mPrevDock)
            mPrevDock->RestoreConfiguration(mPrevConfiguration);
         DoneDragging();
         return;
      }
      else if( mDragDock && !event.ShiftDown() )
      {
         // Trip over...everyone ashore that's going ashore...
         mDragDock->Dock( mDragBar, true, mDragBefore );
         Updated();
         mDragWindow->ClearBar();
 
         // Done with the floater
         mDragWindow->Destroy();
         mDragWindow = nullptr;
         mDragBar->Refresh(false);
      }
      else
      {
         // Calling SetDocked() to force the grabber button to popup
         mDragBar->SetDocked( NULL, false );
      }
 
      DoneDragging();
   }
   else if( event.Dragging() && pos != mLastPos )
   {
      if (!mDidDrag) {
         // Must set the bar afloat if it's currently docked
         mDidDrag = true;
         wxPoint mp = event.GetPosition();
         mp = GetProjectFrame( *mParent ).ClientToScreen(mp);
         if (!mDragWindow) {
            // We no longer have control
            if (mPrevDock)
               mPrevDock->GetConfiguration().Remove( mDragBar );
            UndockBar(mp);
            // Rearrange the remaining toolbars before trying to re-insert this one.
            LayoutToolBars();
         }
      }
 
      // Make toolbar follow the mouse
      mDragWindow->Move( pos  );
 
      // Remember to prevent excessive movement
      mLastPos = pos;
 
      // Calc the top dock hittest rectangle
      wxRect tr = mTopDock->GetRect();
      tr.SetBottom( tr.GetBottom() + 10 );
      tr.SetPosition( mTopDock->GetParent()->ClientToScreen( tr.GetPosition() ) );
 
      // Calc the bottom dock hittest rectangle
      wxRect br = mBotDock->GetRect();
      br.SetTop( br.GetTop() - 10 );
      br.SetBottom( br.GetBottom() + 20 );
      br.SetPosition( mBotDock->GetParent()->ClientToScreen( br.GetPosition() ) );
 
 
      // Add half the bar height.  We could use the actual bar height, but that would be confusing as a
      // bar removed at a place might not dock back there if just let go.
      // Also add 5 pixels in horizontal direction, so that a click without a move (or a very small move)
      // lands back where we started.
      pos +=  wxPoint( 5, 20 );
 
 
      // To find which dock, rather than test against pos, test against the whole dragger rect.
      // This means it is enough to overlap the dock to dock with it.
      wxRect barRect = mDragWindow->GetRect();
      ToolDock *dock = NULL;
      if( tr.Intersects( barRect ) )
         dock = mTopDock;
      else if( br.Intersects( barRect ) )
         dock = mBotDock;
 
      // Looks like we have a winner...
      if( dock )
      {
         wxPoint p;
         wxRect r;
 
         // Calculate where the bar would be placed
         mDragBefore = dock->PositionBar( mDragBar, pos, r );
 
         // If different than the last time, the indicator must be moved
         if( r != mBarPos )
         {
            wxRect dr = dock->GetRect();
 
            // Hide the indicator before changing the shape
            mIndicator->Hide();
 
            // Decide which direction the arrow should point
            if( r.GetTop() >= dr.GetHeight() )
            {
               const auto &box = mDown->GetBox();
               p.x = dr.GetLeft() + ( dr.GetWidth() / 2 )
                 - (box.GetWidth() / 2);
               p.y = dr.GetBottom() - box.GetHeight();
               mCurrent = mDown.get();
            }
            else
            {
               // r is the rectangle of the toolbar being dragged.
               // A tall undocked toolbar will become at most 2 tbs
               // high when docked, so the triangular drop indicator
               // needs to use that height, h, not the bar height
               // for calculating where to be drawn.
               const int tbs = toolbarSingle + toolbarGap;
               int h = wxMin(r.GetHeight(), 2*tbs-1);
               p.x = dr.GetLeft() + r.GetLeft();
               p.y = dr.GetTop() + r.GetTop() +
                  ( ( h - mLeft->GetBox().GetHeight() ) / 2 );
               mCurrent = mLeft.get();
            }
 
            // Change the shape while hidden and then show it if okay
            mIndicator->SetShape( *mCurrent );
            if( !event.ShiftDown() )
            {
               mIndicator->Show();
               mIndicator->Update();
            }
 
            // Move it into position
            // LL:  Do this after the Show() since KDE doesn't move the window
            //      if it's not shown.  (Do it outside if the previous IF as well)
            mIndicator->Move( dock->GetParent()->ClientToScreen( p ) );
 
            // Remember for next go round
            mBarPos = r;
         }
      }
      else
      {
         // Hide the indicator if it's still shown
         if( mBarPos.x != -1 )
         {
            // Hide any
            mIndicator->Hide();
            mBarPos.x = -1;
            mBarPos.y = -1;
         }
      }
 
      // Remember to which dock the drag bar belongs.
      mDragDock = dock;
   }
 
#if defined(__WXMAC__)
   // Reinstate original transition
   wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
#endif
}

References ToolFrame::ClearBar(), ToolDock::Dock(), DoneDragging(), ToolDock::GetConfiguration(), GetProjectFrame(), LayoutToolBars(), mBarPos, mBotDock, mClicked, mCurrent, mDidDrag, mDown, mDragBar, mDragBefore, mDragDock, mDragOffset, mDragWindow, mIndicator, mLastPos, mLeft, mPrevConfiguration, mPrevDock, mTopDock, mTransition, ToolDock::PositionBar(), ToolBarConfiguration::Remove(), ToolDock::RestoreConfiguration(), ToolBar::SetDocked(), toolbarGap, toolbarSingle, UndockBar(), and Updated().

Referenced by CreateWindows(), and OnCaptureLost().

Here is the call graph for this function:

Here is the caller graph for this function:

OnResetToolBars()

void ToolManager::OnResetToolBars ( const CommandContext &  context )

static

Definition at line 566 of file ToolManager.cpp.

{
   auto &project = context.project;
   auto &toolManager = ToolManager::Get( project );
 
   toolManager.Reset();
   Get(project).ModifyToolbarMenus(project);
}

References Get(), ModifyToolbarMenus(), and CommandContext::project.

Referenced by anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), and anonymous_namespace{ToolbarMenus.cpp}::ToolbarsMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnTimer()

void ToolManager::OnTimer ( wxTimerEvent &  event )

private

Definition at line 1329 of file ToolManager.cpp.

{
   // Go ahead and set the event to propagate
   event.Skip();
 
   // Can't do anything if we're not dragging.  This also prevents
   // us from intercepting events that don't belong to us from the
   // parent since we're Connect()ed to a couple.
   if( !mDragWindow )
   {
      return;
   }
 
   bool state = wxGetKeyState( WXK_SHIFT );
   if( mLastState != state )
   {
      mLastState = state;
 
#if defined(__WXMAC__)
      // Disable window animation
      wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
#endif
 
      mIndicator->Show( !state );
 
#if defined(__WXMAC__)
      // Disable window animation
      wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
#endif
   }
 
   return;
}

References mDragWindow, mIndicator, mLastState, and mTransition.

operator=()

ToolManager & ToolManager::operator=

(

const ToolManager &

)

ReadConfig()

void ToolManager::ReadConfig ( )

private

Definition at line 716 of file ToolManager.cpp.

{
   wxString oldpath = gPrefs->GetPath();
   std::vector<Identifier> unordered[ DockCount ];
   std::vector<ToolBar*> dockedAndHidden;
   std::map<Identifier, bool> show;
   std::map<Identifier, int> width;
   std::map<Identifier, int> height;
   int x, y;
   int dock;
   bool someFound { false };
 
#if defined(__WXMAC__)
   // Disable window animation
   wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
#endif
 
   // Change to the bar root
   gPrefs->SetPath( wxT("/GUI/ToolBars") );
 
   ToolBarConfiguration::Legacy topLegacy, botLegacy;
 
   int vMajor, vMinor, vMicro;
   gPrefs->GetVersionKeysInit(vMajor, vMinor, vMicro);
   bool useLegacyDock = false;
   // note that vMajor, vMinor, and vMicro will all be zero if either it's a new audacity.cfg file
   // or the version is less than 1.3.13 (when there were no version keys according to the comments in
   // InitPreferences()). So for new audacity.cfg
   // file useLegacyDock will be true, but this doesn't matter as there are no Dock or DockV2 keys in the file yet.
   if (vMajor <= 1 ||
      (vMajor == 2 && (vMinor <= 1 || (vMinor == 2 && vMicro <= 1))))   // version <= 2.2.1
      useLegacyDock = true;
 
 
   // Load and apply settings for each bar
   ForEach([&](ToolBar *bar){
      //wxPoint Center = mParent->GetPosition() + (mParent->GetSize() * 0.33);
      //wxPoint Center(
      //   wxSystemSettings::GetMetric( wxSYS_SCREEN_X ) /2 ,
      //   wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) /2 );
 
      // Change to the bar subkey
      auto ndx = bar->GetSection();
      gPrefs->SetPath( ndx.GET() );
 
      const bool bShownByDefault = bar->ShownByDefault();
      const int defaultDock = bar->DefaultDockID();
 
      // Read in all the settings
 
      if (useLegacyDock)
         gPrefs->Read( wxT("Dock"), &dock, -1);       // legacy version of DockV2
      else
         gPrefs->Read( wxT("DockV2"), &dock, -1);
 
      const bool found = (dock != -1);
      if (found)
         someFound = true;
      if (!found)
         dock = defaultDock;
 
      ToolDock *d;
      ToolBarConfiguration::Legacy *pLegacy;
      switch(dock)
      {
         case TopDockID: d = mTopDock; pLegacy = &topLegacy; break;
         case BotDockID: d = mBotDock; pLegacy = &botLegacy;  break;
         default:        d = nullptr; pLegacy = nullptr; break;
      }
 
      bool ordered = ToolBarConfiguration::Read(
         d ? &d->GetConfiguration() : nullptr,
         pLegacy,
         bar, show[ ndx ], bShownByDefault)
      && found;
 
      gPrefs->Read( wxT("X"), &x, -1 );
      gPrefs->Read( wxT("Y"), &y, -1 );
      gPrefs->Read( wxT("W"), &width[ ndx ], -1 );
      gPrefs->Read( wxT("H"), &height[ ndx ], -1 );
 
      bar->SetVisible( show[ ndx ] );
 
      // Docked or floating?
      if( dock )
      {
         // Default to top dock if the ID isn't valid
         if( dock < NoDockID || dock > DockCount ) {
            dock = TopDockID;
         }
 
         // Create the bar with the correct parent
         if( dock == TopDockID )
         {
            bar->Create( mTopDock );
         }
         else
         {
            bar->Create( mBotDock );
         }
 
         // Set the width and height
         if( width[ ndx ] != -1 && height[ ndx ] != -1 )
         {
            wxSize sz( width[ ndx ], height[ ndx ] );
            bar->SetSize( sz );
            bar->ResizingDone();
         }
 
         // Set the width
         if( width[ ndx ] >= bar->GetSize().x )
         {
            wxSize sz( width[ ndx ], bar->GetSize().y );
            bar->SetSize( sz );
            bar->Layout();
         }
 
         // make a note of docked and hidden toolbars
         if (!show[ndx])
            dockedAndHidden.push_back(bar);
 
         if (!ordered)
         {
            // These must go at the end
            unordered[ dock - 1 ].push_back( ndx );
         }
      }
      else
      {
         // Create the bar (with the top dock being temporary parent)
         bar->Create( mTopDock );
 
         // Construct a NEW floater
         wxASSERT(mParent);
         ToolFrame *f = safenew ToolFrame( mParent, this, bar, wxPoint( x, y ) );
 
         // Set the width and height
         if( width[ ndx ] != -1 && height[ ndx ] != -1 )
         {
            wxSize sz( width[ ndx ], height[ ndx ] );
            f->SetSizeHints( sz );
            f->SetSize( sz );
            f->Layout();
            if( (x!=-1) && (y!=-1) )
               bar->SetPositioned();
         }
 
         // Required on Linux Xfce
         wxSize msz(width[ndx],height[ndx]-1);
         bar->GetParent()->SetMinSize(msz);
 
         // Inform toolbar of change
         bar->SetDocked( NULL, false );
 
         // Show or hide it
         Expose( bar->GetSection(), show[ ndx ] );
      }
 
      // Change back to the bar root
      //gPrefs->SetPath( wxT("..") );  <-- Causes a warning...
      // May or may not have gone into a subdirectory,
      // so use an absolute path.
      gPrefs->SetPath( wxT("/GUI/ToolBars") );
   });
 
   mTopDock->GetConfiguration().PostRead(topLegacy);
   mBotDock->GetConfiguration().PostRead(botLegacy);
 
   // Add all toolbars to their target dock
   for( dock = 0; dock < DockCount; dock++ )
   {
      ToolDock *d = ( dock + 1 == TopDockID ? mTopDock : mBotDock );
 
      d->LoadConfig();
 
      // Add all unordered toolbars
      for( int ord = 0; ord < (int) unordered[ dock ].size(); ord++ )
      {
         ToolBar *t = mBars[unordered[dock][ord]].get();
 
         // Dock it
         d->Dock( t, false );
 
         // Show or hide the bar
         Expose( t->GetSection(), show[ t->GetSection() ] );
      }
   }
 
   // hidden docked toolbars
   for (auto bar : dockedAndHidden) {
      bar->SetVisible(false );
      bar->GetDock()->Dock(bar, false);
      bar->Expose(false);
   }
 
   // Restore original config path
   gPrefs->SetPath( oldpath );
 
#if defined(__WXMAC__)
   // Reinstate original transition
   wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
#endif
 
   // Setup the neighbors according to the
   // default config
 
   for (const auto& entry : DefaultConfigTable)
   {
      const auto &ndx = entry.barID;
      const auto bar = GetToolBar(ndx);
      bar->SetPreferredNeighbors(entry.rightOf, entry.below);
   }
 
   if (!someFound)
      Reset();
}

References BotDockID, ToolBar::Create(), DefaultConfigTable, ToolBar::DefaultDockID(), ToolDock::Dock(), DockCount, entry, ToolBar::Expose(), Expose(), ForEach(), ToolDock::GetConfiguration(), ToolBar::GetDock(), FileConfig::GetPath(), ToolBar::GetSection(), GetToolBar(), FileConfig::GetVersionKeysInit(), gPrefs, ToolDock::LoadConfig(), mBars, mBotDock, mParent, mTopDock, mTransition, ToolBarConfiguration::PostRead(), ToolBarConfiguration::Read(), Reset(), ToolBar::ResizingDone(), safenew, ToolBar::SetDocked(), FileConfig::SetPath(), ToolBar::SetPositioned(), ToolBar::SetPreferredNeighbors(), ToolBar::SetVisible(), ToolBar::ShownByDefault(), size, TopDockID, and wxT().

Referenced by CreateWindows().

Here is the call graph for this function:

Here is the caller graph for this function:

RegenerateTooltips()

void ToolManager::RegenerateTooltips

(

)

Definition at line 682 of file ToolManager.cpp.

{
   ForEach([](auto bar){
      if (bar)
         bar->RegenerateTooltips();
   });
}

References ForEach().

Referenced by ProjectManager::New().

Here is the call graph for this function:

Here is the caller graph for this function:

Reset()

void ToolManager::Reset

(

)

Definition at line 576 of file ToolManager.cpp.

{
   // Disconnect all docked bars
   for ( const auto &entry : DefaultConfigTable )
   {
      const auto &ndx = entry.barID;
      ToolBar *bar = GetToolBar(ndx);
      if (!bar)
         continue;
 
      ToolBarConfiguration::Position position {
         (entry.rightOf == Identifier{}) ? nullptr : GetToolBar(entry.rightOf),
         (entry.below == Identifier{}) ? nullptr : GetToolBar(entry.below)
      };
      
      bar->SetSize( 20,20 );
 
      wxWindow *floater;
      ToolDock *dock;
      bool expose = true;
 
      // Disconnect the bar
      if( bar->IsDocked() )
      {
         bar->GetDock()->Undock( bar );
         floater = NULL;
      }
      else
      {
         floater = bar->GetParent();
      }
 
      // Decide which dock.
      dock = (bar->DefaultDockID() == ToolBar::TopDockID)
         ? mTopDock : mBotDock;
 
      // PRL: Destroy the tool frame before recreating buttons.
      // This fixes some subtle sizing problems on macOs.
      bar->Reparent( dock );
      //OK (and good) to DELETE floater, as bar is no longer in it.
      if( floater )
         floater->Destroy();
 
      // Recreate bar buttons (and resize it)
      bar->SetToDefaultSize();
      bar->ReCreateButtons();
      bar->EnableDisableButtons();
 
#if 0
      if( bar->IsResizable() )
      {
         bar->SetSize(bar->GetBestFittingSize());
      }
#endif
 
      // Hide some bars.
      expose = bar->ShownByDefault() || bar->HideAfterReset();
 
      // Next condition will always (?) be true, as the reset configuration is
      // with no floating toolbars.
      if( dock != NULL )
      {
         // when we dock, we reparent, so bar is no longer a child of floater.
         dock->Dock( bar, false, position );
         Expose( bar->GetSection(), expose );
      }
      else
      {
         // The (tool)bar has a dragger window round it, the floater.
         // in turn floater will have mParent (the entire App) as its
         // parent.
 
         // Maybe construct a NEW floater
         // this happens if we have just been bounced out of a dock.
         if( floater == NULL ) {
            wxASSERT(mParent);
            floater = safenew ToolFrame( mParent, this, bar, wxPoint(-1,-1) );
            bar->Reparent( floater );
         }
 
         // This bar is undocked and invisible.
         // We are doing a reset toolbars, so even the invisible undocked bars should
         // be moved somewhere sensible. Put bar near center of window.
         // If there were multiple hidden toobars the * 10 adjustment means
         // they won't overlap too much.
         floater->CentreOnParent( );
         const auto index = bar->GetIndex();
         floater->Move(
            floater->GetPosition() + wxSize{ index * 10 - 200, index * 10 });
         bar->SetDocked( NULL, false );
         Expose( bar->GetSection(), false );
      }
   }
 
   ForEach([this](auto bar){
      if (bar && bar->HideAfterReset())
         Expose(bar->GetSection(), false);
   });
   // TODO:??
   // If audio was playing, we stopped the VU meters,
   // It would be nice to show them again, but hardly essential as
   // they will show up again on the next play.
   // SetVUMeters(AudacityProject *p);
   Updated();
}

References DefaultConfigTable, ToolBar::DefaultDockID(), ToolDock::Dock(), ToolBar::EnableDisableButtons(), entry, Expose(), ForEach(), ToolBar::GetDock(), ToolBar::GetIndex(), ToolBar::GetSection(), GetToolBar(), ToolBar::HideAfterReset(), ToolBar::IsDocked(), ToolBar::IsResizable(), mBotDock, mParent, mTopDock, ToolBar::ReCreateButtons(), safenew, ToolBar::SetDocked(), ToolBar::SetToDefaultSize(), ToolBar::ShownByDefault(), ToolBar::TopDockID, ToolDock::Undock(), and Updated().

Referenced by ReadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

RestoreFocus()

bool ToolManager::RestoreFocus

(

)

Definition at line 1537 of file ToolManager.cpp.

{
   if (mLastFocus) {
      auto temp1 = AButton::TemporarilyAllowFocus();
      auto temp2 = ASlider::TemporarilyAllowFocus();
      auto temp3 = MeterPanelBase::TemporarilyAllowFocus();
      mLastFocus->SetFocus();
      return true;
   }
   return false;
}

References mLastFocus, AButton::TemporarilyAllowFocus(), ASlider::TemporarilyAllowFocus(), and MeterPanelBase::TemporarilyAllowFocus().

Referenced by DoneDragging().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowHide()

void ToolManager::ShowHide

(

Identifier

type

)

Definition at line 1073 of file ToolManager.cpp.

{
   Expose( type, !mBars[type]->IsVisible() );
   Updated();
}

References Expose(), IsVisible(), mBars, and Updated().

Referenced by ScreenshotCommand::CaptureToolbar().

Here is the call graph for this function:

Here is the caller graph for this function:

UndockBar()

void ToolManager::UndockBar ( wxPoint  mp )

private

Definition at line 1394 of file ToolManager.cpp.

{
#if defined(__WXMAC__)
   // Disable window animation
   wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, 1 );
#endif
 
   // Adjust the starting position
   mp -= mDragOffset;
 
   // Inform toolbar of change
   mDragBar->SetDocked( NULL, true );
   mDragBar->SetPositioned();
 
   // Construct a NEW floater
   wxASSERT(mParent);
   mDragWindow = safenew ToolFrame( mParent, this, mDragBar, mp );
   mDragWindow->SetLayoutDirection(wxLayout_LeftToRight);
   // Make sure the ferry is visible
   mDragWindow->Show();
 
   // Notify parent of change
   Updated();
 
#if defined(__WXMAC__)
   // Reinstate original transition
   wxSystemOptions::SetOption( wxMAC_WINDOW_PLAIN_TRANSITION, mTransition );
#endif
}

References mDragBar, mDragOffset, mDragWindow, mParent, mTransition, safenew, ToolBar::SetDocked(), ToolBar::SetPositioned(), and Updated().

Referenced by OnMouse().

Here is the call graph for this function:

Here is the caller graph for this function:

Updated()

void ToolManager::Updated ( )

private

Definition at line 1031 of file ToolManager.cpp.

{
   // Queue an update event
   wxCommandEvent e( EVT_TOOLBAR_UPDATED );
   GetProjectFrame( *mParent ).GetEventHandler()->AddPendingEvent( e );
}

References GetProjectFrame().

Referenced by HandleEscapeKey(), OnMouse(), Reset(), ShowHide(), and UndockBar().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteConfig()

void ToolManager::WriteConfig ( )

private

Definition at line 936 of file ToolManager.cpp.

{
   if( !gPrefs )
   {
      return;
   }
 
   wxString oldpath = gPrefs->GetPath();
   int ndx;
 
   // Change to the bar root
   gPrefs->SetPath( wxT("/GUI/ToolBars") );
 
   // Save state of each bar
   ForEach([this](ToolBar *bar){
      // Change to the bar subkey
      gPrefs->SetPath( bar->GetSection().GET() );
 
      // Search both docks for toolbar order
      bool to = mTopDock->GetConfiguration().Contains( bar );
      bool bo = mBotDock->GetConfiguration().Contains( bar );
 
      // Save
      // Note that DockV2 was introduced in 2.2.2 to fix bug #1554. Dock is retained so that
      // the toolbar layout is not changed when opening a version before 2.2.2, and in particular
      // its value is compatible with versions 2.1.3 to 2.2.1 which have this bug.
      ToolDock* dock = bar->GetDock();       // dock for both shown and hidden toolbars
      gPrefs->Write( wxT("DockV2"), static_cast<int>(dock == mTopDock ? TopDockID : dock == mBotDock ? BotDockID : NoDockID ));
 
      gPrefs->Write( wxT("Dock"), static_cast<int>( to ? TopDockID : bo ? BotDockID : NoDockID));
 
      dock = to ? mTopDock : bo ? mBotDock : nullptr;    // dock for shown toolbars
      ToolBarConfiguration::Write
         (dock ? &dock->GetConfiguration() : nullptr, bar);
 
      wxPoint pos( -1, -1 );
      wxSize sz = bar->GetSize();
      if( !bar->IsDocked() && bar->IsPositioned() )
      {
         pos = bar->GetParent()->GetPosition();
         sz = bar->GetParent()->GetSize();
      }
      gPrefs->Write( wxT("X"), pos.x );
      gPrefs->Write( wxT("Y"), pos.y );
      gPrefs->Write( wxT("W"), sz.x );
      gPrefs->Write( wxT("H"), sz.y );
 
      // Change back to the bar root
      gPrefs->SetPath( wxT("..") );
   });
 
   // Restore original config path
   gPrefs->SetPath( oldpath );
   gPrefs->Flush();
}

References BotDockID, ToolBarConfiguration::Contains(), FileConfig::Flush(), ForEach(), Identifier::GET(), ToolDock::GetConfiguration(), ToolBar::GetDock(), FileConfig::GetPath(), ToolBar::GetSection(), gPrefs, ToolBar::IsDocked(), ToolBar::IsPositioned(), mBotDock, mTopDock, NoDockID, FileConfig::SetPath(), TopDockID, ToolBarConfiguration::Write(), and wxT().

Referenced by Destroy().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mBarPos

wxRect ToolManager::mBarPos

private

Definition at line 150 of file ToolManager.h.

Referenced by DoneDragging(), OnMouse(), and ToolManager().

mBars

std::map<Identifier, ToolBar::Holder> ToolManager::mBars

private

map not unordered_map, for the promise made by ForEach

Definition at line 168 of file ToolManager.h.

Referenced by CreateWindows(), Destroy(), Expose(), GetToolBar(), ReadConfig(), and ShowHide().

mBotDock

ToolDock* ToolManager::mBotDock {}

private

Definition at line 165 of file ToolManager.h.

Referenced by CreateWindows(), Destroy(), GetBotDock(), LayoutToolBars(), OnMouse(), ReadConfig(), Reset(), and WriteConfig().

mClicked

bool ToolManager::mClicked {}

private

Definition at line 176 of file ToolManager.h.

Referenced by DoneDragging(), OnGrabber(), and OnMouse().

mCurrent

wxRegion* ToolManager::mCurrent

private

Definition at line 155 of file ToolManager.h.

Referenced by OnIndicatorCreate(), and OnMouse().

mDidDrag

bool ToolManager::mDidDrag {}

private

Definition at line 175 of file ToolManager.h.

Referenced by DoneDragging(), and OnMouse().

mDown

std::unique_ptr<wxRegion> ToolManager::mDown

private

Definition at line 154 of file ToolManager.h.

Referenced by OnMouse(), and ToolManager().

mDragBar

ToolBar* ToolManager::mDragBar {}

private

Definition at line 145 of file ToolManager.h.

Referenced by DoneDragging(), HandleEscapeKey(), OnGrabber(), OnMouse(), ToolManager(), and UndockBar().

mDragBefore

ToolBarConfiguration::Position ToolManager::mDragBefore {}

private

Definition at line 147 of file ToolManager.h.

Referenced by OnMouse().

mDragDock

ToolDock* ToolManager::mDragDock

private

Definition at line 144 of file ToolManager.h.

Referenced by DoneDragging(), OnMouse(), and ToolManager().

mDragOffset

wxPoint ToolManager::mDragOffset

private

Definition at line 146 of file ToolManager.h.

Referenced by OnGrabber(), OnMouse(), and UndockBar().

mDragWindow

ToolFrame* ToolManager::mDragWindow

private

Definition at line 143 of file ToolManager.h.

Referenced by DoneDragging(), HandleEscapeKey(), OnCaptureLost(), OnGrabber(), OnMouse(), OnTimer(), ToolManager(), and UndockBar().

mIndicator

FramePtr ToolManager::mIndicator

private

Definition at line 153 of file ToolManager.h.

Referenced by Destroy(), DoneDragging(), OnIndicatorCreate(), OnMouse(), OnTimer(), and ToolManager().

mLastFocus

wxWindowRef ToolManager::mLastFocus {}

private

Definition at line 141 of file ToolManager.h.

Referenced by FilterEvent(), and RestoreFocus().

mLastPos

wxPoint ToolManager::mLastPos

private

Definition at line 149 of file ToolManager.h.

Referenced by DoneDragging(), OnMouse(), and ToolManager().

mLastState

bool ToolManager::mLastState

private

Definition at line 158 of file ToolManager.h.

Referenced by OnGrabber(), and OnTimer().

mLeft

std::unique_ptr<wxRegion> ToolManager::mLeft

private

Definition at line 154 of file ToolManager.h.

Referenced by OnMouse(), and ToolManager().

mMenuManagerSubscription

Observer::Subscription ToolManager::mMenuManagerSubscription

private

Definition at line 139 of file ToolManager.h.

Referenced by CreateWindows().

mParent

AudacityProject* ToolManager::mParent

private

Definition at line 140 of file ToolManager.h.

Referenced by CreateWindows(), DoneDragging(), FilterEvent(), OnCaptureLost(), OnGrabber(), OnMenuUpdate(), ReadConfig(), Reset(), ToolManager(), and UndockBar().

mPrevConfiguration

ToolBarConfiguration ToolManager::mPrevConfiguration

private

Definition at line 174 of file ToolManager.h.

Referenced by DoneDragging(), HandleEscapeKey(), OnGrabber(), and OnMouse().

mPrevDock

ToolDock* ToolManager::mPrevDock {}

private

Definition at line 171 of file ToolManager.h.

Referenced by DoneDragging(), HandleEscapeKey(), OnGrabber(), and OnMouse().

mPrevPosition

wxPoint ToolManager::mPrevPosition {}

private

Definition at line 170 of file ToolManager.h.

Referenced by HandleEscapeKey(), and OnGrabber().

mPrevSlot

ToolBarConfiguration::Position ToolManager::mPrevSlot { ToolBarConfiguration::UnspecifiedPosition }

private

Definition at line 172 of file ToolManager.h.

Referenced by DoneDragging(), HandleEscapeKey(), and OnGrabber().

mTimer

wxTimer ToolManager::mTimer

private

Definition at line 157 of file ToolManager.h.

Referenced by CreateWindows(), DoneDragging(), and OnGrabber().

mTopDock

ToolDock* ToolManager::mTopDock {}

private

Definition at line 164 of file ToolManager.h.

Referenced by CreateWindows(), Destroy(), GetTopDock(), LayoutToolBars(), OnMouse(), ReadConfig(), Reset(), and WriteConfig().

mTransition

bool ToolManager::mTransition

private

Definition at line 161 of file ToolManager.h.

Referenced by OnMouse(), OnTimer(), ReadConfig(), ToolManager(), and UndockBar().

---

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

• ToolManager.h
• ToolManager.cpp