pqSearchBox.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#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