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

KDE3Support

K3IconViewSearchLine Class Reference

#include <k3iconviewsearchline.h>

Inheritance diagram for K3IconViewSearchLine:

Inheritance graph
[legend]

List of all members.


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.


Public Slots

void clear ()
void setCaseSensitive (bool cs)
void setIconView (Q3IconView *iv)
virtual void updateSearch (const QString &s=QString())

Public Member Functions

bool caseSensitive () const
Q3IconView * iconView () const
 K3IconViewSearchLine (QWidget *parent=0, Q3IconView *iconView=0)
virtual ~K3IconViewSearchLine ()

Protected Slots

void activateSearch ()
void queueSearch (const QString &s)

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)

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 (  )  [protected, slot]

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 (  )  [virtual, slot]

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

Reimplemented from KLineEdit.

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 [protected, virtual]

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  )  [protected, slot]

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()  )  [virtual, slot]

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

KDE3Support

Skip menu "KDE3Support"
  • 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
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
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