• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KDE3Support

Public Slots | Public Member Functions | Protected Slots | Protected Member Functions
K3IconViewSearchLine Class Reference

#include <k3iconviewsearchline.h>

Inheritance diagram for K3IconViewSearchLine:
KLineEdit QLineEdit KCompletionBase

List of all members.

Public Slots

void clear ()
void setCaseSensitive (bool cs)
void setIconView (Q3IconView *iv)
virtual void updateSearch (const QString &s=QString())
- Public Slots inherited from KLineEdit
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 ~KCompletionBase ()
virtual ~KLineEdit ()
QSize clearButtonUsedSize () const
QString clickMessage () const
KCompletionBox * completionBox (bool create=true)
KGlobalSettings::Completion completionMode () const
KCompletion * completionObject (bool hsig=true)
KCompletion * compObj () const
virtual void copy () const
void doCompletion (const QString &txt)
bool emitSignals () const
KShortcut getKeyBinding (KeyBindingType item) const
bool handleSignals () const
bool isClearButtonShown () const
bool isCompletionObjectAutoDeleted () const
bool isContextMenuEnabled () const
bool isSqueezedTextEnabled () const
 KCompletionBase ()
QString originalText () const
void setAutoDeleteCompletionObject (bool autoDelete)
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 setEnableSignals (bool enable)
virtual void setHandleSignals (bool handle)
bool setKeyBinding (KeyBindingType item, const KShortcut &key)
void setSqueezedTextEnabled (bool enable)
void setTrapReturnKey (bool trap)
void setUrl (const KUrl &url)
void setUrlDropsEnabled (bool enable)
bool trapReturnKey () const
bool urlDropsEnabled () const
void useGlobalKeyBindings ()
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 ()
KCompletionBase * delegate () const
virtual void dropEvent (QDropEvent *)
virtual bool event (QEvent *)
virtual void focusInEvent (QFocusEvent *ev)
virtual void focusOutEvent (QFocusEvent *ev)
KeyBindingMap getKeyBindings () const
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 setDelegate (KCompletionBase *delegate)
void setUserSelection (bool userSelection)
virtual void virtual_hook (int id, void *data)

Additional Inherited Members

- Public Types inherited from KLineEdit
typedef QMap< KeyBindingType,
KShortcut > 
KeyBindingMap
enum  KeyBindingType
- Public Types inherited from KCompletionBase
- 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 &)
- Public Attributes inherited from KLineEdit
 NextCompletionMatch
 PrevCompletionMatch
 SubstringCompletion
 TextCompletion
- Public Attributes inherited from KCompletionBase
- 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 ( )
virtualslot

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
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:
sthe 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 23 2013 22:04:43 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDE3Support

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

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal