libcegui-mk2-dev 0.7.6-3.3 / usr / include / CEGUI / elements / 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
{

/*!
\brief
    Base class for menu items.
*/
class CEGUIEXPORT MenuItem : public ItemEntry
{
public:
    static const String EventNamespace;             //!< Namespace for global events
    static const String WidgetTypeName;             //!< Window factory name

    /*************************************************************************
        Event name constants
    *************************************************************************/
    // generated internally by Window
    /** Event fired when the menu item is clicked.
     * Handlers are passed a const WindowEventArgs reference with
     * WindowEventArgs::window set to the MenuItem that was clicked.
     */
    static const String EventClicked;


    /*************************************************************************
        Accessor type functions
    *************************************************************************/
    /*!
    \brief
        return true if user is hovering over this widget (or it's pushed and user is not over it for highlight)

    \return
        true if the user is hovering or if the button is pushed and the mouse is not over the button.  Otherwise return false.
    */
    bool    isHovering(void) const
    {
        return d_hovering;
    }


    /*!
    \brief
        Return true if the button widget is in the pushed state.

    \return
        true if the button-type widget is pushed, false if the widget is not pushed.
    */
    bool    isPushed(void) const
    {
        return d_pushed;
    }


    /*!
    \brief
        Returns true if the popup menu attached to the menu item is open.
    */
    bool    isOpened(void) const
    {
        return d_opened;
    }

    /*!
    \brief
        Returns true if the menu item popup is closing or not.
    */
    bool    isPopupClosing(void) const
    {
        return d_popupClosing;
    }

    /*!
    \brief
        Returns true if the menu item popup is closed or opened automatically if hovering with the mouse.
    */
    bool    hasAutoPopup(void) const
    {
        return d_autoPopupTimeout > 0.0f;
    }

    /*!
    \brief
        Returns the time, which has to elapse before the popup window is opened/closed if the hovering state changes.
    */
    float    getAutoPopupTimeout(void) const
    {
        return d_autoPopupTimeout;
    }

    /*!
    \brief
        Sets the time, which has to elapse before the popup window is opened/closed if the hovering state changes.
    */
    void    setAutoPopupTimeout(float time)
    {
        d_autoPopupTimeout = time;
    }

    /*!
    \brief
        Get the PopupMenu that is currently attached to this MenuItem.

    \return
        A pointer to the currently attached PopupMenu.  Null is there is no PopupMenu attached.
    */
    PopupMenu*  getPopupMenu(void) const
    {
        return d_popup;
    }

    /*!
    \brief
        Returns the current offset for popup placement.
    */
    const UVector2& getPopupOffset(void) const
    {
        return d_popupOffset;
    }

    /*!
    \brief
        sets the current offset for popup placement.
    */
    void setPopupOffset(const UVector2& popupOffset)
    {
        d_popupOffset = popupOffset;
    }

    /*************************************************************************
        Manipulators
    *************************************************************************/
    /*!
    \brief
        Set the popup menu for this item.

    \param popup
        popupmenu window to attach to this item

    \return
        Nothing.
    */
    void    setPopupMenu(PopupMenu* popup);


    /*!
    \brief
        Opens the PopupMenu.

    \param notify
        true if the parent menu bar or menu popup (if any) is to handle the open.
    */
    void    openPopupMenu(bool notify = true);


    /*!
    \brief
        Closes the PopupMenu.

    \param notify
        true if the parent menubar (if any) is to handle the close.

    \return
        Nothing.
    */
    void    closePopupMenu(bool notify = true);


    /*!
    \brief
        Toggles the PopupMenu.

    \return
        true if the popup was opened. false if it was closed.
    */
    bool    togglePopupMenu(void);

    /*!
    \brief
        starts the closing timer for the popup, which will close it if the timer is enabled.
    */
    void    startPopupClosing(void);

    /*!
    \brief
        starts the opening timer for the popup, which will open it if the timer is enabled.
    */
    void    startPopupOpening(void);
    /*************************************************************************
        Construction and Destruction
    *************************************************************************/
    /*!
    \brief
        Constructor for MenuItem objects
    */
    MenuItem(const String& type, const String& name);


    /*!
    \brief
        Destructor for MenuItem objects
    */
    virtual ~MenuItem(void);


protected:
    /*************************************************************************
        New Event Handlers
    *************************************************************************/
    /*!
    \brief
        handler invoked internally when the MenuItem is clicked.
    */
    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
    *************************************************************************/
    /*!
    \brief
        Update the internal state of the widget with the mouse at the given position.

    \param mouse_pos
        Point object describing, in screen pixel co-ordinates, the location of the mouse cursor.

    \return
        Nothing
    */
    void    updateInternalState(const Point& mouse_pos);


    /*!
    \brief
        Recursive function that closes all popups down the hierarcy starting with this one.

    \return
        Nothing.
    */
    void    closeAllMenuItemPopups();


    /*!
    \brief
        Set the popup menu for this item.

    \param popup
        popupmenu window to attach to this item

    \return
        Nothing.
    */
    void    setPopupMenu_impl(PopupMenu* popup, bool add_as_child = true);


    /*!
    \brief
        Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

    \param class_name
        The class name that is to be checked.

    \return
        true if this window was inherited from \a class_name. false if not.
    */
    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;          //!< true when widget is pushed
    bool d_hovering;        //!< true when the button is in 'hover' state and requires the hover rendering.
    bool d_opened;          //!< true when the menu item's popup menu is in its opened state.
    bool d_popupClosing;    //!< true when the d_popupTimerTimeElapsed timer is running to close the popup (another menu item of our container is hovered)
    bool d_popupOpening;    //!< true when the d_popupTimerTimeElapsed timer is running to open the popup (the menu item is hovered)
    float d_autoPopupTimeout; //!< the time in seconds, to wait before opening / closing the popup if the mouse is over the item / over another item in our container
    float d_autoPopupTimeElapsed;  //!< the current time, which is already elapsed if the timer is running (d_popupClosing or d_popupOpening is true)

    PopupMenu*  d_popup;    //!< PopupMenu that this item displays when activated.

    bool d_popupWasClosed;  //!< Used internally to determine if a popup was just closed on a Clicked event

    UVector2 d_popupOffset; //!< current offset for popup placement.

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

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

    /*!
    \brief
        Add given window to child list at an appropriate position
    */
    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_