harbour-books/app/src/BooksItem.h

/*
 * Copyright (C) 2015 Jolla Ltd.
 * Contact: Slava Monich <slava.monich@jolla.com>
 *
 * 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 Nemo Mobile 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 BOOKS_ITEM_H
#define BOOKS_ITEM_H

#include "BooksTypes.h"
#include "BooksStorage.h"

#include <QDir>

class BooksItem
{
public:
    enum {
        PROGRESS_PRECISION = 1000,
        MIN_PROGRESS_DELAY =  100 /* ms */
    };

    class CopyOperation {
    public:
        virtual bool isCanceled() const = 0;
        virtual void copyProgressChanged(int aProgress) = 0;
    };

    virtual ~BooksItem() {}

    virtual BooksItem* retain() = 0;
    virtual void release() = 0;

    virtual QObject* object() = 0;
    virtual BooksShelf* shelf() = 0;
    virtual BooksBook* book() = 0;
    virtual QString name() const = 0;
    virtual QString fileName() const = 0;
    virtual QString path() const = 0;
    virtual bool accessible() const = 0;
    virtual void deleteFiles() = 0;
    virtual BooksItem* copyTo(const BooksStorage& aStorage, QString aRelPath,
        CopyOperation* aOperation = NULL) = 0;
};

#endif // BOOKS_ITEM_H