Crazy Eddie's GUI System  0.8.4
PopupMenu.h
00001 /***********************************************************************
00002     created:    27/3/2005
00003     author:     Tomas Lindquist Olsen (based on code by Paul D Turner)
00004     
00005     purpose:    Interface to base class for PopupMenu widget
00006 *************************************************************************/
00007 /***************************************************************************
00008  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00009  *
00010  *   Permission is hereby granted, free of charge, to any person obtaining
00011  *   a copy of this software and associated documentation files (the
00012  *   "Software"), to deal in the Software without restriction, including
00013  *   without limitation the rights to use, copy, modify, merge, publish,
00014  *   distribute, sublicense, and/or sell copies of the Software, and to
00015  *   permit persons to whom the Software is furnished to do so, subject to
00016  *   the following conditions:
00017  *
00018  *   The above copyright notice and this permission notice shall be
00019  *   included in all copies or substantial portions of the Software.
00020  *
00021  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00022  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00023  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00024  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00025  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00026  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00027  *   OTHER DEALINGS IN THE SOFTWARE.
00028  ***************************************************************************/
00029 #ifndef _CEGUIPopupMenu_h_
00030 #define _CEGUIPopupMenu_h_
00031 
00032 #include "../Base.h"
00033 #include "../Window.h"
00034 #include "./MenuBase.h"
00035 
00036 
00037 #if defined(_MSC_VER)
00038 #    pragma warning(push)
00039 #    pragma warning(disable : 4251)
00040 #endif
00041 
00042 
00043 // Start of CEGUI namespace section
00044 namespace CEGUI
00045 {
00046 
00051 class CEGUIEXPORT PopupMenu : public MenuBase
00052 {
00053 public:
00054     /************************************************************************
00055         Constants
00056     *************************************************************************/
00057     static const String EventNamespace;     
00058     static const String WidgetTypeName;             
00059 
00060     /*************************************************************************
00061         Accessor type functions
00062     *************************************************************************/
00071     float getFadeInTime(void) const      {return d_fadeInTime;}
00072 
00073 
00082     float getFadeOutTime(void) const     {return d_fadeOutTime;}
00083 
00084 
00089     bool isPopupMenuOpen(void) const     {return d_isOpen;}
00090 
00091 
00092     /*************************************************************************
00093         Manipulators
00094     *************************************************************************/
00103     void    setFadeInTime(float fadetime)         {d_fadeInTime=fadetime;}
00104 
00105 
00114     void    setFadeOutTime(float fadetime)        {d_fadeOutTime=fadetime;}
00115 
00116 
00124     void    openPopupMenu(bool notify=true);
00125 
00126 
00134     void    closePopupMenu(bool notify=true);
00135 
00136 
00137     /*************************************************************************
00138         Construction and Destruction
00139     *************************************************************************/
00144     PopupMenu(const String& type, const String& name);
00145 
00146 
00151     virtual ~PopupMenu(void);
00152 
00153 
00154 protected:
00155     /*************************************************************************
00156         Implementation Functions
00157     *************************************************************************/
00168     virtual void    updateSelf(float elapsed);
00169 
00170 
00178     virtual void    layoutItemWidgets(void);
00179 
00180 
00188     virtual Sizef getContentSize(void) const;
00189 
00190     /*************************************************************************
00191         Overridden event handlers
00192     *************************************************************************/
00193     virtual void onAlphaChanged(WindowEventArgs& e);
00194         virtual void onDestructionStarted(WindowEventArgs& e);
00195         virtual void onShown(WindowEventArgs& e);
00196         virtual void onHidden(WindowEventArgs& e);
00197         virtual void onMouseButtonDown(MouseEventArgs& e);
00198         virtual void onMouseButtonUp(MouseEventArgs& e);
00199 
00200 
00201     /*************************************************************************
00202         Implementation Data
00203     *************************************************************************/
00204     float d_origAlpha;      
00205     float d_fadeElapsed;    
00206     float d_fadeOutTime;    
00207     float d_fadeInTime;     
00208     bool d_fading;          
00209     bool d_fadingOut;       
00210     bool d_isOpen;          
00211 
00212 
00213 private:
00214     /*************************************************************************
00215     Private methods
00216     *************************************************************************/
00217     void    addPopupMenuProperties(void);
00218 };
00219 
00220 
00221 } // End of  CEGUI namespace section
00222 
00223 
00224 #if defined(_MSC_VER)
00225 #    pragma warning(pop)
00226 #endif
00227 
00228 
00229 #endif    // end of guard _CEGUIPopupMenu_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends