Combobox.h

/***********************************************************************
        created:        13/4/2004
        author:         Paul D Turner
        
        purpose:        Interface to base class for Combobox widget
*************************************************************************/
/***************************************************************************
 *   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 _CEGUICombobox_h_
#define _CEGUICombobox_h_

#include "CEGUI/Base.h"
#include "CEGUI/Window.h"
#include "CEGUI/RegexMatcher.h"

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


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT Combobox : public Window
{
public:
    typedef RegexMatcher::MatchState MatchState;

        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Constants
        *************************************************************************/
        // event names from edit box
        static const String EventReadOnlyModeChanged;
        static const String EventValidationStringChanged;
        static const String EventMaximumTextLengthChanged;
    static const String EventTextValidityChanged;
        static const String EventCaretMoved;
        static const String EventTextSelectionChanged;
        static const String EventEditboxFull;
        static const String EventTextAccepted;

        // event names from list box
        static const String EventListContentsChanged;
        static const String EventListSelectionChanged;
        static const String EventSortModeChanged;
        static const String EventVertScrollbarModeChanged;
        static const String EventHorzScrollbarModeChanged;

        // events we produce / generate ourselves
        static const String EventDropListDisplayed;
        static const String EventDropListRemoved;
        static const String EventListSelectionAccepted;

    /*************************************************************************
        Child Widget name constants
    *************************************************************************/
    static const String EditboxName;    
    static const String DropListName;   
    static const String ButtonName;     

    // override from Window class
    bool isHit(const Vector2f& position,
               const bool allow_disabled = false) const;

        bool    getSingleClickEnabled(void) const;


        bool    isDropDownListVisible(void) const;


    Editbox* getEditbox() const;

    PushButton* getPushButton() const;

    ComboDropList* getDropList() const;

    bool getAutoSizeListHeightToContent() const;

    bool getAutoSizeListWidthToContent() const;

        /*************************************************************************
                Editbox Accessors
        *************************************************************************/
        bool    hasInputFocus(void) const;


        bool    isReadOnly(void) const;


    MatchState getTextMatchState() const;


        const String&   getValidationString(void) const;


        size_t  getCaretIndex(void) const;


        size_t  getSelectionStartIndex(void) const;


        size_t  getSelectionEndIndex(void) const;

        
        size_t  getSelectionLength(void) const;


        size_t  getMaxTextLength(void) const;


        /*************************************************************************
                List Accessors
        *************************************************************************/
        size_t  getItemCount(void) const;

        
        ListboxItem*    getSelectedItem(void) const;


        ListboxItem*    getListboxItemFromIndex(size_t index) const;


        size_t  getItemIndex(const ListboxItem* item) const;


        bool    isSortEnabled(void) const;


        bool    isItemSelected(size_t index) const;


        ListboxItem*    findItemWithText(const String& text, const ListboxItem* start_item);


        bool    isListboxItemInList(const ListboxItem* item) const;


        bool    isVertScrollbarAlwaysShown(void) const;


        bool    isHorzScrollbarAlwaysShown(void) const;


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


        void    showDropList(void);


        void    hideDropList(void);


        void    setSingleClickEnabled(bool setting);

    void selectListItemWithEditboxText();

    void setAutoSizeListHeightToContent(bool auto_size);

    void setAutoSizeListWidthToContent(bool auto_size);

    void updateAutoSizedDropList();

        /*************************************************************************
                Editbox Manipulators
        *************************************************************************/
        void    setReadOnly(bool setting);


        void    setValidationString(const String& validation_string);


        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    activateEditbox(void);


        /*************************************************************************
                List Manipulators
        *************************************************************************/
        void    resetList(void);


        void    addItem(ListboxItem* item);


        void    insertItem(ListboxItem* item, const ListboxItem* position);


        void    removeItem(const ListboxItem* item);


        void    clearAllSelections(void);


        void    setSortingEnabled(bool setting);

        
        void    setShowVertScrollbar(bool setting);


        void    setShowHorzScrollbar(bool setting);


        void    setItemSelectState(ListboxItem* item, bool state);


        void    setItemSelectState(size_t item_index, bool state);


        void    handleUpdatedListItemData(void);


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


        virtual ~Combobox(void);


protected:
        /*************************************************************************
                Implementation Methods
        *************************************************************************/
        bool    button_PressHandler(const EventArgs& e);


        bool    droplist_SelectionAcceptedHandler(const EventArgs& e);


        bool    droplist_HiddenHandler(const EventArgs& e);


        bool    editbox_MouseDownHandler(const EventArgs& e);

    void itemSelectChangeTextUpdate(const ListboxItem* const item,
                                    bool new_state, bool old_state);

        /*************************************************************************
                Handlers to relay child widget events so they appear to come from us
        *************************************************************************/
        bool editbox_ReadOnlyChangedHandler(const EventArgs& e);
        bool editbox_ValidationStringChangedHandler(const EventArgs& e);
        bool editbox_MaximumTextLengthChangedHandler(const EventArgs& e);
        bool editbox_TextValidityChangedHandler(const EventArgs& e);
        bool editbox_CaretMovedHandler(const EventArgs& e);
        bool editbox_TextSelectionChangedHandler(const EventArgs& e);
        bool editbox_EditboxFullEventHandler(const EventArgs& e);
        bool editbox_TextAcceptedEventHandler(const EventArgs& e);
        bool editbox_TextChangedEventHandler(const EventArgs& e);
        bool listbox_ListContentsChangedHandler(const EventArgs& e);
        bool listbox_ListSelectionChangedHandler(const EventArgs& e);
        bool listbox_SortModeChangedHandler(const EventArgs& e);
        bool listbox_VertScrollModeChangedHandler(const EventArgs& e);
        bool listbox_HorzScrollModeChangedHandler(const EventArgs& e);

        
        /*************************************************************************
                New Events for Combobox
        *************************************************************************/
        virtual void    onReadOnlyChanged(WindowEventArgs& e);


        virtual void    onValidationStringChanged(WindowEventArgs& e);


        virtual void    onMaximumTextLengthChanged(WindowEventArgs& e);


    virtual void onTextValidityChanged(RegexMatchStateEventArgs& e);


        virtual void    onCaretMoved(WindowEventArgs& e);


        virtual void    onTextSelectionChanged(WindowEventArgs& e);


        virtual void    onEditboxFullEvent(WindowEventArgs& e);


        virtual void    onTextAcceptedEvent(WindowEventArgs& e);


        virtual void    onListContentsChanged(WindowEventArgs& e);


        virtual void    onListSelectionChanged(WindowEventArgs& e);


        virtual void    onSortModeChanged(WindowEventArgs& e);


        virtual void    onVertScrollbarModeChanged(WindowEventArgs& e);


        virtual void    onHorzScrollbarModeChanged(WindowEventArgs& e);


        virtual void    onDropListDisplayed(WindowEventArgs& e);


        virtual void    onDroplistRemoved(WindowEventArgs& e);


        virtual void    onListSelectionAccepted(WindowEventArgs& e);


        /*************************************************************************
                Overridden Event handlers
        *************************************************************************/
        virtual void    onFontChanged(WindowEventArgs& e);
        virtual void    onTextChanged(WindowEventArgs& e);
        virtual void    onActivated(ActivationEventArgs& e);
    void onSized(ElementEventArgs& e);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        bool                    d_singleClickOperation;         
    bool d_autoSizeHeight;
    bool d_autoSizeWidth;

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

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUICombobox_h_