GUIEdit.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUIEDIT_H
#define GUIEDIT_H
 
#include "GUIObject.h"
#include "GUITextResource.h"
 
class CGUIEditableText;
class CGUIKeyboardEvent;
 
 
// @guiliani_doxygen limitations CGUIEdit
// @endguiliani_doxygen
class CGUIEdit : public CGUIObject
{
public:
    enum AcceptedChars_t
    {
        AC_ALL,
        AC_LETTERS,
        AC_DIGITS,
        AC_ALPHANUMERIC,
        AC_NONE
    };
 
    CGUIEdit(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_String &rkText,
        AcceptedChars_t eAcceptedChars = AC_ALL,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIEdit(
        CGUICompositeObject* const pkParent,
        const CGUIRect &kRect,
        const eC_String &rkText,
        AcceptedChars_t eAcceptedChars = AC_ALL,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIEdit(const CGUIEdit& rkSource);
 
    ~CGUIEdit();
 
    CGUIEdit& operator=(const CGUIEdit& rkSource);
 
    virtual eC_Bool DoDraw();
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
 
    eC_Bool DoKeyDown(const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers);
 
    eC_Bool DoChar(
        const eC_UInt &uiKey,
        const GUIKeyIdentifier_t &eKeyIdentifier,
        const eC_UInt &uiModifiers);
 
    CGUIEditableText* GetLabel() { return m_pkText; }
 
    void SetLabel(CGUIEditableText* pkText);
 
    void SetWidth(const eC_Value& vX);
 
    void SetHeight(const eC_Value& vY);
 
    void SetMaxLength(eC_Int iMaxLength);
 
    inline eC_Int GetMaxLength() const { return m_iMaxLength; }
 
    void SetAcceptedChars(AcceptedChars_t eAcceptedChars);
 
    inline AcceptedChars_t GetAcceptedChars() const { return m_eAcceptedChars; }
 
    virtual void SetTextString(const eC_String& rkTextString);
 
    virtual void SetTextID(const TextResource_t &eTextID);
 
    void InsertTextString(const eC_String& rkTextString);
 
    eC_String GetSelectedTextString();
 
    eC_String DeleteSelectedTextString();
 
    virtual void GetFocus();
 
    virtual void LoseFocus();
 
    CGUIEdit();
 
    virtual eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoDoubleClick(const eC_Value& vAbsX=eC_FromInt(-1), const eC_Value& vAbsY=eC_FromInt(-1));
 
    virtual eC_Bool DoDrag(const eC_Value& vDeltaX, const eC_Value& vDeltaY, const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    void AddTextChangedObserver(CGUIObserver* pObserver);
 
    void RemoveTextChangedObserver(CGUIObserver* pObserver);
 
    void EnsureCursorVisible();
 
    void SetResetCursorWhenFocusLost(const eC_Bool bResetCursor) { m_bResetCursorWhenFocusLost = bResetCursor; }
    
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
private:
    void Init();
 
    void CopyAttributes(const CGUIEdit& rkSource);
 
    void StartCursorBlinking();
 
    void StopCursorBlinking();
 
    eC_Bool IsCharAllowed(eC_UInt uiChar) const;
 
    CGUIEditableText *m_pkText;
 
    eC_Bool m_bPreviousCharacterWasIntermittent;
 
    AcceptedChars_t m_eAcceptedChars;
 
    CGUISubject m_kTextChangedSubject;
 
    eC_Int m_iMaxLength;
 
    eC_Bool m_bResetCursorWhenFocusLost;
};
 
#endif