KoDocument.h

/* 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;
namespace std { }
using namespace std;
#include <tqwmatrix.h>
 
#include <tdeparts/part.h>
#include <kurl.h>
#include <kservice.h>
#include <KoGlobal.h>
#include <KoUnit.h>
#include <KoPageLayout.h>
#include <koffice_export.h>
 
class TQDomElement;
class TQDomDocument;
class TQXmlSimpleReader;
 
class KoStore;
class KoMainWindow;
 
class KoChild;
class KoDocumentChild;
class KoView;
class KoDocumentInfo;
class DCOPObject;
class KoOasisStyles;
class KoXmlWriter;
class KoOpenPane;

class KOFFICECORE_EXPORT KoDocument : public KParts::ReadWritePart
{
    TQ_OBJECT
  
    TQ_PROPERTY( TQCString dcopObjectId READ dcopObjectId)
    TQ_PROPERTY( bool backupFile READ backupFile WRITE setBackupFile )
 
public:

    KoDocument( TQWidget* parentWidget,
                const char* widgetName,
                TQObject* parent,
                const char* name,
                bool singleViewMode = false );

    virtual ~KoDocument();

    bool isSingleViewMode() const;

    bool isEmbedded() const;

    virtual TDEAction *action( const TQDomElement &element ) const;

    virtual TQDomDocument 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 TQCString readNativeFormatMimeType( TDEInstance *instance = 0 );

    static TQStringList readExtraNativeMimeTypes( TDEInstance *instance = 0 );

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

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

    virtual TQCString nativeFormatMimeType() const;

    TQCString nativeOasisMimeType() const;

    bool isNativeFormat( const TQCString& mimetype ) const;

    virtual TQStringList extraNativeMimeTypes() const;

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

    virtual int supportedSpecialFormats() const;

    TQCString mimeType() const;

    void setMimeType( const TQCString & mimeType );

    void setOutputMimeType( const TQCString & mimeType, int specialOutputFlag = 0 );
    TQCString 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 TQString& errMsg );

    TQString errorMessage() const;

    void showSavingErrorDialog();

    void showLoadingErrorDialog();

    KoView *createView( TQWidget *parent = 0, const char *name = 0 );

    virtual void addView( KoView *view );

    virtual void removeView( KoView *view );

    const TQPtrList<KoView> & views() const;

    int viewCount() const;

    virtual KParts::Part *hitTest( TQWidget *widget, const TQPoint &globalPos );

    virtual KoDocument *hitTest( const TQPoint &pos, const TQWMatrix& matrix = TQWMatrix() );
    KoView* hitTestView();

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

    virtual TQPixmap generatePreview( const TQSize& size );

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

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

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

    bool checkAutoSaveFile();

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

    virtual bool initDoc(InitDocFlags flags, TQWidget* parentWidget=0) = 0;

    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 TQString& url );

    virtual bool loadOasisFromStore( KoStore* store );

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

    virtual bool loadXML( TQIODevice *, const TQDomDocument & doc ) = 0;

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

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

    virtual TQDomDocument saveXML();

    TQDomDocument createDomDocument( const TQString& tagName, const TQString& version ) const;

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

    static TQDomDocument createDomDocument( const TQString& appName, const TQString& tagName, const TQString& version );

    static TQString tagNameToDocumentType( const TQString& localName );

    virtual bool saveToStream( TQIODevice * dev );

    virtual bool loadNativeFormat( const TQString & file );

    virtual bool saveNativeFormat( const TQString & 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 TQPtrList<KoDocumentChild>& children() const;

    KoDocumentChild *child( KoDocument *doc );

    KoDocumentInfo *documentInfo() const;
 
    void setViewBuildDocument( KoView *view, const TQDomDocument &doc );
    TQDomDocument viewBuildDocument( KoView *view );

    virtual void addShell( KoMainWindow *shell );

    virtual void removeShell( KoMainWindow *shell );

    const TQPtrList<KoMainWindow>& shells() const;

    int shellCount() const;

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

    virtual DCOPObject * dcopObject();

    TQCString 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 TQString & _path );

    TQString backupPath()const;

    void setCurrent( bool on = true );

    void forceCurrent( bool on );
    bool isCurrent() const;
 
    void setTitleModified( const TQString caption, bool mod );

    void resetURL() { m_url = KURL(); m_file = TQString(); }

    void setStoreInternal( bool i );

    bool storeInternal() const;
 
    bool hasExternURL() const;

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

    TQString &file() { return m_file; }

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

    void setMimeTypeAfterLoading( const TQString& mimeType );

    virtual int pageCount() const { return 1; }

    virtual TQValueList<KoTextDocument *> allTextDocuments() const;

    KoUnit::Unit unit() const;

    void setUnit( KoUnit::Unit u );

    TQString unitName() const;

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

    virtual bool showEmbedInitDialog(TQWidget* parent);
 
public slots:
    virtual void initEmpty();
 
signals:

    void unitChanged(KoUnit::Unit);

    void childChanged( KoDocumentChild *child );

    void sigProgress( int value );

    void sigStatusBarMessage( const TQString& text );

    void sigClearStatusBarMessage();
 
    void sigBeginOperation();
    void sigEndOperation();

    void modified( bool );
 
    void closeEmbedInitDialog();
 
protected slots:
    virtual void openExistingFile( const TQString& file );
    virtual void openTemplate( const TQString& file );
 
    void deleteOpenPaneDelayed();
 
protected:
 
    TQString autoSaveFile( const TQString & path ) const;
 
    virtual KoView *createViewInstance( TQWidget *parent, const char *name ) = 0;

    virtual bool openFile();

    virtual bool saveFile();

    virtual TQWidget* createCustomDocumentWidget(TQWidget *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(); }

    virtual void insertChild(TQObject *o) { TQObject::insertChild(o); }
 
    KoPageLayout m_pageLayout;

    virtual bool saveExternalChildren();

    bool isImporting() const;

    bool isExporting() const;

    KoOpenPane* createOpenPane( TQWidget* parent, TDEInstance* instance,
                                const TQString& templateType = TQString());
 
private slots:
    void slotChildChanged( KoChild *c );
    void slotChildDestroyed();
    void slotAutoSave();
    void slotStarted( TDEIO::Job* );
    void startCustomDocument();
    void deleteOpenPane();
 
private:
    KService::Ptr nativeService();
    bool oldLoadAndParse( KoStore* store, const TQString& filename, TQDomDocument& doc );
    bool loadNativeFormatFromStore( const TQString& file );
    bool savePreview( KoStore* store );
    bool saveOasisPreview( KoStore* store, KoXmlWriter* manifestWriter );
    class Private;
    Private *d;
    KService::Ptr m_nativeService;
    bool m_bEmpty;
    static TQPtrList<KoDocument> *s_documentList;
    static const int s_defaultAutoSave;
};
 
#endif