KateGlobal Class Reference

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
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)
void	registerView (KateView *view)
KateRendererConfig *	rendererConfig ()
KateSchemaManager *	schemaManager ()
KateScriptManager *	scriptManager ()
void	setContainer (QObject *container)
bool	unregisterCommand (KTextEditor::Command *cmd)
KateViewConfig *	viewConfig ()
QList< KateView * > &	views ()
KateViGlobal *	viInputModeGlobal ()
void	writeConfig (KConfig *config=0)
	~KateGlobal ()
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 59 of file kateglobal.h.

---

Constructor & Destructor Documentation

KateGlobal::~KateGlobal

(

)

Destructor.

Definition at line 171 of file kateglobal.cpp.

---

Member Function Documentation

const KAboutData* KateGlobal::aboutData

(

)

const [inline]

General Information about this editor.

return the about data

Returns:

about data of this editor part

Definition at line 98 of file kateglobal.h.

KateCmd* KateGlobal::cmdManager

(

)

[inline]

command manager

Returns:

command manager

Definition at line 278 of file kateglobal.h.

QStringList KateGlobal::commandList

(

)

const

Get a list of available commandline strings.

Returns:

commandline strings

Definition at line 453 of file kateglobal.cpp.

QList< KTextEditor::Command * > KateGlobal::commands

(

)

const

Get a list of all registered commands.

Returns:

list of all commands

Definition at line 450 of file kateglobal.cpp.

const KComponentData& KateGlobal::componentData

(

)

[inline]

public accessor to the instance

Returns:

instance

Definition at line 180 of file kateglobal.h.

void KateGlobal::configDialog

(

QWidget *

parent

)

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

Definition at line 247 of file kateglobal.cpp.

bool KateGlobal::configDialogSupported

(

)

const

Does this editor support a config dialog.

Returns:

does this editor have a config dialog?

Definition at line 242 of file kateglobal.cpp.

KTextEditor::ConfigPage * KateGlobal::configPage	(	int	number,
		QWidget *	parent
	)

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

Definition at line 301 of file kateglobal.cpp.

QString KateGlobal::configPageFullName

(

int

number

)

const

Definition at line 353 of file kateglobal.cpp.

KIcon KateGlobal::configPageIcon

(

int

number

)

const

Definition at line 379 of file kateglobal.cpp.

QString KateGlobal::configPageName

(

int

number

)

const

Definition at line 327 of file kateglobal.cpp.

int KateGlobal::configPages

(

)

const

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

Definition at line 296 of file kateglobal.cpp.

QObject * KateGlobal::container

(

)

Get the currently associated Container object.

Returns:

container object

Definition at line 459 of file kateglobal.cpp.

KTextEditor::Document * KateGlobal::createDocument

(

QObject *

parent

)

Create a new document object.

Parameters:

parent

parent object

Returns:

created KTextEditor::Document

Definition at line 197 of file kateglobal.cpp.

static void KateGlobal::decRef

(

)

[inline, static]

decrement reference counter

Definition at line 168 of file kateglobal.h.

void KateGlobal::deregisterDocument

(

KateDocument *

doc

)

unregister document at the factory

Parameters:

doc

document to register

Definition at line 421 of file kateglobal.cpp.

void KateGlobal::deregisterView

(

KateView *

view

)

unregister view at the factory

Parameters:

view

view to unregister

Definition at line 434 of file kateglobal.cpp.

KDirWatch* KateGlobal::dirWatch

(

)

[inline]

global dirwatch

Returns:

dirwatch instance

Definition at line 230 of file kateglobal.h.

KateDocumentConfig* KateGlobal::documentConfig

(

)

[inline]

fallback document config

Returns:

default config for all documents

Definition at line 249 of file kateglobal.h.

const QList< KTextEditor::Document * > & KateGlobal::documents

(

)

Returns a list of all documents of this editor.

Returns:

list of all existing documents

Definition at line 206 of file kateglobal.cpp.

KateHlManager* KateGlobal::hlManager

(

)

[inline]

hl manager

Returns:

hl manager

Definition at line 272 of file kateglobal.h.

static void KateGlobal::incRef

(

)

[inline, static]

increment reference counter

Definition at line 163 of file kateglobal.h.

QList<KateDocument*>& KateGlobal::kateDocuments

(

)

[inline]

return a list of all registered docs

Returns:

all known documents

Definition at line 212 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 52 of file kateglobal.cpp.

KateModeManager* KateGlobal::modeManager

(

)

[inline]

global mode manager used to manage the modes centrally

Returns:

mode manager

Definition at line 237 of file kateglobal.h.

KatePartPluginManager* KateGlobal::pluginManager

(

)

[inline]

global plugin manager

Returns:

kate part plugin manager

Definition at line 224 of file kateglobal.h.

KTextEditor::Command * KateGlobal::queryCommand

(

const QString &

cmd

)

const

query for command

Parameters:

cmd

name of command to query for

Returns:

found command or 0

Definition at line 447 of file kateglobal.cpp.

void KateGlobal::readConfig

(

KConfig *

config = 0

)

Configuration management.

Read editor configuration from given config object

Parameters:

config

config object

Definition at line 212 of file kateglobal.cpp.

bool KateGlobal::registerCommand

(

KTextEditor::Command *

cmd

)

register given command this works global, for all documents

Parameters:

cmd

command to register

Returns:

success

Definition at line 441 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 414 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 428 of file kateglobal.cpp.

KateRendererConfig* KateGlobal::rendererConfig

(

)

[inline]

fallback renderer config

Returns:

default config for all renderers

Definition at line 261 of file kateglobal.h.

KateSchemaManager* KateGlobal::schemaManager

(

)

[inline]

manager for the katepart schemas

Returns:

schema manager

Definition at line 243 of file kateglobal.h.

KateScriptManager* KateGlobal::scriptManager

(

)

[inline]

Global script collection.

Definition at line 266 of file kateglobal.h.

KateGlobal * KateGlobal::self

(

)

[static]

Kate Part Internal stuff ;).

singleton accessor

Returns:

instance of the factory

Definition at line 405 of file kateglobal.cpp.

void KateGlobal::setContainer

(

QObject *

container

)

Set the associated container object.

Definition at line 462 of file kateglobal.cpp.

bool KateGlobal::unregisterCommand

(

KTextEditor::Command *

cmd

)

unregister given command this works global, for all documents

Parameters:

cmd

command to unregister

Returns:

success

Definition at line 444 of file kateglobal.cpp.

KateViewConfig* KateGlobal::viewConfig

(

)

[inline]

fallback view config

Returns:

default config for all views

Definition at line 255 of file kateglobal.h.

QList<KateView*>& KateGlobal::views

(

)

[inline]

return a list of all registered views

Returns:

all known views

Definition at line 218 of file kateglobal.h.

KateViGlobal* KateGlobal::viInputModeGlobal

(

)

[inline]

vi input mode global

Returns:

vi input mode global

Definition at line 284 of file kateglobal.h.

void KateGlobal::writeConfig

(

KConfig *

config = 0

)

Write editor configuration to given config object.

Parameters:

config

config object

Definition at line 224 of file kateglobal.cpp.

---

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

• kateglobal.h
• kateglobal.cpp