/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the tools applications of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qtpropertybrowser.h"

#include <QtCore/QSet>

#include <QtCore/QMap>

#include <QtGui/QIcon>

#if defined(Q_CC_MSVC)

#    pragma warning(disable: 4786) /* MS VS 6: truncating debug info after 255 characters */

#endif

QT_BEGIN_NAMESPACE

class QtPropertyPrivate

{

public:

    QtPropertyPrivate(QtAbstractPropertyManager *manager) : m_enabled(true), m_modified(false), m_manager(manager) {}

    QtProperty *q_ptr;

    QSet<QtProperty *> m_parentItems;

    QList<QtProperty *> m_subItems;

    QString m_toolTip;

    QString m_statusTip;

    QString m_whatsThis;

    QString m_name;

    bool m_enabled;

    bool m_modified;

    QtAbstractPropertyManager * const m_manager;

};

class QtAbstractPropertyManagerPrivate

{

    QtAbstractPropertyManager *q_ptr;

    Q_DECLARE_PUBLIC(QtAbstractPropertyManager)

public:

    void propertyDestroyed(QtProperty *property);

    void propertyChanged(QtProperty *property) const;

    void propertyRemoved(QtProperty *property,

                QtProperty *parentProperty) const;

    void propertyInserted(QtProperty *property, QtProperty *parentProperty,

                QtProperty *afterProperty) const;

    QSet<QtProperty *> m_properties;

};

/*!

    \class QtProperty

    \internal

    \inmodule QtDesigner

    \since 4.4

    \brief The QtProperty class encapsulates an instance of a property.

    Properties are created by objects of QtAbstractPropertyManager

    subclasses; a manager can create properties of a given type, and

    is used in conjunction with the QtAbstractPropertyBrowser class. A

    property is always owned by the manager that created it, which can

    be retrieved using the propertyManager() function.

    QtProperty contains the most common property attributes, and

    provides functions for retrieving as well as setting their values:

    \table

    \header \o Getter \o Setter

    \row

    \o propertyName() \o setPropertyName()

    \row

    \o statusTip() \o setStatusTip()

    \row

    \o toolTip() \o setToolTip()

    \row

    \o whatsThis() \o setWhatsThis()

    \row

    \o isEnabled() \o setEnabled()

    \row

    \o isModified() \o setModified()

    \row

    \o valueText() \o Nop

    \row

    \o valueIcon() \o Nop

    \endtable

    It is also possible to nest properties: QtProperty provides the

    addSubProperty(), insertSubProperty() and removeSubProperty() functions to

    manipulate the set of subproperties. Use the subProperties()

    function to retrieve a property's current set of subproperties.

    Note that nested properties are not owned by the parent property,

    i.e. each subproperty is owned by the manager that created it.

    \sa QtAbstractPropertyManager, QtBrowserItem

*/

/*!

    Creates a property with the given \a manager.

    This constructor is only useful when creating a custom QtProperty

    subclass (e.g. QtVariantProperty). To create a regular QtProperty

    object, use the QtAbstractPropertyManager::addProperty()

    function instead.

    \sa QtAbstractPropertyManager::addProperty()

*/

QtProperty::QtProperty(QtAbstractPropertyManager *manager)

    : d_ptr(new QtPropertyPrivate(manager))

{

    d_ptr->q_ptr = this;

}

/*!

    Destroys this property.

    Note that subproperties are detached but not destroyed, i.e. they

    can still be used in another context.

    \sa QtAbstractPropertyManager::clear()

*/

QtProperty::~QtProperty()

{

    QSetIterator<QtProperty *> itParent(d_ptr->m_parentItems);

    while (itParent.hasNext()) {

        QtProperty *property = itParent.next();

        property->d_ptr->m_manager->d_ptr->propertyRemoved(this, property);

    }

    d_ptr->m_manager->d_ptr->propertyDestroyed(this);

    QListIterator<QtProperty *> itChild(d_ptr->m_subItems);

    while (itChild.hasNext()) {

        QtProperty *property = itChild.next();

        property->d_ptr->m_parentItems.remove(this);

    }

    itParent.toFront();

    while (itParent.hasNext()) {

        QtProperty *property = itParent.next();

        property->d_ptr->m_subItems.removeAll(this);

    }

}

