GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/gui/widgets/basiccontainer2.h Lines: 1 1 100.0 %
Date: 2017-11-29 Branches: 0 0 0.0 %

Line Branch Exec Source
1
/*
2
 *  The ManaPlus Client
3
 *  Copyright (C) 2011-2017  The ManaPlus Developers
4
 *
5
 *  This file is part of The ManaPlus Client.
6
 *
7
 *  This program is free software; you can redistribute it and/or modify
8
 *  it under the terms of the GNU General Public License as published by
9
 *  the Free Software Foundation; either version 2 of the License, or
10
 *  any later version.
11
 *
12
 *  This program is distributed in the hope that it will be useful,
13
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 *  GNU General Public License for more details.
16
 *
17
 *  You should have received a copy of the GNU General Public License
18
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 */
20
21
/*      _______   __   __   __   ______   __   __   _______   __   __
22
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
23
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
24
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
25
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
26
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
27
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
28
 *
29
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
30
 *
31
 *
32
 * Per Larsson a.k.a finalman
33
 * Olof Naessén a.k.a jansem/yakslem
34
 *
35
 * Visit: http://guichan.sourceforge.net
36
 *
37
 * License: (BSD)
38
 * Redistribution and use in source and binary forms, with or without
39
 * modification, are permitted provided that the following conditions
40
 * are met:
41
 * 1. Redistributions of source code must retain the above copyright
42
 *    notice, this list of conditions and the following disclaimer.
43
 * 2. Redistributions in binary form must reproduce the above copyright
44
 *    notice, this list of conditions and the following disclaimer in
45
 *    the documentation and/or other materials provided with the
46
 *    distribution.
47
 * 3. Neither the name of Guichan nor the names of its contributors may
48
 *    be used to endorse or promote products derived from this software
49
 *    without specific prior written permission.
50
 *
51
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
57
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
58
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
59
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
60
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
61
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62
 */
63
64
#ifndef GUI_WIDGETS_BASICCONTAINER2_H
65
#define GUI_WIDGETS_BASICCONTAINER2_H
66
67
#include "gui/widgets/basiccontainer.h"
68
69
#include "enums/simpletypes/opaque.h"
70
71
/**
72
  * An implementation of a container able to contain other widgets. A widget's
73
  * position in the container is relative to the container itself and not the screen.
74
  * A container is the most common widget to use as the Gui's top widget as makes the Gui
75
  * able to contain more than one widget.
76
  *
77
  * @see Gui::setTop
78
  */
79
class BasicContainer2: public BasicContainer
80
{
81
    public:
82
        /**
83
          * Constructor. A container is opauqe as default, if you want a
84
          * none opaque container call setQpaque(false).
85
          *
86
          * @see setOpaque, isOpaque
87
          */
88
        explicit BasicContainer2(const Widget2 *const widget);
89
90
        /**
91
          * Destructor.
92
          */
93
        virtual ~BasicContainer2();
94
95
        /**
96
          * Sets the container to be opaque or not. If the container
97
          * is opaque its background will be drawn, if it's not opaque
98
          * its background will not be drawn, and thus making the container
99
          * completely transparent.
100
          *
101
          * NOTE: This is not the same as to set visibility. A non visible
102
          *       container will not itself nor will it draw its content.
103
          *
104
          * @param opaque True if the container should be opaque, false otherwise.
105
          * @see isOpaque
106
          */
107
        void setOpaque(Opaque opaque)
108
1226
        { mOpaque = opaque; }
109
110
        /**
111
          * Checks if the container is opaque or not.
112
          *
113
          * @return True if the container is opaque, false otherwise.
114
          * @see setOpaque
115
          */
116
        bool isOpaque() const
117
        { return mOpaque == Opaque_true; }
118
119
        /**
120
          * Adds a widget to the container.
121
          *
122
          * @param widget The widget to add.
123
          * @see remove, clear
124
          */
125
        virtual void add(Widget *const widget);
126
127
        /**
128
          * Adds a widget to the container and also specifies the widget's
129
          * position in the container. The position is relative to the container
130
          * and not relative to the screen.
131
          *
132
          * @param widget The widget to add.
133
          * @param x The x coordinate for the widget.
134
          * @param y The y coordinate for the widget.
135
          * @see remove, clear
136
          */
137
        void addXY(Widget *const widget,
138
                   const int x, const int y);
139
140
        // Inherited from Widget
141
142
        void draw(Graphics *const graphics) override A_NONNULL(2);
143
144
        void safeDraw(Graphics *const graphics) override A_NONNULL(2);
145
146
    protected:
147
        /**
148
          * True if the container is opaque, false otherwise.
149
          */
150
        Opaque mOpaque;
151
};
152
153
#endif  // GUI_WIDGETS_BASICCONTAINER2_H