libs/text/KoTextLocator.h

0001 /* This file is part of the KDE project
0002  * Copyright (C) 2007 Thomas Zander <zander@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 #ifndef KOTEXTLOCATOR_H
0020 #define KOTEXTLOCATOR_H
0021
0022 #include "KoInlineObject.h"
0023 #include "kotext_export.h"
0024
0025 class KoTextReference;
0026
0027 /**
0028  * This inline object can be inserted in text to mark it and to later get location information from.
0029  * After inserting this locator you can request things like pageNumber() and chapter() for the
0030  * place where the locator has been positioned in the document.
0031  */
0032 class KOTEXT_EXPORT KoTextLocator : public KoInlineObject
0033 {
0034     Q_OBJECT
0035 public:
0036     /// constructor
0037     KoTextLocator();
0038     ~KoTextLocator() override;
0039
0040     /// reimplemented from super
0041     void updatePosition(const QTextDocument *document,
0042                                 int posInDocument, const QTextCharFormat &format) override;
0043     /// reimplemented from super
0044     void resize(const QTextDocument *document, QTextInlineObject &object,
0045                         int posInDocument, const QTextCharFormat &format, QPaintDevice *pd) override;
0046     /// reimplemented from super
0047     void paint(QPainter &painter, QPaintDevice *pd, const QTextDocument *document,
0048                        const QRectF &rect, const QTextInlineObject &object, int posInDocument, const QTextCharFormat &format) override;
0049
0050     /// returns the text of the paragraph that is the first chapter before the index.
0051     QString chapter() const;
0052     /// return the page number on which the locator is placed.
0053     int pageNumber() const;
0054     /// return the position in the text document at which the locator is inserted.
0055     int indexPosition() const;
0056     /// return the word in which the locator is inserted.
0057     QString word() const;
0058
0059     /// Add a text reference that is interested in knowing when this locator is laid-out in a different position.
0060     void addListener(KoTextReference *reference);
0061     /// Remove a reference from the listeners.
0062     void removeListener(KoTextReference *reference);
0063
0064     bool loadOdf(const KoXmlElement &element, KoShapeLoadingContext &context) override;
0065     void saveOdf(KoShapeSavingContext &context) override;
0066
0067 private:
0068     class Private;
0069     Private * const d;
0070 };
0071
0072 #endif