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

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