anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase > Class Template Reference

Changes default arrow navigation to behave more list- or table-like. Instead of searching focusable items among children first, list navigation searches for siblings when arrow key is pressed. Tab behaviour stays same. Requires wxWANT_CHARS style flag to be set. More...

Inheritance diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >:

Collaboration diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >:

Public Member Functions
	ListNavigationEnabled ()

Private Member Functions
void	SetFocus () override
void	OnCharHook (wxKeyEvent &evt)
void	OnKeyDown (wxKeyEvent &evt)
void	OnNavigationKeyEvent (wxNavigationKeyEvent &evt)
bool	Destroy () override

Detailed Description

template<class WindowBase>
class anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >

Changes default arrow navigation to behave more list- or table-like. Instead of searching focusable items among children first, list navigation searches for siblings when arrow key is pressed. Tab behaviour stays same. Requires wxWANT_CHARS style flag to be set.

Definition at line 147 of file RealtimeEffectPanel.cpp.

Constructor & Destructor Documentation

ListNavigationEnabled()

template<class WindowBase >

anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >::ListNavigationEnabled ( )

inline

Definition at line 150 of file RealtimeEffectPanel.cpp.

      {
         WindowBase::Bind(wxEVT_NAVIGATION_KEY, &ListNavigationEnabled::OnNavigationKeyEvent, this);
         WindowBase::Bind(wxEVT_KEY_DOWN, &ListNavigationEnabled::OnKeyDown, this);
         WindowBase::Bind(wxEVT_CHAR_HOOK, &ListNavigationEnabled::OnCharHook, this);
      }

Member Function Documentation

Destroy()

template<class WindowBase >

bool anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >::Destroy ( )

inlineoverrideprivate

Definition at line 223 of file RealtimeEffectPanel.cpp.

      {
         if(WindowBase::IsDescendant(wxWindow::FindFocus()))
         {
            auto next = WindowBase::GetNextSibling();
            if(next != nullptr && next->AcceptsFocus())
               next->SetFocus();
            else
            {
               auto prev = WindowBase::GetPrevSibling();
               if(prev != nullptr && prev->AcceptsFocus())
                  prev->SetFocus();
            }
         }
         return wxNavigationEnabled<WindowBase>::Destroy();
      }

References BasicUI::FindFocus().

Here is the call graph for this function:

OnCharHook()

template<class WindowBase >

void anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >::OnCharHook ( wxKeyEvent &  evt )

inlineprivate

Definition at line 164 of file RealtimeEffectPanel.cpp.

      {
         //We want to restore focus to list item once arrow navigation is used
         //on the child item, for this we need a char hook since key/navigation
         //events are sent directly to the focused item
         const auto keyCode = evt.GetKeyCode();
         if((keyCode == WXK_DOWN || keyCode == WXK_UP) &&
            !WindowBase::HasFocus() &&
            WindowBase::IsDescendant(WindowBase::FindFocus()))
         {
            wxWindow::SetFocusFromKbd();
         }
         else
            evt.Skip();
      }

References BasicUI::FindFocus().

Here is the call graph for this function:

OnKeyDown()

template<class WindowBase >

void anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >::OnKeyDown ( wxKeyEvent &  evt )

inlineprivate

Definition at line 180 of file RealtimeEffectPanel.cpp.

      {
         const auto keyCode = evt.GetKeyCode();
         if(keyCode == WXK_TAB)
            WindowBase::NavigateIn(wxNavigationKeyEvent::FromTab | (evt.ShiftDown() ? wxNavigationKeyEvent::IsBackward : wxNavigationKeyEvent::IsForward));
         else if(keyCode == WXK_DOWN)
            WindowBase::Navigate(wxNavigationKeyEvent::IsForward);
         else if(keyCode == WXK_UP)
            WindowBase::Navigate(wxNavigationKeyEvent::IsBackward);
         else
            evt.Skip();
      }

OnNavigationKeyEvent()

template<class WindowBase >

void anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >::OnNavigationKeyEvent ( wxNavigationKeyEvent &  evt )

inlineprivate

Definition at line 193 of file RealtimeEffectPanel.cpp.

      {
         if(evt.GetEventObject() == WindowBase::GetParent() && !evt.IsFromTab())
            WindowBase::SetFocusFromKbd();
         else if(evt.GetEventObject() == this && evt.GetCurrentFocus() == this && evt.IsFromTab())
         {
            //NavigateIn
            wxPropagationDisabler disableProp(evt);
            const auto isForward = evt.GetDirection();
            const auto& children = WindowBase::GetChildren();
            auto node = isForward ? children.GetFirst() : children.GetLast();
            while(node)
            {
               auto child = node->GetData();
               if(child->CanAcceptFocusFromKeyboard())
               {
                  if(!child->GetEventHandler()->ProcessEvent(evt))
                  {
                     child->SetFocusFromKbd();
                  }
                  evt.Skip(false);
                  return;
               }
               node = isForward ? node->GetNext() : node->GetPrevious();
            }
         }
         else
            evt.Skip();
      }

SetFocus()

template<class WindowBase >

void anonymous_namespace{RealtimeEffectPanel.cpp}::ListNavigationEnabled< WindowBase >::SetFocus ( )

inlineoverrideprivate

Definition at line 158 of file RealtimeEffectPanel.cpp.

      {
         //Prevent attempt to search for a focusable child
         WindowBase::SetFocus();
      }

References BasicUI::SetFocus().

Here is the call graph for this function:

---

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

• RealtimeEffectPanel.cpp