/*!

    Returns the set of subproperties.

    Note that subproperties are not owned by \e this property, but by

    the manager that created them.

    \sa insertSubProperty(), removeSubProperty()

*/

QList<QtProperty *> QtProperty::subProperties() const

{

    return d_ptr->m_subItems;

}

/*!

    Returns a pointer to the manager that owns this property.

*/

QtAbstractPropertyManager *QtProperty::propertyManager() const

{

    return d_ptr->m_manager;

}

/*!

    Returns the property's  tool tip.

    \sa setToolTip()

*/

QString QtProperty::toolTip() const

{

    return d_ptr->m_toolTip;

}

/*!

    Returns the property's status tip.

    \sa setStatusTip()

*/

QString QtProperty::statusTip() const

{

    return d_ptr->m_statusTip;

}

/*!

    Returns the property's "What's This" help text.

    \sa setWhatsThis()

*/

QString QtProperty::whatsThis() const

{

    return d_ptr->m_whatsThis;

}

/*!

    Returns the property's name.

    \sa setPropertyName()

*/

QString QtProperty::propertyName() const

{

    return d_ptr->m_name;

}

/*!

    Returns whether the property is enabled.

    \sa setEnabled()

*/

bool QtProperty::isEnabled() const

{

    return d_ptr->m_enabled;

}

/*!

    Returns whether the property is modified.

    \sa setModified()

*/

bool QtProperty::isModified() const

{

    return d_ptr->m_modified;

}

/*!

    Returns whether the property has a value.

    \sa QtAbstractPropertyManager::hasValue()

*/

bool QtProperty::hasValue() const

{

    return d_ptr->m_manager->hasValue(this);

}

/*!

    Returns an icon representing the current state of this property.

    If the given property type can not generate such an icon, this

    function returns an invalid icon.

    \sa QtAbstractPropertyManager::valueIcon()

*/

QIcon QtProperty::valueIcon() const

{

    return d_ptr->m_manager->valueIcon(this);

}

/*!

    Returns a string representing the current state of this property.

    If the given property type can not generate such a string, this

    function returns an empty string.

    \sa QtAbstractPropertyManager::valueText()

*/

QString QtProperty::valueText() const

{

    return d_ptr->m_manager->valueText(this);

}

/*!

    Sets the property's tool tip to the given \a text.

    \sa toolTip()

*/

void QtProperty::setToolTip(const QString &text)

{

    if (d_ptr->m_toolTip == text)

        return;

    d_ptr->m_toolTip = text;

    propertyChanged();

}

/*!

    Sets the property's status tip to the given \a text.

    \sa statusTip()

*/

void QtProperty::setStatusTip(const QString &text)

{

    if (d_ptr->m_statusTip == text)

        return;

    d_ptr->m_statusTip = text;

    propertyChanged();

}

/*!

    Sets the property's "What's This" help text to the given \a text.

    \sa whatsThis()

*/

void QtProperty::setWhatsThis(const QString &text)

{

    if (d_ptr->m_whatsThis == text)

        return;

    d_ptr->m_whatsThis = text;

    propertyChanged();

}

/*!

    \fn void QtProperty::setPropertyName(const QString &name)

    Sets the property's  name to the given \a name.

    \sa propertyName()

*/

void QtProperty::setPropertyName(const QString &text)

{

    if (d_ptr->m_name == text)

        return;

    d_ptr->m_name = text;

    propertyChanged();

}

/*!

    Enables or disables the property according to the passed \a enable value.

    \sa isEnabled()

*/

void QtProperty::setEnabled(bool enable)

{

    if (d_ptr->m_enabled == enable)

        return;

    d_ptr->m_enabled = enable;

    propertyChanged();

}

/*!

    Sets the property's modified state according to the passed \a modified value.

    \sa isModified()

*/

void QtProperty::setModified(bool modified)

