Qt with Cascades UI Examples Documentation

FtpItemProvider.hpp Example File

qftp/src/FtpItemProvider.hpp
    /****************************************************************************
     **
     ** Portions Copyright (C) 2012 Research In Motion Limited.
     ** Copyright (C) 2011 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 FTPITEMPROVIDER_HPP
    #define FTPITEMPROVIDER_HPP

    #include <bb/cascades/Image>
    #include <bb/cascades/ListItemProvider>

    /**
     * The FtpItemProvider is used to provide custom items in the ListView that
     * shows the result of a FTP directory listing.
     */
    class FtpItemProvider : public bb::cascades::ListItemProvider
    {
        Q_OBJECT

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

        // This method is called to create a new instance of a ListView item
        bb::cascades::VisualNode * createItem(bb::cascades::ListView* list, const QString &type);

        // This method is called to fill an instance of a ListView item with data
        void updateItem(bb::cascades::ListView *list, bb::cascades::VisualNode *control, const QString &type,
                        const QVariantList &indexPath, const QVariant &data);
    private:
        // The image that is used for items that represent files
        bb::cascades::Image m_fileImage;

        // The image that is used for items that represent directories
        bb::cascades::Image m_folderImage;
    };

    QML_DECLARE_TYPE(FtpItemProvider)

    #endif