#include <plugin.h>

Inheritance diagram for Kate::PluginView:

Public Member Functions
	PluginView (MainWindow *mainWindow)

virtual	~PluginView ()

MainWindow *	mainWindow () const

virtual void	readSessionConfig (KConfigBase *config, const QString &groupPrefix)

virtual void	writeSessionConfig (KConfigBase *config, const QString &groupPrefix)

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 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 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

PluginView interface.

Topics:

Introduction

The class PluginView is a interface for the view of a plugin.

Plugin Views

The Kate application supports multiple mainwindows (Window > New Window). For every Kate MainWindow Plugin::createView() is called, i.e. overwrite createView() in your Plugin derived class and hook your view into the given mainwindow's KXMLGUIFactory. That means you have to create an own KXMLGUIClient derived PluginView class and create an own instance for every mainwindow. One PluginView then is bound to this specific MainWindow.

As already mentioned in the Plugin class documentation, readSessionConfig() and writeSessionConfig() are called to load and save session related data.

Basic PluginView Example

A PluginView is bound to a single MainWindow. To add GUI elements KDE's GUI XML frameworks is used, i.e. the MainWindow provides a KXMLGUIFactory into which the KXMLGUIClient is to be hooked. So the plugin view must inherit from Kate::XMLGUIClient, the following example shows the basic skeleton of the PluginView.

class PluginView : public QObject, public Kate::XMLGUIClient
{
    Q_OBJECT
public:
    // Constructor and other methods
    PluginView( Kate::MainWindow* mainwindow )
      : QObject( mainwindow )
      , Kate::XMLGUIClient( YourPluginFactory::componentData() )
      , m_mainwindow( mainwindow )
    { ... }
    // ...
private:
    Kate::MainWindow* m_mainwindow;
};

To embedd a plugin view as a tool view you have to call MainWindow::createToolView() and hook your gui into the returned widget.

See also: Plugin, XMLGUIClient, KXMLGUIClient, MainWindow

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

Definition at line 243 of file plugin.h.

Constructor & Destructor Documentation

Kate::PluginView::PluginView ( MainWindow * mainWindow )

Constructor.

Definition at line 97 of file plugin.cpp.

Kate::PluginView::~PluginView ( )

virtual

Virtual destructor.

Definition at line 104 of file plugin.cpp.

Member Function Documentation

MainWindow * Kate::PluginView::mainWindow ( ) const

Accessor to the Kate mainwindow of this view.

Returns: the mainwindow object

Definition at line 109 of file plugin.cpp.

void Kate::PluginView::readSessionConfig	(	KConfigBase *	config,
		const QString &	groupPrefix
	)

virtual

Load session specific settings here.

This function is called whenever a Kate session is loaded. You should use the given config and prefix groupPrefix to store the data. The group prefix exist so that the group does not clash with other applications that use the same config file.

Parameters

config	the KConfig object which is to be used
groupPrefix	the group prefix which is to be used

See also: writeSessionConfig()

Definition at line 114 of file plugin.cpp.

void Kate::PluginView::writeSessionConfig	(	KConfigBase *	config,
		const QString &	groupPrefix
	)

virtual

Store session specific settings here.

This function is called whenever a Kate session is saved. You should use the given config and prefix groupPrefix to store the data. The group prefix exists so that the group does not clash with other applications that use the same config file.

Parameters

config	the KConfig object which is to be used
groupPrefix	the group prefix which is to be used

See also: readSessionConfig()

Definition at line 117 of file plugin.cpp.

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

kate/kate/interfaces/kate

Public Member Functions

Additional Inherited Members

Detailed Description

Introduction

Plugin Views

Basic PluginView Example

Constructor & Destructor Documentation

Member Function Documentation

kate/kate/interfaces/kate

applications API Reference

Search