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

kdeui

Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KListViewSearchLine Class Reference

#include <klistviewsearchline.h>

Inheritance diagram for KListViewSearchLine:
KLineEdit KCompletionBase

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 (KListView *lv)
 
- Public Slots inherited from KLineEdit
virtual void setReadOnly (bool)
 
void rotateText (KCompletionBase::KeyBindingType type)
 
virtual void setCompletedText (const TQString &)
 
void setCompletedItems (const TQStringList &items)
 
void setCompletedItems (const TQStringList &items, bool autoSuggest)
 
virtual void clear ()
 
void setSqueezedText (const TQString &text)
 
virtual void setText (const TQString &)
 

Public Member Functions

 KListViewSearchLine (TQWidget *parent=0, KListView *listView=0, const char *name=0)
 
 KListViewSearchLine (TQWidget *parent, const char *name)
 
virtual ~KListViewSearchLine ()
 
bool caseSensitive () const
 
TQValueList< int > searchColumns () const
 
bool keepParentsVisible () const
 
KListView * listView () const
 
- Public Member Functions inherited from KLineEdit
 KLineEdit (const TQString &string, TQWidget *parent, const char *name=0)
 
 KLineEdit (TQWidget *parent=0, const char *name=0)
 
virtual ~KLineEdit ()
 
void setURL (const KURL &url)
 
void cursorAtEnd ()
 
virtual void setCompletionMode (KGlobalSettings::Completion mode)
 
virtual void setContextMenuEnabled (bool showMenu)
 
bool isContextMenuEnabled () const
 
void setURLDropsEnabled (bool enable)
 
bool isURLDropsEnabled () const
 
void setTrapReturnKey (bool trap)
 
bool trapReturnKey () const
 
virtual bool eventFilter (TQObject *, TQEvent *)
 
KCompletionBox * completionBox (bool create=true)
 
virtual void setCompletionObject (KCompletion *, bool hsig=true)
 
virtual void copy () const
 
void setEnableSqueezedText (bool enable)
 
bool isSqueezedTextEnabled () const
 
TQString originalText () const
 
void setCompletionBox (KCompletionBox *box)
 
void setClickMessage (const TQString &msg)
 
TQString clickMessage () const
 
- Public Member Functions inherited from KCompletionBase
KCompletion * completionObject (bool hsig=true)
 
virtual void setHandleSignals (bool handle)
 
bool isCompletionObjectAutoDeleted () const
 
void setAutoDeleteCompletionObject (bool autoDelete)
 
void setEnableSignals (bool enable)
 
bool handleSignals () const
 
bool emitSignals () const
 
KGlobalSettings::Completion completionMode () const
 
bool setKeyBinding (KeyBindingType item, const KShortcut &key)
 
const KShortcut & getKeyBinding (KeyBindingType item) const
 
void useGlobalKeyBindings ()
 
virtual void setCompletedText (const TQString &text)=0
 
virtual void setCompletedItems (const TQStringList &items)=0
 
KCompletion * compObj () const
 

Protected Slots

void queueSearch (const TQString &search)
 
void activateSearch ()
 
- Protected Slots inherited from KLineEdit
virtual void makeCompletion (const TQString &)
 
void slotAboutToShow ()
 
void slotCancelled ()
 
void userCancelled (const TQString &cancelText)
 

Protected Member Functions

virtual bool itemMatches (const TQListViewItem *item, const TQString &s) const
 
virtual TQPopupMenu * createPopupMenu ()
 
- Protected Member Functions inherited from KLineEdit
virtual void resizeEvent (TQResizeEvent *)
 
virtual void keyPressEvent (TQKeyEvent *)
 
virtual void mousePressEvent (TQMouseEvent *)
 
virtual void mouseDoubleClickEvent (TQMouseEvent *)
 
virtual void mouseReleaseEvent (TQMouseEvent *)
 
virtual void contextMenuEvent (TQContextMenuEvent *)
 
virtual void drawContents (TQPainter *p)
 
virtual void dropEvent (TQDropEvent *)
 
virtual void setCompletedText (const TQString &, bool)
 
void setUserSelection (bool userSelection)
 
virtual void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 
virtual void focusInEvent (TQFocusEvent *)
 
virtual void focusOutEvent (TQFocusEvent *)
 
bool autoSuggest () const
 
virtual void virtual_hook (int id, void *data)
 
- Protected Member Functions inherited from KCompletionBase
KeyBindingMap getKeyBindings () const
 
void setDelegate (KCompletionBase *delegate)
 
KCompletionBase * delegate () const
 

Additional Inherited Members

- Public Types inherited from KCompletionBase
enum  KeyBindingType
 
- Signals inherited from KLineEdit
void completionBoxActivated (const TQString &)
 
void returnPressed (const TQString &)
 
void completion (const TQString &)
 
void substringCompletion (const TQString &)
 
void textRotation (KCompletionBase::KeyBindingType)
 
void completionModeChanged (KGlobalSettings::Completion)
 
void aboutToShowContextMenu (TQPopupMenu *p)
 
- Public Attributes inherited from KCompletionBase
 TextCompletion
 
 PrevCompletionMatch
 
 NextCompletionMatch
 
 SubstringCompletion
 
- Properties inherited from KLineEdit
bool contextMenuEnabled
 
bool urlDropsEnabled
 
bool trapEnterKeyEvent
 
bool enableSqueezedText
 
TQString clickMessage
 

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 KListView should be needed.

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

Note
{ When iterating over items in the KListView, 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 klistviewsearchline.h.

Constructor & Destructor Documentation

◆ KListViewSearchLine() [1/2]

KListViewSearchLine::KListViewSearchLine ( TQWidget *  parent = 0,
KListView *  listView = 0,
const char *  name = 0 
)

Constructs a KListViewSearchLine with listView being the KListView 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 klistviewsearchline.cpp.

◆ KListViewSearchLine() [2/2]

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

Constructs a KListViewSearchLine without any KListView to filter.

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

Definition at line 80 of file klistviewsearchline.cpp.

◆ ~KListViewSearchLine()

KListViewSearchLine::~KListViewSearchLine ( )
virtual

Destroys the KListViewSearchLine.

Definition at line 93 of file klistviewsearchline.cpp.

Member Function Documentation

◆ activateSearch

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

See also
queueSearch()

Definition at line 291 of file klistviewsearchline.cpp.

◆ caseSensitive()

bool KListViewSearchLine::caseSensitive ( ) const

Returns true if the search is case sensitive.

This defaults to false.

See also
setCaseSensitive()

Definition at line 98 of file klistviewsearchline.cpp.

◆ createPopupMenu()

TQPopupMenu * KListViewSearchLine::createPopupMenu ( )
protectedvirtual

Re-implemented for internal reasons.

API not affected.

See TQLineEdit::mousePressEvent().

Reimplemented from KLineEdit.

Definition at line 234 of file klistviewsearchline.cpp.

◆ itemMatches()

bool KListViewSearchLine::itemMatches ( const TQListViewItem *  item,
const TQString &  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 205 of file klistviewsearchline.cpp.

◆ keepParentsVisible()

bool KListViewSearchLine::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 klistviewsearchline.cpp.

◆ listView()

KListView * KListViewSearchLine::listView ( ) const

Returns the listview that is currently filtered by the search.

See also
setListView()

Definition at line 113 of file klistviewsearchline.cpp.

◆ queueSearch

void KListViewSearchLine::queueSearch ( const TQString &  search)
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
searchthe 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 klistviewsearchline.cpp.

◆ searchColumns()

TQValueList< int > KListViewSearchLine::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 klistviewsearchline.cpp.

◆ setCaseSensitive

void KListViewSearchLine::setCaseSensitive ( bool  cs)
slot

Make the search case sensitive or case insensitive.

See also
caseSenstive()

Definition at line 163 of file klistviewsearchline.cpp.

◆ setKeepParentsVisible

void KListViewSearchLine::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 klistviewsearchline.cpp.

◆ setListView

void KListViewSearchLine::setListView ( KListView *  lv)
slot

Sets the KListView 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 klistviewsearchline.cpp.

◆ setSearchColumns

void KListViewSearchLine::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 klistviewsearchline.cpp.

◆ updateSearch

void KListViewSearchLine::updateSearch ( const TQString &  s = TQString::null)
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 122 of file klistviewsearchline.cpp.


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

kdeui

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

kdeui

Skip menu "kdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdeui by doxygen 1.9.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |