document.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004-2005 by Enrico Ros <eros.kde@email.it>             *
 *   Copyright (C) 2004-2008 by Albert Astals Cid <aacid@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_DOCUMENT_H_
#define _OKULAR_DOCUMENT_H_

#include "okular_export.h"
#include "area.h"
#include "global.h"
#include "pagesize.h"

#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QVector>
#include <QtGui/QPrinter>
#include <QtXml/QDomDocument>

#include <kmimetype.h>

class QPrintDialog;
class KComponentData;
class KBookmark;
class KConfigDialog;
class KXMLGUIClient;
class KUrl;
class DocumentItem;

namespace Okular {

class Annotation;
class BookmarkManager;
class DocumentInfo;
class DocumentObserver;
class DocumentPrivate;
class DocumentSynopsis;
class DocumentViewport;
class EmbeddedFile;
class ExportFormat;
class FontInfo;
class FormFieldText;
class FormFieldButton;
class FormFieldChoice;
class Generator;
class Action;
class MovieAction;
class Page;
class PixmapRequest;
class RenditionAction;
class SourceReference;
class View;
class VisiblePageRect;

#define PART_SEARCH_ID 1
#define PAGEVIEW_SEARCH_ID 2
#define SW_SEARCH_ID 3
#define PRESENTATION_SEARCH_ID 4


class OKULAR_EXPORT Document : public QObject
{
    Q_OBJECT

    public:
        explicit Document( QWidget *widget );

        ~Document();

        enum OpenResult
        {
            OpenSuccess,        //< The document was opened successfully
            OpenError,          //< The document failed to open
            OpenNeedsPassword   //< The document needs a password to be opened or the one provided is not the correct
        };

        OpenResult openDocument( const QString & docFile, const KUrl & url, const KMimeType::Ptr &mime, const QString &password = QString() );

        void closeDocument();

        void addObserver( DocumentObserver *observer );

        void removeObserver( DocumentObserver *observer );

        void reparseConfig();

        bool isOpened() const;

        const DocumentInfo * documentInfo() const;

        const DocumentSynopsis * documentSynopsis() const;

        void startFontReading();

        void stopFontReading();

        bool canProvideFontInformation() const;

        const QList<EmbeddedFile*> *embeddedFiles() const;

        const Page * page( int number ) const;

        const DocumentViewport & viewport() const;

        void setVisiblePageRects( const QVector< VisiblePageRect * > & visiblePageRects, DocumentObserver *excludeObserver = 0 );

        const QVector< VisiblePageRect * > & visiblePageRects() const;

        uint currentPage() const;

        uint pages() const;

        KUrl currentDocument() const;

        bool isAllowed( Permission action ) const;

        bool supportsSearching() const;

        bool supportsPageSizes() const;

        bool supportsTiles() const;

        PageSize::List pageSizes() const;

        bool canExportToText() const;

        bool exportToText( const QString& fileName ) const;

        QList<ExportFormat> exportFormats() const;

        bool exportTo( const QString& fileName, const ExportFormat& format ) const;

        bool historyAtBegin() const;

        bool historyAtEnd() const;

        QVariant metaData( const QString & key, const QVariant & option = QVariant() ) const;

        Rotation rotation() const;

        QSizeF allPagesSize() const;

        QString pageSizeString( int page ) const;

        KXMLGUIClient* guiClient();

        void setViewportPage( int page, DocumentObserver *excludeObserver = 0, bool smoothMove = false );

        void setViewport( const DocumentViewport &viewport, DocumentObserver *excludeObserver = 0, bool smoothMove = false );

        void setPrevViewport();

        void setNextViewport();

        void setNextDocumentViewport( const DocumentViewport &viewport );

        void setNextDocumentDestination( const QString &namedDestination );

        void setZoom( int factor, DocumentObserver *excludeObserver = 0 );

        enum PixmapRequestFlag
        {
            NoOption = 0,                
            RemoveAllPrevious = 1        
        };
        Q_DECLARE_FLAGS( PixmapRequestFlags, PixmapRequestFlag )

        
        void requestPixmaps( const QLinkedList<PixmapRequest*> &requests );

        void requestPixmaps( const QLinkedList<PixmapRequest*> &requests, PixmapRequestFlags reqOptions );

        void requestTextPage( uint number );

        void addPageAnnotation( int page, Annotation *annotation );

        bool canModifyPageAnnotation( const Annotation * annotation ) const;

        void prepareToModifyAnnotationProperties( Annotation * annotation );

        void modifyPageAnnotationProperties( int page, Annotation * annotation );

