NavigationActions::Handler Struct Reference

Inheritance diagram for NavigationActions::Handler:

Collaboration diagram for NavigationActions::Handler:

Public Member Functions
void	OnPrevWindow (const CommandContext &context)
void	OnNextWindow (const CommandContext &context)
void	OnPrevFrame (const CommandContext &context)
void	OnNextFrame (const CommandContext &context)
void	OnCursorUp (const CommandContext &context)
void	OnCursorDown (const CommandContext &context)
void	OnFirstTrack (const CommandContext &context)
void	OnLastTrack (const CommandContext &context)
void	OnShiftUp (const CommandContext &context)
void	OnShiftDown (const CommandContext &context)
void	OnToggle (const CommandContext &context)
void	UpdatePrefs () override
	Handler ()
	Handler (const Handler &)=delete
Handler &	operator= (const Handler &)=delete
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Public Attributes
bool	mCircularTrackNavigation {}

Additional Inherited Members
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

Definition at line 296 of file NavigationMenus.cpp.

Constructor & Destructor Documentation

Handler() [1/2]

NavigationActions::Handler::Handler ( )

inline

Definition at line 534 of file NavigationMenus.cpp.

{
   UpdatePrefs();
}

References UpdatePrefs().

Here is the call graph for this function:

Handler() [2/2]

NavigationActions::Handler::Handler ( const Handler &  )

delete

Member Function Documentation

OnCursorDown()

void NavigationActions::Handler::OnCursorDown ( const CommandContext &  context )

inline

Definition at line 445 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   DoNextTrack( project, false, mCircularTrackNavigation );
}

References anonymous_namespace{NavigationMenus.cpp}::DoNextTrack(), mCircularTrackNavigation, CommandContext::project, and project.

Here is the call graph for this function:

OnCursorUp()

void NavigationActions::Handler::OnCursorUp ( const CommandContext &  context )

inline

Definition at line 439 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   DoPrevTrack( project, false, mCircularTrackNavigation );
}

References anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), mCircularTrackNavigation, CommandContext::project, and project.

Here is the call graph for this function:

OnFirstTrack()

void NavigationActions::Handler::OnFirstTrack ( const CommandContext &  context )

inline

Definition at line 451 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   auto &projectHistory = ProjectHistory::Get(project);
   auto &trackFocus = TrackFocus::Get( project );
   auto &tracks = TrackList::Get( project );
   auto &viewport = Viewport::Get(project);
 
   auto t = trackFocus.Get();
   if (!t)
      return;
 
   auto f = *tracks.begin();
   if (t != f)
      trackFocus.Set(f);
   if (f) {
      viewport.ShowTrack(*f);
      if (t != f)
         projectHistory.ModifyState(false);
   }
}

References TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), Viewport::Get(), CommandContext::project, project, and tracks.

Here is the call graph for this function:

OnLastTrack()

void NavigationActions::Handler::OnLastTrack ( const CommandContext &  context )

inline

Definition at line 473 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   auto &projectHistory = ProjectHistory::Get(project);
   auto &trackFocus = TrackFocus::Get( project );
   auto &tracks = TrackList::Get( project );
   auto &viewport = Viewport::Get(project);
 
   Track *t = trackFocus.Get();
   if (!t)
      return;
 
   auto l = *tracks.rbegin();
   if (t != l)
      trackFocus.Set(l);
   if (l) {
      viewport.ShowTrack(*l);
      if (t != l)
         projectHistory.ModifyState(false);
   }
}

References TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), Viewport::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), CommandContext::project, project, and tracks.

Here is the call graph for this function:

OnNextFrame()

void NavigationActions::Handler::OnNextFrame ( const CommandContext &  context )

inline

Definition at line 430 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   NextOrPrevFrame(project, true);
}

References anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame(), CommandContext::project, and project.

Here is the call graph for this function:

OnNextWindow()

void NavigationActions::Handler::OnNextWindow ( const CommandContext &  context )

inline

Definition at line 361 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   auto &window = GetProjectFrame( project );
   auto isEnabled = window.IsEnabled();
 
   wxWindow *w = wxGetTopLevelParent(wxWindow::FindFocus());
   const auto & list = window.GetChildren();
   auto iter = list.begin(), end = list.end();
 
   // If the project window has the current focus, start the search with the
   // first child
   if (w == &window)
   {
   }
   // Otherwise start the search with the current window's next sibling
   else
   {
      // Find the window in this projects children.  If the window with the
      // focus isn't a child of this project (like when a dialog is created
      // without specifying a parent), then we'll get back NULL here.
      while (iter != end && *iter != w)
         ++iter;
      if (iter != end)
         ++iter;
   }
 
   // Search for the next toplevel window
   for (; iter != end; ++iter)
   {
      // If it's a toplevel, visible (we have hidden windows) and is enabled,
      // then we're done.  The IsEnabled() prevents us from moving away from
      // a modal dialog because all other toplevel windows will be disabled.
      w = *iter;
      if (w->IsTopLevel() && w->IsShown() && w->IsEnabled())
      {
         break;
      }
   }
 
   // Ran out of siblings, so make the current project active
   if ((iter == end) && isEnabled)
   {
      w = &window;
   }
 
   // And make sure it's on top (only for floating windows...project window will
   // not raise)
   // (Really only works on Windows)
   w->Raise();
 
 
