Search for usage in LXR

#include <KTreeWidgetSearchLine>

Inheritance diagram for KTreeWidgetSearchLine:


Qt::CaseSensitivity caseSensitity
QString clickMessage
bool keepParentsVisible
- Properties inherited from QLineEdit
- Properties inherited from QWidget
- Properties inherited from QObject


void hiddenChanged (QTreeWidgetItem *, bool)
void searchUpdated (const QString &searchString)

Public Slots

void addTreeWidget (QTreeWidget *treeWidget)
void removeTreeWidget (QTreeWidget *treeWidget)
void setCaseSensitivity (Qt::CaseSensitivity caseSensitivity)
void setKeepParentsVisible (bool value)
void setSearchColumns (const QList< int > &columns)
void setTreeWidget (QTreeWidget *treeWidget)
void setTreeWidgets (const QList< QTreeWidget * > &treeWidgets)
virtual void updateSearch (const QString &pattern=QString())

Public Member Functions

 KTreeWidgetSearchLine (QWidget *parent, const QList< QTreeWidget * > &treeWidgets)
 KTreeWidgetSearchLine (QWidget *parent=nullptr, QTreeWidget *treeWidget=nullptr)
 ~KTreeWidgetSearchLine () override
Qt::CaseSensitivity caseSensitivity () const
QString clickMessage () const
bool keepParentsVisible () const
QList< int > searchColumns () const
void setClickMessage (const QString &msg)
QTreeWidgettreeWidget () const
QList< QTreeWidget * > treeWidgets () const
- Public Member Functions inherited from QLineEdit
 QLineEdit (const QString &contents, QWidget *parent)
 QLineEdit (QWidget *parent)