        void translatePageAnnotation( int page, Annotation *annotation, const Okular::NormalizedPoint & delta );


        void editPageAnnotationContents( int page, Annotation* annotation, const QString & newContents,
                                         int newCursorPos, int prevCursorPos, int prevAnchorPos );

        bool canRemovePageAnnotation( const Annotation * annotation ) const;

        void removePageAnnotation( int page, Annotation *annotation );

        void removePageAnnotations( int page, const QList<Annotation*> &annotations );

        void setPageTextSelection( int page, RegularAreaRect * rect, const QColor & color );

        bool canUndo() const;

        bool canRedo() const;

        enum SearchType
        {
            NextMatch,      
            PreviousMatch,  
            AllDocument,    
            GoogleAll,      
            GoogleAny       
        };

        enum SearchStatus
        {
            MatchFound,           
            NoMatchFound,         
            SearchCancelled,      
            EndOfDocumentReached  
        };

        void searchText( int searchID, const QString & text, bool fromStart, Qt::CaseSensitivity caseSensitivity,
                         SearchType type, bool moveViewport, const QColor & color );

        void continueSearch( int searchID );

        void continueSearch( int searchID, SearchType type );

        void resetSearch( int searchID );

        BookmarkManager * bookmarkManager() const;

        void processAction( const Action *action );

        QList<int> bookmarkedPageList() const;

        QString bookmarkedPageRange() const;

        void processSourceReference( const SourceReference *reference );

        bool canConfigurePrinter() const;

        enum PrintingType
        {
            NoPrinting,            
            NativePrinting,        
            PostscriptPrinting     
        };

        PrintingType printingSupport() const;

        bool supportsPrintToFile() const;

        bool print( QPrinter &printer );

        QString printError() const;

        QWidget* printConfigurationWidget() const;

        void fillConfigDialog( KConfigDialog * dialog );

        int configurableGenerators() const;

        QStringList supportedMimeTypes() const;

        const KComponentData* componentData() const;

        enum SaveCapability
        {
            SaveFormsCapability = 1,       
            SaveAnnotationsCapability = 2  
        };

        bool canSaveChanges( SaveCapability cap ) const;

        bool canSaveChanges() const;

        bool saveChanges( const QString &fileName );

        bool saveChanges( const QString &fileName, QString *errorText );

        void registerView( View *view );

        void unregisterView( View *view );

        QByteArray fontData(const FontInfo &font) const;

        OpenResult openDocumentArchive( const QString & docFile, const KUrl & url, const QString &password = QString() );

        bool saveDocumentArchive( const QString &fileName );

        const SourceReference * dynamicSourceReference( int pageNr, double absX, double absY );

        QPrinter::Orientation orientation() const;

        void setAnnotationEditingEnabled( bool enable );

        void walletDataForFile( const QString &fileName, QString *walletName, QString *walletFolder, QString *walletKey ) const;

    public Q_SLOTS:
        void setRotation( int rotation );

        void setPageSize( const PageSize &size );

        void cancelSearch();

        void undo();

        void redo();

        void editFormText( int pageNumber,
                           Okular::FormFieldText* form,
                           const QString & newContents,
                           int newCursorPos,
                           int prevCursorPos,
                           int prevAnchorPos );

        void editFormList( int pageNumber,
                           Okular::FormFieldChoice* form,
                           const QList<int> & newChoices );


        void editFormCombo( int pageNumber,
                            Okular::FormFieldChoice *form,
                            const QString & newText,
                            int newCursorPos,
                            int prevCursorPos,
                            int prevAnchorPos );

        void editFormButtons( int pageNumber,
                              const QList< Okular::FormFieldButton* > & formButtons,
                              const QList< bool > & newButtonStates );

    Q_SIGNALS:
        void close();

        void quit();

        void linkFind();

        void linkGoToPage();

        void linkPresentation();

        void linkEndPresentation();

        void openUrl( const KUrl &url );

        void error( const QString &text, int duration );

        void warning( const QString &text, int duration );

        void notice( const QString &text, int duration );

        void gotFont( const Okular::FontInfo& font );

        void fontReadingProgress( int page );

        void fontReadingEnded();

        void searchFinished( int searchID, Okular::Document::SearchStatus endStatus );

        void sourceReferenceActivated(const QString& absFileName, int line, int col, bool *handled);

        void processMovieAction( const Okular::MovieAction *action );

        void canUndoChanged( bool undoAvailable );

        void canRedoChanged( bool redoAvailable );

        void processRenditionAction( const Okular::RenditionAction *action );

        void annotationContentsChangedByUndoRedo( Okular::Annotation* annotation, const QString & contents, int cursorPos, int anchorPos );

        void formTextChangedByUndoRedo( int page, Okular::FormFieldText* form, const QString & contents, int cursorPos, int anchorPos );

        void formListChangedByUndoRedo( int page, Okular::FormFieldChoice* form, const QList< int > & choices );

        void formComboChangedByUndoRedo( int page, Okular::FormFieldChoice* form, const QString & text, int cursorPos, int anchorPos );

        void formButtonsChangedByUndoRedo( int page, const QList< Okular::FormFieldButton* > & formButtons );
    private:
        friend class DocumentPrivate;
        friend class ::DocumentItem;
        friend class EditAnnotationContentsCommand;
        friend class EditFormTextCommand;
        friend class EditFormListCommand;
        friend class EditFormComboCommand;
        friend class EditFormButtonsCommand;
        DocumentPrivate *const d;

        Q_DISABLE_COPY( Document )

        Q_PRIVATE_SLOT( d, void saveDocumentInfo() const )
        Q_PRIVATE_SLOT( d, void slotTimedMemoryCheck() )
        Q_PRIVATE_SLOT( d, void sendGeneratorPixmapRequest() )
        Q_PRIVATE_SLOT( d, void rotationFinished( int page, Okular::Page *okularPage ) )
        Q_PRIVATE_SLOT( d, void fontReadingProgress( int page ) )
        Q_PRIVATE_SLOT( d, void fontReadingGotFont( const Okular::FontInfo& font ) )
        Q_PRIVATE_SLOT( d, void slotGeneratorConfigChanged( const QString& ) )
        Q_PRIVATE_SLOT( d, void refreshPixmaps( int ) )
        Q_PRIVATE_SLOT( d, void _o_configChanged() )

        // search thread simulators
        Q_PRIVATE_SLOT( d, void doContinueDirectionMatchSearch(void *doContinueDirectionMatchSearchStruct) )
        Q_PRIVATE_SLOT( d, void doContinueAllDocumentSearch(void *pagesToNotifySet, void *pageMatchesMap, int currentPage, int searchID) )
        Q_PRIVATE_SLOT( d, void doContinueGooglesDocumentSearch(void *pagesToNotifySet, void *pageMatchesMap, int currentPage, int searchID, const QStringList & words) )
};


class OKULAR_EXPORT DocumentViewport
{
    public:
        DocumentViewport( int number = -1 );

        DocumentViewport( const QString &description );

        QString toString() const;

        bool isValid() const;

        bool operator==( const DocumentViewport &other ) const;
        bool operator<( const DocumentViewport &other ) const;

        int pageNumber;

        enum Position
        {
            Center = 1,  
            TopLeft = 2  
        };

        struct {
            bool enabled;
            double normalizedX;
            double normalizedY;
            Position pos;
        } rePos;

        struct {
            bool enabled;
            bool width;
            bool height;
        } autoFit;
};

class OKULAR_EXPORT DocumentInfo : public QDomDocument
{
    public:
        enum Key {
            Title,              
            Subject,            
            Description,        
            Author,             
            Creator,            
            Producer,           
            Copyright,          
            Pages,              
            CreationDate,       
            ModificationDate,   
            MimeType,           
            Category,           
            Keywords,           
            FilePath,           
            DocumentSize,       
            PagesSize           
        };

        DocumentInfo();

        void set( const QString &key, const QString &value,
                  const QString &title = QString() );

        void set( Key key, const QString &value );

        QString get( const QString &key ) const;

        static QString getKeyString( Key key );

        static QString getKeyTitle( Key key );

};

class OKULAR_EXPORT DocumentSynopsis : public QDomDocument
{
    public:
        DocumentSynopsis();

        DocumentSynopsis( const QDomDocument &document );
};

class OKULAR_EXPORT EmbeddedFile
{
    public:
        EmbeddedFile();

        virtual ~EmbeddedFile();

        virtual QString name() const = 0;

        virtual QString description() const = 0;

        virtual QByteArray data() const = 0;

        virtual int size() const = 0;

        virtual QDateTime modificationDate() const = 0;

        virtual QDateTime creationDate() const = 0;

};

class OKULAR_EXPORT VisiblePageRect
{
    public:
        explicit VisiblePageRect( int pageNumber = -1, const NormalizedRect &rectangle = NormalizedRect() );

        int pageNumber;

        NormalizedRect rect;
};

}

Q_DECLARE_METATYPE( Okular::DocumentInfo::Key )
Q_DECLARE_OPERATORS_FOR_FLAGS( Okular::Document::PixmapRequestFlags )

#endif

/* kate: replace-tabs on; indent-width 4; */