CEGUIMenuBase.h

/***********************************************************************
        filename:       CEGUIMenuBase.h
        created:        5/4/2005
        author:         Tomas Lindquist Olsen (based on code by Paul D Turner)
        
        purpose:        Interface to base class for MenuBase 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 _CEGUIMenuBase_h_
#define _CEGUIMenuBase_h_

#include "../CEGUIBase.h"
#include "../CEGUIWindow.h"
#include "CEGUIMenuBaseProperties.h"
#include "CEGUIItemListBase.h"


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


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT MenuBase : public ItemListBase
{
public:
        static const String EventNamespace;                             


        /*************************************************************************
                Event name constants
        *************************************************************************/
        // generated internally by Window
        static const String EventPopupOpened;                                   
        static const String EventPopupClosed;                                   


        /*************************************************************************
                Accessor type functions
        *************************************************************************/
        float   getItemSpacing(void) const                                      {return d_itemSpacing;}


        bool    isMultiplePopupsAllowed(void) const                     {return d_allowMultiplePopups;}


        MenuItem*       getPopupMenuItem(void) const                            {return d_popupItem;}


        /*************************************************************************
                Manipulators
        *************************************************************************/
        void    setItemSpacing(float spacing)                           {d_itemSpacing=spacing; handleUpdatedItemData();}


        void    changePopupMenuItem(MenuItem* item);


        void    setAllowMultiplePopups(bool setting);


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


        virtual ~MenuBase(void);


protected:
        /*************************************************************************
                New Event Handlers
        *************************************************************************/
        virtual void    onPopupOpened(WindowEventArgs& e);


        virtual void    onPopupClosed(WindowEventArgs& e);

    // overridden from base
    virtual void onChildRemoved(WindowEventArgs& e);

        /*************************************************************************
                Implementation Functions
        *************************************************************************/
        virtual bool    testClassName_impl(const String& class_name) const
        {
                if (class_name=="MenuBase")     return true;
                return ItemListBase::testClassName_impl(class_name);
        }


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        float d_itemSpacing;            
        
        MenuItem* d_popupItem;      
        bool d_allowMultiplePopups;     


private:
        /*************************************************************************
        Static Properties for this class
        *************************************************************************/
        static MenuBaseProperties::ItemSpacing                  d_itemSpacingProperty;
        static MenuBaseProperties::AllowMultiplePopups  d_allowMultiplePopupsProperty;

        /*************************************************************************
        Private methods
        *************************************************************************/
        void    addMenuBaseProperties(void);
};

} // End of  CEGUI namespace section


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

#endif  // end of guard _CEGUIMenuBase_h_