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

Static Public Member Functions
static TextExtension *	childObject (QObject *obj)

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