KateGlobal One instance of this class is hold alive during a kate part session, as long as any factory, document or view stay around, here is the place to put things which are needed and shared by all this objects ;) More...

#include <kateglobal.h>

Inheritance diagram for KateGlobal:

[legend]

List of all members.

Public Member Functions
	~KateGlobal ()
const KAboutData *	aboutData () const
KateCmd *	cmdManager ()
QStringList	commandList () const
QList< KTextEditor::Command * >	commands () const
const KComponentData &	componentData ()
void	configDialog (QWidget *parent)
bool	configDialogSupported () const
KTextEditor::ConfigPage *	configPage (int number, QWidget *parent)
QString	configPageFullName (int number) const
KIcon	configPageIcon (int number) const
QString	configPageName (int number) const
int	configPages () const
QObject *	container ()
KTextEditor::Document *	createDocument (QObject *parent)
void	deregisterDocument (KateDocument *doc)
void	deregisterView (KateView *view)
KDirWatch *	dirWatch ()
KateDocumentConfig *	documentConfig ()
const QList < KTextEditor::Document * > &	documents ()
KateHlManager *	hlManager ()
QList< KateDocument * > &	kateDocuments ()
KateModeManager *	modeManager ()
KatePartPluginManager *	pluginManager ()
KTextEditor::Command *	queryCommand (const QString &cmd) const
void	readConfig (KConfig *config=0)
bool	registerCommand (KTextEditor::Command *cmd)
void	registerDocument (KateDocument *doc)
KTextEditor::TemplateScript *	registerTemplateScript (QObject *owner, const QString &script)
void	registerView (KateView *view)
KateRendererConfig *	rendererConfig ()
KateSchemaManager *	schemaManager ()
KateScriptManager *	scriptManager ()
void	setContainer (QObject *container)
KateSpellCheckManager *	spellCheckManager ()
bool	unregisterCommand (KTextEditor::Command *cmd)
void	unregisterTemplateScript (KTextEditor::TemplateScript *templateScript)
KateViewConfig *	viewConfig ()
QList< KateView * > &	views ()
KateViGlobal *	viInputModeGlobal ()
KateWordCompletionModel *	wordCompletionModel ()
void	writeConfig (KConfig *config=0)
Static Public Member Functions
static void	decRef ()
static void	incRef ()
static QString	katePartVersion ()
static KateGlobal *	self ()

Detailed Description

KateGlobal One instance of this class is hold alive during a kate part session, as long as any factory, document or view stay around, here is the place to put things which are needed and shared by all this objects ;)

Definition at line 67 of file kateglobal.h.

Constructor & Destructor Documentation

KateGlobal::~KateGlobal ( )

Destructor.

Definition at line 188 of file kateglobal.cpp.

Member Function Documentation

const KAboutData* KateGlobal::aboutData ( ) const [inline, virtual]

General Information about this editor.

return the about data

Returns:: about data of this editor part

Implements KTextEditor::Editor.

Definition at line 110 of file kateglobal.h.

KateCmd* KateGlobal::cmdManager ( ) [inline]

command manager

Returns:: command manager

Definition at line 290 of file kateglobal.h.

QStringList KateGlobal::commandList ( ) const [virtual]

Get a list of available commandline strings.

Returns:: commandline strings

Implements KTextEditor::CommandInterface.

Definition at line 487 of file kateglobal.cpp.

QList< KTextEditor::Command * > KateGlobal::commands ( ) const [virtual]

Get a list of all registered commands.

Returns:: list of all commands

Implements KTextEditor::CommandInterface.

Definition at line 484 of file kateglobal.cpp.

const KComponentData& KateGlobal::componentData ( ) [inline]

public accessor to the instance

Returns:: instance

Definition at line 192 of file kateglobal.h.

void KateGlobal::configDialog ( QWidget * parent ) [virtual]

Shows a config dialog for the part, changes will be applied to the editor, but not saved anywhere automagically, call writeConfig to save them.

Implements KTextEditor::Editor.

Definition at line 279 of file kateglobal.cpp.

