pqDoubleLineEdit.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 pqDoubleLineEdit_h
#define pqDoubleLineEdit_h
 
// Qt Includes.
#include <QScopedPointer> // for ivar
#include <QTextStream>    // for formatDouble
 
// ParaView Includes.
#include "pqLineEdit.h"
#include "pqWidgetsModule.h"
 
#include "vtkParaViewDeprecation.h"
 
class PQWIDGETS_EXPORT pqDoubleLineEdit : public pqLineEdit
{
  Q_OBJECT
  Q_ENUMS(RealNumberNotation)
  Q_PROPERTY(RealNumberNotation notation READ notation WRITE setNotation)
  Q_PROPERTY(int precision READ precision WRITE setPrecision)
  Q_PROPERTY(bool useGlobalPrecisionAndNotation READ useGlobalPrecisionAndNotation WRITE
      setUseGlobalPrecisionAndNotation)
  using Superclass = pqLineEdit;
 
public:
  pqDoubleLineEdit(QWidget* parent = nullptr);
  ~pqDoubleLineEdit() override;
 
  enum RealNumberNotation
  {
    MixedNotation = 0,
    ScientificNotation,
    FixedNotation,
    FullNotation
  };
 
  RealNumberNotation notation() const;
 
  int precision() const;
 
  bool useGlobalPrecisionAndNotation() const;
 
 
  static void setGlobalPrecisionAndNotation(int precision, RealNumberNotation notation);
  static int globalPrecision();
  static RealNumberNotation globalNotation();
 
  QString simplifiedText() const;
 
  PARAVIEW_DEPRECATED_IN_5_12_0(
    "Use `pqDoubleLineEdit::formatDouble(double,pqDoubleLineEdit::RealNumberNotation,int)` instead")
  static QString formatDouble(
    double value, QTextStream::RealNumberNotation notation, int precision);
 
  static QString formatDouble(double value, pqDoubleLineEdit::RealNumberNotation notation,
    int precision, int fullLowExponent = -6, int fullHighExponent = 20);
 
  PARAVIEW_DEPRECATED_IN_5_12_0("Use `pqCoreUtilities::formatNumber()` instead")
  static QString formatDoubleUsingGlobalPrecisionAndNotation(double value);
 
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void setNotation(RealNumberNotation _notation);
 
  void setPrecision(int precision);
 
  void setUseGlobalPrecisionAndNotation(bool value);
 
  PARAVIEW_DEPRECATED_IN_5_12_0(
    "Use `pqDoubleLineEdit::setNotation(pqDoubleLineEdit::FullNotation)` instead")
  void setAlwaysUseFullPrecision(bool value);
 
protected:
  void paintEvent(QPaintEvent* evt) override;
  void resizeEvent(QResizeEvent* event) override;
 
private:
  Q_DISABLE_COPY(pqDoubleLineEdit)
 
  static int GlobalPrecision;
  static RealNumberNotation GlobalNotation;
 
  class pqInternals;
  QScopedPointer<pqInternals> Internals;
};
 
#endif