392 lines
11 KiB
C++
392 lines
11 KiB
C++
// ____ ______ __
|
|
// / __ \ / ____// /
|
|
// / /_/ // / / /
|
|
// / ____// /___ / /___ PixInsight Class Library
|
|
// /_/ \____//_____/ PCL 2.4.23
|
|
// ----------------------------------------------------------------------------
|
|
// pcl/Edit.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_Edit_h
|
|
#define __PCL_Edit_h
|
|
|
|
/// \file pcl/Edit.h
|
|
|
|
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
|
|
|
|
#include <pcl/Defs.h>
|
|
|
|
#include <pcl/AutoPointer.h>
|
|
#include <pcl/Frame.h>
|
|
|
|
namespace pcl
|
|
{
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
/*!
|
|
* \class Edit
|
|
* \brief Client-side interface to a PixInsight %Edit control
|
|
*
|
|
* %Edit controls are single-line plain text edit controls.
|
|
*/
|
|
class PCL_CLASS Edit : public Frame
|
|
{
|
|
public:
|
|
|
|
/*!
|
|
* Constructs an %Edit object with the specified \a text, as a child control
|
|
* of \a parent.
|
|
*/
|
|
Edit( const String& text = String(), Control& parent = Control::Null() );
|
|
|
|
/*!
|
|
* Destroys an %Edit control.
|
|
*/
|
|
virtual ~Edit()
|
|
{
|
|
}
|
|
|
|
/*!
|
|
* Returns the current edit text.
|
|
*/
|
|
String Text() const;
|
|
|
|
/*!
|
|
* Sets the current button text.
|
|
*/
|
|
void SetText( const String& );
|
|
|
|
/*!
|
|
* Removes all the text in this %edit control.
|
|
*/
|
|
void Clear()
|
|
{
|
|
SetText( String() );
|
|
}
|
|
|
|
/*!
|
|
* Returns true iff this %Edit control is in read-only mode.
|
|
*/
|
|
bool IsReadOnly() const;
|
|
|
|
/*!
|
|
* Enables or disables the read-only mode for this %Edit control.
|
|
*/
|
|
void SetReadOnly( bool = true );
|
|
|
|
/*!
|
|
* Disables or enables the read-only mode for this %Edit control.
|
|
*
|
|
* This is a convenience member function, equivalent to:
|
|
* SetReadOnly( !rw )
|
|
*/
|
|
void SetReadWrite( bool rw = true )
|
|
{
|
|
SetReadOnly( !rw );
|
|
}
|
|
|
|
/*!
|
|
* Returns true iff the text in this %Edit control has been modified.
|
|
*/
|
|
bool IsModified() const;
|
|
|
|
/*!
|
|
* Sets or clears the modified status for this %Edit control.
|
|
*/
|
|
void SetModified( bool = true );
|
|
|
|
/*!
|
|
* Clears or sets the modified status for this %Edit control.
|
|
*
|
|
* This is a convenience member function, equivalent to:
|
|
* SetModified( !clear )
|
|
*/
|
|
void ClearModified( bool clear = true )
|
|
{
|
|
SetModified( !clear );
|
|
}
|
|
|
|
/*!
|
|
* Returns true iff this %Edit control is in <em>password display mode</em>.
|
|
*
|
|
* In password mode, the text in an edit control is always displayed as a
|
|
* sequence of asterisks. This does not affect the actual text; the password
|
|
* mode only changes the way characters are displayed.
|
|
*
|
|
* \sa EnablePasswordMode(), DisablePasswordMode()
|
|
*/
|
|
bool IsPasswordMode() const;
|
|
|
|
/*!
|
|
* Enables the password display mode for this %Edit control.
|
|
*
|
|
* \sa IsPasswordMode(), DisablePasswordMode()
|
|
*/
|
|
void EnablePasswordMode( bool = true );
|
|
|
|
/*!
|
|
* Disables the password display mode for this %Edit control.
|
|
*
|
|
* This is a convenience member function, equivalent to:
|
|
* EnablePasswordMode( !disable )
|
|
*
|
|
* \sa IsPasswordMode(), EnablePasswordMode()
|
|
*/
|
|
void DisablePasswordMode( bool disable = true )
|
|
{
|
|
EnablePasswordMode( !disable );
|
|
}
|
|
|
|
/*!
|
|
* Returns the maximum allowed length for the text in this %Edit control.
|
|
*/
|
|
int MaxLength() const;
|
|
|
|
/*!
|
|
* Sets the maximum allowed length for the text in this %Edit control.
|
|
*
|
|
* The default length limit is \c int_max, which in practice represents no
|
|
* length limit.
|
|
*/
|
|
void SetMaxLength( int );
|
|
|
|
/*!
|
|
* Enables unlimited length for the text in this %Edit control.
|
|
*
|
|
* This is a convenience member function, equivalent to:
|
|
* SetMaxLength( int_max )
|
|
*/
|
|
void SetUnlimitedLength()
|
|
{
|
|
SetMaxLength( int_max );
|
|
}
|
|
|
|
/*!
|
|
* Selects all the text in this %edit control.
|
|
*/
|
|
void SelectAll( bool = true );
|
|
|
|
/*!
|
|
* Clears the existing selection, if any, in this %edit control.
|
|
*
|
|
* \note This member function does not delete the selected text; it only
|
|
* removes the selection.
|
|
*/
|
|
void Unselect( bool unsel = true )
|
|
{
|
|
SelectAll( !unsel );
|
|
}
|
|
|
|
/*!
|
|
* Gets the limits of the current selection in this %Edit control.
|
|
*
|
|
* \param[out] selStart The index of the first selected character.
|
|
* \param[out] selEnd The index of the last selected character plus one.
|
|
*
|
|
* When \a selStart is equal to \a selEnd, there is no selection in this
|
|
* edit control.
|
|
*/
|
|
void GetSelection( int& selStart, int& selEnd ) const;
|
|
|
|
/*!
|
|
* Sets the limits of the current selection in this %Edit control.
|
|
*
|
|
* \param selStart The index of the first selected character.
|
|
* \param selEnd The index of the last selected character plus one.
|
|
*
|
|
* When \a selStart is equal to \a selEnd, there is no selection in this
|
|
* edit control.
|
|
*/
|
|
void SetSelection( int selStart, int selEnd );
|
|
|
|
/*!
|
|
* Returns true iff there are one or more selected characters in this %Edit
|
|
* control.
|
|
*/
|
|
bool HasSelection() const
|
|
{
|
|
int s0, s1;
|
|
GetSelection( s0, s1 );
|
|
return s0 != s1;
|
|
}
|
|
|
|
/*!
|
|
* Returns the currently selected text, or an empty string if there is no
|
|
* selection in this %Edit control.
|
|
*/
|
|
String SelectedText() const;
|
|
|
|
/*!
|
|
* Returns the current caret position in this %Edit control.
|
|
*/
|
|
int CaretPosition() const;
|
|
|
|
/*!
|
|
* Sets the current caret position in this %Edit control.
|
|
*/
|
|
void SetCaretPosition( int );
|
|
|
|
/*!
|
|
* Moves the caret to the beginning of the text line in this %Edit control.
|
|
*/
|
|
void Home()
|
|
{
|
|
SetCaretPosition( 0 );
|
|
}
|
|
|
|
/*!
|
|
* Moves the caret to the end of the text line in this %Edit control.
|
|
*/
|
|
void End()
|
|
{
|
|
SetCaretPosition( int_max );
|
|
}
|
|
|
|
/*!
|
|
* Returns true iff the text in this %Edit control is right-aligned.
|
|
*/
|
|
bool IsRightAligned() const;
|
|
|
|
/*!
|
|
* Returns true iff the text in this %Edit control is left-aligned.
|
|
*/
|
|
bool IsLeftAligned() const
|
|
{
|
|
return !IsRightAligned();
|
|
}
|
|
|
|
/*!
|
|
* Enables or disables right-alignment for the text in this %edit control.
|
|
*/
|
|
void SetRightAlignment( bool right = true );
|
|
|
|
/*!
|
|
* Disables or enables right-alignment for the text in this %edit control.
|
|
*
|
|
* This is a convenience member function, equivalent to:
|
|
* SetRightAlignment( !left )
|
|
*/
|
|
void SetLeftAlignment( bool left = true )
|
|
{
|
|
SetRightAlignment( !left );
|
|
}
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Event handlers
|
|
//
|
|
// void OnEditCompleted( Edit& sender );
|
|
// void OnReturnPressed( Edit& sender );
|
|
// void OnTextUpdated( Edit& sender, const String& text );
|
|
// void OnCaretPositionUpdated( Edit& sender, int oldPos, int newPos );
|
|
// void OnSelectionUpdated( Edit& sender, int newStart, int newEnd );
|
|
|
|
/*! #
|
|
*/
|
|
typedef void (Control::*edit_event_handler)( Edit& sender );
|
|
|
|
/*! #
|
|
*/
|
|
typedef void (Control::*text_event_handler)( Edit& sender, const String& );
|
|
|
|
/*! #
|
|
*/
|
|
typedef void (Control::*caret_event_handler)( Edit& sender, int oldPos, int newPos );
|
|
|
|
/*! #
|
|
*/
|
|
typedef void (Control::*selection_event_handler)( Edit& sender, int newStart, int newEnd );
|
|
|
|
/*! #
|
|
*/
|
|
void OnEditCompleted( edit_event_handler, Control& );
|
|
|
|
/*! #
|
|
*/
|
|
void OnReturnPressed( edit_event_handler, Control& );
|
|
|
|
/*! #
|
|
*/
|
|
void OnTextUpdated( text_event_handler, Control& );
|
|
|
|
/*! #
|
|
*/
|
|
void OnCaretPositionUpdated( caret_event_handler, Control& );
|
|
|
|
/*! #
|
|
*/
|
|
void OnSelectionUpdated( selection_event_handler, Control& );
|
|
|
|
private:
|
|
|
|
struct EventHandlers
|
|
{
|
|
edit_event_handler onEditCompleted = nullptr;
|
|
edit_event_handler onReturnPressed = nullptr;
|
|
text_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 EditEventDispatcher;
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
} // pcl
|
|
|
|
#endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
|
|
|
|
#endif // __PCL_Edit_h
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// EOF pcl/Edit.h - Released 2022-03-12T18:59:29Z
|