1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
/* This file is part of the KDE project
Copyright (C) 2008 Thorsten Zachmann <zachmann@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 KOFRAMESHAPE_H
#define KOFRAMESHAPE_H
#include "flake_export.h"
#include "KoXmlReaderForward.h"
class KoShapeLoadingContext;
/**
* @brief Base class for shapes that are saved as a part of a draw:frame.
*
* Shapes like the TextShape or the PictureShape are implementing this
* class to deal with frames and their attributes.
*
* What follows is a sample taken out of an ODT-file that shows how this works
* together;
* @code
* <draw:frame draw:style-name="fr1" text:anchor-type="paragraph" svg:x="0.6429in" svg:y="0.1409in" svg:width="4.7638in" svg:height="3.3335in">
* <draw:image xlink:href="Pictures/imagename.jpg" />
* </draw:frame>
* @endcode
*
* The loading code of the shape gets passed the draw:frame element. Out of this element the
* odf attributes can be loaded. Then it calls loadOdfFrame which loads the correct frame element
* the object supports. The loading of the frame element is done in the loadOdfFrameElement.
*
* @code
* bool PictureShape::loadOdf( const KoXmlElement & element, KoShapeLoadingContext &context )
* {
* loadOdfAttributes( element, context, OdfAllAttributes );
* return loadOdfFrame( element, context );
* }
* @endcode
*/
class FLAKE_EXPORT KoFrameShape
{
public:
/**
* Constructor.
*
* \param ns The namespace. E.g. KoXmlNS::draw
* \param element The tag-name. E.g. "image"
*/
KoFrameShape(const QString &ns, const QString &tag);
/**
* Destructor.
*/
virtual ~KoFrameShape();
/**
* Loads the content of the draw:frame element and it's children. This
* method calls the abstract loadOdfFrameElement() method.
*
* @return false if loading failed
*/
virtual bool loadOdfFrame(const KoXmlElement &element, KoShapeLoadingContext &context);
protected:
/**
* Abstract method to handle loading of the defined inner element like
* e.g. the draw:image element.
* @return false if loading failed
*/
virtual bool loadOdfFrameElement(const KoXmlElement &element, KoShapeLoadingContext &context) = 0;
private:
class Private;
Private * const d;
};
#endif /* KOFRAMESHAPE_H */
|