add ListViewFocusController
This commit is contained in:
Cyril Anisimov
parent
75f189e256
commit
f3df9eb5f5
4 changed files with 478 additions and 311 deletions
|
|
@ -1,310 +1,11 @@
|
|||
#include "focusController.h"
|
||||
|
||||
#include "listViewFocusController.h"
|
||||
|
||||
#include <QQuickWindow>
|
||||
#include <QQmlApplicationEngine>
|
||||
#include <QQuickItem>
|
||||
#include <QQueue>
|
||||
#include <QPointF>
|
||||
#include <QRectF>
|
||||
|
||||
|
||||
bool isVisible(QObject* item)
|
||||
{
|
||||
const auto res = item->property("visible").toBool();
|
||||
// qDebug() << "==>> " << (res ? "VISIBLE" : "NOT visible") << item;
|
||||
return res;
|
||||
}
|
||||
|
||||
bool isFocusable(QObject* item)
|
||||
{
|
||||
const auto res = item->property("isFocusable").toBool();
|
||||
return res;
|
||||
}
|
||||
|
||||
QRectF getItemCoordsOnScene(QQuickItem* item) // TODO: remove?
|
||||
{
|
||||
if (!item) return {};
|
||||
return item->mapRectToScene(item->childrenRect());
|
||||
}
|
||||
|
||||
QPointF getItemCenterPointOnScene(QQuickItem* item)
|
||||
{
|
||||
const auto x0 = item->x() + (item->width() / 2);
|
||||
const auto y0 = item->y() + (item->height() / 2);
|
||||
return item->parentItem()->mapToScene(QPointF{x0, y0});
|
||||
}
|
||||
|
||||
bool isLess(QObject* item1, QObject* item2)
|
||||
{
|
||||
const auto p1 = getItemCenterPointOnScene(qobject_cast<QQuickItem*>(item1));
|
||||
const auto p2 = getItemCenterPointOnScene(qobject_cast<QQuickItem*>(item2));
|
||||
return (p1.y() == p2.y()) ? (p1.x() < p2.x()) : (p1.y() < p2.y());
|
||||
}
|
||||
|
||||
bool isMore(QObject* item1, QObject* item2)
|
||||
{
|
||||
return !isLess(item1, item2);
|
||||
}
|
||||
|
||||
bool isListView(QObject* item)
|
||||
{
|
||||
return item->inherits("QQuickListView");
|
||||
}
|
||||
|
||||
bool isOnTheScene(QObject* object)
|
||||
{
|
||||
QQuickItem* item = qobject_cast<QQuickItem*>(object);
|
||||
if (!item) {
|
||||
qWarning() << "Couldn't recognize object as item";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!item->isVisible()) {
|
||||
// qDebug() << "===>> The item is not visible: " << item;
|
||||
return false;
|
||||
}
|
||||
|
||||
QRectF itemRect = item->mapRectToScene(item->childrenRect());
|
||||
|
||||
QQuickWindow* window = item->window();
|
||||
if (!window) {
|
||||
qWarning() << "Couldn't get the window on the Scene check";
|
||||
return false;
|
||||
}
|
||||
|
||||
const auto contentItem = window->contentItem();
|
||||
if (!contentItem) {
|
||||
qWarning() << "Couldn't get the content item on the Scene check";
|
||||
return false;
|
||||
}
|
||||
QRectF windowRect = contentItem->childrenRect();
|
||||
const auto res = (windowRect.contains(itemRect) || isListView(item));
|
||||
// qDebug() << (res ? "===>> item is inside the Scene" : "===>> ITEM IS OUTSIDE THE SCENE") << " itemRect: " << itemRect << "; windowRect: " << windowRect;
|
||||
return res;
|
||||
}
|
||||
|
||||
bool isEnabled(QObject* obj)
|
||||
{
|
||||
const auto item = qobject_cast<QQuickItem*>(obj);
|
||||
return item && item->isEnabled();
|
||||
}
|
||||
|
||||
QQuickItem* getPageOfItem(QQuickItem* item) // TODO: remove?
|
||||
{
|
||||
if(!item) {
|
||||
qWarning() << "item is null";
|
||||
return {};
|
||||
}
|
||||
const auto pagePattern = QString::fromLatin1("Page");
|
||||
QString className{item->metaObject()->className()};
|
||||
const auto isPage = className.contains(pagePattern, Qt::CaseSensitive);
|
||||
if(isPage) {
|
||||
return item;
|
||||
} else {
|
||||
return getPageOfItem(item->parentItem());
|
||||
}
|
||||
}
|
||||
|
||||
QList<QObject*> getSubChain(QObject* item)
|
||||
{
|
||||
QList<QObject*> res;
|
||||
if (!item) {
|
||||
qDebug() << "null top item";
|
||||
return res;
|
||||
}
|
||||
const auto children = item->children();
|
||||
for(const auto child : children) {
|
||||
if (child
|
||||
&& isFocusable(child)
|
||||
&& (isOnTheScene(child))
|
||||
&& isEnabled(child)
|
||||
) {
|
||||
res.append(child);
|
||||
} else {
|
||||
res.append(getSubChain(child));
|
||||
}
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
void printItems(const T& items, QObject* current_item)
|
||||
{
|
||||
for(const auto& item : items) {
|
||||
QQuickItem* i = qobject_cast<QQuickItem*>(item);
|
||||
QPointF coords {getItemCenterPointOnScene(i)};
|
||||
QString prefix = current_item == i ? "==>" : " ";
|
||||
qDebug() << prefix << " Item: " << i << " with coords: " << coords;
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief The ListViewFocusController class manages the focus of elements in ListView
|
||||
* \details This class object moving focus to ListView's controls since ListView stores
|
||||
* it's data implicitly and it could be got one by one.
|
||||
*
|
||||
* This class was made to store as less as possible data getting it from QML
|
||||
* when it's needed.
|
||||
*/
|
||||
class ListViewFocusController : public QObject
|
||||
{
|
||||
public:
|
||||
explicit ListViewFocusController(QQuickItem* listView, QObject* parent = nullptr);
|
||||
~ListViewFocusController();
|
||||
|
||||
void incrementIndex();
|
||||
void decrementIndex();
|
||||
void positionViewAtIndex();
|
||||
void focusNextItem();
|
||||
void focusPreviousItem();
|
||||
void resetFocusChain();
|
||||
bool isListViewFirstFocusItem();
|
||||
bool isDelegateFirstFocusItem();
|
||||
bool isListViewLastFocusItem();
|
||||
bool isDelegateLastFocusItem();
|
||||
bool isReturnNeeded();
|
||||
void viewToBegin();
|
||||
|
||||
private:
|
||||
int size() const;
|
||||
int currentIndex() const;
|
||||
QQuickItem* itemAtIndex(const int index);
|
||||
QQuickItem* currentDelegate();
|
||||
QQuickItem* focusedItem();
|
||||
|
||||
QQuickItem* m_listView;
|
||||
QList<QObject*> m_focusChain;
|
||||
QQuickItem* m_focusedItem;
|
||||
qsizetype m_focusedItemIndex;
|
||||
qsizetype m_delegateIndex;
|
||||
bool m_isReturnNeeded;
|
||||
};
|
||||
|
||||
ListViewFocusController::ListViewFocusController(QQuickItem* listView, QObject* parent)
|
||||
: QObject{parent}
|
||||
, m_listView{listView}
|
||||
, m_focusChain{}
|
||||
, m_focusedItem{nullptr}
|
||||
, m_focusedItemIndex{-1}
|
||||
, m_delegateIndex{0}
|
||||
, m_isReturnNeeded{false}
|
||||
{
|
||||
}
|
||||
|
||||
ListViewFocusController::~ListViewFocusController()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
void ListViewFocusController::positionViewAtIndex()
|
||||
{
|
||||
QMetaObject::invokeMethod(m_listView, "positionViewAtIndex",
|
||||
Q_ARG(int, m_delegateIndex), // Index
|
||||
Q_ARG(int, 2)); // PositionMode (0 = Visible)
|
||||
}
|
||||
|
||||
int ListViewFocusController::size() const
|
||||
{
|
||||
return m_listView->property("count").toInt();
|
||||
}
|
||||
|
||||
int ListViewFocusController::currentIndex() const
|
||||
{
|
||||
return m_delegateIndex;
|
||||
}
|
||||
|
||||
void ListViewFocusController::incrementIndex()
|
||||
{
|
||||
m_delegateIndex++;
|
||||
}
|
||||
|
||||
void ListViewFocusController::decrementIndex()
|
||||
{
|
||||
m_delegateIndex--;
|
||||
}
|
||||
|
||||
QQuickItem* ListViewFocusController::itemAtIndex(const int index)
|
||||
{
|
||||
QQuickItem* item{nullptr};
|
||||
|
||||
QMetaObject::invokeMethod(m_listView, "itemAtIndex",
|
||||
Q_RETURN_ARG(QQuickItem*, item),
|
||||
Q_ARG(int, index));
|
||||
|
||||
return item;
|
||||
}
|
||||
|
||||
QQuickItem* ListViewFocusController::currentDelegate()
|
||||
{
|
||||
return itemAtIndex(m_delegateIndex);
|
||||
}
|
||||
|
||||
QQuickItem* ListViewFocusController::focusedItem()
|
||||
{
|
||||
return m_focusedItem;
|
||||
}
|
||||
|
||||
void ListViewFocusController::focusNextItem()
|
||||
{
|
||||
if (m_focusChain.empty()) {
|
||||
qDebug() << "Empty focusChain with current delegate: " << currentDelegate() << "Scanning for elements...";
|
||||
m_focusChain = getSubChain(currentDelegate());
|
||||
}
|
||||
if (m_focusChain.empty()) {
|
||||
qWarning() << "No elements found. Returning from ListView...";
|
||||
m_isReturnNeeded = true;
|
||||
return;
|
||||
}
|
||||
m_focusedItemIndex++;
|
||||
m_focusedItem = qobject_cast<QQuickItem*>(m_focusChain.at(m_focusedItemIndex));
|
||||
qDebug() << "==>> Focused Item: " << m_focusedItem << " with Index: " << m_focusedItemIndex;
|
||||
m_focusedItem->forceActiveFocus();
|
||||
}
|
||||
|
||||
void ListViewFocusController::focusPreviousItem()
|
||||
{
|
||||
// TODO: implement
|
||||
}
|
||||
|
||||
void ListViewFocusController::resetFocusChain()
|
||||
{
|
||||
m_focusChain.clear();
|
||||
m_focusedItem = nullptr;
|
||||
m_focusedItemIndex = -1;
|
||||
}
|
||||
|
||||
bool ListViewFocusController::isDelegateFirstFocusItem()
|
||||
{
|
||||
return m_focusedItem && (m_focusedItem == m_focusChain.first());
|
||||
}
|
||||
|
||||
bool ListViewFocusController::isDelegateLastFocusItem()
|
||||
{
|
||||
return m_focusedItem && (m_focusedItem == m_focusChain.last());
|
||||
}
|
||||
|
||||
bool ListViewFocusController::isListViewFirstFocusItem()
|
||||
{
|
||||
return (m_delegateIndex == 0) && isDelegateFirstFocusItem();
|
||||
}
|
||||
|
||||
bool ListViewFocusController::isListViewLastFocusItem()
|
||||
{
|
||||
return (m_delegateIndex == size() - 1) && isDelegateLastFocusItem();
|
||||
}
|
||||
|
||||
bool ListViewFocusController::isReturnNeeded()
|
||||
{
|
||||
return m_isReturnNeeded;
|
||||
}
|
||||
|
||||
void ListViewFocusController::viewToBegin()
|
||||
{
|
||||
QMetaObject::invokeMethod(m_listView, "positionViewAtBeginning", Qt::AutoConnection);
|
||||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
FocusController::FocusController(QQmlApplicationEngine* engine, QObject *parent)
|
||||
: QObject{parent}
|
||||
, m_engine{engine}
|
||||
|
|
@ -315,13 +16,11 @@ FocusController::FocusController(QQmlApplicationEngine* engine, QObject *parent)
|
|||
, m_defaultFocusItem{QSharedPointer<QQuickItem>()}
|
||||
, m_lvfc{nullptr}
|
||||
{
|
||||
// connect(this, &FocusController::rootItemChanged, this, &FocusController::onReload);
|
||||
QObject::connect(m_engine.get(), &QQmlApplicationEngine::objectCreated, this, [this](QObject *object, const QUrl &url){
|
||||
qDebug() << "===>> () CREATED " << object << " : " << url;
|
||||
QQuickItem* newDefaultFocusItem = object->findChild<QQuickItem*>("defaultFocusItem");
|
||||
if(newDefaultFocusItem && m_defaultFocusItem != newDefaultFocusItem) {
|
||||
m_defaultFocusItem.reset(newDefaultFocusItem);
|
||||
qDebug() << "===>> [] NEW DEFAULT FOCUS ITEM " << m_defaultFocusItem;
|
||||
qDebug() << "===>> NEW DEFAULT FOCUS ITEM " << m_defaultFocusItem;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
@ -363,8 +62,11 @@ void FocusController::nextItem(bool isForwardOrder)
|
|||
m_lvfc = new ListViewFocusController(m_focusedItem, this);
|
||||
if(isForwardOrder) {
|
||||
m_lvfc->viewToBegin();
|
||||
m_lvfc->nextElement();
|
||||
focusNextListViewItem();
|
||||
} else {
|
||||
m_lvfc->viewToEnd();
|
||||
m_lvfc->previousElement();
|
||||
focusPreviousListViewItem();
|
||||
}
|
||||
return;
|
||||
|
|
@ -390,15 +92,15 @@ void FocusController::focusNextListViewItem()
|
|||
{
|
||||
m_lvfc->focusNextItem();
|
||||
|
||||
if (m_lvfc->isListViewLastFocusItem() || m_lvfc->isReturnNeeded()) {
|
||||
if (m_lvfc->isLastFocusItemInListView() || m_lvfc->isReturnNeeded()) {
|
||||
qDebug() << "===>> [Last item in ListView was reached]";
|
||||
delete m_lvfc;
|
||||
m_lvfc = nullptr;
|
||||
} else if (m_lvfc->isDelegateLastFocusItem()) {
|
||||
} else if (m_lvfc->isLastFocusItemInDelegate()) {
|
||||
qDebug() << "===>> [End of delegate elements was reached. Going to the next delegate]";
|
||||
m_lvfc->resetFocusChain();
|
||||
m_lvfc->incrementIndex();
|
||||
m_lvfc->positionViewAtIndex();
|
||||
m_lvfc->nextElement();
|
||||
m_lvfc->viewAtCurrentIndex();
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -406,13 +108,13 @@ void FocusController::focusPreviousListViewItem()
|
|||
{
|
||||
m_lvfc->focusPreviousItem();
|
||||
|
||||
if (m_lvfc->isListViewFirstFocusItem() || m_lvfc->isReturnNeeded()) {
|
||||
if (m_lvfc->isFirstFocusItemInListView() || m_lvfc->isReturnNeeded()) {
|
||||
delete m_lvfc;
|
||||
m_lvfc = nullptr;
|
||||
} else if (m_lvfc->isDelegateFirstFocusItem()) {
|
||||
} else if (m_lvfc->isFirstFocusItemInDelegate()) {
|
||||
m_lvfc->resetFocusChain();
|
||||
m_lvfc->decrementIndex();
|
||||
m_lvfc->positionViewAtIndex();
|
||||
m_lvfc->viewAtCurrentIndex();
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue