ComboBox.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/ComboBox.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 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_ComboBox_h
#define __PCL_ComboBox_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Bitmap.h>
#include <pcl/Control.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ComboBox : public Control
{
public:
 
   ComboBox( Control& parent = Control::Null() );
 
   ~ComboBox() override
   {
   }
 
   int NumberOfItems() const;
 
   int CurrentItem() const;
 
   void SetCurrentItem( int index );
 
   int FindItem( const String& text, int fromIdx = 0, bool exactMatch = false, bool caseSensitive = false ) const;
 
   void InsertItem( int index, const String& text, const Bitmap& icon = Bitmap::Null() );
 
   void AddItem( const String& text, const Bitmap& icon = Bitmap::Null() )
   {
      InsertItem( NumberOfItems(), text, icon );
   }
 
   template <class FI>
   void InsertItems( int index, FI i, FI j )
   {
      if ( i != j )
      {
         DisableUpdates();
         do
            InsertItem( index++, *i );
         while ( ++i != j );
         EnableUpdates();
         Update();
      }
   }
 
   template <class FI>
   void AddItems( FI i, FI j )
   {
      InsertItems( NumberOfItems(), i, j );
   }
 
   template <class C>
   void InsertItems( int index, const C& c )
   {
      InsertItems( index, c.Begin(), c.End() );
   }
 
   template <class C>
   void AddItems( const C& c )
   {
      InsertItems( NumberOfItems(), c );
   }
 
   void RemoveItem( int index );
 
   void Clear();
 
   String ItemText( int index ) const;
 
   void SetItemText( int index, const String& );
 
   void ClearItemText( int index )
   {
      SetItemText( index, String() );
   }
 
   Bitmap ItemIcon( int index ) const;
 
   void SetItemIcon( int index, const Bitmap& );
 
   void ClearItemIcon( int index )
   {
      SetItemIcon( index, Bitmap::Null() );
   }
 
   bool IsEditEnabled() const;
 
   void EnableEdit( bool = true );
 
   void DisableEdit( bool disable = true )
   {
      EnableEdit( !disable );
   }
 
   String EditText() const;
 
   void SetEditText( const String& );
 
   void ClearEditText()
   {
      SetEditText( String() );
   }
 
   bool IsAutoCompletionEnabled() const;
 
   void EnableAutoCompletion( bool = true );
 
   void DisableAutoCompletion( bool disable = true )
   {
      EnableAutoCompletion( !disable );
   }
 
   void GetIconSize( int& width, int& height ) const;
 
   int IconWidth() const
   {
      int w, dum; GetIconSize( w, dum ); return w;
   }
 
   int IconHeight() const
   {
      int dum, h; GetIconSize( dum, h ); return h;
   }
 
   void SetIconSize( int width, int height );
 
   void SetIconSize( int size )
   {
      SetIconSize( size, size );
   }
 
   void GetScaledIconSize( int& width, int& height ) const
   {
      GetIconSize( width, height ); width = PhysicalPixelsToLogical( width ); height = PhysicalPixelsToLogical( height );
   }
 
   int ScaledIconWidth() const
   {
      int width, dum; GetIconSize( width, dum ); return PhysicalPixelsToLogical( width );
   }
 
   int ScaledIconHeight() const
   {
      int dum, height; GetIconSize( dum, height ); return PhysicalPixelsToLogical( height );
   }
 
   void SetScaledIconSize( int width, int height )
   {
      SetIconSize( LogicalPixelsToPhysical( width ), LogicalPixelsToPhysical( height ) );
   }
 
   void SetScaledIconSize( int size )
   {
      size = LogicalPixelsToPhysical( size );
      SetIconSize( size, size );
   }
 
   int MaxVisibleItemCount() const;
 
   void SetMaxVisibleItemCount( int );
 
   int MinItemCharWidth() const;
 
   void SetMinItemCharWidth( int );
 
   //
   // Drop-down items list
   //
 
   void ShowList();
 
   void HideList();
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnItemSelected( ComboBox& sender, int itemIndex );
   // void OnItemHighlighted( ComboBox& sender, int itemIndex );
   // void OnEditTextUpdated( ComboBox& sender );
 
   using item_event_handler = void (Control::*)( ComboBox& sender, int itemIndex );
 
   using edit_event_handler = void (Control::*)( ComboBox& sender );
 
   void OnItemSelected( item_event_handler handler, Control& receiver );
 
   void OnItemHighlighted( item_event_handler handler, Control& receiver );
 
   void OnEditTextUpdated( edit_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      item_event_handler onItemSelected    = nullptr;
      item_event_handler onItemHighlighted = nullptr;
      edit_event_handler onEditTextUpdated = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   friend class ComboBoxEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_ComboBox_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ComboBox.h - Released 2024-05-07T15:27:32Z