src/filterbar.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
   3  *   Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net>          *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  19  ***************************************************************************/
  20 #ifndef FILTERBAR_H
  21 #define FILTERBAR_H
  22
  23 #include <QtGui/QWidget>
  24
  25 class QLabel;
  26 class QToolButton;
  27 class KLineEdit;
  28
  29 /**
  30  * @brief Provides an input field for filtering the currently shown items.
  31  *
  32  * @author Gregor Kališnik <gregor@podnapisi.net>
  33  * @author Peter Penz <peter.penz@gmx.at>
  34  */
  35 class FilterBar : public QWidget
  36 {
  37     Q_OBJECT
  38
  39 public:
  40     FilterBar(QWidget* parent = 0);
  41     virtual ~FilterBar();
  42
  43 public slots:
  44     /** Clears the input field. */
  45     void clear();
  46
  47 signals:
  48     /**
  49      * Signal that reports the name filter has been
  50      * changed to \a nameFilter.
  51      */
  52     void filterChanged(const QString& nameFilter);
  53
  54     /**
  55      * Emitted as soon as the filterbar should get closed.
  56      */
  57     void closeRequest();
  58
  59 protected:
  60     virtual void showEvent(QShowEvent* event);
  61     virtual void keyReleaseEvent(QKeyEvent* event);
  62
  63 private:
  64     QLabel* m_filter;
  65     KLineEdit* m_filterInput;
  66     QToolButton* m_close;
  67 };
  68
  69 #endif