{

    if (d_ptr->m_modified == modified)

        return;

    d_ptr->m_modified = modified;

    propertyChanged();

}

/*!

    Appends the given \a property to this property's subproperties.

    If the given \a property already is added, this function does

    nothing.

    \sa insertSubProperty(), removeSubProperty()

*/

void QtProperty::addSubProperty(QtProperty *property)

{

    QtProperty *after = 0;

    if (d_ptr->m_subItems.count() > 0)

        after = d_ptr->m_subItems.last();

    insertSubProperty(property, after);

}

/*!

    \fn void QtProperty::insertSubProperty(QtProperty *property, QtProperty *precedingProperty)

    Inserts the given \a property after the specified \a

    precedingProperty into this property's list of subproperties.  If

    \a precedingProperty is 0, the specified \a property is inserted

    at the beginning of the list.

    If the given \a property already is inserted, this function does

    nothing.

    \sa addSubProperty(), removeSubProperty()

*/

void QtProperty::insertSubProperty(QtProperty *property,

            QtProperty *afterProperty)

{

    if (!property)

        return;

    if (property == this)

        return;

    // traverse all children of item. if this item is a child of item then cannot add.

    QList<QtProperty *> pendingList = property->subProperties();

    QMap<QtProperty *, bool> visited;

    while (!pendingList.isEmpty()) {

        QtProperty *i = pendingList.first();

        if (i == this)

            return;

        pendingList.removeFirst();

        if (visited.contains(i))

            continue;

        visited[i] = true;

        pendingList += i->subProperties();

    }

    pendingList = subProperties();

    int pos = 0;

    int newPos = 0;

    QtProperty *properAfterProperty = 0;

    while (pos < pendingList.count()) {

        QtProperty *i = pendingList.at(pos);

        if (i == property)

            return; // if item is already inserted in this item then cannot add.

        if (i == afterProperty) {

            newPos = pos + 1;

            properAfterProperty = afterProperty;

        }

        pos++;

    }

    d_ptr->m_subItems.insert(newPos, property);

    property->d_ptr->m_parentItems.insert(this);

    d_ptr->m_manager->d_ptr->propertyInserted(property, this, properAfterProperty);

}

/*!

    Removes the given \a property from the list of subproperties

    without deleting it.

    \sa addSubProperty(), insertSubProperty()

*/

void QtProperty::removeSubProperty(QtProperty *property)

{

    if (!property)

        return;

    d_ptr->m_manager->d_ptr->propertyRemoved(property, this);

    QList<QtProperty *> pendingList = subProperties();

    int pos = 0;

    while (pos < pendingList.count()) {

        if (pendingList.at(pos) == property) {

            d_ptr->m_subItems.removeAt(pos);

            property->d_ptr->m_parentItems.remove(this);

            return;

        }

        pos++;

    }

}

/*!

    \internal

*/

void QtProperty::propertyChanged()

{

    d_ptr->m_manager->d_ptr->propertyChanged(this);

}

////////////////////////////////

void QtAbstractPropertyManagerPrivate::propertyDestroyed(QtProperty *property)

{

    if (m_properties.contains(property)) {

        emit q_ptr->propertyDestroyed(property);

        q_ptr->uninitializeProperty(property);

        m_properties.remove(property);

    }

}

void QtAbstractPropertyManagerPrivate::propertyChanged(QtProperty *property) const

{

    emit q_ptr->propertyChanged(property);

}

void QtAbstractPropertyManagerPrivate::propertyRemoved(QtProperty *property,

            QtProperty *parentProperty) const

{

    emit q_ptr->propertyRemoved(property, parentProperty);

}

void QtAbstractPropertyManagerPrivate::propertyInserted(QtProperty *property,

            QtProperty *parentProperty, QtProperty *afterProperty) const

{

    emit q_ptr->propertyInserted(property, parentProperty, afterProperty);

}

/*!

    \class QtAbstractPropertyManager

    \internal

    \inmodule QtDesigner

    \since 4.4

    \brief The QtAbstractPropertyManager provides an interface for

    property managers.