libs/flake/KoMarker.h

0001 /* This file is part of the KDE project
0002    Copyright (C) 2011 Thorsten Zachmann <zachmann@kde.org>
0003
0004    This library is free software; you can redistribute it and/or
0005    modify it under the terms of the GNU Library General Public
0006    License as published by the Free Software Foundation; either
0007    version 2 of the License, or (at your option) any later version.
0008
0009    This library is distributed in the hope that it will be useful,
0010    but WITHOUT ANY WARRANTY; without even the implied warranty of
0011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012    Library General Public License for more details.
0013
0014    You should have received a copy of the GNU Library General Public License
0015    along with this library; see the file COPYING.LIB.  If not, write to
0016    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018 */
0019
0020 #ifndef KOMARKER_H
0021 #define KOMARKER_H
0022
0023 #include <QMetaType>
0024 #include <QSharedData>
0025
0026 #include "flake_export.h"
0027
0028 class KoXmlElement;
0029 class KoShapeLoadingContext;
0030 class KoShapeSavingContext;
0031 class QString;
0032 class QPainterPath;
0033
0034 class  FLAKE_EXPORT KoMarker : public QSharedData
0035 {
0036 public:
0037     KoMarker();
0038     ~KoMarker();
0039
0040     /**
0041      * Load the marker
0042      *
0043      * @param element The xml element containing the marker
0044      * @param context The shape loading context
0045      */
0046     bool loadOdf(const KoXmlElement &element, KoShapeLoadingContext &context);
0047
0048     /**
0049      * Save the marker
0050      *
0051      * @return The reference of the marker.
0052      */
0053     QString saveOdf(KoShapeSavingContext &context) const;
0054
0055     /**
0056      * Display name of the marker
0057      *
0058      * @return Display name of the marker
0059      */
0060     QString name() const;
0061
0062     /**
0063      * Get the path of the marker
0064      *
0065      * It calculates the offset depending on the line width
0066      *
0067      * @param The width of the line the marker is attached to.
0068      * @return the path of the marker
0069      */
0070     QPainterPath path(qreal width) const;
0071
0072     bool operator==(const KoMarker &other) const;
0073
0074 private:
0075     class Private;
0076     Private * const d;
0077 };
0078
0079 Q_DECLARE_METATYPE(KoMarker*)
0080
0081 #endif /* KOMARKER_H */