Kate Namespace Reference

Namespace for Kate application interfaces. More...

Classes
class	Application
	Central interface to the application. More...
class	DocumentManager
	Interface for the document manager. More...
class	MainWindow
	Interface to a mainwindow. More...
class	Plugin
	Kate plugin interface. More...
class	PluginConfigPage
	Plugin config page widget. More...
class	PluginConfigPageInterface
	Plugin config page extension interface. More...
class	PluginManager
	Interface to the plugin manager. More...
class	PluginView
	PluginView interface. More...
class	XMLGUIClient
	The KXMLGUIClient client for Kate application plugins. More...
Functions
Application *	application ()
Plugin *	createPlugin (const char *libname, Application *application=0, const QStringList &args=QStringList())
DocumentManager *	documentManager ()
PluginConfigPageInterface *	pluginConfigPageInterface (Plugin *plugin)

---

Detailed Description

Namespace for Kate application interfaces.

This namespace contains interfaces for plugin developers for the Kate application.

---

Function Documentation

KATEINTERFACES_EXPORT Application * Kate::application

(

)

Global accessor to the application object.

Always existing during lifetime of a plugin.

Returns:

application object

KATEINTERFACES_EXPORT Plugin * Kate::createPlugin	(	const char *	libname,
		Application *	application = 0,
		const QStringList &	args = QStringList()
	)

Helper function for the Kate application to create new plugins.

Parameters:

	libname	the plugin/library name
	application	the application
	args	arguments

Returns:

the plugin on success, otherwise NULL

KATEINTERFACES_EXPORT DocumentManager * Kate::documentManager

(

)

Global accessor to the document manager object.

Returns:

document manager object

KATEINTERFACES_EXPORT PluginConfigPageInterface * Kate::pluginConfigPageInterface

(

Plugin *

plugin

)

Helper function that returns the PluginConfigPageInterface of the plugin or NULL if the plugin does not support the interface.

Parameters:

plugin

the plugin for which the plugin config page interface should be returned

Returns:

the plugin config page interface or NULL if the plugin does not support the interface