qttreepropertybrowser.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** 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 Digia Plc and its Subsidiary(-ies) 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$
**
****************************************************************************/
 
 
#pragma once
 
#include "qtpropertybrowser.h"
 
QT_BEGIN_NAMESPACE
 
class QTreeWidgetItem;
class QtTreePropertyBrowserPrivate;
 
class QT_QTPROPERTYBROWSER_EXPORT QtTreePropertyBrowser : public QtAbstractPropertyBrowser
{
    Q_OBJECT
    Q_ENUMS(ResizeMode)
    Q_PROPERTY(int indentation READ indentation WRITE setIndentation)
    Q_PROPERTY(bool rootIsDecorated READ rootIsDecorated WRITE setRootIsDecorated)
    Q_PROPERTY(bool alternatingRowColors READ alternatingRowColors WRITE setAlternatingRowColors)
    Q_PROPERTY(bool headerVisible READ isHeaderVisible WRITE setHeaderVisible)
    Q_PROPERTY(ResizeMode resizeMode READ resizeMode WRITE setResizeMode)
    Q_PROPERTY(int splitterPosition READ splitterPosition WRITE setSplitterPosition)
    Q_PROPERTY(bool propertiesWithoutValueMarked READ propertiesWithoutValueMarked WRITE
                   setPropertiesWithoutValueMarked)
public:
    enum ResizeMode
    {
        Interactive,
        Stretch,
        Fixed,
        ResizeToContents
    };
 
    QtTreePropertyBrowser(QWidget* parent = 0);
    ~QtTreePropertyBrowser() override;
 
    int indentation() const;
    void setIndentation(int i);
 
    bool rootIsDecorated() const;
    void setRootIsDecorated(bool show);
 
    bool alternatingRowColors() const;
    void setAlternatingRowColors(bool enable);
 
    bool isHeaderVisible() const;
    void setHeaderVisible(bool visible);
 
    ResizeMode resizeMode() const;
    void setResizeMode(ResizeMode mode);
 
    int splitterPosition() const;
    void setSplitterPosition(int position);
 
    void setExpanded(QtBrowserItem* item, bool expanded);
    bool isExpanded(QtBrowserItem* item) const;
 
    bool isItemVisible(QtBrowserItem* item) const;
    void setItemVisible(QtBrowserItem* item, bool visible);
 
    void setBackgroundColor(QtBrowserItem* item, const QColor& color);
    QColor backgroundColor(QtBrowserItem* item) const;
    QColor calculatedBackgroundColor(QtBrowserItem* item) const;
 
    void setPropertiesWithoutValueMarked(bool mark);
    bool propertiesWithoutValueMarked() const;
 
    void editItem(QtBrowserItem* item);
 
Q_SIGNALS:
 
    void collapsed(QtBrowserItem* item);
    void expanded(QtBrowserItem* item);
 
protected:
    void itemInserted(QtBrowserItem* item, QtBrowserItem* afterItem) override;
    void itemRemoved(QtBrowserItem* item) override;
    void itemChanged(QtBrowserItem* item) override;
 
private:
    QtTreePropertyBrowserPrivate* d_ptr;
    Q_DECLARE_PRIVATE(QtTreePropertyBrowser)
    Q_DISABLE_COPY(QtTreePropertyBrowser)
 
    Q_PRIVATE_SLOT(d_func(), void slotCollapsed(const QModelIndex&))
    Q_PRIVATE_SLOT(d_func(), void slotExpanded(const QModelIndex&))
    Q_PRIVATE_SLOT(d_func(), void slotCurrentBrowserItemChanged(QtBrowserItem*))
    Q_PRIVATE_SLOT(d_func(), void slotCurrentTreeItemChanged(QTreeWidgetItem*, QTreeWidgetItem*))
};
 
QT_END_NAMESPACE