CTK/Libs/Widgets/ctkSearchBox.h

/*=========================================================================

  Library:   CTK

  Copyright (c) Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0.txt

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=========================================================================*/

#ifndef __ctkSearchBox_h
#define __ctkSearchBox_h

// QT includes
#include <QIcon>
#include <QLineEdit>

// CTK includes
#include "ctkWidgetsExport.h"

class ctkSearchBoxPrivate;

/// \ingroup Widgets
/// QLineEdit with two QIcons on each side: search and clear.
/// "Search" selects all the text
/// "Clear" clears the current text
/// See QLineEdit::text to set/get the current text.
/// ctkSearchBox's purpose is to be used to filter other widgets.
/// e.g.:
/// <code>
///  ctkSearchBox searchBox;
///  QSortFilterProxyModel filterModel;
///  QObject::connect(&searchBox, SIGNAL(textChanged(QString)),
///                   &filterModel, SLOT(setFilterFixedString(QString)));
///  ...
/// </code>
class CTK_WIDGETS_EXPORT ctkSearchBox : public QLineEdit
{
  Q_OBJECT
#if QT_VERSION < 0x040700
  /// Qt < 4.7 don't have a placeholderText property, as we need it, we define it
  /// manually.
  Q_PROPERTY(QString placeholderText READ placeholderText WRITE setPlaceholderText)
#endif
  /// Show an icon at left side of the line edit, indicating that the text
  /// field is used to search/filter something. The default is <code>false</code>.
  Q_PROPERTY(bool showSearchIcon READ showSearchIcon WRITE setShowSearchIcon)

  /// The QIcon to use for the search icon at the left. The default is a
  /// magnifying glass icon.
  Q_PROPERTY(QIcon searchIcon READ searchIcon WRITE setSearchIcon)
  /// The QIcon to use for the clear icon. The default is a round grey button
  /// with a white cross.
  Q_PROPERTY(QIcon clearIcon READ clearIcon WRITE setClearIcon)

public:
  /// Superclass typedef
  typedef QLineEdit Superclass;

  ctkSearchBox(QWidget *parent = 0);
  virtual ~ctkSearchBox();

#if QT_VERSION < 0x040700
  QString placeholderText()const;
  void setPlaceholderText(const QString& defaultText);
#endif
  /// False by default
  void setShowSearchIcon(bool show);
  bool showSearchIcon()const;

  /// False by default
  void setAlwaysShowClearIcon(bool show);
  bool alwaysShowClearIcon()const;

  /// Set the search icon.
  void setSearchIcon(const QIcon& icon);
  /// Get the current search icon.
  QIcon searchIcon()const;

  /// Set the clear icon.
  void setClearIcon(const QIcon& icon);
  /// Get the current clear icon.
  QIcon clearIcon()const;

protected Q_SLOTS:
  /// Change the clear icon's state to enabled or disabled.
  void updateClearButtonState();

protected:
  virtual void paintEvent(QPaintEvent*);
  virtual void mousePressEvent(QMouseEvent* event);
  virtual void mouseMoveEvent(QMouseEvent *event);
  virtual void resizeEvent(QResizeEvent * event);

  QScopedPointer<ctkSearchBoxPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(ctkSearchBox);
  Q_DISABLE_COPY(ctkSearchBox);
};
#endif // __ctkSearchBox_h