TextBox.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/TextBox.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// 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_TextBox_h
#define __PCL_TextBox_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Frame.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS TextBox : public Frame
{
public:
 
   TextBox( const String& text = String(), Control& parent = Control::Null() );
 
   ~TextBox() override
   {
   }
 
   String Text() const;
 
   void SetText( const String& );
 
   template <class S>
   static S PlainText( const S& text )
   {
      return "<raw>" + text + "</raw>";
   }
 
   template <class S>
   void SetPlainText( const S& text )
   {
      SetText( PlainText( text ) );
   }
 
   void Clear()
   {
      SetText( String() );
   }
 
   bool IsReadOnly() const;
 
   void SetReadOnly( bool ro = true );
 
   void SetReadWrite( bool rw = true )
   {
      SetReadOnly( !rw );
   }
 
   void SelectAll( bool = true );
 
   void Unselect( bool unsel = true )
   {
      SelectAll( !unsel );
   }
 
   void GetSelection( int& selStart, int& selEnd ) const;
 
   void SetSelection( int selStart, int selEnd );
 
   bool HasSelection() const
   {
      int s0, s1;
      GetSelection( s0, s1 );
      return s0 != s1;
   }
 
   String SelectedText() const;
 
   int CaretPosition() const;
 
   void SetCaretPosition( int );
 
   void Home()
   {
      SetCaretPosition( 0 );
   }
 
   void End()
   {
      SetCaretPosition( int_max );
   }
 
   void Insert( const String& text );
 
   void Delete();
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnTextUpdated( TextBox& sender, const String& text );
   // void OnCaretPositionUpdated( TextBox& sender, int oldPos, int newPos );
   // void OnSelectionUpdated( TextBox& sender, int newStart, int newEnd );
 
   using unicode_event_handler = void (Control::*)( TextBox& sender, const String& );
 
   using caret_event_handler = void (Control::*)( TextBox& sender, int oldPos, int newPos );
 
   using selection_event_handler = void (Control::*)( TextBox& sender, int newStart, int newEnd );
 
   void OnTextUpdated( unicode_event_handler, Control& );
 
   void OnCaretPositionUpdated( caret_event_handler, Control& );
 
   void OnSelectionUpdated( selection_event_handler, Control& );
 
private:
 
   struct EventHandlers
   {
      unicode_event_handler   onTextUpdated          = nullptr;
      caret_event_handler     onCaretPositionUpdated = nullptr;
      selection_event_handler onSelectionUpdated     = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   friend class TextBoxEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_TextBox_h
 
// ----------------------------------------------------------------------------
// EOF pcl/TextBox.h - Released 2024-06-18T15:48:54Z