• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeui
 

tdeui

Public Slots | Public Member Functions | Protected Slots | Protected Member Functions

TDEListViewSearchLine Class Reference

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

#include <tdelistviewsearchline.h>

Inheritance diagram for TDEListViewSearchLine:
KLineEdit TQLineEdit TDECompletionBase

List of all members.

Public Slots

virtual void updateSearch (const TQString &s=TQString::null)
void setCaseSensitive (bool cs)
void setKeepParentsVisible (bool v)
void setSearchColumns (const TQValueList< int > &columns)
void setListView (TDEListView *lv)

Public Member Functions

 TDEListViewSearchLine (TQWidget *parent=0, TDEListView *listView=0, const char *name=0)
 TDEListViewSearchLine (TQWidget *parent, const char *name)
virtual ~TDEListViewSearchLine ()
bool caseSensitive () const
TQValueList< int > searchColumns () const
bool keepParentsVisible () const
TDEListView * listView () const

Protected Slots

void queueSearch (const TQString &search)
void activateSearch ()

Protected Member Functions

virtual bool itemMatches (const TQListViewItem *item, const TQString &s) const
virtual TQPopupMenu * createPopupMenu ()

Detailed Description

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

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

If you want the clear button and the search label, you should take a look at the TDEListViewSearchLineWidget

Note:
{ When iterating over items in the TDEListView, make sure that the iterator only includes visible items (for example, by adding TQListViewItemIterator::Visible to the iterator flags). Otherwise, actions (such as deletion) may be taken on items that have been hidden by the search function. }
Since:
3.3

Definition at line 47 of file tdelistviewsearchline.h.


Constructor & Destructor Documentation

TDEListViewSearchLine::TDEListViewSearchLine ( TQWidget *  parent = 0,
TDEListView *  listView = 0,
const char *  name = 0 
)

Constructs a TDEListViewSearchLine with listView being the TDEListView to be filtered.

If listView is null then the widget will be disabled until a listview is set with setListView().

Definition at line 59 of file tdelistviewsearchline.cpp.

TDEListViewSearchLine::TDEListViewSearchLine ( TQWidget *  parent,
const char *  name 
)

Constructs a TDEListViewSearchLine without any TDEListView to filter.

The TDEListView object has to be set later with setListView().

Definition at line 80 of file tdelistviewsearchline.cpp.

TDEListViewSearchLine::~TDEListViewSearchLine (  )  [virtual]

Destroys the TDEListViewSearchLine.

Definition at line 93 of file tdelistviewsearchline.cpp.


Member Function Documentation

void TDEListViewSearchLine::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 list view search.

See also:
queueSearch()

Definition at line 291 of file tdelistviewsearchline.cpp.

bool TDEListViewSearchLine::caseSensitive (  )  const

Returns true if the search is case sensitive.

This defaults to false.

See also:
setCaseSensitive()

Definition at line 98 of file tdelistviewsearchline.cpp.

TQPopupMenu * TDEListViewSearchLine::createPopupMenu (  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See TQLineEdit::mousePressEvent().

Reimplemented from KLineEdit.

Definition at line 234 of file tdelistviewsearchline.cpp.

bool TDEListViewSearchLine::itemMatches ( const TQListViewItem *  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 205 of file tdelistviewsearchline.cpp.

bool TDEListViewSearchLine::keepParentsVisible (  )  const

If this is true (the default) then the parents of matched items will also be shown.

See also:
setKeepParentsVisible()

Definition at line 108 of file tdelistviewsearchline.cpp.

TDEListView * TDEListViewSearchLine::listView (  )  const

Returns the listview that is currently filtered by the search.

See also:
setListView()

Definition at line 113 of file tdelistviewsearchline.cpp.

void TDEListViewSearchLine::queueSearch ( const TQString &  search  )  [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:
search 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 284 of file tdelistviewsearchline.cpp.

TQValueList< int > TDEListViewSearchLine::searchColumns (  )  const

Returns the current list of columns that will be searched.

If the returned list is empty all visible columns will be searched.

See also:
setSearchColumns

Definition at line 103 of file tdelistviewsearchline.cpp.

void TDEListViewSearchLine::setCaseSensitive ( bool  cs  )  [slot]

Make the search case sensitive or case insensitive.

See also:
caseSenstive()

Definition at line 163 of file tdelistviewsearchline.cpp.

void TDEListViewSearchLine::setKeepParentsVisible ( bool  v  )  [slot]

When a search is active on a list that's organized into a tree view if a parent or ancesestor of an item is does not match the search then it will be hidden and as such so too will any children that match.

If this is set to true (the default) then the parents of matching items will be shown.

See also:
keepParentsVisible

Definition at line 168 of file tdelistviewsearchline.cpp.

void TDEListViewSearchLine::setListView ( TDEListView *  lv  )  [slot]

Sets the TDEListView that is filtered by this search line.

If lv is null then the widget will be disabled.

See also:
listView()

Definition at line 178 of file tdelistviewsearchline.cpp.

void TDEListViewSearchLine::setSearchColumns ( const TQValueList< int > &  columns  )  [slot]

Sets the list of columns to be searched.

The default is to search all, visible columns which can be restored by passing columns as an empty list.

See also:
searchColumns

Definition at line 173 of file tdelistviewsearchline.cpp.

void TDEListViewSearchLine::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 122 of file tdelistviewsearchline.cpp.


The documentation for this class was generated from the following files:
  • tdelistviewsearchline.h
  • tdelistviewsearchline.cpp

tdeui

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

tdeui

Skip menu "tdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeui by doxygen 1.7.1
This website is maintained by Timothy Pearson.