/***********************************************************************
filename: CEGUIFalEnums.h
created: Mon Jun 13 2005
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* 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 _CEGUIFalEnums_h_
#define _CEGUIFalEnums_h_
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Enumeration of possible values to indicate what a given dimension represents.
*/
enum DimensionType
{
DT_LEFT_EDGE, //!< Dimension represents the left edge of some entity (same as DT_X_POSITION).
DT_X_POSITION, //!< Dimension represents the x position of some entity (same as DT_LEFT_EDGE).
DT_TOP_EDGE, //!< Dimension represents the top edge of some entity (same as DT_Y_POSITION).
DT_Y_POSITION, //!< Dimension represents the y position of some entity (same as DT_TOP_EDGE).
DT_RIGHT_EDGE, //!< Dimension represents the right edge of some entity.
DT_BOTTOM_EDGE, //!< Dimension represents the bottom edge of some entity.
DT_WIDTH, //!< Dimension represents the width of some entity.
DT_HEIGHT, //!< Dimension represents the height of some entity.
DT_X_OFFSET, //!< Dimension represents the x offset of some entity (usually only applies to an Image entity).
DT_Y_OFFSET, //!< Dimension represents the y offset of some entity (usually only applies to an Image entity).
DT_INVALID //!< Invalid / uninitialised DimensionType.
};
/*!
\brief
Enumeration of possible values to indicate the vertical formatting to be used for an image component.
*/
enum VerticalFormatting
{
VF_TOP_ALIGNED, //!< Top of Image should be aligned with the top of the destination area.
VF_CENTRE_ALIGNED, //!< Image should be vertically centred within the destination area.
VF_BOTTOM_ALIGNED, //!< Bottom of Image should be aligned with the bottom of the destination area.
VF_STRETCHED, //!< Image should be stretched vertically to fill the destination area.
VF_TILED //!< Image should be tiled vertically to fill the destination area (bottom-most tile may be clipped).
};
/*!
\brief
Enumeration of possible values to indicate the horizontal formatting to be used for an image component.
*/
enum HorizontalFormatting
{
HF_LEFT_ALIGNED, //!< Left of Image should be aligned with the left of the destination area.
HF_CENTRE_ALIGNED, //!< Image should be horizontally centred within the destination area.
HF_RIGHT_ALIGNED, //!< Right of Image should be aligned with the right of the destination area.
HF_STRETCHED, //!< Image should be stretched horizontally to fill the destination area.
HF_TILED //!< Image should be tiled horizontally to fill the destination area (right-most tile may be clipped).
};
/*!
\brief
Enumeration of possible values to indicate the vertical formatting to be used for a text component.
*/
enum VerticalTextFormatting
{
VTF_TOP_ALIGNED, //!< Top of text should be aligned with the top of the destination area.
VTF_CENTRE_ALIGNED, //!< text should be vertically centred within the destination area.
VTF_BOTTOM_ALIGNED //!< Bottom of text should be aligned with the bottom of the destination area.
};
/*!
\brief
Enumeration of possible values to indicate the horizontal formatting to be used for a text component.
*/
enum HorizontalTextFormatting
{
HTF_LEFT_ALIGNED, //!< Left of text should be aligned with the left of the destination area (single line of text only).
HTF_RIGHT_ALIGNED, //!< Right of text should be aligned with the right of the destination area (single line of text only).
HTF_CENTRE_ALIGNED, //!< text should be horizontally centred within the destination area (single line of text only).
HTF_JUSTIFIED, //!< text should be spaced so that it takes the full width of the destination area (single line of text only).
HTF_WORDWRAP_LEFT_ALIGNED, //!< Left of text should be aligned with the left of the destination area (word wrapped to multiple lines as needed).
HTF_WORDWRAP_RIGHT_ALIGNED, //!< Right of text should be aligned with the right of the destination area (word wrapped to multiple lines as needed).
HTF_WORDWRAP_CENTRE_ALIGNED, //!< text should be horizontally centred within the destination area (word wrapped to multiple lines as needed).
HTF_WORDWRAP_JUSTIFIED //!< text should be spaced so that it takes the full width of the destination area (word wrapped to multiple lines as needed).
};
/*!
\brief
Enumeration of possible values to indicate a particular font metric.
*/
enum FontMetricType
{
FMT_LINE_SPACING, //!< Vertical line spacing value for font.
FMT_BASELINE, //!< Vertical baseline value for font.
FMT_HORZ_EXTENT //!< Horizontal extent of a string.
};
/*!
\brief
Enumeration of values representing mathematical operations on dimensions.
*/
enum DimensionOperator
{
DOP_NOOP, //!< Do nothing operator.
DOP_ADD, //!< Dims should be added.
DOP_SUBTRACT, //!< Dims should be subtracted.
DOP_MULTIPLY, //!< Dims should be multiplied.
DOP_DIVIDE //!< Dims should be divided.
};
/*!
\brief
Enumeration of values referencing available images forming a frame component.
*/
enum FrameImageComponent
{
FIC_BACKGROUND, //!< References image used for the background.
FIC_TOP_LEFT_CORNER, //!< References image used for the top-left corner.
FIC_TOP_RIGHT_CORNER, //!< References image used for the top-right corner.
FIC_BOTTOM_LEFT_CORNER, //!< References image used for the bottom-left corner.
FIC_BOTTOM_RIGHT_CORNER, //!< References image used for the bottom-right corner.
FIC_LEFT_EDGE, //!< References image used for the left edge.
FIC_RIGHT_EDGE, //!< References image used for the right edge.
FIC_TOP_EDGE, //!< References image used for the top edge.
FIC_BOTTOM_EDGE, //!< References image used for the bottom edge.
FIC_FRAME_IMAGE_COUNT //!< Max number of images for a frame.
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUIFalEnums_h_
