• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • applications API Reference
  • KDE Home
  • Contact Us
 

kate/kate/interfaces/kate

  • Kate
  • Application
Public Member Functions | List of all members
Kate::Application Class Reference

#include <application.h>

Inheritance diagram for Kate::Application:
Inheritance graph
[legend]

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 ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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.

Author
Christoph Cullmann <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

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.

Kate::Application::~Application ( )
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:
  • application.h
  • application.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:56:44 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kate/kate/interfaces/kate

Skip menu "kate/kate/interfaces/kate"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

applications API Reference

Skip menu "applications API Reference"
  •   kate
  •       kate
  •   KTextEditor
  •   Kate
  • Konsole

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal