kate Library API Documentation

KateCommands::CoreCommands Class Reference

This Kate::Command provides access to a lot of the core functionality of kate part, settings, utilities, navigation etc. More...

#include <katecmds.h>

Inheritance diagram for KateCommands::CoreCommands:

Kate::Command Kate::CommandExtension List of all members.

Public Member Functions

bool exec (class Kate::View *view, const QString &cmd, QString &errorMsg)
bool help (class Kate::View *, const QString &, QString &)
QStringList cmds ()
KCompletioncompletionObject (const QString &, Kate::View *)

Detailed Description

This Kate::Command provides access to a lot of the core functionality of kate part, settings, utilities, navigation etc.

it needs to get a kateview pointer, it will cast the kate::view pointer hard to kateview

Definition at line 39 of file katecmds.h.


Member Function Documentation

bool KateCommands::CoreCommands::exec class Kate::View view,
const QString cmd,
QString errorMsg
[virtual]
 

execute command

Parameters:
view view to use for execution
cmd cmd string
errorMsg error to return if no success
Returns:
success

Implements Kate::Command.

Definition at line 84 of file katecmds.cpp.

References KateView::cleanIndent(), KateView::comment(), KateDocument::config(), KateView::doc(), KateView::gotoLineNumber(), KateDocument::hlModeName(), KateView::indent(), KateDocumentConfig::indentationWidth(), KateView::killLine(), QString::lower(), KateAutoIndent::modeNumber(), KateDocument::numLines(), QString::section(), KateView::setFoldingMarkersOn(), KateDocument::setHlMode(), KateView::setIconBorder(), KateDocumentConfig::setIndentationMode(), KateDocumentConfig::setIndentationWidth(), KateView::setLineNumbersOn(), KateView::setTabWidth(), KateDocument::setWordWrap(), KateDocument::setWordWrapAt(), QStringList::split(), KateView::tabWidth(), KateView::uncomment(), and KateView::unIndent().

bool KateCommands::CoreCommands::help class Kate::View ,
const QString ,
QString
[inline, virtual]
 

Shows help for the given view and cmd string, return a bool about success, msg for status.

Implements Kate::Command.

Definition at line 51 of file katecmds.h.

QStringList KateCommands::CoreCommands::cmds  )  [virtual]
 

supported commands as prefixes

Returns:
prefix list

Implements Kate::Command.

Definition at line 68 of file katecmds.cpp.

KCompletion * KateCommands::CoreCommands::completionObject const QString cmd,
Kate::View view
[virtual]
 

Returns:
a KCompletion object that will substitute the command line default one while typing the first argument to the command. The text will be added to the command seperated by one space character.
Implement this method if your command can provide a completion object.

Parameters:
cmdname The command name associated with this request.

Reimplemented from Kate::CommandExtension.

Definition at line 265 of file katecmds.cpp.

References KateView::doc(), KateDocument::hlModeName(), and KCompletion::setItems().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Nov 1 10:36:29 2005 by doxygen 1.4.3 written by Dimitri van Heesch, © 1997-2003