pqSearchBox.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:    pqSearchBox.h

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqSearchBox_h
#define pqSearchBox_h

#include "pqComponentsModule.h"
#include <QScopedPointer>
#include <QWidget>

class QSettings;
class PQCOMPONENTS_EXPORT pqSearchBox : public QWidget
{
  Q_OBJECT

  Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged USER true)

  
  Q_PROPERTY(QString placeholderText READ placeholderText WRITE setPlaceholderText)

  Q_PROPERTY(bool advancedSearchActive READ isAdvancedSearchActive WRITE setAdvancedSearchActive
      NOTIFY advancedSearchActivated)

  Q_PROPERTY(bool advancedSearchEnabled READ isAdvancedSearchEnabled WRITE setAdvancedSearchEnabled)

  Q_PROPERTY(QString settingKey READ settingKey WRITE setSettingKey NOTIFY settingKeyChanged)

public:
  typedef QWidget Superclass;

  pqSearchBox(QWidget* parent = nullptr);
  pqSearchBox(
    bool advancedSearchEnabled, const QString& settingKey = "", QWidget* parent = nullptr);

  ~pqSearchBox() override;

  bool isAdvancedSearchActive() const;

  QString text() const;

  QString placeholderText() const;
  void setPlaceholderText(const QString& text);

  QString settingKey() const;

  QSettings* settings() const;

  bool isAdvancedSearchEnabled() const;

Q_SIGNALS:
  void advancedSearchActivated(bool);

  void textChanged(const QString&);

  void settingKeyChanged(const QString&);

public Q_SLOTS:
  void setAdvancedSearchActive(bool use);

  void setText(const QString& text);

  QString setSettingKey(const QString& key);

  void setAdvancedSearchEnabled(bool enable);

protected:
  void keyPressEvent(QKeyEvent* e) override;

protected Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void onAdvancedButtonClicked(bool);
  void updateSettings();
  void updateFromSettings();

private:
  Q_DISABLE_COPY(pqSearchBox)

  class pqInternals;
  friend class pqInternals;

  const QScopedPointer<pqInternals> Internals;
  QString SettingKey;
};

#endif