KateApp Class Reference

#include <kateapp.h>

List of all members.

Detailed Description

Kate Application This class represents the core kate application object.

Definition at line 42 of file kateapp.h.


Public Member Functions

 KateApp (KCmdLineArgs *args)
 ~KateApp ()
Kate::Application * application ()
void shutdownKate (KateMainWindow *win)
bool shouldExit ()
KatePluginManager * pluginManager ()
KateDocManager * documentManager ()
KateSessionManager * sessionManager ()
KateMainWindow * newMainWindow (KConfig *sconfig=0, const QString &sgroup="")
void removeMainWindow (KateMainWindow *mainWindow)
KateMainWindow * activeMainWindow ()
uint mainWindows () const
KateMainWindow * mainWindow (uint n)
bool openURL (const KURL &url, const QString &encoding)
bool setCursor (int line, int column)
bool openInput (const QString &text)

Static Public Member Functions

static KateApp * self ()
static QString kateVersion (bool fullVersion=true)

Constructor & Destructor Documentation

KateApp::KateApp (  KCmdLineArgs *  args  ) 
 

application constructor

Parameters:
args parsed command line args

Definition at line 50 of file kateapp.cpp.

KateApp::~KateApp (   ) 
 

application destructor

Definition at line 99 of file kateapp.cpp.

Member Function Documentation

KateMainWindow * KateApp::activeMainWindow (   ) 
 

give back current active main window can only be 0 at app start or exit

Returns:
current active main window

Definition at line 364 of file kateapp.cpp.

Kate::Application * KateApp::application (   ) 
 

accessor to the Kate::Application plugin interface

Returns:
application plugin interface

Definition at line 116 of file kateapp.cpp.

KateDocManager * KateApp::documentManager (   ) 
 

accessor to document manager

Returns:
document manager instance

Definition at line 279 of file kateapp.cpp.

QString KateApp::kateVersion (  bool  fullVersion = true  )  [static]
 

Returns the current Kate version (X.Y) or (X.Y.Z).

Parameters:
fullVersion should full version be returned?
Returns:
Kate version

Definition at line 125 of file kateapp.cpp.

KateMainWindow * KateApp::mainWindow (  uint  n  ) 
 

give back the window you want

Parameters:
n window index
Returns:
requested main window

Definition at line 382 of file kateapp.cpp.

uint KateApp::mainWindows (   )  const
 

give back number of existing main windows

Returns:
number of main windows

Definition at line 377 of file kateapp.cpp.

KateMainWindow * KateApp::newMainWindow (  KConfig *  sconfig = 0,
const QString &  sgroup = ""
) 
 

create a new main window, use given config if any for restore

Parameters:
sconfig session config object
sgroup session group for this window
Returns:
new constructed main window

Definition at line 342 of file kateapp.cpp.

bool KateApp::openInput (  const QString &  text  ) 
 

helper to handle stdin input open a new document/view, fill it with the text given

Parameters:
text text to fill in the new doc/view
Returns:
success

Definition at line 330 of file kateapp.cpp.

bool KateApp::openURL (  const KURL &  url,
const QString &  encoding
) 
 

open url with given encoding used by kate if --use given

Parameters:
url filename
encoding encoding name
Returns:
success

Definition at line 289 of file kateapp.cpp.

KatePluginManager * KateApp::pluginManager (   ) 
 

accessor to plugin manager

Returns:
plugin manager instance

Definition at line 274 of file kateapp.cpp.

void KateApp::removeMainWindow (  KateMainWindow *  mainWindow  ) 
 

removes the mainwindow given, DOES NOT DELETE IT

Parameters:
mainWindow window to remove

Definition at line 359 of file kateapp.cpp.

KateApp * KateApp::self (   )  [static]
 

static accessor to avoid casting ;)

Returns:
app instance

Definition at line 111 of file kateapp.cpp.

KateSessionManager * KateApp::sessionManager (   ) 
 

accessor to session manager

Returns:
session manager instance

Definition at line 284 of file kateapp.cpp.

bool KateApp::setCursor (  int  line,
int  column
) 
 

position cursor in current active view

Parameters:
line line to set
column column to set
Returns:
success

Definition at line 318 of file kateapp.cpp.

bool KateApp::shouldExit (   )  [inline]
 

application should exit

Returns:
should we exit?

Definition at line 109 of file kateapp.h.

void KateApp::shutdownKate (  KateMainWindow *  win  ) 
 

shutdown kate application

Parameters:
win mainwindow which is used for dialogs

Definition at line 257 of file kateapp.cpp.

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

kate

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys