-
Notifications
You must be signed in to change notification settings - Fork 0
/
enums.html
732 lines (525 loc) · 48.3 KB
/
enums.html
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Enumerations — libratbag documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="DBus API" href="dbus.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> libratbag
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="dbus.html"> The DBus Interfaces</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"> Enumerations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-error-code">ratbag_error_code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-profile-capability">ratbag_profile_capability</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-resolution-capability">ratbag_resolution_capability</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-button-type">ratbag_button_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-button-action-type">ratbag_button_action_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-button-action-special">ratbag_button_action_special</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-led-mode">ratbag_led_mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-led-type">ratbag_led_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-led-colordepth">ratbag_led_colordepth</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ratbag-macro-event-type">ratbag_macro_event_type</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">libratbag</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Enumerations</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/enums.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="enumerations">
<h1>Enumerations<a class="headerlink" href="#enumerations" title="Permalink to this headline">¶</a></h1>
<p>This document contains the enums used by libratbag’s DBus interface.</p>
<div class="section" id="ratbag-error-code">
<h2>ratbag_error_code<a class="headerlink" href="#ratbag-error-code" title="Permalink to this headline">¶</a></h2>
<p>Error codes used by libratbag.</p>
<dl class="enum">
<dt id="_CPPv317ratbag_error_code">
<span id="_CPPv217ratbag_error_code"></span><em class="property">enum </em><code class="descname">ratbag_error_code</code><a class="headerlink" href="#_CPPv317ratbag_error_code" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N17ratbag_error_code14RATBAG_SUCCESSE">
<span id="_CPPv2N17ratbag_error_code14RATBAG_SUCCESSE"></span><em class="property">enumerator </em><code class="descname">RATBAG_SUCCESS</code> = 0<a class="headerlink" href="#_CPPv3N17ratbag_error_code14RATBAG_SUCCESSE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N17ratbag_error_code19RATBAG_ERROR_DEVICEE">
<span id="_CPPv2N17ratbag_error_code19RATBAG_ERROR_DEVICEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_ERROR_DEVICE</code> = -1000<a class="headerlink" href="#_CPPv3N17ratbag_error_code19RATBAG_ERROR_DEVICEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>An error occured on the device. Either the device is not a libratbag device or communication with the device failed.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N17ratbag_error_code23RATBAG_ERROR_CAPABILITYE">
<span id="_CPPv2N17ratbag_error_code23RATBAG_ERROR_CAPABILITYE"></span><em class="property">enumerator </em><code class="descname">RATBAG_ERROR_CAPABILITY</code> = -1001<a class="headerlink" href="#_CPPv3N17ratbag_error_code23RATBAG_ERROR_CAPABILITYE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Insufficient capabilities. This error occurs when a requested change is beyond the device’s capabilities.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N17ratbag_error_code18RATBAG_ERROR_VALUEE">
<span id="_CPPv2N17ratbag_error_code18RATBAG_ERROR_VALUEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_ERROR_VALUE</code> = -1002<a class="headerlink" href="#_CPPv3N17ratbag_error_code18RATBAG_ERROR_VALUEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Invalid value or value range. The provided value or value range is outside of the legal or supported range.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N17ratbag_error_code19RATBAG_ERROR_SYSTEME">
<span id="_CPPv2N17ratbag_error_code19RATBAG_ERROR_SYSTEME"></span><em class="property">enumerator </em><code class="descname">RATBAG_ERROR_SYSTEM</code> = -1003<a class="headerlink" href="#_CPPv3N17ratbag_error_code19RATBAG_ERROR_SYSTEME" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A low-level system error has occured, e.g. a failure to access files that should be there. This error is usually unrecoverable and libratbag will print a log message with details about the error.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N17ratbag_error_code27RATBAG_ERROR_IMPLEMENTATIONE">
<span id="_CPPv2N17ratbag_error_code27RATBAG_ERROR_IMPLEMENTATIONE"></span><em class="property">enumerator </em><code class="descname">RATBAG_ERROR_IMPLEMENTATION</code> = -1004<a class="headerlink" href="#_CPPv3N17ratbag_error_code27RATBAG_ERROR_IMPLEMENTATIONE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Implementation bug, either in libratbag or in the caller. This error is usually unrecoverable and libratbag will print a log message with details about the error.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-profile-capability">
<h2>ratbag_profile_capability<a class="headerlink" href="#ratbag-profile-capability" title="Permalink to this headline">¶</a></h2>
<dl class="enum">
<dt id="_CPPv325ratbag_profile_capability">
<span id="_CPPv225ratbag_profile_capability"></span><em class="property">enum </em><code class="descname">ratbag_profile_capability</code><a class="headerlink" href="#_CPPv325ratbag_profile_capability" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N25ratbag_profile_capability23RATBAG_PROFILE_CAP_NONEE">
<span id="_CPPv2N25ratbag_profile_capability23RATBAG_PROFILE_CAP_NONEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_PROFILE_CAP_NONE</code> = 0<a class="headerlink" href="#_CPPv3N25ratbag_profile_capability23RATBAG_PROFILE_CAP_NONEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_profile_capability30RATBAG_PROFILE_CAP_SET_DEFAULTE">
<span id="_CPPv2N25ratbag_profile_capability30RATBAG_PROFILE_CAP_SET_DEFAULTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_PROFILE_CAP_SET_DEFAULT</code> = 101<a class="headerlink" href="#_CPPv3N25ratbag_profile_capability30RATBAG_PROFILE_CAP_SET_DEFAULTE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>This profile can be assigned as the default profile. A default profile is the profile that is selected when the device is plugged in. Where no profile is assigned as the default profile, the device either picks last-used profile or a specific profile (usually the first).</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_profile_capability26RATBAG_PROFILE_CAP_DISABLEE">
<span id="_CPPv2N25ratbag_profile_capability26RATBAG_PROFILE_CAP_DISABLEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_PROFILE_CAP_DISABLE</code><a class="headerlink" href="#_CPPv3N25ratbag_profile_capability26RATBAG_PROFILE_CAP_DISABLEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The profile can be disabled and enabled. Profiles are not immediately deleted after being disabled, it is not guaranteed that the device will remember any disabled profiles the next time ratbag runs. Furthermore, the order of profiles may get changed the next time ratbag runs if profiles are disabled.Note that this capability only notes the general capability. A specific profile may still fail to be disabled, e.g. when it is the last enabled profile on the device.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_profile_capability29RATBAG_PROFILE_CAP_WRITE_ONLYE">
<span id="_CPPv2N25ratbag_profile_capability29RATBAG_PROFILE_CAP_WRITE_ONLYE"></span><em class="property">enumerator </em><code class="descname">RATBAG_PROFILE_CAP_WRITE_ONLY</code><a class="headerlink" href="#_CPPv3N25ratbag_profile_capability29RATBAG_PROFILE_CAP_WRITE_ONLYE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The profile information cannot be queried from the hardware. Where this capability is present, libratbag cannot query the device for its current configuration and the configured resolutions and button mappings are unknown. libratbag will still provide information about the structure of the device such as the number of buttons and resolutions. Clients that encounter a device without this resolution are encouraged to upload a configuration stored on-disk to the device to reset the device to a known state.Any changes uploaded to the device will be cached in libratbag, once a client has sent a full configuration to the device libratbag can be used to query the device as normal.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-resolution-capability">
<h2>ratbag_resolution_capability<a class="headerlink" href="#ratbag-resolution-capability" title="Permalink to this headline">¶</a></h2>
<dl class="enum">
<dt id="_CPPv328ratbag_resolution_capability">
<span id="_CPPv228ratbag_resolution_capability"></span><em class="property">enum </em><code class="descname">ratbag_resolution_capability</code><a class="headerlink" href="#_CPPv328ratbag_resolution_capability" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N28ratbag_resolution_capability44RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTIONE">
<span id="_CPPv2N28ratbag_resolution_capability44RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTIONE"></span><em class="property">enumerator </em><code class="descname">RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION</code> = 1<a class="headerlink" href="#_CPPv3N28ratbag_resolution_capability44RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTIONE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The resolution can be set for x and y separately.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-button-type">
<h2>ratbag_button_type<a class="headerlink" href="#ratbag-button-type" title="Permalink to this headline">¶</a></h2>
<p>Button types describing the physical button. This enum is deprecated and should not be used.Deprecated</p>
<dl class="enum">
<dt id="_CPPv318ratbag_button_type">
<span id="_CPPv218ratbag_button_type"></span><em class="property">enum </em><code class="descname">ratbag_button_type</code><a class="headerlink" href="#_CPPv318ratbag_button_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type26RATBAG_BUTTON_TYPE_UNKNOWNE">
<span id="_CPPv2N18ratbag_button_type26RATBAG_BUTTON_TYPE_UNKNOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_UNKNOWN</code> = 0<a class="headerlink" href="#_CPPv3N18ratbag_button_type26RATBAG_BUTTON_TYPE_UNKNOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type23RATBAG_BUTTON_TYPE_LEFTE">
<span id="_CPPv2N18ratbag_button_type23RATBAG_BUTTON_TYPE_LEFTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_LEFT</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type23RATBAG_BUTTON_TYPE_LEFTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_MIDDLEE">
<span id="_CPPv2N18ratbag_button_type25RATBAG_BUTTON_TYPE_MIDDLEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_MIDDLE</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_MIDDLEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type24RATBAG_BUTTON_TYPE_RIGHTE">
<span id="_CPPv2N18ratbag_button_type24RATBAG_BUTTON_TYPE_RIGHTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_RIGHT</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type24RATBAG_BUTTON_TYPE_RIGHTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type24RATBAG_BUTTON_TYPE_THUMBE">
<span id="_CPPv2N18ratbag_button_type24RATBAG_BUTTON_TYPE_THUMBE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_THUMB</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type24RATBAG_BUTTON_TYPE_THUMBE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB2E">
<span id="_CPPv2N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB2E"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_THUMB2</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB2E" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB3E">
<span id="_CPPv2N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB3E"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_THUMB3</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB3E" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB4E">
<span id="_CPPv2N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB4E"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_THUMB4</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_THUMB4E" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type29RATBAG_BUTTON_TYPE_WHEEL_LEFTE">
<span id="_CPPv2N18ratbag_button_type29RATBAG_BUTTON_TYPE_WHEEL_LEFTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_WHEEL_LEFT</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type29RATBAG_BUTTON_TYPE_WHEEL_LEFTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type30RATBAG_BUTTON_TYPE_WHEEL_RIGHTE">
<span id="_CPPv2N18ratbag_button_type30RATBAG_BUTTON_TYPE_WHEEL_RIGHTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_WHEEL_RIGHT</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type30RATBAG_BUTTON_TYPE_WHEEL_RIGHTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type30RATBAG_BUTTON_TYPE_WHEEL_CLICKE">
<span id="_CPPv2N18ratbag_button_type30RATBAG_BUTTON_TYPE_WHEEL_CLICKE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_WHEEL_CLICK</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type30RATBAG_BUTTON_TYPE_WHEEL_CLICKE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type27RATBAG_BUTTON_TYPE_WHEEL_UPE">
<span id="_CPPv2N18ratbag_button_type27RATBAG_BUTTON_TYPE_WHEEL_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_WHEEL_UP</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type27RATBAG_BUTTON_TYPE_WHEEL_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type29RATBAG_BUTTON_TYPE_WHEEL_DOWNE">
<span id="_CPPv2N18ratbag_button_type29RATBAG_BUTTON_TYPE_WHEEL_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_WHEEL_DOWN</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type29RATBAG_BUTTON_TYPE_WHEEL_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type43RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFTE">
<span id="_CPPv2N18ratbag_button_type43RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFT</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type43RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFTE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A button to toggle the wheel from free-spinning to click-based.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type24RATBAG_BUTTON_TYPE_EXTRAE">
<span id="_CPPv2N18ratbag_button_type24RATBAG_BUTTON_TYPE_EXTRAE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_EXTRA</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type24RATBAG_BUTTON_TYPE_EXTRAE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type23RATBAG_BUTTON_TYPE_SIDEE">
<span id="_CPPv2N18ratbag_button_type23RATBAG_BUTTON_TYPE_SIDEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_SIDE</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type23RATBAG_BUTTON_TYPE_SIDEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_PINKIEE">
<span id="_CPPv2N18ratbag_button_type25RATBAG_BUTTON_TYPE_PINKIEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_PINKIE</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type25RATBAG_BUTTON_TYPE_PINKIEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type26RATBAG_BUTTON_TYPE_PINKIE2E">
<span id="_CPPv2N18ratbag_button_type26RATBAG_BUTTON_TYPE_PINKIE2E"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_PINKIE2</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type26RATBAG_BUTTON_TYPE_PINKIE2E" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type38RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UPE">
<span id="_CPPv2N18ratbag_button_type38RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UP</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type38RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type32RATBAG_BUTTON_TYPE_RESOLUTION_UPE">
<span id="_CPPv2N18ratbag_button_type32RATBAG_BUTTON_TYPE_RESOLUTION_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_RESOLUTION_UP</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type32RATBAG_BUTTON_TYPE_RESOLUTION_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type34RATBAG_BUTTON_TYPE_RESOLUTION_DOWNE">
<span id="_CPPv2N18ratbag_button_type34RATBAG_BUTTON_TYPE_RESOLUTION_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_RESOLUTION_DOWN</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type34RATBAG_BUTTON_TYPE_RESOLUTION_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type35RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UPE">
<span id="_CPPv2N18ratbag_button_type35RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UP</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type35RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type29RATBAG_BUTTON_TYPE_PROFILE_UPE">
<span id="_CPPv2N18ratbag_button_type29RATBAG_BUTTON_TYPE_PROFILE_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_PROFILE_UP</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type29RATBAG_BUTTON_TYPE_PROFILE_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N18ratbag_button_type31RATBAG_BUTTON_TYPE_PROFILE_DOWNE">
<span id="_CPPv2N18ratbag_button_type31RATBAG_BUTTON_TYPE_PROFILE_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_TYPE_PROFILE_DOWN</code><a class="headerlink" href="#_CPPv3N18ratbag_button_type31RATBAG_BUTTON_TYPE_PROFILE_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-button-action-type">
<h2>ratbag_button_action_type<a class="headerlink" href="#ratbag-button-action-type" title="Permalink to this headline">¶</a></h2>
<p>The type assigned to a button.</p>
<dl class="enum">
<dt id="_CPPv325ratbag_button_action_type">
<span id="_CPPv225ratbag_button_action_type"></span><em class="property">enum </em><code class="descname">ratbag_button_action_type</code><a class="headerlink" href="#_CPPv325ratbag_button_action_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N25ratbag_button_action_type30RATBAG_BUTTON_ACTION_TYPE_NONEE">
<span id="_CPPv2N25ratbag_button_action_type30RATBAG_BUTTON_ACTION_TYPE_NONEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_TYPE_NONE</code> = 0<a class="headerlink" href="#_CPPv3N25ratbag_button_action_type30RATBAG_BUTTON_ACTION_TYPE_NONEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Button is disabled.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_button_action_type32RATBAG_BUTTON_ACTION_TYPE_BUTTONE">
<span id="_CPPv2N25ratbag_button_action_type32RATBAG_BUTTON_ACTION_TYPE_BUTTONE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_TYPE_BUTTON</code><a class="headerlink" href="#_CPPv3N25ratbag_button_action_type32RATBAG_BUTTON_ACTION_TYPE_BUTTONE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Button sends numeric button events.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_button_action_type33RATBAG_BUTTON_ACTION_TYPE_SPECIALE">
<span id="_CPPv2N25ratbag_button_action_type33RATBAG_BUTTON_ACTION_TYPE_SPECIALE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_TYPE_SPECIAL</code><a class="headerlink" href="#_CPPv3N25ratbag_button_action_type33RATBAG_BUTTON_ACTION_TYPE_SPECIALE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Button triggers a mouse-specific special function. This includes resolution changes and profile changes.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_button_action_type29RATBAG_BUTTON_ACTION_TYPE_KEYE">
<span id="_CPPv2N25ratbag_button_action_type29RATBAG_BUTTON_ACTION_TYPE_KEYE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_TYPE_KEY</code><a class="headerlink" href="#_CPPv3N25ratbag_button_action_type29RATBAG_BUTTON_ACTION_TYPE_KEYE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Button sends a key or key + modifier combination.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_button_action_type31RATBAG_BUTTON_ACTION_TYPE_MACROE">
<span id="_CPPv2N25ratbag_button_action_type31RATBAG_BUTTON_ACTION_TYPE_MACROE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_TYPE_MACRO</code><a class="headerlink" href="#_CPPv3N25ratbag_button_action_type31RATBAG_BUTTON_ACTION_TYPE_MACROE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Button sends a user-defined key or button sequence.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N25ratbag_button_action_type33RATBAG_BUTTON_ACTION_TYPE_UNKNOWNE">
<span id="_CPPv2N25ratbag_button_action_type33RATBAG_BUTTON_ACTION_TYPE_UNKNOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_TYPE_UNKNOWN</code> = 1000<a class="headerlink" href="#_CPPv3N25ratbag_button_action_type33RATBAG_BUTTON_ACTION_TYPE_UNKNOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Button action is unknown.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-button-action-special">
<h2>ratbag_button_action_special<a class="headerlink" href="#ratbag-button-action-special" title="Permalink to this headline">¶</a></h2>
<dl class="enum">
<dt id="_CPPv328ratbag_button_action_special">
<span id="_CPPv228ratbag_button_action_special"></span><em class="property">enum </em><code class="descname">ratbag_button_action_special</code><a class="headerlink" href="#_CPPv328ratbag_button_action_special" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special36RATBAG_BUTTON_ACTION_SPECIAL_INVALIDE">
<span id="_CPPv2N28ratbag_button_action_special36RATBAG_BUTTON_ACTION_SPECIAL_INVALIDE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_INVALID</code> = -1<a class="headerlink" href="#_CPPv3N28ratbag_button_action_special36RATBAG_BUTTON_ACTION_SPECIAL_INVALIDE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>This button is not set up for a special action.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special36RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWNE">
<span id="_CPPv2N28ratbag_button_action_special36RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWN</code> = (1 << 30)<a class="headerlink" href="#_CPPv3N28ratbag_button_action_special36RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICKE">
<span id="_CPPv2N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICKE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICK</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICKE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFTE">
<span id="_CPPv2N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFT</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHTE">
<span id="_CPPv2N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHT</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special37RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UPE">
<span id="_CPPv2N28ratbag_button_action_special37RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UP</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special37RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWNE">
<span id="_CPPv2N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWN</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special48RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCHE">
<span id="_CPPv2N28ratbag_button_action_special48RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCHE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCH</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special48RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCHE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special48RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UPE">
<span id="_CPPv2N28ratbag_button_action_special48RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UP</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special48RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special50RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWNE">
<span id="_CPPv2N28ratbag_button_action_special50RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWN</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special50RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special42RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UPE">
<span id="_CPPv2N28ratbag_button_action_special42RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UP</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special42RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special44RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWNE">
<span id="_CPPv2N28ratbag_button_action_special44RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWN</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special44RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special49RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATEE">
<span id="_CPPv2N28ratbag_button_action_special49RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATE</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special49RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special47RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULTE">
<span id="_CPPv2N28ratbag_button_action_special47RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULTE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULT</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special47RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special45RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UPE">
<span id="_CPPv2N28ratbag_button_action_special45RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UP</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special45RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special47RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWNE">
<span id="_CPPv2N28ratbag_button_action_special47RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWN</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special47RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UPE">
<span id="_CPPv2N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UPE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UP</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special39RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special41RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWNE">
<span id="_CPPv2N28ratbag_button_action_special41RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWNE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWN</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special41RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODEE">
<span id="_CPPv2N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODE</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special40RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N28ratbag_button_action_special42RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVELE">
<span id="_CPPv2N28ratbag_button_action_special42RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVELE"></span><em class="property">enumerator </em><code class="descname">RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVEL</code><a class="headerlink" href="#_CPPv3N28ratbag_button_action_special42RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVELE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-led-mode">
<h2>ratbag_led_mode<a class="headerlink" href="#ratbag-led-mode" title="Permalink to this headline">¶</a></h2>
<p>Each LED mode has different properties, e.g. the brightness and rate are only available in modes RATBAG_LED_CYCLE and RATBAG_LED_BREATHING modes</p>
<dl class="enum">
<dt id="_CPPv315ratbag_led_mode">
<span id="_CPPv215ratbag_led_mode"></span><em class="property">enum </em><code class="descname">ratbag_led_mode</code><a class="headerlink" href="#_CPPv315ratbag_led_mode" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_mode14RATBAG_LED_OFFE">
<span id="_CPPv2N15ratbag_led_mode14RATBAG_LED_OFFE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_OFF</code> = 0<a class="headerlink" href="#_CPPv3N15ratbag_led_mode14RATBAG_LED_OFFE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>led is now off</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_mode13RATBAG_LED_ONE">
<span id="_CPPv2N15ratbag_led_mode13RATBAG_LED_ONE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_ON</code><a class="headerlink" href="#_CPPv3N15ratbag_led_mode13RATBAG_LED_ONE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>led is on with static color</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_mode16RATBAG_LED_CYCLEE">
<span id="_CPPv2N15ratbag_led_mode16RATBAG_LED_CYCLEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_CYCLE</code><a class="headerlink" href="#_CPPv3N15ratbag_led_mode16RATBAG_LED_CYCLEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>led is cycling between all colors</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_mode20RATBAG_LED_BREATHINGE">
<span id="_CPPv2N15ratbag_led_mode20RATBAG_LED_BREATHINGE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_BREATHING</code><a class="headerlink" href="#_CPPv3N15ratbag_led_mode20RATBAG_LED_BREATHINGE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>led is pulsating with static color</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-led-type">
<h2>ratbag_led_type<a class="headerlink" href="#ratbag-led-type" title="Permalink to this headline">¶</a></h2>
<p>LED types, usually based on their physical location. This enum is deprecated and should not be used.Deprecated</p>
<dl class="enum">
<dt id="_CPPv315ratbag_led_type">
<span id="_CPPv215ratbag_led_type"></span><em class="property">enum </em><code class="descname">ratbag_led_type</code><a class="headerlink" href="#_CPPv315ratbag_led_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_type20RATBAG_LED_TYPE_LOGOE">
<span id="_CPPv2N15ratbag_led_type20RATBAG_LED_TYPE_LOGOE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_TYPE_LOGO</code> = 1<a class="headerlink" href="#_CPPv3N15ratbag_led_type20RATBAG_LED_TYPE_LOGOE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_type20RATBAG_LED_TYPE_SIDEE">
<span id="_CPPv2N15ratbag_led_type20RATBAG_LED_TYPE_SIDEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_TYPE_SIDE</code><a class="headerlink" href="#_CPPv3N15ratbag_led_type20RATBAG_LED_TYPE_SIDEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_type23RATBAG_LED_TYPE_BATTERYE">
<span id="_CPPv2N15ratbag_led_type23RATBAG_LED_TYPE_BATTERYE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_TYPE_BATTERY</code><a class="headerlink" href="#_CPPv3N15ratbag_led_type23RATBAG_LED_TYPE_BATTERYE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_type19RATBAG_LED_TYPE_DPIE">
<span id="_CPPv2N15ratbag_led_type19RATBAG_LED_TYPE_DPIE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_TYPE_DPI</code><a class="headerlink" href="#_CPPv3N15ratbag_led_type19RATBAG_LED_TYPE_DPIE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N15ratbag_led_type21RATBAG_LED_TYPE_WHEELE">
<span id="_CPPv2N15ratbag_led_type21RATBAG_LED_TYPE_WHEELE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_TYPE_WHEEL</code><a class="headerlink" href="#_CPPv3N15ratbag_led_type21RATBAG_LED_TYPE_WHEELE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-led-colordepth">
<h2>ratbag_led_colordepth<a class="headerlink" href="#ratbag-led-colordepth" title="Permalink to this headline">¶</a></h2>
<dl class="enum">
<dt id="_CPPv321ratbag_led_colordepth">
<span id="_CPPv221ratbag_led_colordepth"></span><em class="property">enum </em><code class="descname">ratbag_led_colordepth</code><a class="headerlink" href="#_CPPv321ratbag_led_colordepth" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N21ratbag_led_colordepth32RATBAG_LED_COLORDEPTH_MONOCHROMEE">
<span id="_CPPv2N21ratbag_led_colordepth32RATBAG_LED_COLORDEPTH_MONOCHROMEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_COLORDEPTH_MONOCHROME</code> = 0<a class="headerlink" href="#_CPPv3N21ratbag_led_colordepth32RATBAG_LED_COLORDEPTH_MONOCHROMEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The device only supports a single color. All color components should be set to 255.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N21ratbag_led_colordepth29RATBAG_LED_COLORDEPTH_RGB_888E">
<span id="_CPPv2N21ratbag_led_colordepth29RATBAG_LED_COLORDEPTH_RGB_888E"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_COLORDEPTH_RGB_888</code><a class="headerlink" href="#_CPPv3N21ratbag_led_colordepth29RATBAG_LED_COLORDEPTH_RGB_888E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The device supports RBG color with 8 bits per color.</p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N21ratbag_led_colordepth29RATBAG_LED_COLORDEPTH_RGB_111E">
<span id="_CPPv2N21ratbag_led_colordepth29RATBAG_LED_COLORDEPTH_RGB_111E"></span><em class="property">enumerator </em><code class="descname">RATBAG_LED_COLORDEPTH_RGB_111</code><a class="headerlink" href="#_CPPv3N21ratbag_led_colordepth29RATBAG_LED_COLORDEPTH_RGB_111E" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The device supports RBG colors with 1 bit per color.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ratbag-macro-event-type">
<h2>ratbag_macro_event_type<a class="headerlink" href="#ratbag-macro-event-type" title="Permalink to this headline">¶</a></h2>
<p>Macro event types describing the event.</p>
<dl class="enum">
<dt id="_CPPv323ratbag_macro_event_type">
<span id="_CPPv223ratbag_macro_event_type"></span><em class="property">enum </em><code class="descname">ratbag_macro_event_type</code><a class="headerlink" href="#_CPPv323ratbag_macro_event_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><dl class="enumerator">
<dt id="_CPPv3N23ratbag_macro_event_type26RATBAG_MACRO_EVENT_INVALIDE">
<span id="_CPPv2N23ratbag_macro_event_type26RATBAG_MACRO_EVENT_INVALIDE"></span><em class="property">enumerator </em><code class="descname">RATBAG_MACRO_EVENT_INVALID</code> = -1<a class="headerlink" href="#_CPPv3N23ratbag_macro_event_type26RATBAG_MACRO_EVENT_INVALIDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N23ratbag_macro_event_type23RATBAG_MACRO_EVENT_NONEE">
<span id="_CPPv2N23ratbag_macro_event_type23RATBAG_MACRO_EVENT_NONEE"></span><em class="property">enumerator </em><code class="descname">RATBAG_MACRO_EVENT_NONE</code> = 0<a class="headerlink" href="#_CPPv3N23ratbag_macro_event_type23RATBAG_MACRO_EVENT_NONEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N23ratbag_macro_event_type30RATBAG_MACRO_EVENT_KEY_PRESSEDE">
<span id="_CPPv2N23ratbag_macro_event_type30RATBAG_MACRO_EVENT_KEY_PRESSEDE"></span><em class="property">enumerator </em><code class="descname">RATBAG_MACRO_EVENT_KEY_PRESSED</code><a class="headerlink" href="#_CPPv3N23ratbag_macro_event_type30RATBAG_MACRO_EVENT_KEY_PRESSEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N23ratbag_macro_event_type31RATBAG_MACRO_EVENT_KEY_RELEASEDE">
<span id="_CPPv2N23ratbag_macro_event_type31RATBAG_MACRO_EVENT_KEY_RELEASEDE"></span><em class="property">enumerator </em><code class="descname">RATBAG_MACRO_EVENT_KEY_RELEASED</code><a class="headerlink" href="#_CPPv3N23ratbag_macro_event_type31RATBAG_MACRO_EVENT_KEY_RELEASEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="enumerator">
<dt id="_CPPv3N23ratbag_macro_event_type23RATBAG_MACRO_EVENT_WAITE">
<span id="_CPPv2N23ratbag_macro_event_type23RATBAG_MACRO_EVENT_WAITE"></span><em class="property">enumerator </em><code class="descname">RATBAG_MACRO_EVENT_WAIT</code><a class="headerlink" href="#_CPPv3N23ratbag_macro_event_type23RATBAG_MACRO_EVENT_WAITE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="dbus.html" class="btn btn-neutral" title="DBus API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, The ratbaggers.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>