Content

CMaskEdit

Implements MaskEdit control.

You can find more information in comments below. Overrided methods can be found in corresponding base classes and interfaces.

class CMaskEdit :public virtual IMaskEdit, public CControl
{
public:
    void(*OnChange)(IControl *sender); // Event called when text changed 

    // IControl getters 
    RectF getClientRect() override;
    RectF getRenderRect() override;
    CURSOR_TYPE getCursor() override;

    // IControl setters 
    bool setDPI(const Point &value) override;

    // IControl methods 
    void Refresh(const bool refresh_children) override;

    // IEdit getters 
    String getText() override;
    String getMask() override;
    IMaskValidator *getValidator() override;

    // IEdit setters 
    bool setText(const String &value) override;
    bool setMask(const String &value) override;
    bool setValidator(IMaskValidator *value) override;

    CMaskEdit();
    CMaskEdit(IControl *parent);
    CMaskEdit(IForm *parent);
    ~CMaskEdit() override;

    // ITextInput getters 
    String getSelectedText();
    Point getSelection();
    int getCaretPosition();
    float getScroll();
    int getMaxLength();
    TEXT_ALIGN getTextAlign();
    CBuiltInTextInput::STATE getState();
    // CTextInput getters(works only if assocciated ITextInput is instance of CTextInput) 
    String getPlaceholder();
    bool isReadOnly();
    bool isReplacing();
    float getScrollInterval();
    Color getTextColor(const CBuiltInTextInput::STATE state);
    Color getPlaceholderColor(const CBuiltInTextInput::STATE state);
    Color getTextShadowColor(const CBuiltInTextInput::STATE state);
    Color getSelectionBackgroundColor(const CBuiltInTextInput::STATE state);
    Color getSelectionTextColor(const CBuiltInTextInput::STATE state);
    Color getSelectionTextShadowColor(const CBuiltInTextInput::STATE state);
    PointF getTextShadowShift(const CBuiltInTextInput::STATE state);
    int getTextShadowRadius(const CBuiltInTextInput::STATE state);
    bool isCopyByMouseEnabled();
    bool isMoveByMouseEnabled();
    bool isSelectWordByDoubleClickEnabled();
    bool isKeyLeftEnabled();
    bool isKeyRightEnabled();
    bool isKeyHomeEnabled();
    bool isKeyEndEnabled();
    bool isKeyDeleteEnabled();
    bool isKeyBackspaceEnabled();
    bool isSelectAllByKeyEnabled();
    bool isPasteByKeyEnabled();
    bool isCopyByKeyEnabled();
    bool isCutByKeyEnabled();
    bool isInsertReplaceChangeByKeyEnabled();
    // Return layout properties 
    RectF getBorderWidth() const;
    float getLeftBorderWidth() const;
    float getTopBorderWidth() const;
    float getRightBorderWidth() const;
    float getBottomBorderWidth() const;
    RectF getBorderRadius() const;
    float getLeftBorderRadius() const;
    float getTopBorderRadius() const;
    float getRightBorderRadius() const;
    float getBottomBorderRadius() const;
    RectF getPadding() const;
    float getLeftPadding() const;
    float getTopPadding() const;
    float getRightPadding() const;
    float getBottomPadding() const;
    RectC getBorderColor(const CBuiltInTextInput::STATE state) const;
    Color getLeftBorderColor(const CBuiltInTextInput::STATE state) const;
    Color getTopBorderColor(const CBuiltInTextInput::STATE state) const;
    Color getRightBorderColor(const CBuiltInTextInput::STATE state) const;
    Color getBottomBorderColor(const CBuiltInTextInput::STATE state) const;
    Color getBackgroundColor(const CBuiltInTextInput::STATE state) const;
    Gradient *getBackgroundGradient(const CBuiltInTextInput::STATE state);
    int getShadowRadius(const CBuiltInTextInput::STATE state) const;
    PointF getShadowShift(const CBuiltInTextInput::STATE state) const;
    Color getShadowColor(const CBuiltInTextInput::STATE state) const;

    // ITextInput setters 
    bool setSelection(const Point &value);
    bool setCaretPosition(const int value);
    bool setScroll(const float value);
    bool setMaxLength(const int value);
    bool setTextAlign(const TEXT_ALIGN value);
    // CTextInput setters(works only if assocciated ITextInput is instance of CTextInput) 
    bool setPlaceholder(const String &value);
    bool setReadOnly(const bool value);
    bool setReplacing(const bool value);
    bool setScrollInterval(const float value);
    bool setTextColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setPlaceholderColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setTextShadowColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setSelectionBackgroundColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setSelectionTextColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setSelectionTextShadowColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setTextShadowShift(const CBuiltInTextInput::STATE state, const PointF &value);
    bool setTextShadowRadius(const CBuiltInTextInput::STATE state, const int value);
    bool setCopyByMouseEnabled(const bool value);
    bool setMoveByMouseEnabled(const bool value);
    bool setSelectWordByDoubleClickEnabled(const bool value);
    bool setKeyLeftEnabled(const bool value);
    bool setKeyRightEnabled(const bool value);
    bool setKeyHomeEnabled(const bool value);
    bool setKeyEndEnabled(const bool value);
    bool setKeyDeleteEnabled(const bool value);
    bool setKeyBackspaceEnabled(const bool value);
    bool setSelectAllByKeyEnabled(const bool value);
    bool setPasteByKeyEnabled(const bool value);
    bool setCopyByKeyEnabled(const bool value);
    bool setCutByKeyEnabled(const bool value);
    bool setInsertReplaceChangeByKeyEnabled(const bool value);
    // Set layout properties 
    bool setTextInput(IBuiltInTextInput *value);
    bool setBorderWidth(const RectF &value);
    bool setLeftBorderWidth(const float value);
    bool setTopBorderWidth(const float value);
    bool setRightBorderWidth(const float value);
    bool setBottomBorderWidth(const float value);
    bool setBorderRadius(const RectF &value);
    bool setLeftBorderRadius(const float value);
    bool setTopBorderRadius(const float value);
    bool setRightBorderRadius(const float value);
    bool setBottomBorderRadius(const float value);
    bool setPadding(const RectF &value);
    bool setLeftPadding(const float value);
    bool setTopPadding(const float value);
    bool setRightPadding(const float value);
    bool setBottomPadding(const float value);
    bool setBorderColor(const CBuiltInTextInput::STATE state, const RectC &value);
    bool setLeftBorderColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setTopBorderColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setRightBorderColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setBottomBorderColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setBackgroundColor(const CBuiltInTextInput::STATE state, const Color &value);
    bool setShadowRadius(const CBuiltInTextInput::STATE state, const int value);
    bool setShadowShift(const CBuiltInTextInput::STATE state, const PointF &value);
    bool setShadowColor(const CBuiltInTextInput::STATE state, const Color &value);

    // ITextInput actions 
    bool DeleteSelection();
    bool DeleteCharBeforeCaret();
    bool DeleteCharAfterCaret();
    bool DeleteWordBeforeCaret();
    bool DeleteWordAfterCaret();
    bool DeleteAllBeforeCaret();
    bool DeleteAllAfterCaret();
    bool MoveCaretLeft(const bool select);
    bool MoveCaretRight(const bool select);
    bool MoveCaretWordLeft(const bool select);
    bool MoveCaretWordRight(const bool select);
    bool MoveCaretStart(const bool select);
    bool MoveCaretEnd(const bool select);
    bool Insert(const wchar_t chr);
    bool Insert(const String &str);
    bool Replace(const wchar_t chr);
    bool Replace(const String &str);
    bool MoveSelection(const int dst_caret_pos);
    bool CopySelection(const int dst_caret_pos);
    bool Copy();
    bool Cut();
    bool Paste();
    bool SelectAll();
    bool DeselectAll();
};