KParts::TextExtension Class Reference

#include <textextension.h>

Inheritance diagram for KParts::TextExtension:

Public Types
enum	Format { PlainText, HTML }

Signals
void	selectionChanged ()

Public Member Functions
	TextExtension (KParts::ReadOnlyPart *parent)
	~TextExtension ()
virtual QString	completeText (Format format) const
virtual int	currentPage () const
virtual bool	findText (const QString &string, KFind::SearchOptions options) const
virtual bool	hasSelection () const
virtual int	pageCount () const
virtual QString	pageText (Format format) const
virtual QString	selectedText (Format format) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static TextExtension *	childObject (QObject *obj)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

an extension for KParts that allows to retrieve text from the part.

For instance, the text-to-speech plugin uses this to speak the whole text from the part or the selected text. The translation plugin uses it for translating the selected text, and so on.

Since

4.6

Definition at line 42 of file textextension.h.

Member Enumeration Documentation

enum KParts::TextExtension::Format

Enumerator
PlainText
HTML

Definition at line 55 of file textextension.h.

Constructor & Destructor Documentation

KParts::TextExtension::TextExtension

(

KParts::ReadOnlyPart *

parent

)

Definition at line 24 of file textextension.cpp.

KParts::TextExtension::~TextExtension

(

)

Definition at line 29 of file textextension.cpp.

Member Function Documentation

KParts::TextExtension * KParts::TextExtension::childObject ( QObject *  obj )

static

Queries obj for a child object which inherits from this TextExtension class.

Definition at line 48 of file textextension.cpp.

QString KParts::TextExtension::completeText ( Format  format ) const

virtual

Returns the complete text shown in the part, in the requested format.

If the format is not supported, the part must return an empty string.

Definition at line 43 of file textextension.cpp.

int KParts::TextExtension::currentPage ( ) const

virtual

Returns the current page (between 0 and pageCount()-1), for parts who support the concept of pages.

Otherwise returns 0.

Definition at line 58 of file textextension.cpp.

bool KParts::TextExtension::findText ( const QString &  string, KFind::SearchOptions  options  ) const

virtual

Returns true if string is found using the given options.

If any text matches string, then it will be selected/highlighted. To find the next matching text, simply call this function again with the same search text until it returns false.

To clear a selection, just pass an empty string.

Note that parts that implement this extension might not support all the options available in KFind::SearchOptions.

Definition at line 68 of file textextension.cpp.

bool KParts::TextExtension::hasSelection ( ) const

virtual

Returns true if the user selected text in the part.

Definition at line 33 of file textextension.cpp.

int KParts::TextExtension::pageCount ( ) const

virtual

Returns the number of pages, for parts who support the concept of pages.

Otherwise returns 0.

Definition at line 53 of file textextension.cpp.

QString KParts::TextExtension::pageText ( Format  format ) const

virtual

Returns the text in a given page, in the requested format.

Definition at line 63 of file textextension.cpp.

QString KParts::TextExtension::selectedText ( Format  format ) const

virtual

Returns the selected text, in the requested format.

If the format is not supported, the part must return an empty string.

Definition at line 38 of file textextension.cpp.

void KParts::TextExtension::selectionChanged ( )

signal

This signal is emitted when the selection changes.

---

The documentation for this class was generated from the following files:

• textextension.h
• textextension.cpp