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::Applicationapplication ()
void shutdownKate (KateMainWindow *win)
bool shouldExit ()
KatePluginManagerpluginManager ()
KateDocManagerdocumentManager ()
KateSessionManagersessionManager ()
KateMainWindownewMainWindow (KConfig *sconfig=0, const QString &sgroup="")
void removeMainWindow (KateMainWindow *mainWindow)
KateMainWindowactiveMainWindow ()
uint mainWindows () const
KateMainWindowmainWindow (uint n)
bool openURL (const KURL &url, const QString &encoding, bool isTempFile)
bool setCursor (int line, int column)
bool openInput (const QString &text)

Static Public Member Functions

static KateAppself ()
static QString kateVersion (bool fullVersion=true)

Constructor & Destructor Documentation

KateApp::KateApp ( KCmdLineArgs *  args  ) 

application constructor

Parameters:
args parsed command line args

Definition at line 54 of file kateapp.cpp.

KateApp::~KateApp (  ) 

application destructor

Definition at line 106 of file kateapp.cpp.


Member Function Documentation

KateApp * KateApp::self (  )  [static]

static accessor to avoid casting ;)

Returns:
app instance

Definition at line 118 of file kateapp.cpp.

Kate::Application * KateApp::application (  ) 

accessor to the Kate::Application plugin interface

Returns:
application plugin interface

Definition at line 123 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 132 of file kateapp.cpp.

void KateApp::shutdownKate ( KateMainWindow win  ) 

shutdown kate application

Parameters:
win mainwindow which is used for dialogs

Definition at line 266 of file kateapp.cpp.

bool KateApp::shouldExit (  )  [inline]

application should exit

Returns:
should we exit?

Definition at line 109 of file kateapp.h.

KatePluginManager * KateApp::pluginManager (  ) 

accessor to plugin manager

Returns:
plugin manager instance

Definition at line 283 of file kateapp.cpp.

KateDocManager * KateApp::documentManager (  ) 

accessor to document manager

Returns:
document manager instance

Definition at line 288 of file kateapp.cpp.

KateSessionManager * KateApp::sessionManager (  ) 

accessor to session manager

Returns:
session manager instance

Definition at line 293 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 351 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 368 of file kateapp.cpp.

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 373 of file kateapp.cpp.

uint KateApp::mainWindows (  )  const

give back number of existing main windows

Returns:
number of main windows

Definition at line 386 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 391 of file kateapp.cpp.

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

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

Parameters:
url filename
encoding encoding name
isTempFile if set to true and the file is a local file, it will be deleted when the document is closed.
Returns:
success

Definition at line 298 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 327 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 339 of file kateapp.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys