document.h

/***************************************************************************
 *   Copyright (C) 2005 by David Saxton                                    *
 *   david@bluehaze.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 DOCUMENT_H
#define DOCUMENT_H

#include <kurl.h>
#include <qguardedptr.h>

class DCOPObject;
class Document;
class DocumentIface;
class KTechlab;
class View;
class ViewContainer;

typedef QValueList<QGuardedPtr<View> > ViewList;

class Document : public QObject
{
Q_OBJECT
public:
        enum DocumentType
        {
                dt_none, // Used to denote document type not known / specified / etc, when appropriate
                dt_flowcode,
                dt_circuit,
                dt_mechanics,
                dt_text,
                dt_pinMapEditor
        };
        Document( const QString &caption, KTechlab *ktechlab, const char *name = 0 );
        virtual ~Document();
        void setAddToProjectOnSave( bool add ) { m_bAddToProjectOnSave = add; }
        QString caption() const { return m_caption; }
        void setCaption( const QString &caption );
        DCOPObject * dcopObject() const;
        unsigned dcopID() const { return m_dcopID; }
        void setDCOPID( unsigned id );
        View *activeView() const { return p_activeView; }
        ViewList viewList() const { return m_viewList; }
        DocumentType type() const { return m_type; }
        uint numberOfViews() const { return m_viewList.size(); }
        virtual View *createView( ViewContainer *viewContainer, uint viewAreaId, const char *name = 0 ) = 0;
        const KURL& url() const { return m_url; }
        bool getURL( const QString &types );
        virtual bool openURL( const KURL &url ) = 0;
        void setURL( const KURL &url );
        virtual void setModified( bool modified );
        virtual bool isModified() const { return b_modified; }
        virtual bool isUndoAvailable() const { return false; }
        virtual bool isRedoAvailable() const { return false; }
        virtual void fileSaveAs() = 0;
        virtual bool fileClose();
        virtual void fileSave() = 0;
        virtual void print() {};
        virtual void cut() {};
        virtual void copy() {};
        virtual void paste() {};
        virtual void undo() {};
        virtual void redo() {};
        virtual void selectAll() {};

        virtual void convertToMicrobe() {};
        virtual void convertToHex() {};
        virtual void convertToPIC() {};
        virtual void convertToAssembly() {};
        virtual void debugRun() {};
        virtual void debugInterrupt() {};
        virtual void debugStop() {};
        virtual void debugStep() {};
        KTechlab *ktechlab() const { return p_ktechlab; }
        bool isDeleted() const { return m_bDeleted; }

protected slots:
        virtual void slotUpdateConfiguration() {};
        
#define protected public
signals:
        void undoRedoStateChanged();
#undef protected
        
signals:
        void modifiedStateChanged();
        void fileNameChanged( const KURL &url );
        
        void viewFocused( View *view );
        void viewUnfocused();
        
private slots:
        void slotViewDestroyed( QObject *obj );
        void slotViewFocused( View *view );
        
protected:
        virtual void handleNewView( View *view );
        
        bool b_modified;
        KTechlab *p_ktechlab;
        QGuardedPtr<View> p_activeView;
        DocumentType m_type;
        ViewList m_viewList;
        QString m_caption;
        bool m_bAddToProjectOnSave;
        DocumentIface * m_pDocumentIface;
        unsigned m_dcopID;
        unsigned m_nextViewID;
        
        // Set to true by the document et subclasses destructors, used to avoid
        // doing stuff that might lead to crash when being deleted.
        bool m_bDeleted; 
        
private:
        KURL m_url;
};

#endif

---