vdocument.h

/* This file is part of the KDE project
   Copyright (C) 2001, The Karbon Developers
   Copyright (C) 2002, The Karbon Developers
 
   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 VDOCUMENT_H
#define VDOCUMENT_H
 
#include <KoUnit.h>
 
#include <tqstring.h>
#include <tqptrlist.h>
#include <tqptrdict.h>
 
#include "vobject.h"
 
#include "karbon_grid_data.h"
#include <koffice_export.h>
 
class TQDomDocument;
class TQDomElement;
class VSelection;
class VLayer;
class KoPageLayout;
 
typedef TQPtrList<VLayer> VLayerList;
typedef TQPtrListIterator<VLayer> VLayerListIterator;
 

 
class KARBONBASE_EXPORT VDocument : public VObject
{
public:
    enum VSelectionMode {
        ActiveLayer,    
        VisibleLayers,  
        SelectedLayers, 
        AllLayers       
    };

    VDocument();

    VDocument( const VDocument& document );

    virtual ~VDocument();
 
    virtual void draw( VPainter* painter, const KoRect* rect ) const;
    
    void drawPage( VPainter *painter, const KoPageLayout &pl, bool drawPageMargins ) const;

    double width() const { return m_width; }

    double height() const { return m_height; }

    void setWidth( double width ) { m_width = width; m_boundingBox.setWidth( width ); }

    void setHeight( double height ) { m_height = height; m_boundingBox.setHeight( height ); }

    KoUnit::Unit unit() const
        { return m_unit; }

    void setUnit( KoUnit::Unit unit )
        { m_unit = unit; }

    bool canRaiseLayer( VLayer* layer );

    bool canLowerLayer( VLayer* layer );

    void raiseLayer( VLayer* layer );

    void lowerLayer( VLayer* layer );

    int layerPos( VLayer* layer );

    void insertLayer( VLayer* layer );

    void removeLayer( VLayer* layer );

    void setActiveLayer( VLayer* layer );

    VLayer* activeLayer() const { return m_activeLayer; }

    const VLayerList& layers() const { return m_layers; }
 
    TQDomDocument saveXML() const;
    virtual void saveOasis( KoStore *store, KoXmlWriter *docWriter, KoGenStyles &mainStyles ) const;
    enum { STYLE_GRAPHICAUTO = 20, STYLE_LINEAR_GRADIENT, STYLE_RADIAL_GRADIENT, STYLE_STROKE };
    bool loadXML( const TQDomElement& doc );
    virtual bool loadOasis( const TQDomElement &element, KoOasisLoadingContext &context );
    virtual void save( TQDomElement& element ) const;
    virtual void load( const TQDomElement& element );
    void loadDocumentContent( const TQDomElement& doc );
 
    virtual VDocument* clone() const;
 
    virtual void accept( VVisitor& visitor );
 

    VSelection* selection() const
        { return m_selection; }

    VSelectionMode selectionMode() { return m_selectionMode; }

    void setSelectionMode( VSelectionMode mode ) { m_selectionMode = mode; }

    void append( VObject* object );

    TQString objectName( const VObject *obj ) const;

    void setObjectName( const VObject *obj, const TQString name ) { m_objectNames.insert( obj, name ); }
 
    bool saveAsPath() const { return m_saveAsPath; }
    void saveAsPath( bool b ) { m_saveAsPath = b; }

    KarbonGridData &grid() { return m_gridData; }
 
private:
    double m_width;

    double m_height;
 

    VLayerList m_layers;
    VLayer* m_activeLayer;

    VSelection* m_selection;
    VSelectionMode m_selectionMode;

    KoUnit::Unit m_unit;
 
    TQMap<const VObject *, TQString>    m_objectNames;
 
    // TODO this flag is used nowhere, can we remove it?
    bool m_saveAsPath;
 
    KarbonGridData m_gridData;
};
 
#endif