• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KParts

  • kparts
textextension.h
Go to the documentation of this file.
1/* This file is part of the KDE project
2 Copyright (C) 2010 David Faure <faure@kde.org>
3
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version.
8
9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 Boston, MA 02110-1301, USA.
18 */
19
20#ifndef KPARTS_TEXTEXTENSION_H
21#define KPARTS_TEXTEXTENSION_H
22
23#include <QtCore/QObject>
24#include <kparts/kparts_export.h>
25#include <kfind.h>
26
27namespace KParts
28{
29
30class ReadOnlyPart;
31class TextExtensionPrivate;
32
42class KPARTS_EXPORT TextExtension : public QObject
43{
44 Q_OBJECT
45public:
46 TextExtension(KParts::ReadOnlyPart* parent);
47 ~TextExtension();
48
53 static TextExtension *childObject( QObject *obj );
54
55 enum Format { PlainText, HTML };
56
60 virtual bool hasSelection() const;
65 virtual QString selectedText(Format format) const;
70 virtual QString completeText(Format format) const;
71
72
77 virtual int pageCount() const;
83 virtual int currentPage() const;
87 virtual QString pageText(Format format) const;
88
101 virtual bool findText(const QString& string, KFind::SearchOptions options) const;
102
103 // for future extensions can be made via slots
104
105Q_SIGNALS:
109 void selectionChanged();
110
111private:
112 // for future extensions
113 TextExtensionPrivate* const d;
114};
115
116}
117
118#endif /* KPARTS_TEXTEXTENSION_H */
KParts::ReadOnlyPart
Base class for any "viewer" part.
Definition: part.h:489
KParts::TextExtension
an extension for KParts that allows to retrieve text from the part.
Definition: textextension.h:43
KParts::TextExtension::selectionChanged
void selectionChanged()
This signal is emitted when the selection changes.
KParts::TextExtension::Format
Format
Definition: textextension.h:55
QObject
kfind.h
kparts_export.h
KParts
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KParts

Skip menu "KParts"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal