CEGUIComboDropList.h

/***********************************************************************
        filename:       CEGUIComboDropList.h
        created:        13/6/2004
        author:         Paul D Turner

        purpose:        Interface for the Combobox Drop-List widget 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 _CEGUIComboDropList_h_
#define _CEGUIComboDropList_h_

#include "CEGUIListbox.h"


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


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ComboDropList : public Listbox
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             


        /*************************************************************************
                Constants
        *************************************************************************/
        // Event names
        static const String EventListSelectionAccepted;         


        virtual void    initialiseComponents(void);


        void    setArmed(bool setting)          { d_armed = setting; }


        bool    isArmed(void) const             { return d_armed; }


        void    setAutoArmEnabled(bool setting)         { d_autoArm = setting; }


        bool    isAutoArmEnabled(void) const            { return d_autoArm; }


        /*************************************************************************
                Constructor & Destructor
        *************************************************************************/
        ComboDropList(const String& type, const String& name);


        virtual ~ComboDropList(void);


protected:
        virtual bool    testClassName_impl(const String& class_name) const
        {
                if (class_name=="ComboDropList")        return true;
                return Listbox::testClassName_impl(class_name);
        }

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


        /*************************************************************************
                Overridden Event handling
        *************************************************************************/
        virtual void    onMouseMove(MouseEventArgs& e);
        virtual void    onMouseButtonDown(MouseEventArgs& e);
        virtual void    onMouseButtonUp(MouseEventArgs& e);
        virtual void    onCaptureLost(WindowEventArgs& e);
        virtual void    onActivated(ActivationEventArgs& e);
    virtual void    onListContentsChanged(WindowEventArgs& e);
    virtual void    onSelectionChanged(WindowEventArgs& e);

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        bool    d_autoArm;              
        bool    d_armed;                
    ListboxItem* d_lastClickSelected; 
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIComboDropList_h_