/
commandbinding.h
65 lines (56 loc) · 2.26 KB
/
commandbinding.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/** @file commandbinding.h Command binding record accessor.
*
* @authors Copyright © 2009-2014 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2007-2014 Daniel Swanson <danij@dengine.net>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef CLIENT_INPUTSYSTEM_COMMANDBINDING_H
#define CLIENT_INPUTSYSTEM_COMMANDBINDING_H
#include <de/Action>
#include <de/String>
#include "Binding"
#include "ddevent.h"
class BindContext;
/**
* Utility for handling event => command binding records.
*
* @ingroup ui
*/
class CommandBinding : public Binding
{
public:
CommandBinding() : Binding() {}
CommandBinding(CommandBinding const &other) : Binding(other) {}
CommandBinding(de::Record &d) : Binding(d) {}
CommandBinding(de::Record const &d) : Binding(d) {}
CommandBinding &operator = (de::Record const *d) {
*static_cast<Binding *>(this) = d;
return *this;
}
void resetToDefaults();
de::String composeDescriptor();
/**
* Evaluate the given binding and event pair and attempt to generate an Action.
*
* @param event Event to match against.
* @param context Context in which the binding exists.
* @param respectHigherContexts Bindings are shadowed by higher active contexts.
*
* @return Action instance (caller gets ownership), or @c nullptr if no matching.
*/
de::Action *makeAction(ddevent_t const &event, BindContext const &context,
bool respectHigherContexts) const;
};
#endif // CLIENT_INPUTSYSTEM_COMMANDBINDING_H