GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/events/actionevent.h Lines: 3 4 75.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 EVENTS_ACTIONEVENT_H
65
#define EVENTS_ACTIONEVENT_H
66
67
#include "events/event.h"
68
69
#include <string>
70
71
#include "localconsts.h"
72
73
class Widget;
74
75
/**
76
  * Represents an action event. An action event is an event
77
  * that can be fired by a widget whenever an action has occured.
78
  * What exactly an action is is up to the widget that fires
79
  * the action event. An example is a Button which fires an action
80
  * event as soon as the Button is clicked, another example is
81
  * TextField which fires an action event as soon as the enter
82
  * key is pressed.
83
  *
84
  * Any object can listen for actions from widgets by implementing
85
  * the ActionListener interface.
86
  *
87
  * If you have implement a widget of your own it's a good idea to
88
  * let the widget fire action events whenever you feel an action
89
  * has occured so action listeners of the widget can be informed
90
  * of the state of the widget.
91
  *
92
  * @see Widget::addActionListener, Widget::removeActionListener,
93
  *      Widget::distributeActionEvent
94
  * @author Olof Naessén
95
  */
96
class ActionEvent final : public Event
97
{
98
    public:
99
        /**
100
          * Constructor.
101
          *
102
          * @param source The source widget of the event.
103
          * @param id An identifier of the event.
104
          */
105
        ActionEvent(Widget *const source, const std::string &id) :
106
            Event(source),
107
6
            mId(id)
108
        {
109
        }
110
111
        A_DELETE_COPY(ActionEvent)
112
113
        /**
114
          * Destructor.
115
          */
116
        virtual ~ActionEvent()
117
4
        { }
118
119
        /**
120
          * Gets the identifier of the event. An identifier can
121
          * be used to distinguish from two actions from the same
122
          * widget or to let many widgets fire the same widgets
123
          * that should be treated equally.
124
          *
125
          * @return The identifier of the event.
126
          */
127
        const std::string &getId() const noexcept2 A_WARN_UNUSED
128
2
        { return mId; }
129
130
    protected:
131
        /**
132
          * Holds the identifier of the event.
133
          */
134
        std::string mId;
135
};
136
137
#endif  // EVENTS_ACTIONEVENT_H