#include <factory.h>

Inheritance diagram for KTextEditor::Factory:

Public Member Functions
	Factory (QObject *parent)

virtual	~Factory ()

virtual Editor *	editor ()=0

Public Member Functions inherited from KParts::Factory
	Factory (QObject *parent=0)

Part *	createPart (QWidget parentWidget=0, QObject parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())

virtual KComponentData	partComponentData ()

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

Additional Inherited Members
Static Public Member Functions inherited from KParts::Factory
static KComponentData	partComponentDataFromLibrary (const QString &libraryName)

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)

Protected Member Functions inherited from KParts::Factory
virtual QObject *	createObject (QObject parent=0, const char classname="QObject", const QStringList &args=QStringList())

virtual Part *	createPartObject (QWidget parentWidget=0, QObject parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())=0

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

Accessor to the Editor implementation.

Topics:

Introduction

The Factory provides access to the chosen Editor (selected with KTextEditor::EditorChooser). The Editor itself then provides methods to handle documents and config options.

To access the Editor use editor().

Each KTextEditor implementation must reimplement this factory to allow access to the editor object.

Creating an Editor Part

To get a kate part the following code snippet can be used:

KLibFactory* factory = KLibLoader::self()->factory("katepart");
KTextEditor::Factory* kte_factory =
    qobject_cast<KTextEditor::Factory*>(factory);
if(kte_factory) {
    // valid editor factory, it is possible to access the editor now
    KTextEditor::Editor* editor = kte_factory->editor();
} else {
    // error
}

If another editor part is desired substitue the string "katepart" with the corresponding library name.

However, if you are only interested in getting the editor part (which is usually the case) a simple call of

KTextEditor::Editor* editor = KTextEditor::editor("katepart");

is enough.

Notes

It is recommend to use the EditorChooser to get the used editor part. This way the user can choose the editor implementation. The Factory itself is not needed to get the Editor with the help of the EditorChooser.

See also: KParts::Factory, KTextEditor::Editor

Author: Christoph Cullmann <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

Definition at line 90 of file factory.h.

Constructor & Destructor Documentation

Factory::Factory ( QObject * parent )

Constructor.

Create a new Factory with parent.

Parameters

parent parent object

Definition at line 67 of file ktexteditor.cpp.

Factory::~Factory ( )

virtual

Virtual destructor.

Reimplemented from KParts::Factory.

Definition at line 73 of file ktexteditor.cpp.

Member Function Documentation

virtual Editor* KTextEditor::Factory::editor ( )

pure virtual

Get the global Editor object.

The editor part implementation must ensure that this object lives as long as any factory or document object exists.

Returns: global KTextEditor::Editor object

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

KTextEditor

Public Member Functions

Additional Inherited Members