• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Kate

KateCommands::CoreCommands

KateCommands::CoreCommands Class Reference

This KTextEditor::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:

Inheritance graph
[legend]

List of all members.


Public Member Functions

const QStringList & cmds ()
KCompletion * completionObject (KTextEditor::View *, const QString &)
bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg, const KTextEditor::Range &range=KTextEditor::Range(-1,-0,-1, 0))
bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg)
virtual void flagCompletions (QStringList &)
bool help (class KTextEditor::View *, const QString &, QString &)
virtual void processText (KTextEditor::View *, const QString &)
bool supportsRange (const QString &range)
virtual bool wantsToProcessText (const QString &)

Detailed Description

This KTextEditor::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 44 of file katecmds.h.


Member Function Documentation

const QStringList & KateCommands::CoreCommands::cmds (  ) 

supported commands as prefixes

Returns:
prefix list

Definition at line 70 of file katecmds.cpp.

KCompletion * KateCommands::CoreCommands::completionObject ( KTextEditor::View *  view,
const QString &  cmd 
)

override completionObject from interfaces/document.h .

Definition at line 351 of file katecmds.cpp.

bool KateCommands::CoreCommands::exec ( class KTextEditor::View *  view,
const QString &  cmd,
QString &  errorMsg,
const KTextEditor::Range &  range = KTextEditor::Range(-1, -0, -1, 0) 
)

execute command on given range

Parameters:
view view to use for execution
cmd cmd string
errorMsg error to return if no success
rangeStart first line in range
rangeEnd last line in range
Returns:
success

Definition at line 98 of file katecmds.cpp.

bool KateCommands::CoreCommands::exec ( class KTextEditor::View *  view,
const QString &  cmd,
QString &  errorMsg 
)

execute command

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

Definition at line 91 of file katecmds.cpp.

virtual void KateCommands::CoreCommands::flagCompletions ( QStringList &   )  [inline, virtual]

Definition at line 85 of file katecmds.h.

bool KateCommands::CoreCommands::help ( class KTextEditor::View *  ,
const QString &  ,
QString &   
) [inline]

This command does not have help.

See also:
KTextEditor::Command::help

Definition at line 72 of file katecmds.h.

virtual void KateCommands::CoreCommands::processText ( KTextEditor::View *  ,
const QString &   
) [inline, virtual]

Definition at line 87 of file katecmds.h.

bool KateCommands::CoreCommands::supportsRange ( const QString &  range  ) 

Definition at line 340 of file katecmds.cpp.

virtual bool KateCommands::CoreCommands::wantsToProcessText ( const QString &   )  [inline, virtual]

Definition at line 86 of file katecmds.h.


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

Kate

Skip menu "Kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal