PCL
ColorComboBox.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/ColorComboBox.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_ColorComboBox_h
53 #define __PCL_ColorComboBox_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 
61 #include <pcl/AutoPointer.h>
62 #include <pcl/Color.h>
63 #include <pcl/ComboBox.h>
64 
65 namespace pcl
66 {
67 
68 // ----------------------------------------------------------------------------
69 
91 class PCL_CLASS ColorComboBox : public ComboBox
92 {
93 public:
94 
102 
106  ~ColorComboBox() override
107  {
108  }
109 
117 
130  void SetCurrentColor( RGBA color );
131 
142  {
143  return m_customColor;
144  }
145 
155  bool HasCustomColor() const
156  {
157  return CustomColor() != 0;
158  }
159 
160  // -------------------------------------------------------------------------
161  // Event handlers
162  //
163  // void OnColorSelected( ColorComboBox& sender, RGBA color );
164  // void OnColorHighlighted( ColorComboBox& sender, RGBA color );
165  // void OnCustomColorDefined( ColorComboBox& sender, RGBA color );
166 
186  using color_event_handler = void (Control::*)( ColorComboBox& sender, RGBA color );
187 
201  void OnColorSelected( color_event_handler handler, Control& receiver );
202 
217  void OnColorHighlighted( color_event_handler handler, Control& receiver );
218 
234 
235 private:
236 
237  struct EventHandlers
238  {
239  color_event_handler onColorSelected = nullptr;
240  Control* onColorSelectedReceiver = nullptr;
241 
242  color_event_handler onColorHighlighted = nullptr;
243  Control* onColorHighlightedReceiver = nullptr;
244 
245  color_event_handler onCustomColorDefined = nullptr;
246  Control* onCustomColorDefinedReceiver = nullptr;
247 
248  EventHandlers() = default;
249  EventHandlers( const EventHandlers& ) = default;
250  EventHandlers& operator =( const EventHandlers& ) = default;
251  };
252 
253  AutoPointer<EventHandlers> m_handlers;
254  RGBA m_customColor;
255 
256  void ItemSelected( ComboBox&, int );
257  void ItemHighlighted( ComboBox&, int );
258 };
259 
260 // ----------------------------------------------------------------------------
261 
262 } // pcl
263 
264 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
265 
266 #endif // __PCL_ColorComboBox_h
267 
268 // ----------------------------------------------------------------------------
269 // EOF pcl/ColorComboBox.h - Released 2024-06-18T15:48:54Z
A ComboBox descendant class to select RGB colors.
Definition: ColorComboBox.h:92
bool HasCustomColor() const
void SetCurrentColor(RGBA color)
ColorComboBox(Control &parent=Control::Null())
RGBA CurrentColor() const
RGBA CustomColor() const
~ColorComboBox() override
Client-side interface to a PixInsight ComboBox control.
Definition: ComboBox.h:77
Client-side interface to a PixInsight Control object.
Definition: Control.h:126
static Control & Null()
void OnColorSelected(color_event_handler handler, Control &receiver)
void(Control::*)(ColorComboBox &sender, RGBA color) color_event_handler
void OnCustomColorDefined(color_event_handler handler, Control &receiver)
void OnColorHighlighted(color_event_handler handler, Control &receiver)
uint32 RGBA
Definition: Color.h:92
PCL root namespace.
Definition: AbstractImage.h:77