Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/waypoints/src/orxonox/overlays/GUISheet.h @ 9355

Last change on this file since 9355 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 2.2 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _GUISheet_H__
30#define _GUISheet_H__
31
32#include "OrxonoxPrereqs.h"
33
34#include <string>
35#include "core/BaseObject.h"
36
37namespace orxonox
38{
39    //! Simple XML loadable interface to the otherwise Lua coded GUI framework.
40    class _OrxonoxExport GUISheet : public BaseObject
41    {
42    public:
43        GUISheet(BaseObject* creator);
44        ~GUISheet();
45
46        void XMLPort(Element& xmlelement, XMLPort::Mode mode);
47
48        void show();
49        void hide();
50
51        void setSheetName(const std::string& name);
52        inline const std::string& getSheetName() const
53            { return this->sheetName_; }
54
55        inline void setShowOnLoad(bool bShow)
56            { this->bShowOnLoad_ = bShow; }
57        inline bool getShowOnLoad() const
58            { return this->bShowOnLoad_; }
59
60        void setPreviousHiding(bool bHide);
61        inline bool getPreviousHiding() const
62            { return this->bHidePrevious_; }
63
64        void setBackgroundImage(const std::string& image)
65            { this->backgroundImage_ = image; }
66        inline const std::string& getBackgroundImage() const
67            { return this->backgroundImage_; }
68
69    private:
70        std::string sheetName_;
71        bool bShowOnLoad_;
72        bool bHidePrevious_;
73        bool bHidePreviousSet_;
74        std::string backgroundImage_;
75  };
76}
77
78#endif /* _GUISheet_H__ */
Note: See TracBrowser for help on using the repository browser.