bool KateGlobal::configDialogSupported ( ) const [virtual]

Does this editor support a config dialog.

Returns:: does this editor have a config dialog?

Implements KTextEditor::Editor.

Definition at line 274 of file kateglobal.cpp.

KTextEditor::ConfigPage * KateGlobal::configPage	(	int	number,
		QWidget *	parent
	)		`[virtual]`

returns config page with the given number, config pages from 0 to configPages()-1 are available if configPages() > 0

Implements KTextEditor::Editor.

Definition at line 335 of file kateglobal.cpp.

QString KateGlobal::configPageFullName ( int number ) const [virtual]

Implements KTextEditor::Editor.

Definition at line 387 of file kateglobal.cpp.

KIcon KateGlobal::configPageIcon ( int number ) const [virtual]

Implements KTextEditor::Editor.

Definition at line 413 of file kateglobal.cpp.

QString KateGlobal::configPageName ( int number ) const [virtual]

Implements KTextEditor::Editor.

Definition at line 361 of file kateglobal.cpp.

int KateGlobal::configPages ( ) const [virtual]

Number of available config pages If the editor returns a number < 1, it doesn't support this and the embedding app should use the configDialog () instead.

Returns:: number of config pages

Implements KTextEditor::Editor.

Definition at line 330 of file kateglobal.cpp.

QObject * KateGlobal::container ( ) [virtual]

Get the currently associated Container object.

Returns:: container object

Implements KTextEditor::ContainerInterface.

Definition at line 493 of file kateglobal.cpp.

KTextEditor::Document * KateGlobal::createDocument ( QObject * parent ) [virtual]

Create a new document object.

Parameters:

parent parent object

Returns:: created KTextEditor::Document

Implements KTextEditor::Editor.

Definition at line 219 of file kateglobal.cpp.

static void KateGlobal::decRef ( ) [inline, static]

decrement reference counter

Definition at line 180 of file kateglobal.h.

void KateGlobal::deregisterDocument ( KateDocument * doc )

unregister document at the factory

Parameters:

doc	document to register

Definition at line 455 of file kateglobal.cpp.

void KateGlobal::deregisterView ( KateView * view )

unregister view at the factory

Parameters:

view	view to unregister

Definition at line 468 of file kateglobal.cpp.

KDirWatch* KateGlobal::dirWatch ( ) [inline]

global dirwatch

Returns:: dirwatch instance

Definition at line 242 of file kateglobal.h.

KateDocumentConfig* KateGlobal::documentConfig ( ) [inline]

fallback document config

Returns:: default config for all documents

Definition at line 261 of file kateglobal.h.

const QList< KTextEditor::Document * > & KateGlobal::documents ( ) [virtual]

Returns a list of all documents of this editor.

Returns:: list of all existing documents

Implements KTextEditor::Editor.

Definition at line 228 of file kateglobal.cpp.

KateHlManager* KateGlobal::hlManager ( ) [inline]

hl manager

Returns:: hl manager

Definition at line 284 of file kateglobal.h.

static void KateGlobal::incRef ( ) [inline, static]

increment reference counter

Definition at line 175 of file kateglobal.h.

QList<KateDocument*>& KateGlobal::kateDocuments ( ) [inline]

return a list of all registered docs

Returns:: all known documents

Definition at line 224 of file kateglobal.h.

QString KateGlobal::katePartVersion ( ) [static]

Returns the current version of Kate Part: KDE X.Y.Z contains Kate Part X-1.Y.

Returns:: version of type x.y, e.g. 3.2

Definition at line 57 of file kateglobal.cpp.

KateModeManager* KateGlobal::modeManager ( ) [inline]

global mode manager used to manage the modes centrally

Returns:: mode manager

Definition at line 249 of file kateglobal.h.

KatePartPluginManager* KateGlobal::pluginManager ( ) [inline]

global plugin manager

Returns:: kate part plugin manager

Definition at line 236 of file kateglobal.h.

KTextEditor::Command * KateGlobal::queryCommand ( const QString & cmd ) const [virtual]

