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...

#include <ListNavigationEnabled.h>

Inheritance diagram for ListNavigationEnabled< WindowBase >:

Collaboration diagram for ListNavigationEnabled< WindowBase >:

Public Member Functions
	ListNavigationEnabled ()
void	SetInTabOrder (bool inTabOrder)

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

Private Attributes
bool	mInTabOrder { true }

Friends
void	ListNavigationEnabled_HandleCharHook (wxWindow *self, wxKeyEvent &evt)
void	ListNavigationEnabled_HandleKeyDown (wxWindow *self, wxKeyEvent &evt)
void	ListNavigationEnabled_HandleNavigationKeyEvent (wxWindow *self, wxNavigationKeyEvent &evt, bool inTabOrder)
void	ListNavigationEnabled_HandleDestroy (wxWindow *self)

Detailed Description

template<class WindowBase>
class 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 24 of file ListNavigationEnabled.h.

Constructor & Destructor Documentation

ListNavigationEnabled()

template<class WindowBase >

ListNavigationEnabled< WindowBase >::ListNavigationEnabled ( )

inline

Definition at line 33 of file ListNavigationEnabled.h.

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

References ListNavigationEnabled< WindowBase >::OnCharHook(), ListNavigationEnabled< WindowBase >::OnKeyDown(), and ListNavigationEnabled< WindowBase >::OnNavigationKeyEvent().

Here is the call graph for this function:

Member Function Documentation

Destroy()

template<class WindowBase >

bool ListNavigationEnabled< WindowBase >::Destroy ( )

inlineoverrideprivate

Definition at line 64 of file ListNavigationEnabled.h.

   {
      ListNavigationEnabled_HandleDestroy(this);
      return wxNavigationEnabled<WindowBase>::Destroy();
   }

References ListNavigationEnabled< WindowBase >::ListNavigationEnabled_HandleDestroy.

OnCharHook()

template<class WindowBase >

void ListNavigationEnabled< WindowBase >::OnCharHook ( wxKeyEvent &  evt )

inlineprivate

Definition at line 49 of file ListNavigationEnabled.h.

   {
      ListNavigationEnabled_HandleCharHook(this, evt);
   }

References ListNavigationEnabled< WindowBase >::ListNavigationEnabled_HandleCharHook.

Referenced by ListNavigationEnabled< WindowBase >::ListNavigationEnabled().

Here is the caller graph for this function:

OnKeyDown()

template<class WindowBase >

void ListNavigationEnabled< WindowBase >::OnKeyDown ( wxKeyEvent &  evt )

inlineprivate

Definition at line 54 of file ListNavigationEnabled.h.

   {
      ListNavigationEnabled_HandleKeyDown(this, evt);
   }

References ListNavigationEnabled< WindowBase >::ListNavigationEnabled_HandleKeyDown.

Referenced by ListNavigationEnabled< WindowBase >::ListNavigationEnabled().

Here is the caller graph for this function:

OnNavigationKeyEvent()

template<class WindowBase >

void ListNavigationEnabled< WindowBase >::OnNavigationKeyEvent ( wxNavigationKeyEvent &  evt )

inlineprivate

Definition at line 59 of file ListNavigationEnabled.h.

   {
      ListNavigationEnabled_HandleNavigationKeyEvent(this, evt, mInTabOrder);
   }

References ListNavigationEnabled< WindowBase >::ListNavigationEnabled_HandleNavigationKeyEvent, and ListNavigationEnabled< WindowBase >::mInTabOrder.

Referenced by ListNavigationEnabled< WindowBase >::ListNavigationEnabled().

Here is the caller graph for this function:

SetFocus()

template<class WindowBase >

void ListNavigationEnabled< WindowBase >::SetFocus ( )

inlineoverrideprivate

Definition at line 43 of file ListNavigationEnabled.h.

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

References BasicUI::SetFocus().

Here is the call graph for this function:

SetInTabOrder()

template<class WindowBase >

void ListNavigationEnabled< WindowBase >::SetInTabOrder ( bool  inTabOrder )

inline

Definition at line 40 of file ListNavigationEnabled.h.

{ mInTabOrder = inTabOrder; }

References ListNavigationEnabled< WindowBase >::mInTabOrder.

Friends And Related Function Documentation

ListNavigationEnabled_HandleCharHook

template<class WindowBase >

void ListNavigationEnabled_HandleCharHook ( wxWindow *  self, wxKeyEvent &  evt  )

friend

Definition at line 13 of file ListNavigationEnabled.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) &&
      !self->HasFocus() &&
      self->IsDescendant(wxWindow::FindFocus()))
   {
      self->SetFocusFromKbd();
   }
   else
      evt.Skip();
}

Referenced by ListNavigationEnabled< WindowBase >::OnCharHook().

ListNavigationEnabled_HandleDestroy

template<class WindowBase >

void ListNavigationEnabled_HandleDestroy ( wxWindow *  self )

friend

Definition at line 73 of file ListNavigationEnabled.cpp.

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

Referenced by ListNavigationEnabled< WindowBase >::Destroy().

ListNavigationEnabled_HandleKeyDown

template<class WindowBase >

void ListNavigationEnabled_HandleKeyDown ( wxWindow *  self, wxKeyEvent &  evt  )

friend

Definition at line 29 of file ListNavigationEnabled.cpp.

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

Referenced by ListNavigationEnabled< WindowBase >::OnKeyDown().

ListNavigationEnabled_HandleNavigationKeyEvent

template<class WindowBase >

void ListNavigationEnabled_HandleNavigationKeyEvent ( wxWindow *  self, wxNavigationKeyEvent &  evt, bool  inTabOrder  )

friend

Definition at line 42 of file ListNavigationEnabled.cpp.

{
   if(evt.GetEventObject() == self->GetParent() && (!evt.IsFromTab() || inTabOrder))
      self->SetFocusFromKbd();
   else if(evt.GetEventObject() == self && evt.GetCurrentFocus() == self && evt.IsFromTab())
   {
      //NavigateIn
      wxPropagationDisabler disableProp(evt);
      const auto isForward = evt.GetDirection();
      const auto& children = self->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();
}

Referenced by ListNavigationEnabled< WindowBase >::OnNavigationKeyEvent().

Member Data Documentation

mInTabOrder

template<class WindowBase >

bool ListNavigationEnabled< WindowBase >::mInTabOrder { true }

private

Definition at line 70 of file ListNavigationEnabled.h.

Referenced by ListNavigationEnabled< WindowBase >::OnNavigationKeyEvent(), and ListNavigationEnabled< WindowBase >::SetInTabOrder().

---

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

• ListNavigationEnabled.h