[1809] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIStaticImageProperties.h
|
---|
| 3 | created: 10/7/2004
|
---|
| 4 | author: Paul D Turner
|
---|
| 5 |
|
---|
| 6 | purpose: Interface for StaticImage property classes
|
---|
| 7 | *************************************************************************/
|
---|
| 8 | /*************************************************************************
|
---|
| 9 | Crazy Eddie's GUI System (http://www.cegui.org.uk)
|
---|
| 10 | Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
|
---|
| 11 |
|
---|
| 12 | This library is free software; you can redistribute it and/or
|
---|
| 13 | modify it under the terms of the GNU Lesser General Public
|
---|
| 14 | License as published by the Free Software Foundation; either
|
---|
| 15 | version 2.1 of the License, or (at your option) any later version.
|
---|
| 16 |
|
---|
| 17 | This library is distributed in the hope that it will be useful,
|
---|
| 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 20 | Lesser General Public License for more details.
|
---|
| 21 |
|
---|
| 22 | You should have received a copy of the GNU Lesser General Public
|
---|
| 23 | License along with this library; if not, write to the Free Software
|
---|
| 24 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
---|
| 25 | *************************************************************************/
|
---|
| 26 | #ifndef _CEGUIStaticImageProperties_h_
|
---|
| 27 | #define _CEGUIStaticImageProperties_h_
|
---|
| 28 |
|
---|
| 29 | #include "CEGUIProperty.h"
|
---|
| 30 |
|
---|
| 31 |
|
---|
| 32 | // Start of CEGUI namespace section
|
---|
| 33 | namespace CEGUI
|
---|
| 34 | {
|
---|
| 35 |
|
---|
| 36 | // Start of StaticImageProperties namespace section
|
---|
| 37 | /*!
|
---|
| 38 | \brief
|
---|
| 39 | Namespace containing all classes that make up the properties interface for the StaticImage class
|
---|
| 40 | */
|
---|
| 41 | namespace StaticImageProperties
|
---|
| 42 | {
|
---|
| 43 | /*!
|
---|
| 44 | \brief
|
---|
| 45 | Property to access the image for the StaticImage widget.
|
---|
| 46 |
|
---|
| 47 | \par Usage:
|
---|
| 48 | - Name: Image
|
---|
| 49 | - Format: "set:[text] image:[text]".
|
---|
| 50 |
|
---|
| 51 | \par Where:
|
---|
| 52 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 53 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 54 | */
|
---|
| 55 | class Image : public Property
|
---|
| 56 | {
|
---|
| 57 | public:
|
---|
| 58 | Image() : Property(
|
---|
| 59 | "Image",
|
---|
| 60 | "Property to get/set the image for the StaticImage widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 61 | "")
|
---|
| 62 | {}
|
---|
| 63 |
|
---|
| 64 | String get(const PropertyReceiver* receiver) const;
|
---|
| 65 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 66 | };
|
---|
| 67 |
|
---|
| 68 |
|
---|
| 69 | /*!
|
---|
| 70 | \brief
|
---|
| 71 | Property to access the image colours for the StaticImage widget.
|
---|
| 72 |
|
---|
| 73 | \par Usage:
|
---|
| 74 | - Name: ImageColours
|
---|
| 75 | - Format: "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".
|
---|
| 76 |
|
---|
| 77 | \par Where:
|
---|
| 78 | - tl:[aarrggbb] is the top-left colour value specified as ARGB (hex).
|
---|
| 79 | - tr:[aarrggbb] is the top-right colour value specified as ARGB (hex).
|
---|
| 80 | - bl:[aarrggbb] is the bottom-left colour value specified as ARGB (hex).
|
---|
| 81 | - br:[aarrggbb] is the bottom-right colour value specified as ARGB (hex).
|
---|
| 82 | */
|
---|
| 83 | class ImageColours : public Property
|
---|
| 84 | {
|
---|
| 85 | public:
|
---|
| 86 | ImageColours() : Property(
|
---|
| 87 | "ImageColours",
|
---|
| 88 | "Property to get/set the text colours for the StaticImage widget. Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
|
---|
| 89 | "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
|
---|
| 90 | {}
|
---|
| 91 |
|
---|
| 92 | String get(const PropertyReceiver* receiver) const;
|
---|
| 93 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 94 | };
|
---|
| 95 |
|
---|
| 96 |
|
---|
| 97 | /*!
|
---|
| 98 | \brief
|
---|
| 99 | Property to access the horizontal formatting mode setting.
|
---|
| 100 |
|
---|
| 101 | \par Usage:
|
---|
| 102 | - Name: HorzFormatting
|
---|
| 103 | - Format: "[text]".
|
---|
| 104 |
|
---|
| 105 | \par Where [text] is one of:
|
---|
| 106 | - "LeftAligned"
|
---|
| 107 | - "RightAligned"
|
---|
| 108 | - "HorzCentred"
|
---|
| 109 | - "HorzStretched"
|
---|
| 110 | - "HorzTiled"
|
---|
| 111 | */
|
---|
| 112 | class HorzFormatting : public Property
|
---|
| 113 | {
|
---|
| 114 | public:
|
---|
| 115 | HorzFormatting() : Property(
|
---|
| 116 | "HorzFormatting",
|
---|
| 117 | "Property to get/set the horizontal formatting mode. Value is one of the HorzFormatting strings.",
|
---|
| 118 | "HorzStretched")
|
---|
| 119 | {}
|
---|
| 120 |
|
---|
| 121 | String get(const PropertyReceiver* receiver) const;
|
---|
| 122 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 123 | };
|
---|
| 124 |
|
---|
| 125 |
|
---|
| 126 | /*!
|
---|
| 127 | \brief
|
---|
| 128 | Property to access the vertical formatting mode setting.
|
---|
| 129 |
|
---|
| 130 | \par Usage:
|
---|
| 131 | - Name: VertFormatting
|
---|
| 132 | - Format: "[text]".
|
---|
| 133 |
|
---|
| 134 | \par Where [text] is one of:
|
---|
| 135 | - "TopAligned"
|
---|
| 136 | - "BottomAligned"
|
---|
| 137 | - "VertCentred"
|
---|
| 138 | - "VertStretched"
|
---|
| 139 | - "VertTiled"
|
---|
| 140 | */
|
---|
| 141 | class VertFormatting : public Property
|
---|
| 142 | {
|
---|
| 143 | public:
|
---|
| 144 | VertFormatting() : Property(
|
---|
| 145 | "VertFormatting",
|
---|
| 146 | "Property to get/set the vertical formatting mode. Value is one of the VertFormatting strings.",
|
---|
| 147 | "VertStretched")
|
---|
| 148 | {}
|
---|
| 149 |
|
---|
| 150 | String get(const PropertyReceiver* receiver) const;
|
---|
| 151 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 152 | };
|
---|
| 153 |
|
---|
| 154 |
|
---|
| 155 | } // End of StaticImageProperties namespace section
|
---|
| 156 |
|
---|
| 157 | } // End of CEGUI namespace section
|
---|
| 158 |
|
---|
| 159 |
|
---|
| 160 | #endif // end of guard _CEGUIStaticImageProperties_h_
|
---|