F:/KPlato/koffice/libs/kofficecore/KoDocument.h

Aller à la documentation de ce fichier.

// -*- c-basic-offset: 4 -*-
/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
   Copyright (C) 2000-2005 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef __ko_document_h__
#define __ko_document_h__

class KoTextDocument;
#include <QDateTime>
#include <QList>
#include <QMatrix>
//Added by qt3to4:
#include <QPixmap>
#include <QByteArray>
#include <Q3PtrList>
#include <QList>

#include <kparts/part.h>
#include <kurl.h>
#include <kservice.h>
#include <KoGlobal.h>
#include <KoUnit.h>
#include <KoPageLayout.h>
#include <koffice_export.h>

#include <KoXmlReader.h>


class QDomElement;
class QDomDocument;
class QXmlSimpleReader;

class KoStore;
class KoMainWindow;

class KoChild;
class KoDocumentChild;
class KoView;
class KoDocumentInfo;
// class DCOPObject;
class KoOasisStyles;
class KoXmlWriter;
class KoOpenPane;


class KoVersionInfo
{
public:
    QDateTime date;
    QString saved_by;
    QString comment;
    QString title;

    QByteArray data; //the content of the compressed version
};

class KOFFICECORE_EXPORT KoDocument : public KParts::ReadWritePart
{
    Q_OBJECT
//     Q_PROPERTY( QByteArray dcopObjectId READ dcopObjectId)
    Q_PROPERTY( bool backupFile READ backupFile WRITE setBackupFile )

public:

    KoDocument( QWidget* parentWidget,
                QObject* parent,
                bool singleViewMode = false );

    virtual ~KoDocument();

    bool isSingleViewMode() const;

    bool isEmbedded() const;

    virtual KAction *action( const QDomElement &element ) const;

    virtual QDomDocument domDocument() const;

    virtual void setManager( KParts::PartManager *manager );

    virtual bool openURL( const KUrl & url );

    bool import( const KUrl &url );

    bool exp0rt( const KUrl &url );

    virtual void setReadWrite( bool readwrite = true );

    static QByteArray readNativeFormatMimeType( KInstance *instance = 0 );

    static QStringList readExtraNativeMimeTypes( KInstance *instance = 0 );

    static KService::Ptr readNativeService( KInstance *instance = 0 );

    static void setupXmlReader( QXmlSimpleReader& reader, bool namespaceProcessing = false );

    virtual QByteArray nativeFormatMimeType() const;

    QByteArray nativeOasisMimeType() const;

    bool isNativeFormat( const QByteArray& mimetype ) const;

    virtual QStringList extraNativeMimeTypes() const;

    enum { /*SaveAsKOffice1dot1 = 1,*/ // old and removed
           SaveAsDirectoryStore = 2,
           SaveAsFlatXML = 4
           // bitfield! next value is 8
         };

    virtual int supportedSpecialFormats() const;

    QByteArray mimeType() const;

    void setMimeType( const QByteArray & mimeType );

    void setOutputMimeType( const QByteArray & mimeType, int specialOutputFlag = 0 );
    QByteArray outputMimeType() const;
    int specialOutputFlag() const;

    bool confirmNonNativeSave( const bool exporting ) const;
    void setConfirmNonNativeSave( const bool exporting, const bool on );

    virtual bool wantExportConfirmation() const;

    void setErrorMessage( const QString& errMsg );

    QString errorMessage() const;

    void showSavingErrorDialog();

    void showLoadingErrorDialog();

    KoView *createView( QWidget *parent = 0 );

    virtual void addView( KoView *view );

    virtual void removeView( KoView *view );

    const QList<KoView*> & views() const;

    int viewCount() const;

    virtual KParts::Part *hitTest( QWidget *widget, const QPoint &globalPos );

    virtual KoDocument *hitTest( const QPoint &pos, KoView* view, const QMatrix& matrix = QMatrix() );

    virtual void paintEverything( QPainter &painter, const QRect &rect, bool transparent = false,
                                  KoView *view = 0L, double zoomX = 1.0, double zoomY = 1.0 );

    virtual QPixmap generatePreview( const QSize& size );

    virtual void paintChildren( QPainter &painter, const QRect &rect, KoView *view, double zoomX = 1.0, double zoomY = 1.0 );

    virtual void paintChild( KoDocumentChild *child, QPainter &painter, KoView *view,
                             double zoomX = 1.0, double zoomY = 1.0 );

    virtual void paintContent( QPainter &painter, const QRect &rect, bool transparent = false,
                               double zoomX = 1.0, double zoomY = 1.0 ) = 0;

    bool checkAutoSaveFile();

    enum InitDocFlags { InitDocAppStarting, InitDocFileNew, InitDocFileClose, InitDocEmbedded, InitDocEmpty };

    virtual void showStartUpWidget(KoMainWindow* parent, bool alwaysShow = false);

    virtual void setModified( bool _mod );

    virtual void setTitleModified();

    virtual bool isEmpty() const { return m_bEmpty; }

    virtual void setEmpty() { m_bEmpty = true; }

    virtual bool loadFromStore( KoStore* store, const QString& url );

    virtual bool loadOasisFromStore( KoStore* store );

    virtual bool saveToStore( KoStore* store, const QString& path );

    virtual bool loadXML( QIODevice *, const KoXmlDocument & doc ) = 0;

    virtual bool loadOasis( const KoXmlDocument & doc, KoOasisStyles& oasisStyles,
                            const KoXmlDocument & settings, KoStore* store ) = 0;

    virtual bool saveOasis( KoStore* store, KoXmlWriter* manifestWriter ) = 0;

    virtual QDomDocument saveXML();

    QDomDocument createDomDocument( const QString& tagName, const QString& version ) const;

    static KoXmlWriter* createOasisXmlWriter( QIODevice* dev, const char* rootElementName );

    static QDomDocument createDomDocument( const QString& appName, const QString& tagName, const QString& version );

    static QString tagNameToDocumentType( const QString& localName );

    virtual bool saveToStream( QIODevice * dev );

    virtual bool loadNativeFormat( const QString & file );

    virtual bool saveNativeFormat( const QString & file );

    void setAutoSave( int delay );

    bool isAutosaving() const;

    void setCheckAutoSaveFile( bool b );

    void setAutoErrorHandlingEnabled( bool b );

    bool isAutoErrorHandlingEnabled() const;

    static int defaultAutoSave() { return s_defaultAutoSave; }

    const Q3PtrList<KoDocumentChild>& children() const;

    KoDocumentChild *child( KoDocument *doc );

    KoDocumentInfo *documentInfo() const;

    void setViewBuildDocument( KoView *view, const QDomDocument &doc );
    QDomDocument viewBuildDocument( KoView *view );

    virtual void addShell( KoMainWindow *shell );

    virtual void removeShell( KoMainWindow *shell );

    const Q3PtrList<KoMainWindow>& shells() const;

    int shellCount() const;

    static Q3PtrList<KoDocument> *documentList() { return s_documentList; }

//     virtual DCOPObject * dcopObject();

//     QByteArray dcopObjectId() const;

    void emitProgress( int value ) { emit sigProgress( value ); }

    bool isInOperation() const;
    virtual void emitBeginOperation();
    virtual void emitEndOperation();

    virtual bool isStoredExtern() const;

    virtual KoPageLayout pageLayout(int pageNumber = 0) const;

    void removeAutoSaveFiles();

    void setBackupFile( bool _b );

    bool backupFile()const;

    bool isModified() const;

    bool isLoading() const;

    int queryCloseExternalChildren();
    int queryCloseDia();

    void setDoNotSaveExtDoc( bool on = true );

    void setBackupPath( const QString & _path );

    QString backupPath()const;

    void setCurrent( bool on = true );

    void forceCurrent( bool on );
    bool isCurrent() const;

    void setTitleModified( const QString caption, bool mod );

    void resetURL() { m_url = KUrl(); m_file.clear(); }

    void setStoreInternal( bool i );

    bool storeInternal() const;

    bool hasExternURL() const;

    void setURL( const KUrl& url ) { m_url = url; }

    QString &file() { return m_file; }

    void setFile( const QString &file ) { m_file = file; }

    void setMimeTypeAfterLoading( const QString& mimeType );

    virtual int pageCount() const { return 1; }

    virtual QList<KoTextDocument *> allTextDocuments() const;

    KoUnit::Unit unit() const;

    void setUnit( KoUnit::Unit u );

    QString unitName() const;

    void setTemplateType(const QString& _templateType);
    QString templateType() const;

    virtual bool showEmbedInitDialog(QWidget* parent);


    QList<KoVersionInfo> &versionList();

    bool loadNativeFormatFromStore( QByteArray &data );

    bool addVersion( const QString& comment );

public slots:
    virtual void initEmpty();

signals:

    void unitChanged(KoUnit::Unit);

    void childChanged( KoDocumentChild *child );

    void sigProgress( int value );

    void sigStatusBarMessage( const QString& text );

    void sigClearStatusBarMessage();

    void sigBeginOperation();
    void sigEndOperation();

    void modified( bool );

    void closeEmbedInitDialog();

protected slots:
    virtual void openExistingFile( const KUrl& url );
    virtual void openTemplate( const KUrl& url );

    void deleteOpenPaneDelayed();

protected:

    QString newObjectName();

    QString autoSaveFile( const QString & path ) const;

    virtual KoView *createViewInstance( QWidget *parent ) = 0;

    virtual bool openFile();

    virtual bool saveFile();

    virtual QWidget* createCustomDocumentWidget(QWidget *parent);

    virtual bool loadChildren( KoStore* );

    virtual bool saveChildren( KoStore* store );

    virtual bool saveChildrenOasis( KoStore* store, KoXmlWriter* manifestWriter );

    virtual bool completeLoading( KoStore* store );

    virtual bool completeSaving( KoStore* store );

    virtual void insertChild( KoDocumentChild *child );

    virtual void setModified() { KParts::ReadWritePart::setModified(); }

    KoPageLayout m_pageLayout;

    virtual bool saveExternalChildren();

    bool isImporting() const;

    bool isExporting() const;

    KoOpenPane* createOpenPane( QWidget* parent, KInstance* instance,
                                const QString& templateType = QString::null);

private slots:
    void slotChildChanged( KoChild *c );
    void slotChildDestroyed();
    void slotAutoSave();
    void slotStarted( KIO::Job* );
    void startCustomDocument();
    void deleteOpenPane();

private:
    virtual void insertChild(QObject *) { Q_ASSERT( 0 ); } // avoid compiler warning, but don't call deprecated insertChild() in QObject

    KService::Ptr nativeService();
    bool oldLoadAndParse( KoStore* store, const QString& filename, KoXmlDocument& doc );
    bool loadNativeFormatFromStore( const QString& file );
    bool loadNativeFormatFromStoreInternal( KoStore * store );

    bool savePreview( KoStore* store );
    bool saveOasisPreview( KoStore* store, KoXmlWriter* manifestWriter );
    class Private;
    Private *d;
    KService::Ptr m_nativeService;
    bool m_bEmpty;
    static Q3PtrList<KoDocument> *s_documentList;
    static const int s_defaultAutoSave;
};

#endif

---