qt-everywhere-src-5.15.1/qtbase/examples/widgets/tools/settingseditor/settingstree.cpp - orbit - Git at Google

 /****************************************************************************
 **
 ** Copyright (C) 2016 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the examples of the Qt Toolkit.
 **
 ** $QT_BEGIN_LICENSE:BSD$
 ** Commercial License Usage
 ** Licensees holding valid commercial Qt licenses may use this file in
 ** accordance with the commercial license agreement provided with the
 ** Software or, alternatively, in accordance with the terms contained in
 ** a written agreement between you and The Qt Company. For licensing terms
 ** and conditions see https://www.qt.io/terms-conditions. For further
 ** information use the contact form at https://www.qt.io/contact-us.
 **
 ** BSD License Usage
 ** Alternatively, you may use this file under the terms of the BSD license
 ** as follows:
 **
 ** "Redistribution and use in source and binary forms, with or without
 ** modification, are permitted provided that the following conditions are
 ** met:
 **   * Redistributions of source code must retain the above copyright
 **     notice, this list of conditions and the following disclaimer.
 **   * Redistributions in binary form must reproduce the above copyright
 **     notice, this list of conditions and the following disclaimer in
 **     the documentation and/or other materials provided with the
 **     distribution.
 **   * Neither the name of The Qt Company Ltd nor the names of its
 **     contributors may be used to endorse or promote products derived
 **     from this software without specific prior written permission.
 **
 **
 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
 **
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/

 #include "settingstree.h"
 #include "variantdelegate.h"

 #include <QApplication>
 #include <QHeaderView>
 #include <QScreen>
 #include <QSettings>

 SettingsTree::SettingsTree(QWidget *parent)
     : QTreeWidget(parent)
 {
     setItemDelegate(new VariantDelegate(this));

     setHeaderLabels({tr("Setting"), tr("Type"), tr("Value")});
     header()->setSectionResizeMode(0, QHeaderView::ResizeToContents);
     header()->setSectionResizeMode(1, QHeaderView::ResizeToContents);
     header()->setSectionResizeMode(2, QHeaderView::Stretch);

     refreshTimer.setInterval(2000);

     groupIcon.addPixmap(style()->standardPixmap(QStyle::SP_DirClosedIcon),
                         QIcon::Normal, QIcon::Off);
     groupIcon.addPixmap(style()->standardPixmap(QStyle::SP_DirOpenIcon),
                         QIcon::Normal, QIcon::On);
     keyIcon.addPixmap(style()->standardPixmap(QStyle::SP_FileIcon));

     connect(&refreshTimer, &QTimer::timeout, this, &SettingsTree::maybeRefresh);
 }

 void SettingsTree::setSettingsObject(const SettingsPtr &newSettings)
 {
     settings = newSettings;
     clear();

     if (settings.isNull()) {
         refreshTimer.stop();
     } else {
         refresh();
         if (autoRefresh)
             refreshTimer.start();
     }
 }

 QSize SettingsTree::sizeHint() const
 {
     const QRect availableGeometry = screen()->availableGeometry();
     return QSize(availableGeometry.width() * 2 / 3, availableGeometry.height() * 2 / 3);
 }

 void SettingsTree::setAutoRefresh(bool autoRefresh)
 {
     this->autoRefresh = autoRefresh;
     if (!settings.isNull()) {
         if (autoRefresh) {
             maybeRefresh();
             refreshTimer.start();
         } else {
             refreshTimer.stop();
         }
     }
 }

 void SettingsTree::setFallbacksEnabled(bool enabled)
 {
     if (!settings.isNull()) {
         settings->setFallbacksEnabled(enabled);
         refresh();
     }
 }

 void SettingsTree::maybeRefresh()
 {
     if (state() != EditingState)
         refresh();
 }

 void SettingsTree::refresh()
 {
     if (settings.isNull())
         return;

     disconnect(this, &QTreeWidget::itemChanged,
                this, &SettingsTree::updateSetting);

     settings->sync();
     updateChildItems(nullptr);

     connect(this, &QTreeWidget::itemChanged,
             this, &SettingsTree::updateSetting);
 }

 bool SettingsTree::event(QEvent *event)
 {
     if (event->type() == QEvent::WindowActivate) {
         if (isActiveWindow() && autoRefresh)
             maybeRefresh();
     }
     return QTreeWidget::event(event);
 }

 void SettingsTree::updateSetting(QTreeWidgetItem *item)
 {
     QString key = item->text(0);
     QTreeWidgetItem *ancestor = item->parent();
     while (ancestor) {
         key.prepend(ancestor->text(0) + QLatin1Char('/'));
         ancestor = ancestor->parent();
     }

     settings->setValue(key, item->data(2, Qt::UserRole));
     if (autoRefresh)
         refresh();
 }

 void SettingsTree::updateChildItems(QTreeWidgetItem *parent)
 {
     int dividerIndex = 0;

     const QStringList childGroups = settings->childGroups();
     for (const QString &group : childGroups) {
         QTreeWidgetItem *child;
         int childIndex = findChild(parent, group, dividerIndex);
         if (childIndex != -1) {
             child = childAt(parent, childIndex);
             child->setText(1, QString());
             child->setText(2, QString());
             child->setData(2, Qt::UserRole, QVariant());
             moveItemForward(parent, childIndex, dividerIndex);
         } else {
             child = createItem(group, parent, dividerIndex);
         }
         child->setIcon(0, groupIcon);
         ++dividerIndex;

         settings->beginGroup(group);
         updateChildItems(child);
         settings->endGroup();
     }

     const QStringList childKeys = settings->childKeys();
     for (const QString &key : childKeys) {
         QTreeWidgetItem *child;
         int childIndex = findChild(parent, key, 0);

         if (childIndex == -1 || childIndex >= dividerIndex) {
             if (childIndex != -1) {
                 child = childAt(parent, childIndex);
                 for (int i = 0; i < child->childCount(); ++i)
                     delete childAt(child, i);
                 moveItemForward(parent, childIndex, dividerIndex);
             } else {
                 child = createItem(key, parent, dividerIndex);
             }
             child->setIcon(0, keyIcon);
             ++dividerIndex;
         } else {
             child = childAt(parent, childIndex);
         }

         QVariant value = settings->value(key);
         if (value.userType() == QMetaType::UnknownType) {
             child->setText(1, "Invalid");
         } else {
             child->setText(1, value.typeName());
         }
         child->setText(2, VariantDelegate::displayText(value));
         child->setData(2, Qt::UserRole, value);
     }

     while (dividerIndex < childCount(parent))
         delete childAt(parent, dividerIndex);
 }

 QTreeWidgetItem *SettingsTree::createItem(const QString &text,
                                           QTreeWidgetItem *parent, int index)
 {
     QTreeWidgetItem *after = nullptr;
     if (index != 0)
         after = childAt(parent, index - 1);

     QTreeWidgetItem *item;
     if (parent)
         item = new QTreeWidgetItem(parent, after);
     else
         item = new QTreeWidgetItem(this, after);

     item->setText(0, text);
     item->setFlags(item->flags() | Qt::ItemIsEditable);
     return item;
 }

 QTreeWidgetItem *SettingsTree::childAt(QTreeWidgetItem *parent, int index) const
 {
     return (parent ? parent->child(index) : topLevelItem(index));
 }

 int SettingsTree::childCount(QTreeWidgetItem *parent) const
 {
     return (parent ? parent->childCount() : topLevelItemCount());
 }

 int SettingsTree::findChild(QTreeWidgetItem *parent, const QString &text,
                             int startIndex) const
 {
     for (int i = startIndex; i < childCount(parent); ++i) {
         if (childAt(parent, i)->text(0) == text)
             return i;
     }
     return -1;
 }

 void SettingsTree::moveItemForward(QTreeWidgetItem *parent, int oldIndex,
                                    int newIndex)
 {
     for (int i = 0; i < oldIndex - newIndex; ++i)
         delete childAt(parent, newIndex);
 }
	/****************************************************************************
	**
	** Copyright (C) 2016 The Qt Company Ltd.
	** Contact: https://www.qt.io/licensing/
	**
	** This file is part of the examples of the Qt Toolkit.
	**
	** $QT_BEGIN_LICENSE:BSD$
	** Commercial License Usage
	** Licensees holding valid commercial Qt licenses may use this file in
	** accordance with the commercial license agreement provided with the
	** Software or, alternatively, in accordance with the terms contained in
	** a written agreement between you and The Qt Company. For licensing terms
	** and conditions see https://www.qt.io/terms-conditions. For further
	** information use the contact form at https://www.qt.io/contact-us.
	**
	** BSD License Usage
	** Alternatively, you may use this file under the terms of the BSD license
	** as follows:
	**
	** "Redistribution and use in source and binary forms, with or without
	** modification, are permitted provided that the following conditions are
	** met:
	** * Redistributions of source code must retain the above copyright
	** notice, this list of conditions and the following disclaimer.
	** * Redistributions in binary form must reproduce the above copyright
	** notice, this list of conditions and the following disclaimer in
	** the documentation and/or other materials provided with the
	** distribution.
	** * Neither the name of The Qt Company Ltd nor the names of its
	** contributors may be used to endorse or promote products derived
	** from this software without specific prior written permission.
	**
	**
	** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
	**
	** $QT_END_LICENSE$
	**
	****************************************************************************/

	#include "settingstree.h"
	#include "variantdelegate.h"

	#include <QApplication>
	#include <QHeaderView>
	#include <QScreen>
	#include <QSettings>

	SettingsTree::SettingsTree(QWidget *parent)
	: QTreeWidget(parent)
	{
	setItemDelegate(new VariantDelegate(this));

	setHeaderLabels({tr("Setting"), tr("Type"), tr("Value")});
	header()->setSectionResizeMode(0, QHeaderView::ResizeToContents);
	header()->setSectionResizeMode(1, QHeaderView::ResizeToContents);
	header()->setSectionResizeMode(2, QHeaderView::Stretch);

	refreshTimer.setInterval(2000);

	groupIcon.addPixmap(style()->standardPixmap(QStyle::SP_DirClosedIcon),
	QIcon::Normal, QIcon::Off);
	groupIcon.addPixmap(style()->standardPixmap(QStyle::SP_DirOpenIcon),
	QIcon::Normal, QIcon::On);
	keyIcon.addPixmap(style()->standardPixmap(QStyle::SP_FileIcon));

	connect(&refreshTimer, &QTimer::timeout, this, &SettingsTree::maybeRefresh);
	}

	void SettingsTree::setSettingsObject(const SettingsPtr &newSettings)
	{
	settings = newSettings;
	clear();

	if (settings.isNull()) {
	refreshTimer.stop();
	} else {
	refresh();
	if (autoRefresh)
	refreshTimer.start();
	}
	}

	QSize SettingsTree::sizeHint() const
	{
	const QRect availableGeometry = screen()->availableGeometry();
	return QSize(availableGeometry.width() * 2 / 3, availableGeometry.height() * 2 / 3);
	}

	void SettingsTree::setAutoRefresh(bool autoRefresh)
	{
	this->autoRefresh = autoRefresh;
	if (!settings.isNull()) {
	if (autoRefresh) {
	maybeRefresh();
	refreshTimer.start();
	} else {
	refreshTimer.stop();
	}
	}
	}

	void SettingsTree::setFallbacksEnabled(bool enabled)
	{
	if (!settings.isNull()) {
	settings->setFallbacksEnabled(enabled);
	refresh();
	}
	}

	void SettingsTree::maybeRefresh()
	{
	if (state() != EditingState)
	refresh();
	}

	void SettingsTree::refresh()
	{
	if (settings.isNull())
	return;

	disconnect(this, &QTreeWidget::itemChanged,
	this, &SettingsTree::updateSetting);

	settings->sync();
	updateChildItems(nullptr);

	connect(this, &QTreeWidget::itemChanged,
	this, &SettingsTree::updateSetting);
	}

	bool SettingsTree::event(QEvent *event)
	{
	if (event->type() == QEvent::WindowActivate) {
	if (isActiveWindow() && autoRefresh)
	maybeRefresh();
	}
	return QTreeWidget::event(event);
	}

	void SettingsTree::updateSetting(QTreeWidgetItem *item)
	{
	QString key = item->text(0);
	QTreeWidgetItem *ancestor = item->parent();
	while (ancestor) {
	key.prepend(ancestor->text(0) + QLatin1Char('/'));
	ancestor = ancestor->parent();
	}

	settings->setValue(key, item->data(2, Qt::UserRole));
	if (autoRefresh)
	refresh();
	}

	void SettingsTree::updateChildItems(QTreeWidgetItem *parent)
	{
	int dividerIndex = 0;

	const QStringList childGroups = settings->childGroups();
	for (const QString &group : childGroups) {
	QTreeWidgetItem *child;
	int childIndex = findChild(parent, group, dividerIndex);
	if (childIndex != -1) {
	child = childAt(parent, childIndex);
	child->setText(1, QString());
	child->setText(2, QString());
	child->setData(2, Qt::UserRole, QVariant());
	moveItemForward(parent, childIndex, dividerIndex);
	} else {
	child = createItem(group, parent, dividerIndex);
	}
	child->setIcon(0, groupIcon);
	++dividerIndex;

	settings->beginGroup(group);
	updateChildItems(child);
	settings->endGroup();
	}

	const QStringList childKeys = settings->childKeys();
	for (const QString &key : childKeys) {
	QTreeWidgetItem *child;
	int childIndex = findChild(parent, key, 0);

	if (childIndex == -1 \|\| childIndex >= dividerIndex) {
	if (childIndex != -1) {
	child = childAt(parent, childIndex);
	for (int i = 0; i < child->childCount(); ++i)
	delete childAt(child, i);
	moveItemForward(parent, childIndex, dividerIndex);
	} else {
	child = createItem(key, parent, dividerIndex);
	}
	child->setIcon(0, keyIcon);
	++dividerIndex;
	} else {
	child = childAt(parent, childIndex);
	}

	QVariant value = settings->value(key);
	if (value.userType() == QMetaType::UnknownType) {
	child->setText(1, "Invalid");
	} else {
	child->setText(1, value.typeName());
	}
	child->setText(2, VariantDelegate::displayText(value));
	child->setData(2, Qt::UserRole, value);
	}

	while (dividerIndex < childCount(parent))
	delete childAt(parent, dividerIndex);
	}

	QTreeWidgetItem *SettingsTree::createItem(const QString &text,
	QTreeWidgetItem *parent, int index)
	{
	QTreeWidgetItem *after = nullptr;
	if (index != 0)
	after = childAt(parent, index - 1);

	QTreeWidgetItem *item;
	if (parent)
	item = new QTreeWidgetItem(parent, after);
	else
	item = new QTreeWidgetItem(this, after);

	item->setText(0, text);
	item->setFlags(item->flags() \| Qt::ItemIsEditable);
	return item;
	}

	QTreeWidgetItem SettingsTree::childAt(QTreeWidgetItem parent, int index) const
	{
	return (parent ? parent->child(index) : topLevelItem(index));
	}

	int SettingsTree::childCount(QTreeWidgetItem *parent) const
	{
	return (parent ? parent->childCount() : topLevelItemCount());
	}

	int SettingsTree::findChild(QTreeWidgetItem *parent, const QString &text,
	int startIndex) const
	{
	for (int i = startIndex; i < childCount(parent); ++i) {
	if (childAt(parent, i)->text(0) == text)
	return i;
	}
	return -1;
	}

	void SettingsTree::moveItemForward(QTreeWidgetItem *parent, int oldIndex,
	int newIndex)
	{
	for (int i = 0; i < oldIndex - newIndex; ++i)
	delete childAt(parent, newIndex);
	}