anonymous_namespace{NavigationMenus.cpp} Namespace Reference

Functions
void	NextOrPrevFrame (AudacityProject &project, bool forward)
void	DoPrevTrack (AudacityProject &project, bool shift, bool circularTrackNavigation)
void	DoNextTrack (AudacityProject &project, bool shift, bool circularTrackNavigation)
BaseItemSharedPtr	ExtraGlobalCommands ()
BaseItemSharedPtr	ExtraFocusMenu ()

Variables
AttachedItem	sAttachment2
AttachedItem	sAttachment3

Function Documentation

DoNextTrack()

void anonymous_namespace{NavigationMenus.cpp}::DoNextTrack	(	AudacityProject &	project,
		bool	shift,
		bool	circularTrackNavigation
	)

The following method moves to the next track, selecting and unselecting depending if you are on the start of a block or not.

Definition at line 185 of file NavigationMenus.cpp.

{
   auto &projectHistory = ProjectHistory::Get( project );
   auto &trackFocus = TrackFocus::Get( project );
   auto &tracks = TrackList::Get( project );
   auto &selectionState = SelectionState::Get( project );
 
   auto t = trackFocus.Get();   // Get currently focused track
   if( t == NULL )   // if there isn't one, focus on first
   {
      t = *tracks.Any().begin();
      trackFocus.Set( t );
      if (t)
         t->EnsureVisible( true );
      return;
   }
 
   if( shift )
   {
      auto n = * ++ tracks.FindLeader( t ); // Get next track
      if( n == NULL )   // On last track so stay there
      {
         wxBell();
         if( circularTrackNavigation )
            n = *tracks.Any().begin();
         else
         {
            t->EnsureVisible();
            return;
         }
      }
      auto tSelected = t->GetSelected();
      auto nSelected = n->GetSelected();
      if( tSelected && nSelected )
      {
         selectionState.SelectTrack
            ( *t, false, false );
         trackFocus.Set( n );   // move focus to next track down
         if (n)
            n->EnsureVisible( true );
         return;
      }
      if( tSelected && !nSelected )
      {
         selectionState.SelectTrack
            ( *n, true, false );
         trackFocus.Set( n );   // move focus to next track down
         if (n)
            n->EnsureVisible( true );
         return;
      }
      if( !tSelected && nSelected )
      {
         selectionState.SelectTrack
            ( *n, false, false );
         trackFocus.Set( n );   // move focus to next track down
         if (n)
            n->EnsureVisible( true );
         return;
      }
      if( !tSelected && !nSelected )
      {
         selectionState.SelectTrack
            ( *t, true, false );
         trackFocus.Set( n );   // move focus to next track down
         if (n)
            n->EnsureVisible( true );
         return;
      }
   }
   else
   {
      auto n = * ++ tracks.FindLeader( t ); // Get next track
      if( n == NULL )   // On last track so stay there
      {
         wxBell();
         if( circularTrackNavigation )
         {
            n = *tracks.Any().begin();
            trackFocus.Set( n );   // Wrap to the first track
            if (n)
               n->EnsureVisible( true );
            return;
         }
         else
         {
            t->EnsureVisible();
            return;
         }
      }
      else
      {
         trackFocus.Set( n );   // move focus to next track down
         n->EnsureVisible( true );
         return;
      }
   }
}

References TrackFocus::Get(), ProjectHistory::Get(), SelectionState::Get(), and TrackList::Get().

Referenced by NavigationActions::Handler::OnCursorDown(), and NavigationActions::Handler::OnShiftDown().

Here is the call graph for this function:

Here is the caller graph for this function:

DoPrevTrack()

void anonymous_namespace{NavigationMenus.cpp}::DoPrevTrack	(	AudacityProject &	project,
		bool	shift,
		bool	circularTrackNavigation
	)

Todo:

Merge related methods, OnPrevTrack and OnNextTrack.

Definition at line 75 of file NavigationMenus.cpp.

{
   auto &projectHistory = ProjectHistory::Get( project );
   auto &trackFocus = TrackFocus::Get( project );
   auto &tracks = TrackList::Get( project );
   auto &selectionState = SelectionState::Get( project );
 
   auto t = trackFocus.Get();
   if( t == NULL )   // if there isn't one, focus on last
   {
      t = *tracks.Any().rbegin();
      trackFocus.Set( t );
      if (t)
         t->EnsureVisible( true );
      return;
   }
 
   Track* p = NULL;
   bool tSelected = false;
   bool pSelected = false;
   if( shift )
   {
      p = * -- tracks.FindLeader( t ); // Get previous track
      if( p == NULL )   // On first track
      {
         // JKC: wxBell() is probably for accessibility, so a blind
         // user knows they were at the top track.
         wxBell();
         if( circularTrackNavigation )
            p = *tracks.Any().rbegin();
         else
         {
            t->EnsureVisible();
            return;
         }
      }
      tSelected = t->GetSelected();
      if (p)
         pSelected = p->GetSelected();
      if( tSelected && pSelected )
      {
         selectionState.SelectTrack
            ( *t, false, false );
         trackFocus.Set( p );   // move focus to next track up
         if (p)
            p->EnsureVisible( true );
         return;
      }
      if( tSelected && !pSelected )
      {
         selectionState.SelectTrack
            ( *p, true, false );
         trackFocus.Set( p );   // move focus to next track up
         if (p)
            p->EnsureVisible( true );
         return;
      }
      if( !tSelected && pSelected )
      {
         selectionState.SelectTrack
            ( *p, false, false );
         trackFocus.Set( p );   // move focus to next track up
         if (p)
            p->EnsureVisible( true );
         return;
      }
      if( !tSelected && !pSelected )
      {
         selectionState.SelectTrack
            ( *t, true, false );
         trackFocus.Set( p );   // move focus to next track up
         if (p)
            p->EnsureVisible( true );
         return;
      }
   }
   else
   {
      p = * -- tracks.FindLeader( t ); // Get previous track
      if( p == NULL )   // On first track so stay there?
      {
         wxBell();
         if( circularTrackNavigation )
         {
            auto range = tracks.Leaders();
            p = * range.rbegin(); // null if range is empty
            trackFocus.Set( p );   // Wrap to the last track
            if (p)
               p->EnsureVisible( true );
            return;
         }
         else
         {
            t->EnsureVisible();
            return;
         }
      }
      else
      {
         trackFocus.Set( p );   // move focus to next track up
         p->EnsureVisible( true );
         return;
      }
   }
}

References Track::Any(), Track::EnsureVisible(), TrackFocus::Get(), ProjectHistory::Get(), SelectionState::Get(), TrackList::Get(), and Track::GetSelected().

Referenced by NavigationActions::Handler::OnCursorUp(), and NavigationActions::Handler::OnShiftUp().

Here is the call graph for this function:

Here is the caller graph for this function:

ExtraFocusMenu()

BaseItemSharedPtr anonymous_namespace{NavigationMenus.cpp}::ExtraFocusMenu

(

)

Definition at line 572 of file NavigationMenus.cpp.

{
   static const auto FocusedTracksFlags = TracksExistFlag() | TrackPanelHasFocus();
 
   static BaseItemSharedPtr menu{
   ( FinderScope{ findCommandHandler },
   Menu( wxT("Focus"), XXO("Foc&us"),
      Command( wxT("PrevFrame"),
         XXO("Move &Backward from Toolbars to Tracks"), FN(OnPrevFrame),
         AlwaysEnabledFlag, wxT("Ctrl+Shift+F6") ),
      Command( wxT("NextFrame"),
         XXO("Move F&orward from Toolbars to Tracks"), FN(OnNextFrame),
         AlwaysEnabledFlag, wxT("Ctrl+F6") ),
      Command( wxT("PrevTrack"), XXO("Move Focus to &Previous Track"),
         FN(OnCursorUp), FocusedTracksFlags, wxT("Up") ),
      Command( wxT("NextTrack"), XXO("Move Focus to &Next Track"),
         FN(OnCursorDown), FocusedTracksFlags, wxT("Down") ),
      Command( wxT("FirstTrack"), XXO("Move Focus to &First Track"),
         FN(OnFirstTrack), FocusedTracksFlags, wxT("Ctrl+Home") ),
      Command( wxT("LastTrack"), XXO("Move Focus to &Last Track"),
         FN(OnLastTrack), FocusedTracksFlags, wxT("Ctrl+End") ),
      Command( wxT("ShiftUp"), XXO("Move Focus to P&revious and Select"),
         FN(OnShiftUp), FocusedTracksFlags, wxT("Shift+Up") ),
      Command( wxT("ShiftDown"), XXO("Move Focus to N&ext and Select"),
         FN(OnShiftDown), FocusedTracksFlags, wxT("Shift+Down") ),
      Command( wxT("Toggle"), XXO("&Toggle Focused Track"), FN(OnToggle),
         FocusedTracksFlags, wxT("Return") ),
      Command( wxT("ToggleAlt"), XXO("Toggle Focuse&d Track"), FN(OnToggle),
         FocusedTracksFlags, wxT("NUMPAD_ENTER") )
   ) ) };
   return menu;
}

References AlwaysEnabledFlag, MenuTable::Command, findCommandHandler(), FN, MenuTable::Menu, TrackPanelHasFocus(), TracksExistFlag(), wxT(), and XXO().

Here is the call graph for this function:

ExtraGlobalCommands()

BaseItemSharedPtr anonymous_namespace{NavigationMenus.cpp}::ExtraGlobalCommands

(

)

Definition at line 549 of file NavigationMenus.cpp.

{
   // Ceci n'est pas un menu
   using Options = CommandManager::Options;
 
   static BaseItemSharedPtr items{
   ( FinderScope{ findCommandHandler },
   Items( wxT("Navigation"),
      Command( wxT("PrevWindow"), XXO("Move Backward Through Active Windows"),
         FN(OnPrevWindow), AlwaysEnabledFlag,
         Options{ wxT("Alt+Shift+F6") }.IsGlobal() ),
      Command( wxT("NextWindow"), XXO("Move Forward Through Active Windows"),
         FN(OnNextWindow), AlwaysEnabledFlag,
         Options{ wxT("Alt+F6") }.IsGlobal() )
   ) ) };
   return items;
}

References AlwaysEnabledFlag, MenuTable::Command, findCommandHandler(), FN, MenuTable::Items, wxT(), and XXO().

Here is the call graph for this function:

NextOrPrevFrame()

void anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame	(	AudacityProject &	project,
		bool	forward
	)

Definition at line 24 of file NavigationMenus.cpp.

{
   // Focus won't take in a dock unless at least one descendant window
   // accepts focus.  Tell controls to take focus for the duration of this
   // function, only.  Outside of this, they won't steal the focus when
   // clicked.
   auto temp1 = AButton::TemporarilyAllowFocus();
   auto temp2 = ASlider::TemporarilyAllowFocus();
   auto temp3 = MeterPanel::TemporarilyAllowFocus();
   
   std::vector<wxWindow*> seq;
   // Skip docks that are empty (Bug 1564).
   if(!ToolManager::Get(project).GetTopDock()->GetChildren().IsEmpty())
      seq.push_back(ProjectWindow::Get( project ).GetTopPanel());
   seq.push_back(&TrackPanel::Get( project ));
   seq.push_back(&RealtimeEffectPanel::Get(project));
   if(!ToolManager::Get( project ).GetBotDock()->GetChildren().IsEmpty())
      seq.push_back(ToolManager::Get( project ).GetBotDock());
 
   auto FindAncestor = [&]() {
      wxWindow *pWindow = wxWindow::FindFocus();
      while (pWindow)
      {
         auto it = std::find(seq.cbegin(), seq.cend(), pWindow);
         if(it != seq.cend())
            return static_cast<size_t>(std::distance(seq.cbegin(), it));
         pWindow = pWindow->GetParent();
      }
      return seq.size();
   };
 
   const auto idx = FindAncestor();
   if (idx == seq.size())
      return;
 
   auto idx2 = idx;
   const auto increment = (forward ? 1 : static_cast<int>(seq.size()) - 1);
 
   while( idx != (idx2 = (idx2 + increment) % seq.size()) ) {
      wxWindow *toFocus = seq[idx2];
      if(!toFocus->IsShown())
         continue;
 
      toFocus->SetFocus();
      if ( FindAncestor() == idx2 )
         // The focus took!
         break;
   }
}

References BasicUI::FindFocus(), ProjectWindow::Get(), RealtimeEffectPanel::Get(), ToolManager::Get(), TrackPanel::Get(), AButton::TemporarilyAllowFocus(), ASlider::TemporarilyAllowFocus(), and MeterPanelBase::TemporarilyAllowFocus().

Referenced by NavigationActions::Handler::OnNextFrame(), and NavigationActions::Handler::OnPrevFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

sAttachment2

AttachedItem anonymous_namespace{NavigationMenus.cpp}::sAttachment2

Initial value:

{
   wxT("Optional/Extra/Part2"),
   Indirect(ExtraGlobalCommands())
}

Definition at line 567 of file NavigationMenus.cpp.

sAttachment3

AttachedItem anonymous_namespace{NavigationMenus.cpp}::sAttachment3

Initial value:

{
   wxT("Optional/Extra/Part2"),
   Indirect(ExtraFocusMenu())
}

Definition at line 605 of file NavigationMenus.cpp.