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

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 60 of file kateglobal.h.
Constructor & Destructor Documentation
KateGlobal::~KateGlobal | ( | ) |
Destructor.
Definition at line 176 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 99 of file kateglobal.h.
KateCmd* KateGlobal::cmdManager | ( | ) | [inline] |
QStringList KateGlobal::commandList | ( | ) | const [virtual] |
Get a list of available commandline strings.
- Returns:
- commandline strings
Implements KTextEditor::CommandInterface.
Definition at line 460 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 457 of file kateglobal.cpp.
const KComponentData& KateGlobal::componentData | ( | ) | [inline] |
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 255 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 250 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 308 of file kateglobal.cpp.
QString KateGlobal::configPageFullName | ( | int | number | ) | const [virtual] |
Implements KTextEditor::Editor.
Definition at line 360 of file kateglobal.cpp.
KIcon KateGlobal::configPageIcon | ( | int | number | ) | const [virtual] |
Implements KTextEditor::Editor.
Definition at line 386 of file kateglobal.cpp.
QString KateGlobal::configPageName | ( | int | number | ) | const [virtual] |
Implements KTextEditor::Editor.
Definition at line 334 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 303 of file kateglobal.cpp.
QObject * KateGlobal::container | ( | ) | [virtual] |
Get the currently associated Container object.
- Returns:
- container object
Implements KTextEditor::ContainerInterface.
Definition at line 466 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 205 of file kateglobal.cpp.
static void KateGlobal::decRef | ( | ) | [inline, static] |
decrement reference counter
Definition at line 169 of file kateglobal.h.
void KateGlobal::deregisterDocument | ( | KateDocument * | doc | ) |
unregister document at the factory
- Parameters:
-
doc document to register
Definition at line 428 of file kateglobal.cpp.
void KateGlobal::deregisterView | ( | KateView * | view | ) |
unregister view at the factory
- Parameters:
-
view view to unregister
Definition at line 441 of file kateglobal.cpp.
KDirWatch* KateGlobal::dirWatch | ( | ) | [inline] |
KateDocumentConfig* KateGlobal::documentConfig | ( | ) | [inline] |
fallback document config
- Returns:
- default config for all documents
Definition at line 250 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 214 of file kateglobal.cpp.
KateHlManager* KateGlobal::hlManager | ( | ) | [inline] |
static void KateGlobal::incRef | ( | ) | [inline, static] |
increment reference counter
Definition at line 164 of file kateglobal.h.
QList<KateDocument*>& KateGlobal::kateDocuments | ( | ) | [inline] |
return a list of all registered docs
- Returns:
- all known documents
Definition at line 213 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 53 of file kateglobal.cpp.
KateModeManager* KateGlobal::modeManager | ( | ) | [inline] |
global mode manager used to manage the modes centrally
- Returns:
- mode manager
Definition at line 238 of file kateglobal.h.
KatePartPluginManager* KateGlobal::pluginManager | ( | ) | [inline] |
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 454 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 220 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 448 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 421 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 435 of file kateglobal.cpp.
KateRendererConfig* KateGlobal::rendererConfig | ( | ) | [inline] |
fallback renderer config
- Returns:
- default config for all renderers
Definition at line 262 of file kateglobal.h.
KateSchemaManager* KateGlobal::schemaManager | ( | ) | [inline] |
manager for the katepart schemas
- Returns:
- schema manager
Definition at line 244 of file kateglobal.h.
KateScriptManager* KateGlobal::scriptManager | ( | ) | [inline] |
Global script collection.
Definition at line 267 of file kateglobal.h.
KateGlobal * KateGlobal::self | ( | ) | [static] |
Kate Part Internal stuff ;).
singleton accessor
- Returns:
- instance of the factory
Definition at line 412 of file kateglobal.cpp.
void KateGlobal::setContainer | ( | QObject * | container | ) | [virtual] |
Set the associated container object.
Implements KTextEditor::ContainerInterface.
Definition at line 469 of file kateglobal.cpp.
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 451 of file kateglobal.cpp.
KateViewConfig* KateGlobal::viewConfig | ( | ) | [inline] |
fallback view config
- Returns:
- default config for all views
Definition at line 256 of file kateglobal.h.
return a list of all registered views
- Returns:
- all known views
Definition at line 219 of file kateglobal.h.
KateViGlobal* KateGlobal::viInputModeGlobal | ( | ) | [inline] |
KateWordCompletionModel* KateGlobal::wordCompletionModel | ( | ) | [inline] |
global instance of the simple word completion mode
- Returns:
- global instance of the simple word completion mode
Definition at line 291 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 232 of file kateglobal.cpp.
The documentation for this class was generated from the following files: