source: OGRE/trunk/ogre_dependencies/Dependencies/include/CEGUI/elements/CEGUITooltipProperties.h @ 692

Revision 692, 3.9 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies

Line 
1/************************************************************************
2        filename:       CEGUITooltipProperties.h
3        created:        3/3/2005
4        author:         Paul D Turner
5*************************************************************************/
6/*************************************************************************
7    Crazy Eddie's GUI System (http://www.cegui.org.uk)
8    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
9
10    This library is free software; you can redistribute it and/or
11    modify it under the terms of the GNU Lesser General Public
12    License as published by the Free Software Foundation; either
13    version 2.1 of the License, or (at your option) any later version.
14
15    This library is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    Lesser General Public License for more details.
19
20    You should have received a copy of the GNU Lesser General Public
21    License along with this library; if not, write to the Free Software
22    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23*************************************************************************/
24#ifndef _CEGUITooltipProperties_h_
25#define _CEGUITooltipProperties_h_
26
27#include "CEGUIProperty.h"
28
29// Start of CEGUI namespace section
30namespace CEGUI
31{
32// Start of TooltipProperties namespace section
33/*!
34\brief
35        Namespace containing all classes that make up the properties interface for the Tooltip class
36*/
37namespace TooltipProperties
38{
39    /*!
40    \brief
41        Property to access the timout that must expire before the tooltip gets activated.
42
43    \par Usage:
44        - Name: HoverTime
45        - Format: "[float]".
46
47    \par Where:
48        - [float] specifies the number of seconds the mouse must hover stationary on a widget before the tooltip gets activated.
49    */
50    class HoverTime : public Property
51    {
52    public:
53        HoverTime() : Property(
54            "HoverTime",
55            "Property to get/set the hover timeout value in seconds.  Value is a float.",
56            "0.400000")
57        {}
58
59        String  get(const PropertyReceiver* receiver) const;
60        void    set(PropertyReceiver* receiver, const String& value);
61    };
62
63    /*!
64    \brief
65        Property to access the time after which the tooltip automatically de-activates itself.
66
67    \par Usage:
68        - Name: DisplayTime
69        - Format: "[float]".
70
71    \par Where:
72        - [float] specifies the number of seconds after which the tooltip will deactivate itself if the mouse has remained stationary.
73    */
74    class DisplayTime : public Property
75    {
76    public:
77        DisplayTime() : Property(
78            "DisplayTime",
79            "Property to get/set the display timeout value in seconds.  Value is a float.",
80            "7.500000")
81        {}
82
83        String  get(const PropertyReceiver* receiver) const;
84        void    set(PropertyReceiver* receiver, const String& value);
85    };
86
87    /*!
88    \brief
89        Property to access the duration of the fade effect for the tooltip.
90
91    \par Usage:
92        - Name: FadeTime
93        - Format: "[float]".
94
95    \par Where:
96        - [float] specifies the number of seconds over which the fade in / fade out effect will happen.
97    */
98    class FadeTime : public Property
99    {
100    public:
101        FadeTime() : Property(
102            "FadeTime",
103            "Property to get/set duration of the fade effect in seconds.  Value is a float.",
104            "0.330000")
105        {}
106
107        String  get(const PropertyReceiver* receiver) const;
108        void    set(PropertyReceiver* receiver, const String& value);
109    };
110
111} // End of  TooltipProperties namespace section
112} // End of  CEGUI namespace section
113
114
115#endif  // end of guard _CEGUITooltipProperties_h_
Note: See TracBrowser for help on using the repository browser.