TreeViewFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_TREEVIEWFILTER_H_
#define _MIRA_TREEVIEWFILTER_H_

#include <QWidget>

#include <widgets/GuiWidgetsExports.h>

class QModelIndex;
class QTreeView;

namespace mira {


class LineEditClear;

class MIRA_GUI_WIDGETS_EXPORT TreeViewFilter : public QWidget
{
    Q_OBJECT
public:

    TreeViewFilter(QTreeView* view, QWidget* parent=NULL);

protected:

    virtual void timerEvent(QTimerEvent*);

public slots:

    void setAutoHide(bool hide);
    void showFilter();
    void hideFilter();

    void useFilterRole(bool use=true);

public:
    enum {
        FilterRole = Qt::UserRole+0x1F
    };

public:

    bool getAutoHide() const;

    void setAlwaysActive(bool always);

    void setExpandAll(bool expandAll);

    void setShowChildren(bool show);

    void setExpandChildren(bool expand);

    void setFilterColumns(const std::vector<int>& cols);
    void setFilterColumns(int col1);
    void setFilterColumns(int col1, int col2);
    void setFilterColumns(int col1, int col2, int col3);

    void clearFilter();

private slots:

    void onFilterTextChanged(const QString& text);

private:

    void autoHide();
    bool applyFilter(const QString& filter, const QModelIndex& parent,
                     bool forceVisible);
    void startFilterUpdateTimer(int delay);

private:

    QTreeView* mTreeView;
    LineEditClear* mFilterEdit;
    int mFilterTimerId;
    int mHideTimerId;

    std::vector<int> mFilterColumns;

    bool mAutoHide;
    bool mAlwaysActive;
    bool mExpandAll;
    bool mShowChildren;
    bool mExpandChildren;
    bool mUseFilterRole;
};


}

#endif