QActionaddAction (const QIcon &icon, QLineEdit::ActionPosition position)
void addAction (QAction *action, QLineEdit::ActionPosition position)
Qt::Alignment alignment () const const
void backspace ()
void clear ()
QCompletercompleter () const const
void copy () const const
QMenucreateStandardContextMenu ()
void cursorBackward (bool mark, int steps)
void cursorForward (bool mark, int steps)
Qt::CursorMoveStyle cursorMoveStyle () const const
int cursorPosition () const const
int cursorPositionAt (const QPoint &pos)
void cursorPositionChanged (int oldPos, int newPos)
void cursorWordBackward (bool mark)
void cursorWordForward (bool mark)
void cut ()
void del ()
void deselect ()
QString displayText () const const
bool dragEnabled () const const
QLineEdit::EchoMode echoMode () const const
void editingFinished ()
void end (bool mark)
void getTextMargins (int *left, int *top, int *right, int *bottom) const const
bool hasAcceptableInput () const const
bool hasFrame () const const
bool hasSelectedText () const const
void home (bool mark)
QString inputMask () const const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery property) const const override
void inputRejected ()
void insert (const QString &newText)
bool isClearButtonEnabled () const const
bool isModified () const const
bool isReadOnly () const const
bool isRedoAvailable () const const
bool isUndoAvailable () const const
int maxLength () const const
virtual QSize minimumSizeHint () const const override
void paste ()
QString placeholderText () const const
void redo ()
void returnPressed ()
void selectAll ()
QString selectedText () const const
void selectionChanged ()
int selectionEnd () const const
int selectionLength () const const
int selectionStart () const const
void setAlignment (Qt::Alignment flag)
void setClearButtonEnabled (bool enable)
void setCompleter (QCompleter *c)
void setCursorMoveStyle (Qt::CursorMoveStyle style)
void setCursorPosition (int)
void setDragEnabled (bool b)
void setEchoMode (QLineEdit::EchoMode)
void setFrame (bool)
void setInputMask (const QString &inputMask)
void setMaxLength (int)
void setModified (bool)
void setPlaceholderText (const QString &)
void setReadOnly (bool)
void setSelection (int start, int length)
void setText (const QString &)
void setTextMargins (const QMargins &margins)
void setTextMargins (int left, int top, int right, int bottom)
void setValidator (const QValidator *v)
virtual QSize sizeHint () const const override
QString text () const const
void textChanged (const QString &text)
void textEdited (const QString &text)
QMargins textMargins () const const
void undo ()
const QValidatorvalidator () const const
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
bool acceptDrops () const const
QString accessibleDescription () const const
QString accessibleName () const const
QList< QAction * > actions () const const
void activateWindow ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (const QPoint &p) const const
QWidgetchildAt (int x, int y) const const
QRect childrenRect () const const
QRegion childrenRegion () const const
void clearFocus ()
void clearMask ()
bool close ()
QMargins contentsMargins () const const
QRect contentsRect () const const
Qt::ContextMenuPolicy contextMenuPolicy () const const
QCursor cursor () const const
void customContextMenuRequested (const QPoint &pos)
WId effectiveWinId () const const
void ensurePolished () const const
Qt::FocusPolicy focusPolicy () const const
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
QPixmap grab (const QRect &rectangle)
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () const const
bool hasEditFocus () const const
bool hasFocus () const const
virtual bool hasHeightForWidth () const const
bool hasMouseTracking () const const
bool hasTabletTracking () const const
int height () const const
virtual int heightForWidth (int w) const const
void hide ()
Qt::InputMethodHints inputMethodHints () const const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const const
bool isAncestorOf (const QWidget *child) const const
bool isEnabled () const const
bool isEnabledTo (const QWidget *ancestor) const const
bool isEnabledToTLW () const const
bool isFullScreen () const const
bool isHidden () const const
bool isMaximized () const const
bool isMinimized () const const
bool isModal () const const
bool isTopLevel () const const
bool isVisible () const const
bool isVisibleTo (const QWidget *ancestor) const const
bool isWindow () const const
bool isWindowModified () const const
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &pos) const const
QRegion mask () const const
int maximumHeight () const const
QSize maximumSize () const const
int maximumWidth () const const
int minimumHeight () const const
QSize minimumSize () const const
int minimumWidth () const const
void move (const QPoint &)
void move (int x, int y)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
void raise ()
QRect rect () const const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void repaint (int x, int y, int w, int h)
void resize (const QSize &)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () const const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &r)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool on)
void setAutoFillBackground (bool enabled)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &)
void setDisabled (bool disable)
void setEditFocus (bool enable)
void setEnabled (bool)
void setFixedHeight (int h)
void setFixedSize (const QSize &s)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus ()
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *w)
void setFont (const QFont &)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setHidden (bool hidden)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags f)
void setShortcutAutoRepeat (int id, bool enable)
void setShortcutEnabled (int id, bool enable)
void setSizeIncrement (const QSize &)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &)
void setStyle (QStyle *style)
void setStyleSheet (const QString &styleSheet)
void setTabletTracking (bool enable)
void setToolTip (const QString &)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setupUi (QWidget *widget)
virtual void setVisible (bool visible)
void setWhatsThis (const QString &)
void setWindowFilePath (const QString &filePath)
void setWindowFlag (Qt::WindowType flag, bool on)
void setWindowFlags (Qt::WindowFlags type)
void setWindowIcon (const QIcon &icon)
void setWindowIconText (const QString &)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowModified (bool)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
void setWindowTitle (const QString &)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
QSize size () const const
QSize sizeIncrement () const const
QSizePolicy sizePolicy () const const
void stackUnder (QWidget *w)
QString statusTip () const const
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update ()
void update (const QRect &rect)
void update (const QRegion &rgn)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () const const
QIcon windowIcon () const const
void windowIconChanged (const QIcon &icon)
QString windowIconText () const const
void windowIconTextChanged (const QString &iconText)
Qt::WindowModality windowModality () const const
qreal windowOpacity () const const
QString windowRole () const const
Qt::WindowStates windowState () const const
QString windowTitle () const const
void windowTitleChanged (const QString &title)
Qt::WindowType windowType () const const
WId winId () const const
int x () const const
int y () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int devicePixelRatio () const const
qreal devicePixelRatioF () const const
int height () const const
int heightMM () const const
int logicalDpiX () const const
int logicalDpiY () const const
bool paintingActive () const const
int physicalDpiX () const const
int physicalDpiY () const const
int width () const const
int widthMM () const const

Protected Member Functions

