// ____ ______ __ // / __ \ / ____// / // / /_/ // / / / // / ____// /___ / /___ PixInsight Class Library // /_/ \____//_____/ PCL 2.4.23 // ---------------------------------------------------------------------------- // pcl/ColorComboBox.h - Released 2022-03-12T18:59:29Z // ---------------------------------------------------------------------------- // This file is part of the PixInsight Class Library (PCL). // PCL is a multiplatform C++ framework for development of PixInsight modules. // // Copyright (c) 2003-2022 Pleiades Astrophoto S.L. All Rights Reserved. // // Redistribution and use in both source and binary forms, with or without // modification, is permitted provided that the following conditions are met: // // 1. All redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // // 2. All redistributions in binary form must reproduce the above copyright // notice, this list of conditions and the following disclaimer in the // documentation and/or other materials provided with the distribution. // // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names // of their contributors, may be used to endorse or promote products derived // from this software without specific prior written permission. For written // permission, please contact info@pixinsight.com. // // 4. All products derived from this software, in any form whatsoever, must // reproduce the following acknowledgment in the end-user documentation // and/or other materials provided with the product: // // "This product is based on software from the PixInsight project, developed // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)." // // Alternatively, if that is where third-party acknowledgments normally // appear, this acknowledgment must be reproduced in the product itself. // // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE, // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE // POSSIBILITY OF SUCH DAMAGE. // ---------------------------------------------------------------------------- #ifndef __PCL_ColorComboBox_h #define __PCL_ColorComboBox_h /// \file pcl/ColorComboBox.h #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION #include #include #include #include namespace pcl { // ---------------------------------------------------------------------------- /*! * \class ColorComboBox * \brief A %ComboBox descendant class to select RGB colors. * * %ColorComboBox is a utility class that provides a simple list with the full * set of CSS3 standard colors. This includes 143 %ComboBox items that are * automatically shared by all existing %ColorComboBox instances. Thanks to * this implicit sharing mechanism, a module can define a large number of * %ColorComboBox controls without consuming too much resources on any * supported platform. * * The list of items corresponding to CSS3 colors is sorted by \e hue value (in * the HSV or HSI color ordering systems). This makes it much easier the task * of selecting colors since similar hues are grouped visually. * * In addition to CSS3 standard colors, a single custom color item can be * defined for a %ColorComboBox object. The custom color item is automatically * managed by %ColorComboBox and appended to the end of standard items. * * \sa pcl/Color.h, ComboBox */ class PCL_CLASS ColorComboBox : public ComboBox { public: /*! * Constructs a %ColorComboBox as a child control of \a parent. * * A standard set of %ComboBox items is created for the full set of CSS3 * colors. This includes 143 color items. */ ColorComboBox( Control& parent = Control::Null() ); /*! * Destroys a %ColorComboBox control. */ virtual ~ColorComboBox() { } /*! * Returns the RGB color value that corresponds to the currently selected * %ComboBox item, or zero if no item is currently selected. * * \sa SetCurrentColor(), CustomColor(), HasCustomColor() */ RGBA CurrentColor() const; /*! * Selects a %ComboBox item corresponding to the specified \a color. * * If the specified \a color doesn't correspond to a standard CSS color, it * replaces the existing custom color item in this %ColorComboBox, * or a new one is created if there is no custom color item yet. * * \note The alpha (transparency) component of the specified \a color is * always ignored. %ColorComboBox only includes opaque colors (alpha=0xff). * * \sa CurrentColor(), CustomColor(), HasCustomColor() */ void SetCurrentColor( RGBA color ); /*! * Returns the current custom color in this %ColorComboBox, or zero * if no custom color has been defined. * * To set a new custom color, call SetCurrentColor() with the desired custom * color value. * * \sa HasCustomColor(), CurrentColor(), SetCurrentColor() */ RGBA CustomColor() const { return m_customColor; } /*! * Returns true iff a custom color item has been defined in this * %ColorComboBox control. * * This is a convenience member function, equivalent to: * CustomColor() != 0. * * \sa CustomColor(), CurrentColor(), SetCurrentColor() */ bool HasCustomColor() const { return CustomColor() != 0; } // ------------------------------------------------------------------------- // Event handlers // // void OnColorSelected( ColorComboBox& sender, RGBA color ); // void OnColorHighlighted( ColorComboBox& sender, RGBA color ); // void OnCustomColorDefined( ColorComboBox& sender, RGBA color ); /*! * \defgroup colorcombobox_event_handlers ColorComboBox Event Handlers */ /*! * Defines the prototype of a color combo box event handler. * * A color combo box event is generated when an item is selected or * highlighted in a color combo box, or when a new custom color has * been defined. * * \param sender The %ColorComboBox control that sends a color combo box * event. * * \param color The RGBA value of the color that has been selected or * highlighted in the \a sender color combo box. * * \ingroup colorcombobox_event_handlers */ typedef void (Control::*color_event_handler)( ColorComboBox& sender, RGBA color ); /*! * Sets the color selected event handler for this color combo box. * * \param handler The color combo box event handler. Must be a member * function of the receiver object's class. This handler * will be called whenever a color is selected in this * color combo box control. * * \param receiver The control that will receive color selected * events from this color combo box. * * \ingroup colorcombobox_event_handlers */ void OnColorSelected( color_event_handler handler, Control& receiver ); /*! * Sets the color highlighted event handler for this color combo * box control. * * \param handler The color combo box event handler. Must be a member * function of the receiver object's class. This handler * will be called whenever a color is highlighted in this * color combo box control. * * \param receiver The control that will receive color * highlighted events from this color combo box. * * \ingroup colorcombobox_event_handlers */ void OnColorHighlighted( color_event_handler handler, Control& receiver ); /*! * Sets the custom color defined event handler for this color combo * box control. * * \param handler The color combo box event handler. Must be a member * function of the receiver object's class. This handler * will be called whenever a new custom color is defined * in this color combo box control. * * \param receiver The control that will receive custom color * defined events from this color combo box. * * \ingroup colorcombobox_event_handlers */ void OnCustomColorDefined( color_event_handler handler, Control& receiver ); private: struct EventHandlers { color_event_handler onColorSelected = nullptr; Control* onColorSelectedReceiver = nullptr; color_event_handler onColorHighlighted = nullptr; Control* onColorHighlightedReceiver = nullptr; color_event_handler onCustomColorDefined = nullptr; Control* onCustomColorDefinedReceiver = nullptr; EventHandlers() = default; EventHandlers( const EventHandlers& ) = default; EventHandlers& operator =( const EventHandlers& ) = default; }; AutoPointer m_handlers; RGBA m_customColor; void ItemSelected( ComboBox&, int ); void ItemHighlighted( ComboBox&, int ); }; // ---------------------------------------------------------------------------- } // pcl #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION #endif // __PCL_ColorComboBox_h // ---------------------------------------------------------------------------- // EOF pcl/ColorComboBox.h - Released 2022-03-12T18:59:29Z