kate Library API Documentation

SearchCommand Class Reference

Inheritance diagram for SearchCommand:

Inheritance graph
[legend]
Collaboration diagram for SearchCommand:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Detailed Description

Definition at line 217 of file katesearch.h.


Member Function Documentation

bool SearchCommand::exec class Kate::View view,
const QString cmd,
QString errorMsg
[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 718 of file katesearch.cpp.

References QRegExp::cap(), QString::contains(), endl(), kdDebug(), QRegExp::search(), and QString::startsWith().

bool SearchCommand::help class Kate::View ,
const QString ,
QString
[virtual]
 

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

Implements Kate::Command.

Definition at line 824 of file katesearch.cpp.

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 863 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 870 of file katesearch.cpp.

void SearchCommand::processText Kate::View view,
const QString cmd
[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 875 of file katesearch.cpp.

References QRegExp::cap(), KateView::find(), KateView::getDoc(), QString::isEmpty(), QString::length(), QRegExp::search(), KateView::setCursorPositionInternal(), and QString::startsWith().


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.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Sep 16 07:19:00 2005 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003