/usr/include/CEGUI/elements/CEGUIScrollbarProperties.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | /***********************************************************************
filename: CEGUIScrollbarProperties.h
created: 10/7/2004
author: Paul D Turner
purpose: Interface for Scrollbar properties
*************************************************************************/
/***************************************************************************
* 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 _CEGUIScrollbarProperties_h_
#define _CEGUIScrollbarProperties_h_
#include "../CEGUIProperty.h"
// Start of CEGUI namespace section
namespace CEGUI
{
// Start of ScrollbarProperties namespace section
/*!
\brief
Namespace containing all classes that make up the properties interface for the Scrollbar class
*/
namespace ScrollbarProperties
{
/*!
\brief
Property to access the document size for the Scrollbar.
\par Usage:
- Name: DocumentSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the document being scrolled (as defined by the client code).
*/
class DocumentSize : public Property
{
public:
DocumentSize() : Property(
"DocumentSize",
"Property to get/set the document size for the Scrollbar. Value is a float.",
"1.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the page size for the Scrollbar.
\par Usage:
- Name: PageSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the visible page (as defined by the client code).
*/
class PageSize : public Property
{
public:
PageSize() : Property(
"PageSize",
"Property to get/set the page size for the Scrollbar. Value is a float.",
"0.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the step size for the Scrollbar.
\par Usage:
- Name: StepSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the increase/decrease button step (as defined by the client code).
*/
class StepSize : public Property
{
public:
StepSize() : Property(
"StepSize",
"Property to get/set the step size for the Scrollbar. Value is a float.",
"1.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the overlap size for the Scrollbar.
\par Usage:
- Name: OverlapSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the per-page overlap (as defined by the client code).
*/
class OverlapSize : public Property
{
public:
OverlapSize() : Property(
"OverlapSize",
"Property to get/set the overlap size for the Scrollbar. Value is a float.",
"0.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the scroll position of the Scrollbar.
\par Usage:
- Name: ScrollPosition
- Format: "[float]".
\par Where:
- [float] specifies the current scroll position / value of the Scrollbar.
*/
class ScrollPosition : public Property
{
public:
ScrollPosition() : Property(
"ScrollPosition",
"Property to get/set the scroll position of the Scrollbar. Value is a float.",
"0.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the end lock mode setting for the Scrollbar.
\par Usage:
- Name: EndLockEnabled
- Format: "[text]".
\par Where [Text] is:
- "True" to indicate end lock mode is enabled.
- "False" to indicate end lock mode is disabled.
*/
class EndLockEnabled : public Property
{
public:
EndLockEnabled() : Property(
"EndLockEnabled",
"Property to get/set the 'end lock' mode setting for the Scrollbar. "
"Value is either \"True\" or \"False\".",
"False")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
} // End of ScrollbarProperties namespace section
} // End of CEGUI namespace section
#endif // end of guard _CEGUIScrollbarProperties_h_
|