path: root/src/declarative/fx/qfxitem.h

/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module 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 either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** 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.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QFXITEM_H
#define QFXITEM_H

#include <QtCore/QObject>
#include <QtScript/qscriptvalue.h>
#include <QtCore/QList>
#include <QtDeclarative/qfxanchors.h>
#include <QtDeclarative/qfxglobal.h>
#include <QtDeclarative/qml.h>
#include <QtDeclarative/qfxscalegrid.h>
#include <QtDeclarative/qsimplecanvasitem.h>
#include <QtDeclarative/qmlcomponent.h>
#include <QtDeclarative/qmlstate.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Declarative)

class Q_DECLARATIVE_EXPORT QFxContents : public QObject
{
    Q_OBJECT
    Q_PROPERTY(qreal height READ height NOTIFY heightChanged)
    Q_PROPERTY(qreal width READ width NOTIFY widthChanged)
public:
    QFxContents();

    qreal height() const;

    qreal width() const;

    void setItem(QFxItem *item);

public Q_SLOTS:
    void calcHeight();
    void calcWidth();

Q_SIGNALS:
    void heightChanged();
    void widthChanged();

private:
    QFxItem *m_item;
    qreal m_height;
    qreal m_width;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QFxAnchors::UsedAnchors)

class QmlState;
class QmlTransition;
class QFxTransform;
class QFxKeyEvent;
class QFxItemPrivate;
class Q_DECLARATIVE_EXPORT QFxItem : public QSimpleCanvasItem, public QmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QmlParserStatus)

    Q_PROPERTY(QFxItem * parent READ itemParent WRITE setItemParent NOTIFY parentChanged DESIGNABLE false)
    Q_PROPERTY(QFxItem * moveToParent READ itemParent WRITE moveToParent NOTIFY parentChanged DESIGNABLE false)
    Q_PROPERTY(QString id READ id WRITE setId)
    Q_PROPERTY(QmlList<QFxItem *>* children READ children DESIGNABLE false)
    Q_PROPERTY(QmlList<QObject *>* resources READ resources DESIGNABLE false)
    Q_PROPERTY(QFxAnchors * anchors READ anchors DESIGNABLE false)
    Q_PROPERTY(QmlList<QObject *> *data READ data DESIGNABLE false)
    Q_PROPERTY(QFxContents * contents READ contents DESIGNABLE false)
    Q_PROPERTY(QmlList<QmlState *>* states READ states DESIGNABLE false)
    Q_PROPERTY(QmlList<QmlTransition *>* transitions READ transitions DESIGNABLE false)
    Q_PROPERTY(QString state READ state WRITE setState NOTIFY stateChanged)
    Q_PROPERTY(QUrl qml READ qml WRITE setQml NOTIFY qmlChanged)
    Q_PROPERTY(QFxItem *qmlItem READ qmlItem NOTIFY qmlChanged)
    Q_PROPERTY(qreal x READ x WRITE setX NOTIFY xChanged)
    Q_PROPERTY(qreal y READ y WRITE setY NOTIFY yChanged)
    Q_PROPERTY(qreal z READ z WRITE setZ)
    Q_PROPERTY(qreal width READ width WRITE setWidth NOTIFY widthChanged)
    Q_PROPERTY(qreal height READ height WRITE setHeight NOTIFY heightChanged)
    Q_PROPERTY(QFxAnchorLine left READ left)
    Q_PROPERTY(QFxAnchorLine right READ right)
    Q_PROPERTY(QFxAnchorLine horizontalCenter READ horizontalCenter)
    Q_PROPERTY(QFxAnchorLine top READ top)
    Q_PROPERTY(QFxAnchorLine bottom READ bottom)
    Q_PROPERTY(QFxAnchorLine verticalCenter READ verticalCenter)
    Q_PROPERTY(QFxAnchorLine baseline READ baseline)
    Q_PROPERTY(qreal baselineOffset READ baselineOffset WRITE setBaselineOffset NOTIFY baselineOffsetChanged)
    Q_PROPERTY(bool flipVertically READ flipVertically WRITE setFlipVertically)
    Q_PROPERTY(bool flipHorizontally READ flipHorizontally WRITE setFlipHorizontally)
    Q_PROPERTY(qreal rotation READ rotation WRITE setRotation NOTIFY rotationChanged)
    Q_PROPERTY(qreal scale READ scale WRITE setScale NOTIFY scaleChanged)
    Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity NOTIFY opacityChanged)
    Q_PROPERTY(QSimpleCanvasFilter *filter READ filter WRITE setFilter)
    Q_PROPERTY(bool clip READ clip WRITE setClip)
    Q_PROPERTY(bool focusable READ isFocusable WRITE setFocusable)
    Q_PROPERTY(bool focus READ hasFocus WRITE setFocus NOTIFY focusChanged)
    Q_PROPERTY(bool activeFocus READ hasActiveFocus NOTIFY activeFocusChanged)
    Q_PROPERTY(QList<QFxTransform *>* transform READ transform)
    Q_PROPERTY(bool visible READ visible WRITE setVisible NOTIFY visibleChanged)
    Q_CLASSINFO("DefaultProperty", "data")

    typedef QHash<QString, QFxItem *> QmlChildren;

