src/XGUI/XGUI_ColorDialog.h

   1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef XGUI_ColorDialog_H
  21 #define XGUI_ColorDialog_H
  22
  23 #include "XGUI.h"
  24
  25 #include <QDialog>
  26
  27 class QButtonGroup;
  28 class QtxColorButton;
  29
  30 /**
  31 * \ingroup GUI
  32 * A class of dialog to chose a color. The color can be set in two ways: use a random value or
  33 * a certain color. There is a radio button to provide this choice. The color button is
  34 * visualized to select a certain color.
  35 */
  36 class XGUI_ColorDialog : public QDialog
  37 {
  38   Q_OBJECT
  39 public:
  40   /// Constructor
  41   /// \param theParent a parent widget for the dialog
  42   XGUI_EXPORT XGUI_ColorDialog(QWidget* theParent);
  43
  44   XGUI_EXPORT virtual ~XGUI_ColorDialog() {};
  45
  46   /// Returns whether the random state of color is chosen
  47   /// \return a boolean value
  48   bool isRandomColor() const;
  49
  50   /// Initializes the dialog with the given value. Set choice on certain value and fill it by.
  51   /// \param theValue an RGB components value
  52   void setColor(const std::vector<int>& theValue);
  53
  54   /// Returns a container with the current color value.
  55   /// These are tree int values for RGB definition.
  56   /// These value is depend on the random choice and eighter
  57   /// a next random color or a certain color.
  58   /// \return a vector of values
  59   std::vector<int> getColor() const;
  60
  61   /// Returns a container with the current color value.
  62   /// These are tree int values for RGB definition.
  63   /// It returns the next random color.
  64   /// \return a vector of values
  65   std::vector<int> getRandomColor() const;
  66
  67 private:
  68   QButtonGroup* myButtonGroup; /// a group, contained random and certain color radio button choice
  69   QtxColorButton* myColorButton; /// a control to select a color
  70 };
  71
  72 #endif