view.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2008 by Pino Toscano <pino@kde.org>                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 ***************************************************************************/

#ifndef OKULAR_VIEW_H
#define OKULAR_VIEW_H

#include "okular_export.h"

class QString;
class QVariant;

namespace Okular {

class Document;
class DocumentPrivate;
class ViewPrivate;

class OKULAR_EXPORT View
{
    friend class Document;
    friend class DocumentPrivate;

    public:
        enum ViewCapability
        {
            Zoom,                
            ZoomModality         
        };

        enum CapabilityFlag
        {
            NoFlag = 0,
            CapabilityRead = 0x01,      
            CapabilityWrite = 0x02,     
            CapabilitySerializable = 0x04  
        };
        Q_DECLARE_FLAGS( CapabilityFlags, CapabilityFlag )

        virtual ~View();

        Document* viewDocument() const;

        QString name() const;

        virtual bool supportsCapability( ViewCapability capability ) const;

        virtual CapabilityFlags capabilityFlags( ViewCapability capability ) const;

        virtual QVariant capability( ViewCapability capability ) const;

        virtual void setCapability( ViewCapability capability, const QVariant &option );

    protected:
        View( const QString &name );

        Q_DECLARE_PRIVATE( View )
        ViewPrivate *d_ptr;

    private:
        Q_DISABLE_COPY( View )
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS( Okular::View::CapabilityFlags )

#endif