Konsole::SearchHistoryTask Class Reference

#include <SessionController.h>

Inheritance diagram for Konsole::SearchHistoryTask:

Public Types
enum	SearchDirection { ForwardsSearch, BackwardsSearch }

Public Member Functions
	SearchHistoryTask (QObject *parent=0)
void	addScreenWindow (Session *session, ScreenWindow *searchWindow)
virtual void	execute ()
QRegExp	regExp () const
SearchDirection	searchDirection () const
void	setRegExp (const QRegExp &regExp)
void	setSearchDirection (SearchDirection direction)
void	setStartLine (int startLine)
Public Member Functions inherited from Konsole::SessionTask
	SessionTask (QObject *parent=0)
void	addSession (Session *session)
bool	autoDelete () const
void	setAutoDelete (bool enable)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Signals inherited from Konsole::SessionTask
void	completed (bool success)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from Konsole::SessionTask
QList< SessionPtr >	sessions () const
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

A task which searches through the output of sessions for matches for a given regular expression.

SearchHistoryTask operates on ScreenWindow instances rather than sessions added by addSession(). A screen window can be added to the list to search using addScreenWindow()

When execute() is called, the search begins in the direction specified by searchDirection(), starting at the position of the current selection.

FIXME - This is not a proper implementation of SessionTask, in that it ignores sessions specified with addSession()

TODO - Implementation requirements: May provide progress feedback to the user when searching very large output logs.

Definition at line 479 of file SessionController.h.

Member Enumeration Documentation

enum Konsole::SearchHistoryTask::SearchDirection

This enum describes the strategies available for searching through the session's output.

Enumerator
ForwardsSearch	Searches forwards through the output, starting at the current selection.
BackwardsSearch	Searches backwards through the output, starting at the current selection.

Definition at line 488 of file SessionController.h.

Constructor & Destructor Documentation

SearchHistoryTask::SearchHistoryTask ( QObject *  parent = 0 )

explicit

Constructs a new search task.

Definition at line 1957 of file SessionController.cpp.

Member Function Documentation

void SearchHistoryTask::addScreenWindow	(	Session *	session,
		ScreenWindow *	searchWindow
	)

Adds a screen window to the list to search when execute() is called.

Definition at line 1802 of file SessionController.cpp.

void SearchHistoryTask::execute ( )

virtual

Performs a search through the session's history, starting at the position of the current selection, in the direction specified by setSearchDirection().

If it finds a match, the ScreenWindow specified in the constructor is scrolled to the position where the match occurred and the selection is set to the matching text. execute() then returns immediately.

To continue the search looking for further matches, call execute() again.

Implements Konsole::SessionTask.

Definition at line 1806 of file SessionController.cpp.

QRegExp SearchHistoryTask::regExp

(

)

const

Returns the regular expression which is searched for when execute() is called.

Definition at line 1979 of file SessionController.cpp.

SearchHistoryTask::SearchDirection SearchHistoryTask::searchDirection

(

)

const

Returns the current search direction.

See setSearchDirection().

Definition at line 1971 of file SessionController.cpp.

void SearchHistoryTask::setRegExp

(

const QRegExp &

regExp

)

Sets the regular expression which is searched for when execute() is called.

Definition at line 1975 of file SessionController.cpp.

void SearchHistoryTask::setSearchDirection

(

SearchDirection

direction

)

Specifies the direction to search in when execute() is called.

Definition at line 1963 of file SessionController.cpp.

void SearchHistoryTask::setStartLine

(

int

startLine

)

The line from which the search will be done.

Definition at line 1967 of file SessionController.cpp.

---

The documentation for this class was generated from the following files:

• SessionController.h
• SessionController.cpp