Crazy Eddies GUI System 0.7.6
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 "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
00059         static const String EventClicked;
00065         static const String EventDragged;
00070         static const String EventScrolled;
00071 
00072         /*************************************************************************
00073                 Construction and Destruction
00074         *************************************************************************/
00079         TabButton(const String& type, const String& name);
00080 
00081 
00086         virtual ~TabButton(void);
00087 
00092     virtual void setSelected(bool selected) { d_selected = selected; invalidate(); }
00093 
00098     bool isSelected(void) const { return d_selected; }
00099 
00100 
00106     void setTargetWindow(Window* wnd);
00112     Window* getTargetWindow(void) { return d_targetWindow; }
00113 
00114 protected:
00115     /*************************************************************************
00116     Implementation Data
00117     *************************************************************************/
00118     bool    d_selected;             
00119     bool    d_dragging;             
00120     Window* d_targetWindow;         
00121         /*************************************************************************
00122                 New Event Handlers
00123         *************************************************************************/
00128         virtual void    onClicked(WindowEventArgs& e);
00129 
00130 
00131         /*************************************************************************
00132                 Overridden Event Handlers
00133         *************************************************************************/
00134     virtual void onMouseButtonUp(MouseEventArgs& e);
00135     virtual void onMouseButtonDown(MouseEventArgs& e);
00136     virtual void onMouseWheel(MouseEventArgs& e);
00137     virtual void onMouseMove(MouseEventArgs& e);
00138 
00139         /*************************************************************************
00140                 Implementation Functions
00141         *************************************************************************/
00152         virtual bool    testClassName_impl(const String& class_name) const
00153         {
00154                 if (class_name=="TabButton")    return true;
00155                 return ButtonBase::testClassName_impl(class_name);
00156         }
00157 };
00158 
00159 
00160 } // End of  CEGUI namespace section
00161 
00162 
00163 #endif  // end of guard _CEGUITabButton_h_