GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/listeners/widgetlistener.h Lines: 10 11 90.9 %
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 LISTENERS_WIDGETLISTENER_H
66
#define LISTENERS_WIDGETLISTENER_H
67
68
#include "events/event.h"
69
70
#include "localconsts.h"
71
72
/**
73
  * Interface for listening for events from widgets. When a widget's size,
74
  * location or visibility changes, the relevant method of the listener is
75
  * invoked.
76
  *
77
  * @see Widget::addWidgetListener, Widget::removeWidgetListener
78
  * @author Olof Naessén
79
  */
80
class WidgetListener notfinal
81
{
82
    public:
83
        A_DELETE_COPY(WidgetListener)
84
85
        /**
86
          * Destructor.
87
          */
88
        virtual ~WidgetListener()
89
2004
        { }
90
91
        /**
92
          * Invoked when a widget changes its size.
93
          *
94
          * @param event Describes the event.
95
          */
96
352
        virtual void widgetResized(const Event &event A_UNUSED)
97
352
        { }
98
99
        /**
100
          * Invoked when a widget is moved.
101
          *
102
          * @param event Describes the event.
103
          */
104
1110
        virtual void widgetMoved(const Event &event A_UNUSED)
105
1110
        { }
106
107
        /**
108
          * Invoked when a widget is hidden, i.e it's set to be
109
          * not visible.
110
          *
111
          * @param event Describes the event.
112
          */
113
119
        virtual void widgetHidden(const Event &event A_UNUSED)
114
119
        { }
115
116
        /**
117
          * Invoked when a widget is shown, i.e it's set to be
118
          * visible.
119
          *
120
          * @param event Describes the event.
121
          */
122
367
        virtual void widgetShown(const Event &event A_UNUSED)
123
367
        { }
124
125
    protected:
126
        /**
127
          * Constructor.
128
          *
129
          * You should not be able to make an instance of WidgetListener,
130
          * therefore its constructor is protected.
131
          */
132
        WidgetListener()
133
1955
        { }
134
};
135
136
#endif  // LISTENERS_WIDGETLISTENER_H