DialogController.hpp Example File

    /****************************************************************************
     **
     ** Portions Copyright (C) 2012 Research In Motion Limited.
     ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
     ** All rights reserved.
     ** Contact: Research In Motion Ltd. (http://www.rim.com/company/contact/)
     ** Contact: Nokia Corporation (qt-info@nokia.com)
     **
     ** This file is part of the examples of the BB10 Platform and is derived
     ** from a similar file that is part of the Qt Toolkit.
     **
     ** 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 Research In Motion, nor the name of Nokia
     **     Corporation 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."
     **
     ****************************************************************************/

    #ifndef DIALOGCONTROLLER_HPP
    #define DIALOGCONTROLLER_HPP

    #include <QtCore/QEventLoop>
    #include <QtCore/QObject>

    /**
     * The DialogController is a helper class that is used to implement
     * dialog-like behavior with QML.
     * It blocks the execution flow when opening a dialog by starting a
     * nested event loop. The event loop will handle all user input while
     * the dialog is open and will be quit when the dialog is closed.
     */
    class DialogController : public QObject
    {
        Q_OBJECT

        // This property describes whether the dialog is currently visible
        Q_PROPERTY(bool visible READ visible NOTIFY visibleChanged)

    public:
        explicit DialogController(QObject *parent = 0);

        // This method is called to show the dialog
        void exec();

        // The accessor method for the visible property
        bool visible() const;

    Q_SIGNALS:
        // The change notification signal of the visible property
        void visibleChanged();

    protected:
        // This method is called to close the dialog.
        void close();

        // The accessor method for the visible property
        void setVisible(bool visible);

    private:
        // The flag that defines whether the dialog is visible or not
        bool m_visible;

        // The nested event loop
        QEventLoop m_localLoop;
    };

    #endif