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