widgets/TabButton.h

/***********************************************************************
        created:        8/8/2004
        author:         Steve Streeting
        
        purpose:        Interface to base class for TabButton widget
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUITabButton_h_
#define _CEGUITabButton_h_

#include "../Base.h"
#include "./ButtonBase.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT TabButton : public ButtonBase
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Event name constants
        *************************************************************************/
        // generated internally by Window
        static const String EventClicked;
        static const String EventDragged;
        static const String EventScrolled;

        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        TabButton(const String& type, const String& name);


        virtual ~TabButton(void);

    virtual void setSelected(bool selected) { d_selected = selected; invalidate(); }

    bool isSelected(void) const { return d_selected; }


    void setTargetWindow(Window* wnd);
    Window* getTargetWindow(void) { return d_targetWindow; }

protected:
    /*************************************************************************
    Implementation Data
    *************************************************************************/
    bool    d_selected;             
    bool    d_dragging;             
    Window* d_targetWindow;         
        /*************************************************************************
                New Event Handlers
        *************************************************************************/
        virtual void    onClicked(WindowEventArgs& e);


        /*************************************************************************
                Overridden Event Handlers
        *************************************************************************/
    virtual void onMouseButtonUp(MouseEventArgs& e);
    virtual void onMouseButtonDown(MouseEventArgs& e);
    virtual void onMouseWheel(MouseEventArgs& e);
    virtual void onMouseMove(MouseEventArgs& e);
};


} // End of  CEGUI namespace section


#endif  // end of guard _CEGUITabButton_h_