kate/kate/interfaces/kate
#include <application.h>
Public Member Functions | |
Application (void *application) | |
virtual | ~Application () |
Kate::MainWindow * | activeMainWindow () |
Kate::DocumentManager * | documentManager () |
KTextEditor::Editor * | editor () |
const QList< Kate::MainWindow * > & | mainWindows () const |
Kate::PluginManager * | pluginManager () |
Detailed Description
Central interface to the application.
The class Application is central as it provides access to the core application, which includes the
- document manager, access it with documentManager()
- plugin manager, access it with pluginManager()
- main windows, access a main window with mainWindow() or activeMainWindow()
- used editor component, access it with editor().
To access the application use the global accessor function application(). You should never have to create an instance of this class yourself.
Definition at line 61 of file application.h.
Constructor & Destructor Documentation
Kate::Application::Application | ( | void * | application | ) |
Construtor.
The constructor is internally used by the Kate application, so it is of no interest for plugin developers. Plugin developers should use the global accessor application() instead.
Definition at line 48 of file application.cpp.
|
virtual |
Virtual desctructor.
Definition at line 54 of file application.cpp.
Member Function Documentation
MainWindow * Kate::Application::activeMainWindow | ( | ) |
Accessor to the active mainwindow.
There is always an active mainwindow, so it is not necessary to test the returned value for NULL.
- Returns
- a pointer to the active mainwindow
Definition at line 69 of file application.cpp.
DocumentManager * Kate::Application::documentManager | ( | ) |
Accessor to the document manager.
There is always an document manager, so it is not necessary to test the returned value for NULL.
- Returns
- a pointer to the document manager
Definition at line 59 of file application.cpp.
KTextEditor::Editor * Kate::Application::editor | ( | ) |
Accessor to the global editor part.
There is always an editor part, so it is not necessary to test the returned value for NULL.
- Returns
- KTextEditor component
Definition at line 87 of file application.cpp.
const QList< MainWindow * > & Kate::Application::mainWindows | ( | ) | const |
Get a list of all mainwindows.
At least one entry, always.
- Returns
- all mainwindows
- See also
- activeMainWindow()
Definition at line 77 of file application.cpp.
PluginManager * Kate::Application::pluginManager | ( | ) |
Accessor to the plugin manager.
There is always an plugin manager, so it is not necessary to test the returned value for NULL.
- Returns
- a pointer to the plugin manager
Definition at line 64 of file application.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:31:36 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.