• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kate
 

kate

KateApp Class Reference

Kate Application This class represents the core kate application object. More...

#include <kateapp.h>

Inherits TDEApplication.

List of all members.

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Kate Application This class represents the core kate application object.

Definition at line 42 of file kateapp.h.


Constructor & Destructor Documentation

KateApp::KateApp ( TDECmdLineArgs *  args  ) 

constructors & accessor to app object + plugin interface for it

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

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 377 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.

KateDocManager * KateApp::documentManager (  ) 

accessor to document manager

Returns:
document manager instance

Definition at line 292 of file kateapp.cpp.

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

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

Has always been the Kate Versioning Scheme: KDE X.Y.Z contains Kate X-1.Y.Z.

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

The previous version computation scheme (commented out above) worked fine in the 3.5.x days. With the new Trinity Rx.y.z scheme the version number gets weird. We now hard-code the first two numbers to match the 3.5.x days and only update the last number.

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

uint KateApp::mainWindows (  )  const

give back number of existing main windows

Returns:
number of main windows

Definition at line 390 of file kateapp.cpp.

KateMainWindow * KateApp::newMainWindow ( TDEConfig *  sconfig = 0,
const TQString &  sgroup = "" 
)

window management

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

bool KateApp::openInput ( const TQString &  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 343 of file kateapp.cpp.

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

some stuff for the dcop API

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

KatePluginManager * KateApp::pluginManager (  ) 

other accessors for global unique instances

accessor to plugin manager

Returns:
plugin manager instance

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

KateApp * KateApp::self (  )  [static]

static accessor to avoid casting ;)

Returns:
app instance

Definition at line 118 of file kateapp.cpp.

KateSessionManager * KateApp::sessionManager (  ) 

accessor to session manager

Returns:
session manager instance

Definition at line 297 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 331 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  ) 

kate shutdown

shutdown kate application

Parameters:
win mainwindow which is used for dialogs

Definition at line 270 of file kateapp.cpp.


The documentation for this class was generated from the following files:
  • kateapp.h
  • kateapp.cpp

kate

Skip menu "kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kate

Skip menu "kate"
  • kate
  • libkonq
  • twin
  •   lib
Generated for kate by doxygen 1.6.3
This website is maintained by Timothy Pearson.