CEGUITabButton.h

00001 /***********************************************************************
00002         filename:       CEGUITabButton.h
00003         created:        8/8/2004
00004         author:         Steve Streeting
00005         
00006         purpose:        Interface to base class for TabButton 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 _CEGUITabButton_h_
00031 #define _CEGUITabButton_h_
00032 
00033 #include "CEGUIBase.h"
00034 #include "elements/CEGUIButtonBase.h"
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00045 class CEGUIEXPORT TabButton : public ButtonBase
00046 {
00047 public:
00048         static const String EventNamespace;                             
00049     static const String WidgetTypeName;             
00050 
00051         /*************************************************************************
00052                 Event name constants
00053         *************************************************************************/
00054         // generated internally by Window
00055         static const String EventClicked;                                       
00056         static const String EventDragged;                                       
00057         static const String EventScrolled;                                      
00058 
00059         /*************************************************************************
00060                 Construction and Destruction
00061         *************************************************************************/
00066         TabButton(const String& type, const String& name);
00067 
00068 
00073         virtual ~TabButton(void);
00074 
00079     virtual void setSelected(bool selected) { d_selected = selected; requestRedraw(); }
00080 
00085     bool isSelected(void) const { return d_selected; }
00086 
00087 
00093     void setTargetWindow(Window* wnd);
00099     Window* getTargetWindow(void) { return d_targetWindow; }
00100 
00101 protected:
00102     /*************************************************************************
00103     Implementation Data
00104     *************************************************************************/
00105     bool    d_selected;             
00106     bool    d_dragging;             
00107     Window* d_targetWindow;         
00108         /*************************************************************************
00109                 New Event Handlers
00110         *************************************************************************/
00115         virtual void    onClicked(WindowEventArgs& e);
00116 
00117 
00118         /*************************************************************************
00119                 Overridden Event Handlers
00120         *************************************************************************/
00121     virtual void onMouseButtonUp(MouseEventArgs& e);
00122     virtual void onMouseButtonDown(MouseEventArgs& e);
00123     virtual void onMouseWheel(MouseEventArgs& e);
00124     virtual void onMouseMove(MouseEventArgs& e);
00125 
00126         /*************************************************************************
00127                 Implementation Functions
00128         *************************************************************************/
00139         virtual bool    testClassName_impl(const String& class_name) const
00140         {
00141                 if (class_name=="TabButton")    return true;
00142                 return ButtonBase::testClassName_impl(class_name);
00143         }
00144 };
00145 
00146 
00147 } // End of  CEGUI namespace section
00148 
00149 
00150 #endif  // end of guard _CEGUITabButton_h_

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