source: OGRE/trunk/ogre_dependencies/Dependencies/include/CEGUI/falagard/CEGUIFalNamedArea.h @ 692

Revision 692, 2.9 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies

Line 
1/************************************************************************
2    filename:   CEGUIFalNamedArea.h
3    created:    Sun Jun 26 2005
4    author:     Paul D Turner <paul@cegui.org.uk>
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 _CEGUIFalNamedArea_h_
25#define _CEGUIFalNamedArea_h_
26
27#include "falagard/CEGUIFalDimensions.h"
28
29// Start of CEGUI namespace section
30namespace CEGUI
31{
32    /*!
33    \brief
34        NamedArea defines an area for a component which may later be obtained
35        and referenced by a name unique to the WidgetLook holding the NamedArea.
36    */
37    class CEGUIEXPORT NamedArea
38    {
39    public:
40        NamedArea() {}
41        NamedArea(const String& name);
42
43        /*!
44        \brief
45            Return the name of this NamedArea.
46
47        \return
48            String object holding the name of this NamedArea.
49        */
50        const String& getName() const;
51
52        /*!
53        \brief
54            Return the ComponentArea of this NamedArea
55
56        \return
57            ComponentArea object describing the NamedArea's current target area.
58        */
59        const ComponentArea& getArea() const;
60
61        /*!
62        \brief
63            Set the Area for this NamedArea.
64
65        \param area
66            ComponentArea object describing a new target area for the NamedArea..
67
68        \return
69            Nothing.
70        */
71        void setArea(const ComponentArea& area);
72
73        /*!
74        \brief
75            Writes an xml representation of this NamedArea to \a out_stream.
76
77        \param out_stream
78            Stream where xml data should be output.
79
80        \return
81            Nothing.
82        */
83        void writeXMLToStream(OutStream& out_stream) const;
84
85    private:
86        String d_name;
87        ComponentArea d_area;
88    };
89
90} // End of  CEGUI namespace section
91
92
93#endif  // end of guard _CEGUIFalNamedArea_h_
Note: See TracBrowser for help on using the repository browser.