File: CEGUIMenuItemProperties.h

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (101 lines) | stat: -rw-r--r-- 3,917 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/************************************************************************
    filename:   CEGUIMenuItemProperties.h
    created:    Mon Oct 18 2010
    author:     Robert Stoll
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 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 _CEGUIMenuItemProperties_h_
#define _CEGUIMenuItemProperties_h_

#include "../CEGUIProperty.h"

// Start of CEGUI namespace section
namespace CEGUI
{
// Start of MenuItemProperties namespace section
/*!
\brief
    Namespace containing all classes that make up the properties interface for the MenuItem class
*/
namespace MenuItemProperties
{
/*!
\brief
    Property to specify an offset for the popup menu position.

    \par Usage:
        - Name: PopupOffset
        - Format: "{{[xs],[xo]},{[ys],[yo]}}"

    \par Where:
        - [xs] is a floating point value describing the relative scale
          value for the offset x-coordinate.
        - [xo] is a floating point value describing the absolute offset
          value for the offset x-coordinate.
        - [ys] is a floating point value describing the relative scale
          value for the offset y-coordinate.
        - [yo] is a floating point value describing the absolute offset
          value for the offset y-coordinate.
*/
class PopupOffset : public Property
{
public:
    PopupOffset() : Property(
            "PopupOffset",
            "Property to specify an offset for the popup menu position. Value is a UVector2 property value.",
            "{{0,0},{0,0}}")
    {}

    String  get(const PropertyReceiver* receiver) const;
    void    set(PropertyReceiver* receiver, const String& value);
};

/*!
\brief
Property to specify the time, which has to elapse before the popup window is opened/closed if the hovering state changes

\par Usage:
- Name: AutoPopupTimeout
- Format: "[Float]"

\par Where [Float] is:
- wait time in seconds
- set to 0.0f if you want no automatic popups
*/
class AutoPopupTimeout : public Property
{
public:
    AutoPopupTimeout() : Property(
            "AutoPopupTimeout",
            "Property to specify the time, which has to elapse before the popup window is opened/closed if the hovering state changes. Value is a float property value.",
            "0.0f")
    {}

    String  get(const PropertyReceiver* receiver) const;
    void    set(PropertyReceiver* receiver, const String& value);
};
} // End of  MenuItemProperties namespace section
} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIMenuItemProperties_h_