[1809] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUITextItemProperties.h
|
---|
| 3 | created: 8/4/2005
|
---|
| 4 | author: Tomas Lindquist Olsen (based on code by 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 _CEGUITextItemProperties_h_
|
---|
| 25 | #define _CEGUITextItemProperties_h_
|
---|
| 26 |
|
---|
| 27 | #include "CEGUIProperty.h"
|
---|
| 28 |
|
---|
| 29 | // Start of CEGUI namespace section
|
---|
| 30 | namespace CEGUI
|
---|
| 31 | {
|
---|
| 32 | // Start of TextItemProperties namespace section
|
---|
| 33 | namespace TextItemProperties
|
---|
| 34 | {
|
---|
| 35 |
|
---|
| 36 | /*!
|
---|
| 37 | \brief
|
---|
| 38 | Property to access the X offset of the text on the item.
|
---|
| 39 |
|
---|
| 40 | \par Usage:
|
---|
| 41 | - Name: TextXOffset
|
---|
| 42 | - Format: "[float]".
|
---|
| 43 |
|
---|
| 44 | \par Where:
|
---|
| 45 | - [float] represents the X offset of the text on the item.
|
---|
| 46 | */
|
---|
| 47 | class TextXOffset : public Property
|
---|
| 48 | {
|
---|
| 49 | public:
|
---|
| 50 | TextXOffset() : Property(
|
---|
| 51 | "TextXOffset",
|
---|
| 52 | "Property to get/set the X offset of the text on the item. Value is a float.",
|
---|
| 53 | "0.000000")
|
---|
| 54 | {}
|
---|
| 55 |
|
---|
| 56 | String get(const PropertyReceiver* receiver) const;
|
---|
| 57 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 58 | };
|
---|
| 59 |
|
---|
| 60 |
|
---|
| 61 | /*!
|
---|
| 62 | \brief
|
---|
| 63 | Property to access the text colour of the item.
|
---|
| 64 |
|
---|
| 65 | \par Usage:
|
---|
| 66 | - Name: TextColour
|
---|
| 67 | - Format: "[aarrggbb]".
|
---|
| 68 |
|
---|
| 69 | \par Where:
|
---|
| 70 | - [aarrggbb] represents the text colour of the item.
|
---|
| 71 | */
|
---|
| 72 | class TextColour : public Property
|
---|
| 73 | {
|
---|
| 74 | public:
|
---|
| 75 | TextColour() : Property(
|
---|
| 76 | "TextColour",
|
---|
| 77 | "Property to get/set the text colour of the item. Value is a colour.",
|
---|
| 78 | "00FFFFFF")
|
---|
| 79 | {}
|
---|
| 80 |
|
---|
| 81 | String get(const PropertyReceiver* receiver) const;
|
---|
| 82 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 83 | };
|
---|
| 84 |
|
---|
| 85 |
|
---|
| 86 | /*!
|
---|
| 87 | \brief
|
---|
| 88 | Property to access the horizontal formatting mode setting.
|
---|
| 89 |
|
---|
| 90 | \par Usage:
|
---|
| 91 | - Name: TextFormatting
|
---|
| 92 | - Format: "[text]".
|
---|
| 93 |
|
---|
| 94 | \par Where [text] is one of:
|
---|
| 95 | - "LeftAligned"
|
---|
| 96 | - "RightAligned"
|
---|
| 97 | - "HorzCentred"
|
---|
| 98 | - "HorzJustified"
|
---|
| 99 | - "WordWrapLeftAligned"
|
---|
| 100 | - "WordWrapRightAligned"
|
---|
| 101 | - "WordWrapCentred"
|
---|
| 102 | - "WordWrapJustified"
|
---|
| 103 | */
|
---|
| 104 | class TextFormatting : public Property
|
---|
| 105 | {
|
---|
| 106 | public:
|
---|
| 107 | TextFormatting() : Property(
|
---|
| 108 | "TextFormatting",
|
---|
| 109 | "Property to get/set the horizontal formatting mode. Value is one of the HorzFormatting strings.",
|
---|
| 110 | "LeftAligned")
|
---|
| 111 | {}
|
---|
| 112 |
|
---|
| 113 | String get(const PropertyReceiver* receiver) const;
|
---|
| 114 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 115 | };
|
---|
| 116 |
|
---|
| 117 | } // End of TextItemProperties namespace section
|
---|
| 118 | } // End of CEGUI namespace section
|
---|
| 119 |
|
---|
| 120 | #endif // end of guard _CEGUITextItemProperties_h_
|
---|