/usr/include/cegui-0.8.7/CEGUI/falagard/ImageryComponent.h is in libcegui-mk2-dev 0.8.7-1.3+b2.
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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | /***********************************************************************
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 _CEGUIFalImageryComponent_h_
#define _CEGUIFalImageryComponent_h_
#include "./ComponentBase.h"
#include "../XMLSerializer.h"
#include "CEGUI/falagard/FormattingSetting.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Class that encapsulates information for a single image component.
*/
class CEGUIEXPORT ImageryComponent : public FalagardComponentBase
{
public:
/*!
\brief
Constructor
*/
ImageryComponent();
/*!
\brief
Return the Image object that will be drawn by this ImageryComponent.
\return
Image object.
*/
const Image* getImage() const;
/*!
\brief
Set the Image that will be drawn by this ImageryComponent.
\param
Pointer to the Image object to be drawn by this ImageryComponent.
\return
Nothing.
*/
void setImage(const Image* image);
/*!
\brief
Set the Image that will be drawn by this ImageryComponent.
\param name
String holding the name of the Image to be rendered.
\return
Nothing.
*/
void setImage(const String& name);
/*!
\brief
Return the current vertical formatting setting for this ImageryComponent.
\return
The VerticalFormatting enum.
*/
VerticalFormatting getVerticalFormatting(const Window& wnd) const;
/*!
\brief
Directly returns the vertical formatting which was set for the ImageryComponent.
\return
The VerticalFormatting enum.
*/
VerticalFormatting getVerticalFormattingFromComponent() const;
/*!
\brief
Set the vertical formatting setting for this ImageryComponent.
\param fmt
One of the VerticalFormatting enumerated values.
\return
Nothing.
*/
void setVerticalFormatting(VerticalFormatting fmt);
/*!
\brief
Return the current horizontal formatting setting for this ImageryComponent.
\return
One of the HorizontalFormatting enumerated values.
*/
HorizontalFormatting getHorizontalFormatting(const Window& wnd) const;
/*!
\brief
Directly returns the horizontal formatting which was set for the ImageryComponent.
\return
The HorizontalFormatting enum.
*/
HorizontalFormatting getHorizontalFormattingFromComponent() const;
/*!
\brief
Set the horizontal formatting setting for this ImageryComponent.
\param fmt
One of the HorizontalFormatting enumerated values.
\return
Nothing.
*/
void setHorizontalFormatting(HorizontalFormatting fmt);
/*!
\brief
Returns the name of the property that will be used to obtain the horizontal
formatting to use for this ImageryComponent or an empty string if none is set.
\return
A String containing the name of the property
*/
const String& getHorizontalFormattingPropertySource() const;
/*!
\brief
Set the name of a property that will be used to obtain the horizontal
formatting to use for this ImageryComponent.
*/
void setHorizontalFormattingPropertySource(const String& property_name);
/*!
\brief
Returns the name of the property that will be used to obtain the vertical
formatting to use for this ImageryComponent or an empty string if none is set.
\return
A String containing the name of the property
*/
const String& getVerticalFormattingPropertySource() const;
/*!
\brief
Set the name of a property that will be used to obtain the vertical
formatting to use for this ImageryComponent.
*/
void setVerticalFormattingPropertySource(const String& property_name);
/*!
\brief
Writes an xml representation of this ImageryComponent to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
/*!
\brief
Return whether this ImageryComponent fetches it's image via a property on the target window.
\return
- true if the image comes via a Propery.
- false if the image is defined explicitly.
*/
bool isImageFetchedFromProperty() const;
/*!
\brief
Return the name of the property that will be used to determine the image for this ImageryComponent.
\return
String object holding the name of a Propery.
*/
const String& getImagePropertySource() const;
/*!
\brief
Set the name of the property that will be used to determine the image for this ImageryComponent.
\param property
String object holding the name of a Propery. The property should access a imageset & image specification.
\return
Nothing.
*/
void setImagePropertySource(const String& property);
protected:
// implemets abstract from base
void render_impl(Window& srcWindow, Rectf& destRect, const CEGUI::ColourRect* modColours, const Rectf* clipper, bool clipToDisplay) const;
const Image* d_image; //!< CEGUI::Image to be drawn by this image component.
//! Vertical formatting to be applied when rendering the image component.
FormattingSetting<VerticalFormatting> d_vertFormatting;
//! Horizontal formatting to be applied when rendering the image component.
FormattingSetting<HorizontalFormatting> d_horzFormatting;
String d_imagePropertyName; //!< Name of the property to access to obtain the image to be used.
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIFalImageryComponent_h_
|