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

Kate

SearchCommand Class Reference

#include <katesearch.h>

Inheritance diagram for SearchCommand:

Inheritance graph
[legend]

List of all members.


Public Member Functions

QStringList cmds ()
bool exec (class Kate::View *view, const QString &cmd, QString &errorMsg)
bool help (class Kate::View *, const QString &, QString &)
void processText (Kate::View *view, const QString &text)
 SearchCommand ()
bool wantsToProcessText (const QString &)

Detailed Description

Definition at line 218 of file katesearch.h.


Constructor & Destructor Documentation

SearchCommand::SearchCommand (  )  [inline]

Definition at line 221 of file katesearch.h.


Member Function Documentation

QStringList SearchCommand::cmds (  )  [virtual]

Pure text start part of the commands which can be handled by this object which means i.e.

for s/sdl/sdf/g => s or for char:1212 => char

Implements Kate::Command.

Definition at line 950 of file katesearch.cpp.

bool SearchCommand::exec ( class Kate::View *  view,
const QString &  cmd,
QString &  msg 
) [virtual]

Execute this command for the given view and cmd string, return a bool about success, msg for status.

Implements Kate::Command.

Definition at line 805 of file katesearch.cpp.

bool SearchCommand::help ( class Kate::View *  view,
const QString &  cmd,
QString &  msg 
) [virtual]

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

Implements Kate::Command.

Definition at line 911 of file katesearch.cpp.

void SearchCommand::processText ( Kate::View *  view,
const QString &  text 
) [virtual]

This is called by the commandline each time the argument text for the command changes, if wantsToProcessText() returns true.

Parameters:
view The current view
text The current command text typed by the user.

Reimplemented from Kate::CommandExtension.

Definition at line 962 of file katesearch.cpp.

bool SearchCommand::wantsToProcessText ( const QString &  cmdname  )  [virtual]

Returns:
whether this command wants to process text interactively given the cmdname. If true, the command's processText() method is called when the text in the command line is changed.
Reimplement this to return true, if your commands wants to process the text as typed.

Parameters:
cmdname the command name associated with this query.

Reimplemented from Kate::CommandExtension.

Definition at line 957 of file katesearch.cpp.


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

Kate

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

API Reference

Skip menu "API Reference"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
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