#if defined(__WXMAC__) || defined(__WXGTK__)
   // bug 868
   // Simulate a TAB key press before continuing, else the cycle of
   // navigation among top level windows stops because the keystrokes don't
   // go to the CommandManager.
   if (dynamic_cast<wxDialog*>(w)) {
      w->SetFocus();
   }
#endif
}

References details::end(), BasicUI::FindFocus(), GetProjectFrame(), CommandContext::project, and project.

Here is the call graph for this function:

OnPrevFrame()

void NavigationActions::Handler::OnPrevFrame ( const CommandContext &  context )

inline

Definition at line 424 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   NextOrPrevFrame(project, false);
}

References anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame(), CommandContext::project, and project.

Here is the call graph for this function:

OnPrevWindow()

void NavigationActions::Handler::OnPrevWindow ( const CommandContext &  context )

inline

Definition at line 302 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   auto &window = GetProjectFrame( project );
   auto isEnabled = window.IsEnabled();
 
   wxWindow *w = wxGetTopLevelParent(wxWindow::FindFocus());
   const auto & list = window.GetChildren();
   auto iter = list.rbegin(), end = list.rend();
 
   // If the project window has the current focus, start the search with the
   // last child
   if (w == &window)
   {
   }
   // Otherwise start the search with the current window's previous sibling
   else
   {
      while (iter != end && *iter != w)
         ++iter;
      if (iter != end)
         ++iter;
   }
 
   // Search for the previous toplevel window
   for (; iter != end; ++iter)
   {
      // If it's a toplevel and is visible (we have come hidden windows), then
      // we're done
      w = *iter;
      if (w->IsTopLevel() && w->IsShown() && isEnabled)
      {
         break;
      }
   }
 
   // Ran out of siblings, so make the current project active
   if ((iter == end) && isEnabled)
   {
      w = &window;
   }
 
   // And make sure it's on top (only for floating windows...project window will
   // not raise)
   // (Really only works on Windows)
   w->Raise();
 
 
#if defined(__WXMAC__) || defined(__WXGTK__)
   // bug 868
   // Simulate a TAB key press before continuing, else the cycle of
   // navigation among top level windows stops because the keystrokes don't
   // go to the CommandManager.
   if (dynamic_cast<wxDialog*>(w)) {
      w->SetFocus();
   }
#endif
}

References details::end(), BasicUI::FindFocus(), GetProjectFrame(), CommandContext::project, and project.

Here is the call graph for this function:

OnShiftDown()

void NavigationActions::Handler::OnShiftDown ( const CommandContext &  context )

inline

Definition at line 501 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   DoNextTrack( project, true, mCircularTrackNavigation );
}

References anonymous_namespace{NavigationMenus.cpp}::DoNextTrack(), mCircularTrackNavigation, CommandContext::project, and project.

Here is the call graph for this function:

OnShiftUp()

void NavigationActions::Handler::OnShiftUp ( const CommandContext &  context )

inline

Definition at line 495 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   DoPrevTrack( project, true, mCircularTrackNavigation );
}

References anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack(), mCircularTrackNavigation, CommandContext::project, and project.

Here is the call graph for this function:

OnToggle()

void NavigationActions::Handler::OnToggle ( const CommandContext &  context )

inline

Definition at line 507 of file NavigationMenus.cpp.

{
   auto &project = context.project;
   auto &projectHistory = ProjectHistory::Get(project);
   auto &trackFocus = TrackFocus::Get(project);
   auto &selectionState = SelectionState::Get(project);
   auto &viewport = Viewport::Get(project);
 
   Track *t;
 
   t = trackFocus.Get();   // Get currently focused track
   if (!t)
      return;
   selectionState.SelectTrack(*t, !t->GetSelected(), true);
   viewport.ShowTrack(*t);
   projectHistory.ModifyState(false);
 
   trackFocus.UpdateAccessibility();
 
   return;
}

References TrackFocus::Get(), ProjectHistory::Get(), SelectionState::Get(), Viewport::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), Track::GetSelected(), CommandContext::project, and project.

Here is the call graph for this function:

operator=()

Handler & NavigationActions::Handler::operator= ( const Handler &  )

delete

UpdatePrefs()

void NavigationActions::Handler::UpdatePrefs ( )

inlineoverridevirtual

Implements PrefsListener.

Definition at line 529 of file NavigationMenus.cpp.

{
   mCircularTrackNavigation =
      gPrefs->ReadBool(wxT("/GUI/CircularTrackNavigation"), false);
}

References gPrefs, mCircularTrackNavigation, audacity::BasicSettings::ReadBool(), and wxT().

Referenced by Handler().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCircularTrackNavigation

bool NavigationActions::Handler::mCircularTrackNavigation {}

Definition at line 437 of file NavigationMenus.cpp.

Referenced by OnCursorDown(), OnCursorUp(), OnShiftDown(), OnShiftUp(), and UpdatePrefs().

---

The documentation for this struct was generated from the following file:

• NavigationMenus.cpp