virtual bool canChooseColumnsCheck ()
virtual void connectTreeWidget (QTreeWidget *)
void contextMenuEvent (QContextMenuEvent *) override
virtual void disconnectTreeWidget (QTreeWidget *)
bool event (QEvent *event) override
virtual bool itemMatches (const QTreeWidgetItem *item, const QString &pattern) const
virtual void updateSearch (QTreeWidget *treeWidget)
- Protected Member Functions inherited from QLineEdit
virtual void changeEvent (QEvent *ev) override
QRect cursorRect () const const
virtual void dragEnterEvent (QDragEnterEvent *e) override
virtual void dragLeaveEvent (QDragLeaveEvent *e) override
virtual void dragMoveEvent (QDragMoveEvent *e) override
virtual void dropEvent (QDropEvent *e) override
virtual void focusInEvent (QFocusEvent *e) override
virtual void focusOutEvent (QFocusEvent *e) override
void initStyleOption (QStyleOptionFrame *option) const const
virtual void inputMethodEvent (QInputMethodEvent *e) override
virtual void keyPressEvent (QKeyEvent *event) override
virtual void mouseDoubleClickEvent (QMouseEvent *e) override
virtual void mouseMoveEvent (QMouseEvent *e) override
virtual void mousePressEvent (QMouseEvent *e) override
virtual void mouseReleaseEvent (QMouseEvent *e) override
virtual void paintEvent (QPaintEvent *) override
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void closeEvent (QCloseEvent *event)
void create (WId window, bool initializeWindow, bool destroyOldWindow)
void destroy (bool destroyWindow, bool destroySubWindows)
virtual void enterEvent (QEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
bool focusPreviousChild ()
virtual void hideEvent (QHideEvent *event)
virtual void initPainter (QPainter *painter) const const override
virtual void keyReleaseEvent (QKeyEvent *event)
virtual void leaveEvent (QEvent *event)
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
virtual void wheelEvent (QWheelEvent *event)
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Additional Inherited Members

- Public Types inherited from QLineEdit
enum  ActionPosition
enum  EchoMode
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
- Public Attributes inherited from QLineEdit
- Public Attributes inherited from QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice

Detailed Description

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

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

Definition at line 31 of file ktreewidgetsearchline.h.

Constructor & Destructor Documentation

◆ KTreeWidgetSearchLine() [1/2]

KTreeWidgetSearchLine::KTreeWidgetSearchLine ( QWidget parent = nullptr,
QTreeWidget treeWidget = nullptr 

Constructs a KTreeWidgetSearchLine with treeWidget being the QTreeWidget to be filtered.

If treeWidget is null then the widget will be disabled until listviews are set with setTreeWidget(), setTreeWidgets() or added with addTreeWidget().

Definition at line 205 of file ktreewidgetsearchline.cpp.

◆ KTreeWidgetSearchLine() [2/2]

KTreeWidgetSearchLine::KTreeWidgetSearchLine ( QWidget parent,
const QList< QTreeWidget * > &  treeWidgets 

Constructs a KTreeWidgetSearchLine with treeWidgets being the list of pointers to QTreeWidgets to be filtered.

If treeWidgets is empty then the widget will be disabled until listviews are set with setTreeWidget(), setTreeWidgets() or added with addTreeWidget().

Definition at line 220 of file ktreewidgetsearchline.cpp.

◆ ~KTreeWidgetSearchLine()

KTreeWidgetSearchLine::~KTreeWidgetSearchLine ( )

Destroys the KTreeWidgetSearchLine.

Member Function Documentation

◆ addTreeWidget

void KTreeWidgetSearchLine::addTreeWidget ( QTreeWidget treeWidget)

Adds a QTreeWidget to the list of listviews filtered by this search line.

If treeWidget is null then the widget will be disabled.

See also
treeWidget(), setTreeWidgets(), removeTreeWidget()

Definition at line 269 of file ktreewidgetsearchline.cpp.

◆ canChooseColumnsCheck()

bool KTreeWidgetSearchLine::canChooseColumnsCheck ( )

Checks columns in all listviews and decides whether choosing columns to filter on makes any sense.

Returns false if either of the following is true:

  • there are no listviews connected,
  • the listviews have different numbers of columns,
  • the listviews have only one column,
  • the listviews differ in column labels.

Otherwise it returns true.

See also

Definition at line 478 of file ktreewidgetsearchline.cpp.

◆ caseSensitivity()

Qt::CaseSensitivity KTreeWidgetSearchLine::caseSensitivity ( ) const

Returns true if the search is case sensitive.

This defaults to false.

See also

Definition at line 232 of file ktreewidgetsearchline.cpp.

◆ clickMessage()

QString KTreeWidgetSearchLine::clickMessage ( ) const
the message set with setClickMessage
since 5.0, use QLineEdit::placeholderText() instead.

Definition at line 110 of file ktreewidgetsearchline.h.

◆ connectTreeWidget()

void KTreeWidgetSearchLine::connectTreeWidget ( QTreeWidget treeWidget)

Connects signals of this listview to the appropriate slots of the search line.

Definition at line 464 of file ktreewidgetsearchline.cpp.

◆ contextMenuEvent()

void KTreeWidgetSearchLine::contextMenuEvent ( QContextMenuEvent event)

Re-implemented for internal reasons.

API not affected.

Reimplemented from QLineEdit.

Definition at line 411 of file ktreewidgetsearchline.cpp.

◆ disconnectTreeWidget()

void KTreeWidgetSearchLine::disconnectTreeWidget ( QTreeWidget treeWidget)

Disconnects signals of a listviews from the search line.

Definition at line 471 of file ktreewidgetsearchline.cpp.

◆ event()

bool KTreeWidgetSearchLine::event ( QEvent event)

Re-implemented for internal reasons.

API not affected.

Reimplemented from QLineEdit.

Definition at line 523 of file ktreewidgetsearchline.cpp.

◆ hiddenChanged

void KTreeWidgetSearchLine::hiddenChanged ( QTreeWidgetItem ,

This signal is emitted whenever an item gets hidden or unhidden due to it not matching or matching the search string.

◆ itemMatches()

bool KTreeWidgetSearchLine::itemMatches ( const QTreeWidgetItem item,
const QString pattern 
) const

Returns true if item matches the search pattern.

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 382 of file ktreewidgetsearchline.cpp.

◆ keepParentsVisible()

bool KTreeWidgetSearchLine::keepParentsVisible ( ) const

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

See also

◆ removeTreeWidget

void KTreeWidgetSearchLine::removeTreeWidget ( QTreeWidget treeWidget)

Removes a QTreeWidget from the list of listviews filtered by this search line.

Does nothing if treeWidget is 0 or is not filtered by the quick search line.

See also
listVew(), setTreeWidgets(), addTreeWidget()

Definition at line 281 of file ktreewidgetsearchline.cpp.

◆ searchColumns()

QList< int > KTreeWidgetSearchLine::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

Definition at line 237 of file ktreewidgetsearchline.cpp.

◆ searchUpdated

void KTreeWidgetSearchLine::searchUpdated ( const QString searchString)

This signal is emitted when user finished entering filter text or when he made a pause long enough, after the QTreeWidget items got filtered.

searchStringis the text currently entered by the user

◆ setCaseSensitivity

void KTreeWidgetSearchLine::setCaseSensitivity ( Qt::CaseSensitivity  caseSensitivity)

Make the search case sensitive or case insensitive.

See also

Definition at line 332 of file ktreewidgetsearchline.cpp.

◆ setClickMessage()

void KTreeWidgetSearchLine::setClickMessage ( const QString msg)

This makes the line edit display a grayed-out hinting text as long as the user didn't enter any text.

It is often used as indication about the purpose of the line edit.

since 5.0, use QLineEdit::setPlaceholderText() instead.

Definition at line 124 of file ktreewidgetsearchline.h.

◆ setKeepParentsVisible

void KTreeWidgetSearchLine::setKeepParentsVisible ( bool  value)

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.

setKeepParentsVisible(true) does not have the expected effect on items being added to or removed from the view while a search is active. When a new search starts afterwards the behavior will be normal.
See also

Definition at line 340 of file ktreewidgetsearchline.cpp.

◆ setSearchColumns

void KTreeWidgetSearchLine::setSearchColumns ( const QList< int > &  columns)

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. If listviews to be filtered have different numbers or labels of columns this method has no effect.

See also

Definition at line 348 of file ktreewidgetsearchline.cpp.

◆ setTreeWidget

void KTreeWidgetSearchLine::setTreeWidget ( QTreeWidget treeWidget)

Sets the QTreeWidget that is filtered by this search line, replacing any previously filtered listviews.

If treeWidget is null then the widget will be disabled.

See also
treeWidget(), setTreeWidgets()

Definition at line 355 of file ktreewidgetsearchline.cpp.

◆ setTreeWidgets

void KTreeWidgetSearchLine::setTreeWidgets ( const QList< QTreeWidget * > &  treeWidgets)

Sets QTreeWidgets that are filtered by this search line, replacing any previously filtered listviews.

If treeWidgets is empty then the widget will be disabled.

See also
treeWidgets(), addTreeWidget(), setTreeWidget()

Definition at line 361 of file ktreewidgetsearchline.cpp.

◆ treeWidget()

QTreeWidget * KTreeWidgetSearchLine::treeWidget ( ) const

Returns the listview that is currently filtered by the search.

If there are multiple listviews filtered, it returns 0.

See also
setTreeWidget(), treeWidgets()

Definition at line 251 of file ktreewidgetsearchline.cpp.

◆ treeWidgets()

QList< QTreeWidget * > KTreeWidgetSearchLine::treeWidgets ( ) const

Returns the list of pointers to listviews that are currently filtered by the search.

See also
setTreeWidgets(), addTreeWidget(), treeWidget()

Definition at line 260 of file ktreewidgetsearchline.cpp.

◆ updateSearch [1/2]

void KTreeWidgetSearchLine::updateSearch ( const QString pattern = QString())

Updates search to only make visible the items that match pattern.

If s is null then the line edit's text will be used.

Definition at line 297 of file ktreewidgetsearchline.cpp.

◆ updateSearch() [2/2]

void KTreeWidgetSearchLine::updateSearch ( QTreeWidget treeWidget)

Updates search to only make visible appropriate items in treeWidget.

If treeWidget is null then nothing is done.

Definition at line 306 of file ktreewidgetsearchline.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Dec 6 2023 04:03:27 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.