CEGUIPopupMenu.h

/***********************************************************************
    filename:   CEGUIPopupMenu.h
    created:    27/3/2005
    author:     Tomas Lindquist Olsen (based on code by Paul D Turner)
    
    purpose:    Interface to base class for PopupMenu 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 _CEGUIPopupMenu_h_
#define _CEGUIPopupMenu_h_

#include "../CEGUIBase.h"
#include "../CEGUIWindow.h"
#include "CEGUIPopupMenuProperties.h"
#include "CEGUIMenuBase.h"


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


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT PopupMenu : public MenuBase
{
public:
    /************************************************************************
        Constants
    *************************************************************************/
    static const String EventNamespace;     
    static const String WidgetTypeName;             

    /*************************************************************************
        Accessor type functions
    *************************************************************************/
    float getFadeInTime(void) const      {return d_fadeInTime;}


    float getFadeOutTime(void) const     {return d_fadeOutTime;}


    bool isPopupMenuOpen(void) const     {return d_isOpen;}


    /*************************************************************************
        Manipulators
    *************************************************************************/
    void    setFadeInTime(float fadetime)         {d_fadeInTime=fadetime;}


    void    setFadeOutTime(float fadetime)        {d_fadeOutTime=fadetime;}


    void    openPopupMenu(bool notify=true);


    void    closePopupMenu(bool notify=true);


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


    virtual ~PopupMenu(void);


protected:
    /*************************************************************************
        Implementation Functions
    *************************************************************************/
    virtual void    updateSelf(float elapsed);


    virtual void    layoutItemWidgets(void);


    virtual Size getContentSize(void) const;


    virtual bool    testClassName_impl(const String& class_name) const
    {
        if (class_name=="PopupMenu")    return true;
        return MenuBase::testClassName_impl(class_name);
    }


    /*************************************************************************
        Overridden event handlers
    *************************************************************************/
    virtual void onAlphaChanged(WindowEventArgs& e);
        virtual void onDestructionStarted(WindowEventArgs& e);
        virtual void onShown(WindowEventArgs& e);
        virtual void onHidden(WindowEventArgs& e);
        virtual void onMouseButtonDown(MouseEventArgs& e);
        virtual void onMouseButtonUp(MouseEventArgs& e);


    /*************************************************************************
        Implementation Data
    *************************************************************************/
    float d_origAlpha;      
    float d_fadeElapsed;    
    float d_fadeOutTime;    
    float d_fadeInTime;     
    bool d_fading;          
    bool d_fadingOut;       
    bool d_isOpen;          


private:
    /*************************************************************************
    Static Properties for this class
    *************************************************************************/
    static PopupMenuProperties::FadeInTime  d_fadeInTimeProperty;
    static PopupMenuProperties::FadeOutTime d_fadeOutTimeProperty;


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


} // End of  CEGUI namespace section


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


#endif    // end of guard _CEGUIPopupMenu_h_