query for command

Parameters:

cmd	name of command to query for

Returns:: found command or 0

Implements KTextEditor::CommandInterface.

Definition at line 481 of file kateglobal.cpp.

void KateGlobal::readConfig ( KConfig * config = 0 ) [virtual]

Configuration management.

Read editor configuration from given config object

Parameters:

config config object

Implements KTextEditor::Editor.

Definition at line 234 of file kateglobal.cpp.

bool KateGlobal::registerCommand ( KTextEditor::Command * cmd ) [virtual]

register given command this works global, for all documents

Parameters:

cmd	command to register

Returns:: success

Implements KTextEditor::CommandInterface.

Definition at line 475 of file kateglobal.cpp.

void KateGlobal::registerDocument ( KateDocument * doc )

register document at the factory this allows us to loop over all docs for example on config changes

Parameters:

doc	document to register

Definition at line 448 of file kateglobal.cpp.

KTextEditor::TemplateScript * KateGlobal::registerTemplateScript	(	QObject *	owner,
		const QString &	script
	)		`[virtual]`

TemplateScriptRegistrar interface.

Implements KTextEditor::TemplateScriptRegistrar.

Definition at line 502 of file kateglobal.cpp.

void KateGlobal::registerView ( KateView * view )

register view at the factory this allows us to loop over all views for example on config changes

Parameters:

view	view to register

Definition at line 462 of file kateglobal.cpp.

KateRendererConfig* KateGlobal::rendererConfig ( ) [inline]

fallback renderer config

Returns:: default config for all renderers

Definition at line 273 of file kateglobal.h.

KateSchemaManager* KateGlobal::schemaManager ( ) [inline]

manager for the katepart schemas

Returns:: schema manager

Definition at line 255 of file kateglobal.h.

KateScriptManager* KateGlobal::scriptManager ( ) [inline]

Global script collection.

Definition at line 278 of file kateglobal.h.

KateGlobal * KateGlobal::self ( ) [static]

Kate Part Internal stuff ;)

singleton accessor

Returns:: instance of the factory

Definition at line 439 of file kateglobal.cpp.

void KateGlobal::setContainer ( QObject * container ) [virtual]

Set the associated container object.

Implements KTextEditor::ContainerInterface.

Definition at line 496 of file kateglobal.cpp.

KateSpellCheckManager* KateGlobal::spellCheckManager ( ) [inline]

spell check manager

Returns:: spell check manager

Definition at line 302 of file kateglobal.h.

bool KateGlobal::unregisterCommand ( KTextEditor::Command * cmd ) [virtual]

unregister given command this works global, for all documents

Parameters:

cmd	command to unregister

Returns:: success

Implements KTextEditor::CommandInterface.

Definition at line 478 of file kateglobal.cpp.

void KateGlobal::unregisterTemplateScript ( KTextEditor::TemplateScript * templateScript ) [virtual]

Implements KTextEditor::TemplateScriptRegistrar.

Definition at line 507 of file kateglobal.cpp.

KateViewConfig* KateGlobal::viewConfig ( ) [inline]

fallback view config

Returns:: default config for all views

Definition at line 267 of file kateglobal.h.

QList<KateView*>& KateGlobal::views ( ) [inline]

return a list of all registered views

Returns:: all known views

Definition at line 230 of file kateglobal.h.

KateViGlobal* KateGlobal::viInputModeGlobal ( ) [inline]

vi input mode global

Returns:: vi input mode global

Definition at line 296 of file kateglobal.h.

KateWordCompletionModel* KateGlobal::wordCompletionModel ( ) [inline]

global instance of the simple word completion mode

Returns:: global instance of the simple word completion mode

Definition at line 308 of file kateglobal.h.

void KateGlobal::writeConfig ( KConfig * config = 0 ) [virtual]

Write editor configuration to given config object.

Parameters:

config config object

Implements KTextEditor::Editor.

Definition at line 250 of file kateglobal.cpp.

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

Kate

KateGlobal Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Kate

kdelibs