tdeui
TDEIconViewSearchLine Class Reference
This class makes it easy to add a search line for filtering the items in a iconview based on a simple text search. More...
#include <kiconviewsearchline.h>

Public Slots | |
virtual void | updateSearch (const TQString &s=TQString::null) |
void | setCaseSensitive (bool cs) |
void | setIconView (TQIconView *iv) |
void | clear () |
void | iconDeleted (const TQString &filename) |
Public Member Functions | |
TDEIconViewSearchLine (TQWidget *parent=0, TQIconView *iconView=0, const char *name=0) | |
TDEIconViewSearchLine (TQWidget *parent, const char *name) | |
virtual | ~TDEIconViewSearchLine () |
bool | caseSensitive () const |
TQIconView * | iconView () const |
Protected Slots | |
void | queueSearch (const TQString &s) |
void | activateSearch () |
Protected Member Functions | |
virtual bool | itemMatches (const TQIconViewItem *item, const TQString &s) const |
void | init (TQIconView *iconView=0) |
void | hideItem (TQIconViewItem *item) |
void | showItem (TQIconViewItem *item) |
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 TQIconView should be needed.
- Since:
- 3.3
Definition at line 38 of file kiconviewsearchline.h.
Constructor & Destructor Documentation
TDEIconViewSearchLine::TDEIconViewSearchLine | ( | TQWidget * | parent = 0 , |
|
TQIconView * | iconView = 0 , |
|||
const char * | name = 0 | |||
) |
Constructs a TDEIconViewSearchLine with iconView being the TQIconView 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 kiconviewsearchline.cpp.
TDEIconViewSearchLine::TDEIconViewSearchLine | ( | TQWidget * | parent, | |
const char * | name | |||
) |
Constructs a TDEIconViewSearchLine without any TQIconView to filter.
The TQIconView object has to be set later with setIconView().
Definition at line 66 of file kiconviewsearchline.cpp.
TDEIconViewSearchLine::~TDEIconViewSearchLine | ( | ) | [virtual] |
Destroys the TDEIconViewSearchLine.
Definition at line 73 of file kiconviewsearchline.cpp.
Member Function Documentation
void TDEIconViewSearchLine::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 237 of file kiconviewsearchline.cpp.
bool TDEIconViewSearchLine::caseSensitive | ( | ) | const |
Returns true if the search is case sensitive.
This defaults to false.
- See also:
- setCaseSensitive()
Definition at line 79 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::clear | ( | ) | [virtual, slot] |
Clear line edit and empty hiddenItems, returning elements to iconView.
Reimplemented from KLineEdit.
Definition at line 123 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::hideItem | ( | TQIconViewItem * | item | ) | [protected] |
Hide item.
Definition at line 206 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::iconDeleted | ( | const TQString & | filename | ) | [slot] |
Should be called before updateSearch() whenever an icon is deleted.
Definition at line 143 of file kiconviewsearchline.cpp.
TQIconView * TDEIconViewSearchLine::iconView | ( | ) | const |
Returns the iconview that is currently filtered by the search.
- See also:
- setIconView()
Definition at line 84 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::init | ( | TQIconView * | iconView = 0 |
) | [protected] |
Do initialization common to both constructors.
Definition at line 186 of file kiconviewsearchline.cpp.
bool TDEIconViewSearchLine::itemMatches | ( | const TQIconViewItem * | item, | |
const TQString & | 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 173 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::queueSearch | ( | const TQString & | 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 230 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::setCaseSensitive | ( | bool | cs | ) | [slot] |
Make the search case sensitive or case insensitive.
- See also:
- caseSenstive()
Definition at line 147 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::setIconView | ( | TQIconView * | iv | ) | [slot] |
Sets the TQIconView that is filtered by this search line.
If lv is null then the widget will be disabled.
- See also:
- iconView()
Definition at line 152 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::showItem | ( | TQIconViewItem * | item | ) | [protected] |
Show item.
Just unhide it, doesn't necessary show it on screen, for that use iconView->ensureItemVisible()
Definition at line 214 of file kiconviewsearchline.cpp.
void TDEIconViewSearchLine::updateSearch | ( | const TQString & | s = TQString::null |
) | [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 92 of file kiconviewsearchline.cpp.
The documentation for this class was generated from the following files: