widgets/MultiLineEditbox.h

/***********************************************************************
        filename:       CEGUIMultiLineEditbox.h
        created:        30/6/2004
        author:         Paul D Turner
        
        purpose:        Interface to the Multi-lien edit box base class.
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIMultiLineEditbox_h_
#define _CEGUIMultiLineEditbox_h_

#include "../Base.h"
#include "../Window.h"
#include "../Font.h"

#include <vector>

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT MultiLineEditboxWindowRenderer : public WindowRenderer
{
public:
    MultiLineEditboxWindowRenderer(const String& name);

    virtual Rectf getTextRenderArea(void) const = 0;

protected:
    // base class overrides
    void onLookNFeelAssigned();
};

class CEGUIEXPORT MultiLineEditbox : public Window
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Constants
        *************************************************************************/
        // event names
        static const String EventReadOnlyModeChanged;
        static const String EventWordWrapModeChanged;
        static const String EventMaximumTextLengthChanged;
        static const String EventCaretMoved;
        static const String EventTextSelectionChanged;
        static const String EventEditboxFull;
        static const String EventVertScrollbarModeChanged;
        static const String EventHorzScrollbarModeChanged;

    /*************************************************************************
        Child Widget name constants
    *************************************************************************/
    static const String VertScrollbarName;   
    static const String HorzScrollbarName;   

    /*************************************************************************
        Implementation struct
    *************************************************************************/
    struct LineInfo
    {
        size_t  d_startIdx;     
        size_t  d_length;       
        float   d_extent;       
    };
    typedef std::vector<LineInfo
        CEGUI_VECTOR_ALLOC(LineInfo)>   LineList;   

        /*************************************************************************
                Accessor Functions
        *************************************************************************/
        bool    hasInputFocus(void) const;


        bool    isReadOnly(void) const          {return d_readOnly;}


        size_t  getCaretIndex(void) const               {return d_caretPos;}


        size_t  getSelectionStartIndex(void) const;


        size_t  getSelectionEndIndex(void) const;

        
        size_t  getSelectionLength(void) const;


        size_t  getMaxTextLength(void) const            {return d_maxTextLen;}


        bool    isWordWrapped(void) const;


    Scrollbar* getVertScrollbar() const;

        bool    isVertScrollbarAlwaysShown(void) const;

    Scrollbar* getHorzScrollbar() const;


    Rectf getTextRenderArea(void) const;

    // get d_lines
    const LineList& getFormattedLines(void) const   {return d_lines;}

    size_t  getLineNumberFromIndex(size_t index) const;

        /*************************************************************************
                Manipulators
        *************************************************************************/
        virtual void    initialiseComponents(void);


        void    setReadOnly(bool setting);


        void    setCaretIndex(size_t caret_pos);


        void    setSelection(size_t start_pos, size_t end_pos);
        

    void setSelectionStart(size_t start_pos);

    void setSelectionLength(size_t length);

        void    setMaxTextLength(size_t max_len);


        void    ensureCaretIsVisible(void);


        void    setWordWrapping(bool setting);

        void    setShowVertScrollbar(bool setting);

    // selection brush image property support
    void setSelectionBrushImage(const Image* image);
    const Image* getSelectionBrushImage() const;
    
    virtual bool performCopy(Clipboard& clipboard);
    
    virtual bool performCut(Clipboard& clipboard);
    
    virtual bool performPaste(Clipboard& clipboard);

    void formatText(const bool update_scrollbars);

        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        MultiLineEditbox(const String& type, const String& name);


        virtual ~MultiLineEditbox(void);


protected:
        /*************************************************************************
                Implementation Methods (abstract)
        *************************************************************************/
        //virtual       Rect    getTextRenderArea_impl(void) const              = 0;


        /*************************************************************************
                Implementation Methods
        *************************************************************************/
        void    formatText(void);

        size_t  getNextTokenLength(const String& text, size_t start_idx) const;


        void    configureScrollbars(void);


        size_t  getTextIndexFromPosition(const Vector2f& pt) const;


        void    clearSelection(void);


        void    eraseSelectedText(bool modify_text = true);


        void    handleBackspace(void);


        void    handleDelete(void);


        void    handleCharLeft(uint sysKeys);


        void    handleWordLeft(uint sysKeys);


        void    handleCharRight(uint sysKeys);


        void    handleWordRight(uint sysKeys);


        void    handleDocHome(uint sysKeys);


        void    handleDocEnd(uint sysKeys);


        void    handleLineHome(uint sysKeys);


        void    handleLineEnd(uint sysKeys);


        void    handleLineUp(uint sysKeys);


        void    handleLineDown(uint sysKeys);


        void    handleNewLine(uint sysKeys);


    void    handlePageUp(uint sysKeys);


    void    handlePageDown(uint sysKeys);

    bool handle_scrollChange(const EventArgs& args);

    // handler triggered when vertical scrollbar is shown or hidden
    bool handle_vertScrollbarVisibilityChanged(const EventArgs&);

    // validate window renderer
    virtual bool validateWindowRenderer(const WindowRenderer* renderer) const;

        /*************************************************************************
                New event handlers
        *************************************************************************/
        void    onReadOnlyChanged(WindowEventArgs& e);


        void    onWordWrapModeChanged(WindowEventArgs& e);


        void    onMaximumTextLengthChanged(WindowEventArgs& e);


        void    onCaretMoved(WindowEventArgs& e);


        void    onTextSelectionChanged(WindowEventArgs& e);


        void    onEditboxFullEvent(WindowEventArgs& e);


        void    onVertScrollbarModeChanged(WindowEventArgs& e);


        void    onHorzScrollbarModeChanged(WindowEventArgs& e);


        /*************************************************************************
                Overridden event handlers
        *************************************************************************/
        virtual void    onMouseButtonDown(MouseEventArgs& e);
        virtual void    onMouseButtonUp(MouseEventArgs& e);
        virtual void    onMouseDoubleClicked(MouseEventArgs& e);
        virtual void    onMouseTripleClicked(MouseEventArgs& e);
        virtual void    onMouseMove(MouseEventArgs& e);
        virtual void    onCaptureLost(WindowEventArgs& e);
        virtual void    onCharacter(KeyEventArgs& e);
        virtual void    onKeyDown(KeyEventArgs& e);
        virtual void    onTextChanged(WindowEventArgs& e);
        virtual void    onSized(ElementEventArgs& e);
        virtual void    onMouseWheel(MouseEventArgs& e);
    virtual void onFontChanged(WindowEventArgs& e);


        /*************************************************************************
                Implementation data
        *************************************************************************/
        bool    d_readOnly;                     
        size_t  d_maxTextLen;           
        size_t  d_caretPos;                     
        size_t  d_selectionStart;       
        size_t  d_selectionEnd;         
        bool    d_dragging;                     
        size_t  d_dragAnchorIdx;        

        static String d_lineBreakChars; 
        bool            d_wordWrap;                     
        LineList        d_lines;                        
        float           d_widestExtent;         

        // component widget settings
        bool    d_forceVertScroll;              
        bool    d_forceHorzScroll;              

        // images
        const Image*    d_selectionBrush;       


private:
        /*************************************************************************
                Private methods
        *************************************************************************/
        void    addMultiLineEditboxProperties(void);
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIMultiLineEditbox_h_