CEGUIPushButton.h

00001 /***********************************************************************
00002         filename:       CEGUIPushButton.h
00003         created:        13/4/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface to base class for PushButton widget
00007 *************************************************************************/
00008 /***************************************************************************
00009  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00010  *
00011  *   Permission is hereby granted, free of charge, to any person obtaining
00012  *   a copy of this software and associated documentation files (the
00013  *   "Software"), to deal in the Software without restriction, including
00014  *   without limitation the rights to use, copy, modify, merge, publish,
00015  *   distribute, sublicense, and/or sell copies of the Software, and to
00016  *   permit persons to whom the Software is furnished to do so, subject to
00017  *   the following conditions:
00018  *
00019  *   The above copyright notice and this permission notice shall be
00020  *   included in all copies or substantial portions of the Software.
00021  *
00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00028  *   OTHER DEALINGS IN THE SOFTWARE.
00029  ***************************************************************************/
00030 #ifndef _CEGUIPushButton_h_
00031 #define _CEGUIPushButton_h_
00032 
00033 #include "CEGUIBase.h"
00034 #include "elements/CEGUIButtonBase.h"
00035 
00036 #if defined(_MSC_VER)
00037 #       pragma warning(push)
00038 #       pragma warning(disable : 4251)
00039 #endif
00040 
00041 // Start of CEGUI namespace section
00042 namespace CEGUI
00043 {
00048 class CEGUIEXPORT PushButton : public ButtonBase
00049 {
00050 public:
00051         static const String EventNamespace;                             
00052     static const String WidgetTypeName;             
00053 
00054         /*************************************************************************
00055                 Event name constants
00056         *************************************************************************/
00057         // generated internally by Window
00058         static const String EventClicked;                                       
00059 
00060         /*************************************************************************
00061                 Construction and Destruction
00062         *************************************************************************/
00067         PushButton(const String& type, const String& name);
00068 
00069 
00074         virtual ~PushButton(void);
00075 
00076 
00077 protected:
00078         /*************************************************************************
00079                 New Event Handlers
00080         *************************************************************************/
00085         virtual void    onClicked(WindowEventArgs& e);
00086 
00087 
00088         /*************************************************************************
00089                 Overridden Event Handlers
00090         *************************************************************************/
00091         virtual void    onMouseButtonUp(MouseEventArgs& e);
00092 
00093 
00094         /*************************************************************************
00095                 Implementation Functions
00096         *************************************************************************/
00107         virtual bool    testClassName_impl(const String& class_name) const
00108         {
00109                 if (class_name=="PushButton")   return true;
00110                 return ButtonBase::testClassName_impl(class_name);
00111         }
00112 
00113 };
00114 
00115 } // End of  CEGUI namespace section
00116 
00117 #if defined(_MSC_VER)
00118 #       pragma warning(pop)
00119 #endif
00120 
00121 #endif  // end of guard _CEGUIPushButton_h_

Generated on Sat Jun 28 14:35:44 2008 for Crazy Eddies GUI System by  doxygen 1.5.4