PCL
ColorDialog.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/ColorDialog.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_ColorDialog_h
53 #define __PCL_ColorDialog_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/Color.h>
60 #include <pcl/Dialog.h>
61 #include <pcl/NumericControl.h>
62 #include <pcl/PushButton.h>
63 
64 namespace pcl
65 {
66 
67 // ----------------------------------------------------------------------------
68 
69 /*
70  * ### TODO: Implement a fully-functional color dialog box in PCL.
71  */
72 
73 // ----------------------------------------------------------------------------
74 
75 class PCL_INTERNAL SimpleColorDialogPrivate;
76 
89 class PCL_CLASS SimpleColorDialog : public Dialog
90 {
91 public:
92 
93  enum
94  {
95  AlphaEnabled = 0x0080,
96  Grayscale = 0x0020
97  };
98 
117  SimpleColorDialog( RGBA* color = nullptr, uint32 flags = 0 );
118 
123  {
124  }
125 
133  void SetColor( RGBA color );
134 
142  RGBA Color() const
143  {
144  return m_workingColor;
145  }
146 
151  bool IsAlphaEnabled() const
152  {
153  return (m_flags & AlphaEnabled) != 0;
154  }
155 
160  bool IsGrayscale() const
161  {
162  return (m_flags & Grayscale) != 0;
163  }
164 
165 protected:
166 
167  RGBA* m_color;
168  RGBA m_workingColor;
169  uint32 m_flags;
170 
171  VerticalSizer Global_Sizer;
172  HorizontalSizer Color_Sizer;
173  VerticalSizer Sliders_Sizer;
174  NumericControl V0_NumericControl;
175  NumericControl V1_NumericControl;
176  NumericControl V2_NumericControl;
177  NumericControl V3_NumericControl;
178  Control ColorSample_Control;
179  HorizontalSizer Buttons_Sizer;
180  PushButton OK_PushButton;
181  PushButton Cancel_PushButton;
182 
183  void Color_ValueUpdated( NumericEdit& sender, double value );
184  void ColorSample_Paint( Control& sender, const Rect& updateRect );
185  void Done_Click( Button& sender, bool checked );
186  void Dialog_Return( Dialog& sender, int retVal );
187 };
188 
189 // ----------------------------------------------------------------------------
190 
191 } // pcl
192 
193 #endif // __PCL_ColorDialog_h
194 
195 // ----------------------------------------------------------------------------
196 // EOF pcl/ColorDialog.h - Released 2024-06-18T15:48:54Z
Abstract base class for all client-side interfaces to PixInsight button controls.
Definition: Button.h:100
Client-side interface to a PixInsight Control object.
Definition: Control.h:126
Client-side interface to a PixInsight modal dialog.
Definition: Dialog.h:97
A generic rectangle in the two-dimensional space.
Definition: Rectangle.h:314
Client-side interface to a PixInsight horizontal sizer.
Definition: Sizer.h:580
A label/edit/slider compound control to edit numeric parameters.
A label/edit compound control to edit numeric parameters.
Client-side interface to a PixInsight PushButton control.
Definition: PushButton.h:75
A simple color selection dialog.
Definition: ColorDialog.h:90
bool IsGrayscale() const
Definition: ColorDialog.h:160
SimpleColorDialog(RGBA *color=nullptr, uint32 flags=0)
~SimpleColorDialog() override
Definition: ColorDialog.h:122
bool IsAlphaEnabled() const
Definition: ColorDialog.h:151
void SetColor(RGBA color)
Client-side interface to a PixInsight vertical sizer.
Definition: Sizer.h:612
unsigned int uint32
Definition: Defs.h:666
uint32 RGBA
Definition: Color.h:92
PCL root namespace.
Definition: AbstractImage.h:77