CEGUITooltip.h

/***********************************************************************
    filename:   CEGUITooltip.h
    created:    21/2/2005
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   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 _CEGUITooltip_h_
#define _CEGUITooltip_h_

#include "CEGUIWindow.h"
#include "elements/CEGUITooltipProperties.h"

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT TooltipWindowRenderer : public WindowRenderer
    {
    public:
        TooltipWindowRenderer(const String& name);

        virtual Size getTextSize() const = 0;
    };

    class CEGUIEXPORT Tooltip : public Window
    {
    public:
        /*************************************************************************
            Constants
        *************************************************************************/
        static const String WidgetTypeName;                 
        static const String EventNamespace;                 
        static const String EventHoverTimeChanged;          
        static const String EventDisplayTimeChanged;        
        static const String EventFadeTimeChanged;           
        static const String EventTooltipActive;             
        static const String EventTooltipInactive;           

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

        ~Tooltip(void);

        /************************************************************************
            Public interface
        ************************************************************************/
        void setTargetWindow(Window* wnd);

        const Window* getTargetWindow();

        void resetTimer(void);

        float getHoverTime(void) const;

        void setDisplayTime(float seconds);

        float getFadeTime(void) const;

        void setHoverTime(float seconds);

        float getDisplayTime(void) const;

        void setFadeTime(float seconds);

        void positionSelf(void);

        void sizeSelf(void);

        Size getTextSize() const;

        virtual Size getTextSize_impl() const;

    protected:
        /*************************************************************************
            Implementation Methods
        *************************************************************************/
        // methods to perform processing for each of the widget states
        void doActiveState(float elapsed);
        void doInactiveState(float elapsed);
        void doFadeInState(float elapsed);
        void doFadeOutState(float elapsed);

        // methods to switch widget states
        void switchToInactiveState(void);
        void switchToActiveState(void);
        void switchToFadeInState(void);
        void switchToFadeOutState(void);


                virtual bool    testClassName_impl(const String& class_name) const
                {
                        if (class_name=="Tooltip")      return true;
                        return Window::testClassName_impl(class_name);
                }

        // validate window renderer
        virtual bool validateWindowRenderer(const String& name) const
        {
            return (name == "Tooltip");
        }

        /*************************************************************************
            Event triggers
        *************************************************************************/
        virtual void onHoverTimeChanged(WindowEventArgs& e);

        virtual void onDisplayTimeChanged(WindowEventArgs& e);

        virtual void onFadeTimeChanged(WindowEventArgs& e);

        virtual void onTooltipActive(WindowEventArgs& e);

        virtual void onTooltipInactive(WindowEventArgs& e);


        /************************************************************************
            Overridden from Window.
        ************************************************************************/
        void updateSelf(float elapsed);
        void onMouseEnters(MouseEventArgs& e);
        void onTextChanged(WindowEventArgs& e);

        /************************************************************************
            Enumerations
        ************************************************************************/
        enum TipState
        {
            Inactive,   
            Active,     
            FadeIn,     
            FadeOut     
        };

        /************************************************************************
            Data fields
        ************************************************************************/
        TipState    d_state;        
        float       d_elapsed;      
        const Window* d_target;     
        float       d_hoverTime;    
        float       d_displayTime;  
        float       d_fadeTime;     

    private:
        /*************************************************************************
            Static Properties for this class
        *************************************************************************/
        static TooltipProperties::HoverTime      d_hoverTimeProperty;
        static TooltipProperties::DisplayTime    d_displayTimeProperty;
        static TooltipProperties::FadeTime       d_fadeTimeProperty;

        /*************************************************************************
            Private methods
        *************************************************************************/
        void addTooltipProperties(void);
    };


} // End of  CEGUI namespace section


#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUITooltip_h_