CEGUIMenuItem.h

/***********************************************************************
    filename:   CEGUIMenuItem.h
    created:    2/4/2005
    author:     Tomas Lindquist Olsen (based on code by Paul D Turner)

    purpose:    Interface to base class for MenuItem 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 _CEGUIMenuItem_h_
#define _CEGUIMenuItem_h_

#include "../CEGUIBase.h"
#include "../CEGUIWindow.h"
#include "CEGUIItemEntry.h"

#include "CEGUIMenuItemProperties.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT MenuItem : public ItemEntry
{
public:
    static const String EventNamespace;             
    static const String WidgetTypeName;             

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


    /*************************************************************************
        Accessor type functions
    *************************************************************************/
    bool    isHovering(void) const
    {
        return d_hovering;
    }


    bool    isPushed(void) const
    {
        return d_pushed;
    }


    bool    isOpened(void) const
    {
        return d_opened;
    }

    bool    isPopupClosing(void) const
    {
        return d_popupClosing;
    }

    bool    hasAutoPopup(void) const
    {
        return d_autoPopupTimeout > 0.0f;
    }

    float    getAutoPopupTimeout(void) const
    {
        return d_autoPopupTimeout;
    }

    void    setAutoPopupTimeout(float time)
    {
        d_autoPopupTimeout = time;
    }

    PopupMenu*  getPopupMenu(void) const
    {
        return d_popup;
    }

    const UVector2& getPopupOffset(void) const
    {
        return d_popupOffset;
    }

    void setPopupOffset(const UVector2& popupOffset)
    {
        d_popupOffset = popupOffset;
    }

    /*************************************************************************
        Manipulators
    *************************************************************************/
    void    setPopupMenu(PopupMenu* popup);


    void    openPopupMenu(bool notify = true);


    void    closePopupMenu(bool notify = true);


    bool    togglePopupMenu(void);

    void    startPopupClosing(void);

    void    startPopupOpening(void);
    /*************************************************************************
        Construction and Destruction
    *************************************************************************/
    MenuItem(const String& type, const String& name);


    virtual ~MenuItem(void);


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


    /*************************************************************************
        Overridden event handlers
    *************************************************************************/
    virtual void    onMouseMove(MouseEventArgs& e);
    virtual void    onMouseButtonDown(MouseEventArgs& e);
    virtual void    onMouseButtonUp(MouseEventArgs& e);
    virtual void    onCaptureLost(WindowEventArgs& e);
    virtual void    onMouseLeaves(MouseEventArgs& e);
    virtual void    onTextChanged(WindowEventArgs& e);
    virtual void    updateSelf(float elapsed);


    /*************************************************************************
        Implementation Functions
    *************************************************************************/
    void    updateInternalState(const Point& mouse_pos);


    void    closeAllMenuItemPopups();


    void    setPopupMenu_impl(PopupMenu* popup, bool add_as_child = true);


    virtual bool    testClassName_impl(const String& class_name) const
    {
        if (class_name == "MenuItem") return true;

        return ItemEntry::testClassName_impl(class_name);
    }


    /*************************************************************************
        Implementation Data
    *************************************************************************/
    bool d_pushed;          
    bool d_hovering;        
    bool d_opened;          
    bool d_popupClosing;    
    bool d_popupOpening;    
    float d_autoPopupTimeout; 
    float d_autoPopupTimeElapsed;  

    PopupMenu*  d_popup;    

    bool d_popupWasClosed;  

    UVector2 d_popupOffset; 

private:
    /************************************************************************
    Static Properties for this class
    ************************************************************************/
    static MenuItemProperties::PopupOffset d_popupOffsetProperty;
    static MenuItemProperties::AutoPopupTimeout d_autoPopupTimeoutProperty;

    /*************************************************************************
        Private methods
    *************************************************************************/
    void addMenuItemProperties(void);

    virtual void    addChild_impl(Window* wnd);
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIMenuItem_h_