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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpcontroller.h
* Copyright (C) 2004 Michael Natterer <mitch@gimp.org>
*
* This library is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <https://www.gnu.org/licenses/>.
*/
#ifndef GIMP_ENABLE_CONTROLLER_UNDER_CONSTRUCTION
#error GimpController is unstable API under construction
#endif
#ifndef __GIMP_CONTROLLER_H__
#define __GIMP_CONTROLLER_H__
G_BEGIN_DECLS
/* For information look at the html documentation */
/**
* GimpControllerEventType:
* @GIMP_CONTROLLER_EVENT_TRIGGER: the event is a simple trigger
* @GIMP_CONTROLLER_EVENT_VALUE: the event carries a double value
*
* Event types for #GimpController.
**/
typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
} GimpControllerEventType;
typedef struct _GimpControllerEventAny GimpControllerEventAny;
typedef struct _GimpControllerEventTrigger GimpControllerEventTrigger;
typedef struct _GimpControllerEventValue GimpControllerEventValue;
typedef union _GimpControllerEvent GimpControllerEvent;
/**
* GimpControllerEventAny:
* @type: The event's #GimpControllerEventType
* @source: The event's source #GimpController
* @event_id: The event's ID
*
* Generic controller event. Every event has these three members at the
* beginning of its struct
**/
struct _GimpControllerEventAny
{
GimpControllerEventType type;
GimpController *source;
gint event_id;
};
/**
* GimpControllerEventTrigger:
* @type: The event's #GimpControllerEventType
* @source: The event's source #GimpController
* @event_id: The event's ID
*
* Trigger controller event.
**/
struct _GimpControllerEventTrigger
{
GimpControllerEventType type;
GimpController *source;
gint event_id;
};
/**
* GimpControllerEventValue:
* @type: The event's #GimpControllerEventType
* @source: The event's source #GimpController
* @event_id: The event's ID
* @value: The event's value
*
* Value controller event.
**/
struct _GimpControllerEventValue
{
GimpControllerEventType type;
GimpController *source;
gint event_id;
GValue value;
};
/**
* GimpControllerEvent:
* @type: The event type
* @any: GimpControllerEventAny
* @trigger: GimpControllerEventTrigger
* @value: GimpControllerEventValue
*
* A union to hjold all event event types
**/
union _GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
GimpControllerEventTrigger trigger;
GimpControllerEventValue value;
};
#define GIMP_TYPE_CONTROLLER (gimp_controller_get_type ())
G_DECLARE_DERIVABLE_TYPE (GimpController, gimp_controller, GIMP, CONTROLLER, GObject)
struct _GimpControllerClass
{
GObjectClass parent_class;
const gchar *name;
const gchar *help_domain;
const gchar *help_id;
const gchar *icon_name;
/* virtual functions */
gint (* get_n_events) (GimpController *controller);
const gchar * (* get_event_name) (GimpController *controller,
gint event_id);
const gchar * (* get_event_blurb) (GimpController *controller,
gint event_id);
/* signals */
gboolean (* event) (GimpController *controller,
const GimpControllerEvent *event);
/* Padding for future expansion */
void (* _gimp_reserved0) (void);
void (* _gimp_reserved1) (void);
void (* _gimp_reserved2) (void);
void (* _gimp_reserved3) (void);
void (* _gimp_reserved4) (void);
void (* _gimp_reserved5) (void);
void (* _gimp_reserved6) (void);
void (* _gimp_reserved7) (void);
void (* _gimp_reserved8) (void);
void (* _gimp_reserved9) (void);
};
GimpController * gimp_controller_new (GType controller_type);
gint gimp_controller_get_n_events (GimpController *controller);
const gchar * gimp_controller_get_event_name (GimpController *controller,
gint event_id);
const gchar * gimp_controller_get_event_blurb (GimpController *controller,
gint event_id);
/* protected */
gboolean gimp_controller_event (GimpController *controller,
const GimpControllerEvent *event);
G_END_DECLS
#endif /* __GIMP_CONTROLLER_H__ */
|
