/************************************************************************
    filename:   FalTooltip.h
    created:    Thu Jul 7 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/*************************************************************************
    Crazy Eddie's GUI System (http://www.cegui.org.uk)
    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*************************************************************************/
#ifndef _FalTooltip_h_
#define _FalTooltip_h_

#include "FalModule.h"
#include "CEGUIWindowFactory.h"
#include "elements/CEGUITooltip.h"

// Start of CEGUI namespace section
namespace CEGUI
{
    /*!
    \brief
        Tooltip class for the FalagardBase module.

        This class requires LookNFeel to be assigned.  The LookNFeel should provide the following:

        States:
            - Enabled
            - Disabled

        Named Areas:
            TextArea    - Typically this would be the same area as the TextComponent you define to receive the tooltip text.  This
                            named area is used when deciding how to dynamically size the Tooltip so that text is not clipped.
    */
    class FALAGARDBASE_API FalagardTooltip : public Tooltip
    {
    public:
        static const utf8   WidgetTypeName[];       //!< type name for this widget.

        /*!
        \brief
            Constructor
        */
        FalagardTooltip(const String& type, const String& name);

        /*!
        \brief
            Destructor
        */
        ~FalagardTooltip();

    protected:
        // overridden from Tooltip base class.
        void populateRenderCache();
        Size getTextSize() const;

    };

    /*!
    \brief
        WindowFactory for FalagardTooltip type Window objects.
    */
    class FALAGARDBASE_API FalagardTooltipFactory : public WindowFactory
    {
    public:
        FalagardTooltipFactory(void) : WindowFactory(FalagardTooltip::WidgetTypeName) { }
        ~FalagardTooltipFactory(void){}
        Window* createWindow(const String& name);
        void destroyWindow(Window* window);
    };

} // End of  CEGUI namespace section


#endif  // end of guard _FalTooltip_h_
