K3IconViewSearchLine Class Reference

#include <k3iconviewsearchline.h>

Inheritance diagram for K3IconViewSearchLine:

Public Slots
void	clear ()
void	setCaseSensitive (bool cs)
void	setIconView (Q3IconView *iv)
virtual void	updateSearch (const QString &s=QString())
Public Slots inherited from KLineEdit
virtual void	clear ()
bool	passwordMode () const
void	rotateText (KCompletionBase::KeyBindingType type)
void	setCompletedItems (const QStringList &items, bool autoSuggest=true)
virtual void	setCompletedText (const QString &)
void	setPasswordMode (bool b=true)
virtual void	setReadOnly (bool)
void	setSqueezedText (const QString &text)
virtual void	setText (const QString &)

Public Member Functions
	K3IconViewSearchLine (QWidget *parent=0, Q3IconView *iconView=0)
virtual	~K3IconViewSearchLine ()
bool	caseSensitive () const
Q3IconView *	iconView () const
Public Member Functions inherited from KLineEdit
	KLineEdit (const QString &string, QWidget *parent=0)
	KLineEdit (QWidget *parent=0)
virtual	~KLineEdit ()
QSize	clearButtonUsedSize () const
QString	clickMessage () const
KCompletionBox *	completionBox (bool create=true)
virtual void	copy () const
void	doCompletion (const QString &txt)
bool	isClearButtonShown () const
bool	isContextMenuEnabled () const
bool	isSqueezedTextEnabled () const
QString	originalText () const
void	setClearButtonShown (bool show)
void	setClickMessage (const QString &msg)
void	setCompletionBox (KCompletionBox *box)
virtual void	setCompletionMode (KGlobalSettings::Completion mode)
void	setCompletionModeDisabled (KGlobalSettings::Completion mode, bool disable=true)
virtual void	setCompletionObject (KCompletion *, bool hsig=true)
virtual void	setContextMenuEnabled (bool showMenu)
void	setSqueezedTextEnabled (bool enable)
void	setTrapReturnKey (bool trap)
void	setUrl (const KUrl &url)
void	setUrlDropsEnabled (bool enable)
bool	trapReturnKey () const
bool	urlDropsEnabled () const
QString	userText () const

Protected Slots
void	activateSearch ()
void	queueSearch (const QString &s)
Protected Slots inherited from KLineEdit
virtual void	makeCompletion (const QString &)
void	userCancelled (const QString &cancelText)

Protected Member Functions
void	hideItem (Q3IconViewItem *item)
void	init (Q3IconView *iconView=0)
virtual bool	itemMatches (const Q3IconViewItem *item, const QString &s) const
void	showItem (Q3IconViewItem *item)
Protected Member Functions inherited from KLineEdit
bool	autoSuggest () const
virtual void	contextMenuEvent (QContextMenuEvent *)
virtual void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
QMenu *	createStandardContextMenu ()
virtual void	dropEvent (QDropEvent *)
virtual bool	event (QEvent *)
virtual void	focusInEvent (QFocusEvent *ev)
virtual void	focusOutEvent (QFocusEvent *ev)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	mouseDoubleClickEvent (QMouseEvent *)
virtual void	mousePressEvent (QMouseEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *)
virtual void	paintEvent (QPaintEvent *ev)
virtual void	resizeEvent (QResizeEvent *)
virtual void	setCompletedText (const QString &, bool)
void	setUserSelection (bool userSelection)

Additional Inherited Members
Signals inherited from KLineEdit
void	aboutToShowContextMenu (QMenu *menu)
void	clearButtonClicked ()
void	completion (const QString &)
void	completionBoxActivated (const QString &)
void	completionModeChanged (KGlobalSettings::Completion)
void	returnPressed (const QString &)
void	substringCompletion (const QString &)
void	textRotation (KCompletionBase::KeyBindingType)
QT_MOC_COMPAT void	userTextChanged (const QString &)
Properties inherited from KLineEdit
QString	clickMessage
bool	contextMenuEnabled
bool	passwordMode
bool	showClearButton
bool	squeezedTextEnabled
bool	trapEnterKeyEvent
bool	urlDropsEnabled

Detailed Description

This class makes it easy to add a search line for filtering the items in a iconview based on a simple text search.

No changes to the application other than instantiating this class with an appropriate QIconView should be needed.

Definition at line 36 of file k3iconviewsearchline.h.

Constructor & Destructor Documentation

K3IconViewSearchLine::K3IconViewSearchLine	(	QWidget *	parent = 0,
		Q3IconView *	iconView = 0
	)

Constructs a K3IconViewSearchLine with iconView being the QIconView to be filtered.

If iconView is null then the widget will be disabled until a iconview is set with setIconView().

Definition at line 57 of file k3iconviewsearchline.cpp.

K3IconViewSearchLine::~K3IconViewSearchLine ( )

virtual

Destroys the K3IconViewSearchLine.

Definition at line 65 of file k3iconviewsearchline.cpp.

Member Function Documentation

void K3IconViewSearchLine::activateSearch ( )

protectedslot

When the timer started with queueSearch() expires this slot is called.

If there has been another timer started then this slot does nothing. However if there are no other pending searches this starts the icon view search.

See also

queueSearch()

Definition at line 249 of file k3iconviewsearchline.cpp.

bool K3IconViewSearchLine::caseSensitive

(

)

const

Returns true if the search is case sensitive.

This defaults to false.

See also

setCaseSensitive()

Definition at line 71 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::clear ( )

slot

Clear line edit and empty hiddenItems, returning elements to iconView.

Definition at line 129 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::hideItem ( Q3IconViewItem *  item )

protected

Hide item.

Definition at line 217 of file k3iconviewsearchline.cpp.

Q3IconView * K3IconViewSearchLine::iconView

(

)

const

Returns the iconview that is currently filtered by the search.

See also

setIconView()

Definition at line 76 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::init ( Q3IconView *  iconView = 0 )

protected

Do initialization common to both constructors.

Definition at line 195 of file k3iconviewsearchline.cpp.

bool K3IconViewSearchLine::itemMatches ( const Q3IconViewItem *  item, const QString &  s  ) const

protectedvirtual

Returns true if item matches the search s.

This will be evaluated based on the value of caseSensitive(). This can be overridden in subclasses to implement more complicated matching schemes.

Definition at line 182 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::queueSearch ( const QString &  s )

protectedslot

When keys are pressed a new search string is created and a timer is activated.

The most recent search is activated when this timer runs out if another key has not yet been pressed.

This method makes

Parameters

s	the most recent search and starts the timer.

Together with activateSearch() this makes it such that searches are not started until there is a short break in the users typing.

See also

activateSearch()

Definition at line 242 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::setCaseSensitive ( bool  cs )

slot

Make the search case sensitive or case insensitive.

See also

caseSenstive()

Definition at line 156 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::setIconView ( Q3IconView *  iv )

slot

Sets the QIconView that is filtered by this search line.

If lv is null then the widget will be disabled.

See also

iconView()

Definition at line 161 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::showItem ( Q3IconViewItem *  item )

protected

Show item.

Just unhide it, doesn't necessary show it on screen, for that use iconView->ensureItemVisible()

Definition at line 226 of file k3iconviewsearchline.cpp.

void K3IconViewSearchLine::updateSearch ( const QString &  s = QString() )

virtualslot

Updates search to only make visible the items that match s.

If s is null then the line edit's text will be used.

Definition at line 84 of file k3iconviewsearchline.cpp.

---

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

• k3iconviewsearchline.h
• k3iconviewsearchline.cpp