ktreewidgetsearchline.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (c) 2003 Scott Wheeler <wheeler@kde.org>
   Copyright (c) 2005 Rafal Rzepecki <divide@users.sourceforge.net>
   Copyright (c) 2006 Hamish Rodda <rodda@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KTREEWIDGETSEARCHLINE_H
#define KTREEWIDGETSEARCHLINE_H

#include <klineedit.h>

class QModelIndex;
class QTreeWidget;
class QTreeWidgetItem;

class KDEUI_EXPORT KTreeWidgetSearchLine : public KLineEdit
{
    Q_OBJECT

    Q_PROPERTY( Qt::CaseSensitivity caseSensitity READ caseSensitivity WRITE setCaseSensitivity )
    Q_PROPERTY( bool keepParentsVisible READ keepParentsVisible WRITE setKeepParentsVisible )


  public:
    explicit KTreeWidgetSearchLine( QWidget *parent = 0, QTreeWidget *treeWidget = 0 );

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


    virtual ~KTreeWidgetSearchLine();

    Qt::CaseSensitivity caseSensitivity() const;

    QList<int> searchColumns() const;

    bool keepParentsVisible() const;

    QTreeWidget *treeWidget() const;

    QList<QTreeWidget *> treeWidgets() const;

Q_SIGNALS:
    void hiddenChanged(QTreeWidgetItem *, bool);

  public Q_SLOTS:
    void addTreeWidget( QTreeWidget *treeWidget );

    void removeTreeWidget( QTreeWidget *treeWidget );

    virtual void updateSearch( const QString &pattern = QString() );

    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 );


  protected:
    virtual bool itemMatches( const QTreeWidgetItem *item, const QString &pattern ) const;

    virtual void contextMenuEvent( QContextMenuEvent* );

    virtual void updateSearch( QTreeWidget *treeWidget );

    virtual void connectTreeWidget( QTreeWidget* );

    virtual void disconnectTreeWidget( QTreeWidget* );

    virtual bool canChooseColumnsCheck();

    virtual bool event(QEvent *event);
  private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT(d, void _k_rowsInserted(const QModelIndex&, int, int) const)
    Q_PRIVATE_SLOT(d, void _k_treeWidgetDeleted(QObject*))
    Q_PRIVATE_SLOT(d, void _k_slotColumnActivated(QAction*))
    Q_PRIVATE_SLOT(d, void _k_slotAllVisibleColumns())
    Q_PRIVATE_SLOT(d, void _k_queueSearch(const QString&))
    Q_PRIVATE_SLOT(d, void _k_activateSearch())
};

class KDEUI_EXPORT KTreeWidgetSearchLineWidget : public QWidget
{
    Q_OBJECT

  public:
    explicit KTreeWidgetSearchLineWidget( QWidget *parent = 0, QTreeWidget *treeWidget = 0 );

    ~KTreeWidgetSearchLineWidget();

    KTreeWidgetSearchLine *searchLine() const;

  protected Q_SLOTS:
    virtual void createWidgets();

  protected:
    virtual KTreeWidgetSearchLine *createSearchLine( QTreeWidget *treeWidget ) const;

  private:
    class Private;
    Private* const d;
};

#endif