1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
JUCE/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.cpp

134 lines
4.2 KiB
C++

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2017 - ROLI Ltd.
JUCE is an open source library subject to commercial or open-source
licensing.
By using JUCE, you agree to the terms of both the JUCE 5 End-User License
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
27th April 2017).
End User License Agreement: www.juce.com/juce-5-licence
Privacy Policy: www.juce.com/juce-5-privacy-policy
Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
namespace juce
{
namespace KeyboardFocusHelpers
{
// This will sort a set of components, so that they are ordered in terms of
// left-to-right and then top-to-bottom.
struct ScreenPositionComparator
{
static int compareElements (const Component* first, const Component* second)
{
auto explicitOrder1 = getOrder (first);
auto explicitOrder2 = getOrder (second);
if (explicitOrder1 != explicitOrder2)
return explicitOrder1 - explicitOrder2;
auto yDiff = first->getY() - second->getY();
return yDiff == 0 ? first->getX() - second->getX()
: yDiff;
}
static int getOrder (const Component* c)
{
auto order = c->getExplicitFocusOrder();
return order > 0 ? order : (std::numeric_limits<int>::max() / 2);
}
};
static void findAllFocusableComponents (Component* parent, Array<Component*>& comps)
{
if (parent->getNumChildComponents() != 0)
{
Array<Component*> localComps;
ScreenPositionComparator comparator;
for (auto* c : parent->getChildren())
if (c->isVisible() && c->isEnabled())
localComps.addSorted (comparator, c);
for (auto* c : localComps)
{
if (c->getWantsKeyboardFocus())
comps.add (c);
if (! c->isFocusContainer())
findAllFocusableComponents (c, comps);
}
}
}
static Component* findFocusContainer (Component* c)
{
c = c->getParentComponent();
if (c != nullptr)
while (c->getParentComponent() != nullptr && ! c->isFocusContainer())
c = c->getParentComponent();
return c;
}
static Component* getIncrementedComponent (Component* current, int delta)
{
if (auto* focusContainer = findFocusContainer (current))
{
Array<Component*> comps;
KeyboardFocusHelpers::findAllFocusableComponents (focusContainer, comps);
if (! comps.isEmpty())
{
auto index = comps.indexOf (current);
return comps [(index + comps.size() + delta) % comps.size()];
}
}
return nullptr;
}
}
//==============================================================================
KeyboardFocusTraverser::KeyboardFocusTraverser() {}
KeyboardFocusTraverser::~KeyboardFocusTraverser() {}
Component* KeyboardFocusTraverser::getNextComponent (Component* current)
{
jassert (current != nullptr);
return KeyboardFocusHelpers::getIncrementedComponent (current, 1);
}
Component* KeyboardFocusTraverser::getPreviousComponent (Component* current)
{
jassert (current != nullptr);
return KeyboardFocusHelpers::getIncrementedComponent (current, -1);
}
Component* KeyboardFocusTraverser::getDefaultComponent (Component* parentComponent)
{
Array<Component*> comps;
if (parentComponent != nullptr)
KeyboardFocusHelpers::findAllFocusableComponents (parentComponent, comps);
return comps.getFirst();
}
} // namespace juce