public:
    QFxItem(QFxItem *parent = 0);
    virtual ~QFxItem();

    QFxItem *itemParent() const;
    void setItemParent(QFxItem *parent);

    void moveToParent(QFxItem *parent);

    QString id() const;
    void setId(const QString &);

    QmlList<QObject *> *data();
    QmlList<QFxItem *> *children();
    QmlList<QObject *> *resources();

    QFxAnchors *anchors();

    QFxContents *contents();

    QmlList<QmlState *>* states();
    QmlState *findState(const QString &name) const;

    QmlList<QmlTransition *>* transitions();

    QString state() const;
    void setState(const QString &);

    QFxItem *qmlItem() const;
    QUrl qml() const;
    void setQml(const QUrl &);

    bool flipVertically() const;
    void setFlipVertically(bool);
    bool flipHorizontally() const;
    void setFlipHorizontally(bool);

    qreal baselineOffset() const;
    void setBaselineOffset(qreal);

    qreal rotation() const;
    void setRotation(qreal);

    qreal scale() const;
    void setScale(qreal);

    qreal opacity() const;
    virtual void setOpacity(qreal);

    QList<QFxTransform *> *transform();

    bool isVisible() const;
    void setVisible(bool);

    virtual void dump(int depth = 0);
    virtual QString propertyInfo() const;

    bool isClassComplete() const;
    bool isComponentComplete() const;

    QRectF sceneBoundingRect() const;

    void updateTransform();

    bool keepMouseGrab() const;
    void setKeepMouseGrab(bool);

public Q_SLOTS:
    void newChild(const QString &url);

Q_SIGNALS:
    void xChanged();
    void yChanged();
    void widthChanged();
    void heightChanged();
    void baselineOffsetChanged();
    void stateChanged(const QString &);
    void focusChanged();
    void activeFocusChanged();
    void parentChanged();
    void keyPress(QFxKeyEvent *event);
    void keyRelease(QFxKeyEvent *event);
    void rotationChanged();
    void scaleChanged();
    void opacityChanged();
    void visibleChanged();
    void qmlChanged();
    void newChildCreated(const QString &url, QScriptValue);

protected:
    virtual void transformChanged(const QSimpleCanvas::Matrix &);
    virtual void classBegin();
    virtual void classComplete();
    virtual void componentComplete();
    virtual void parentChanged(QSimpleCanvasItem *, QSimpleCanvasItem *);
    virtual void reparentItems();
    virtual void focusChanged(bool);
    virtual void activeFocusChanged(bool);
    void keyPressEvent(QKeyEvent *event);
    void keyReleaseEvent(QKeyEvent *event);
    virtual void geometryChanged(const QRectF &newGeometry, 
                                 const QRectF &oldGeometry);

private Q_SLOTS:
    void doUpdate();
    void qmlLoaded();

protected:
    QFxItem(QFxItemPrivate &dd, QFxItem *parent = 0);

private:
    QFxAnchorLine left() const;
    QFxAnchorLine right() const;
    QFxAnchorLine horizontalCenter() const;
    QFxAnchorLine top() const;
    QFxAnchorLine bottom() const;
    QFxAnchorLine verticalCenter() const;
    QFxAnchorLine baseline() const;

    void init(QFxItem *parent);
    friend class QmlStatePrivate;
    friend class QFxAnchors;
    Q_DISABLE_COPY(QFxItem)
    Q_DECLARE_PRIVATE(QFxItem)
};

QT_END_NAMESPACE

QML_DECLARE_TYPE(QFxContents)
QML_DECLARE_TYPE(QFxItem)
QML_DECLARE_TYPE(QSimpleCanvasFilter)

QT_END_HEADER

#endif // QFXITEM_H