/usr/include/cegui-0.8.4/CEGUI/falagard/WidgetComponent.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
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 | /***********************************************************************
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 _CEGUIFalWidgetComponent_h_
#define _CEGUIFalWidgetComponent_h_
#include "CEGUI/falagard/Dimensions.h"
#include "CEGUI/falagard/PropertyInitialiser.h"
#include "CEGUI/falagard/EventAction.h"
#include "CEGUI/Window.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 regarding a sub-widget required for a widget.
\todo
This is not finished in the slightest! There will be many changes here...
*/
class CEGUIEXPORT WidgetComponent :
public AllocatedObject<WidgetComponent>
{
public:
WidgetComponent() {}
WidgetComponent(const String& type,
const String& look,
const String& suffix,
const String& renderer,
bool autoWindow);
/*!
\brief
Create an instance of this widget component adding it as a child to
the given Window.
*/
void create(Window& parent) const;
/*!
\brief
Cleanup from the given parent widget, the instance of the child
created for this WidgetComponent.
*/
void cleanup(Window& parent) const;
const ComponentArea& getComponentArea() const;
void setComponentArea(const ComponentArea& area);
const String& getBaseWidgetType() const;
void setBaseWidgetType(const String& type);
const String& getWidgetLookName() const;
void setWidgetLookName(const String& look);
const String& getWidgetName() const;
void setWidgetName(const String& name);
const String& getWindowRendererType() const;
void setWindowRendererType(const String& type);
VerticalAlignment getVerticalWidgetAlignment() const;
void setVerticalWidgetAlignment(VerticalAlignment alignment);
HorizontalAlignment getHorizontalWidgetAlignment() const;
void setHorizontalWidgetAlignment(HorizontalAlignment alignment);
void addPropertyInitialiser(const PropertyInitialiser& initialiser);
void removePropertyInitialiser(const String& name);
void clearPropertyInitialisers();
void setAutoWindow(bool is_auto);
bool isAutoWindow() const;
void addEventAction(const EventAction& event_action);
void clearEventActions();
void layout(const Window& owner) const;
/*!
\brief
Writes an xml representation of this WidgetComponent to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
/*!
\brief
Takes the name of a property and returns a pointer to the last
PropertyInitialiser for this property or 0 if the is no
PropertyInitialiser for this property in the WidgetLookFeel
\param propertyName
The name of the property to look for.
*/
const PropertyInitialiser* findPropertyInitialiser(const String& propertyName) const;
//! perform any processing required due to the given font having changed.
bool handleFontRenderSizeChange(Window& window, const Font* font) const;
//! Default value for the HorzAlignment elements of the WidgetComponent
static const HorizontalAlignment HorizontalAlignmentDefault;
//! Default value for the VertAlignment elements of the WidgetComponent
static const VerticalAlignment VerticalAlignmentDefault;
private:
typedef std::vector<PropertyInitialiser
CEGUI_VECTOR_ALLOC(PropertyInitialiser)> PropertiesList;
typedef std::vector<EventAction
CEGUI_VECTOR_ALLOC(EventAction)> EventActionList;
public:
/*************************************************************************
Iterator stuff
*************************************************************************/
typedef ConstVectorIterator<PropertiesList> PropertyIterator;
typedef ConstVectorIterator<EventActionList> EventActionIterator;
/*!
* Return a WidgetComponent::PropertyIterator that iterates over the
* PropertyInitialiser inside this WidgetComponent.
*/
PropertyIterator getPropertyIterator() const;
/*!
* Return a WidgetComponent::EventActionIterator that iterates over the
* EventAction definitions for this WidgetComponent.
*/
EventActionIterator getEventActionIterator() const;
private:
ComponentArea d_area; //!< Destination area for the widget (relative to it's parent).
String d_baseType; //!< Type of widget to be created.
String d_imageryName; //!< Name of a WidgetLookFeel to be used for the widget.
String d_name; //!< name to create this widget with.
String d_rendererType; //!< Name of the window renderer type to assign to the widget.
bool d_autoWindow; //!< specifies whether to mark component as an auto-window.
VerticalAlignment d_vertAlign; //!< Vertical alignment to be used for this widget.
HorizontalAlignment d_horzAlign; //!< Horizontal alignment to be used for this widget.
PropertiesList d_properties; //!< Collection of PropertyInitialisers to be applied the the widget upon creation.
//! EventActions added to the WidgetComponent
EventActionList d_eventActions;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIFalWidgetComponent_h_
|