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     Crazy Eddie's GUI System (http://www.cegui.org.uk)
00010     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
00011 
00012     This library is free software; you can redistribute it and/or
00013     modify it under the terms of the GNU Lesser General Public
00014     License as published by the Free Software Foundation; either
00015     version 2.1 of the License, or (at your option) any later version.
00016 
00017     This library is distributed in the hope that it will be useful,
00018     but WITHOUT ANY WARRANTY; without even the implied warranty of
00019     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020     Lesser General Public License for more details.
00021 
00022     You should have received a copy of the GNU Lesser General Public
00023     License along with this library; if not, write to the Free Software
00024     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00025 *************************************************************************/
00026 #ifndef _CEGUITabButton_h_
00027 #define _CEGUITabButton_h_
00028 
00029 #include "CEGUIBase.h"
00030 #include "elements/CEGUIButtonBase.h"
00031 
00032 // Start of CEGUI namespace section
00033 namespace CEGUI
00034 {
00041 class CEGUIEXPORT TabButton : public ButtonBase
00042 {
00043 public:
00044         static const String EventNamespace;                             
00045 
00046 
00047         /*************************************************************************
00048                 Event name constants
00049         *************************************************************************/
00050         // generated internally by Window
00051         static const String EventClicked;                                       
00052 
00053         /*************************************************************************
00054                 Construction and Destruction
00055         *************************************************************************/
00060         TabButton(const String& type, const String& name);
00061 
00062 
00067         virtual ~TabButton(void);
00068 
00073     virtual void setSelected(bool selected) { d_selected = selected; requestRedraw(); }
00074 
00081     virtual void setRightOfSelected(bool isRight) { d_rightOfSelected = isRight; requestRedraw(); }
00082 
00087     bool isSelected(void) const { return d_selected; }
00088 
00089 
00095     void setTargetWindow(Window* wnd);
00101     Window* getTargetWindow(void) { return d_targetWindow; }
00102 
00107     void setTabIndex(uint idx) { d_tabIndex = idx; }
00108 
00113     uint getTabIndex(void) { return d_tabIndex; }
00114 protected:
00115     /*************************************************************************
00116     Implementation Data
00117     *************************************************************************/
00118     bool    d_selected;             
00119     bool    d_rightOfSelected;      
00120     Window* d_targetWindow;         
00121     uint    d_tabIndex;             
00122         /*************************************************************************
00123                 New Event Handlers
00124         *************************************************************************/
00129         virtual void    onClicked(WindowEventArgs& e);
00130 
00131 
00132         /*************************************************************************
00133                 Overridden Event Handlers
00134         *************************************************************************/
00135         virtual void    onMouseButtonUp(MouseEventArgs& e);
00136 
00137 
00138         /*************************************************************************
00139                 Implementation Functions
00140         *************************************************************************/
00145         void    addTabButtonEvents(void);
00156         void    drawSelf(float z);
00157 
00158 
00169         virtual bool    testClassName_impl(const String& class_name) const
00170         {
00171                 if (class_name==(const utf8*)"TabButton")       return true;
00172                 return ButtonBase::testClassName_impl(class_name);
00173         }
00174 };
00175 
00176 
00177 } // End of  CEGUI namespace section
00178 
00179 
00180 #endif  // end of guard _CEGUITabButton_h_

Generated on Sat Nov 26 09:34:49 2005 for Crazy Eddies GUI System by  doxygen 1.4.5