FxUITextEdit.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxUIBaseView.h"

 
class COMMONUI_API CFxUITextEdit : public CFxUIBaseView
{
public:
    enum EchoMode
    {
        eNormal = 0,
        ePassword = 1
    };
 
    enum MoveOperation
    {
        NoMove,
 
        Start,
        Up,
        StartOfLine,
        StartOfBlock,
        StartOfWord,
        PreviousBlock,
        PreviousCharacter,
        PreviousWord,
        Left,
        WordLeft,
 
        End,
        Down,
        EndOfLine,
        EndOfWord,
        EndOfBlock,
        NextBlock,
        NextCharacter,
        NextWord,
        Right,
        WordRight,
 
        NextCell,
        PreviousCell,
        NextRow,
        PreviousRow
    };
 
    enum MoveMode
    {
        MoveAnchor,
        KeepAnchor
    };
 
    enum InputType
    {
        Text,
        Number,
        URL
    };

    explicit CFxUITextEdit(UIWidthSizePolicy width = eM );

    ~CFxUITextEdit();

    void setText( const CFxUIString& str );

    CFxUIString text() const;

    void setPlainText( const CFxUIString& sText );

    CFxUIString toPlainText() const;

    void setPlaceholderText( const CFxUIString& str );

    CFxUIString placeholderText() const;

    void setClearButtonEnabled( bool bEnable );

    bool isClearButtonEnabled() const;

    void selectAll();

    void setFocus();

    void moveCursor( MoveOperation operation, MoveMode mode = MoveAnchor );

    void setCursorPosition( int index );

    void setInputType( InputType type );
    
    void setInputMask( const CFxUIString& str );

    CFxUIString inputMask() const;

    void setReadOnly( bool readOnly );

    void clear();

    void setTextAlignment( TextAlignment iAlignment );

    void setEchoMode( EchoMode echoMode );
        
    CFxUISignal<void(const CFxUIString )>& textChanged();

    CFxUISignal<void(void)>& editingFinished();

    CFxUISignal<void(const CFxUIString )>& textEdited();

    CFxUISignal<void( int, int, CFxUIString )>& keyPressed();

    CFxUISignal<void( void )>& focusInEventSignal();

    CFxUISignal<void( void )>& focusOutEventSignal();
 
    //...
};