libratbag-doc 0.9-4 / usr / share / doc / libratbag-dev / html / group__button.html

This file is indexed.

/usr/share/doc/libratbag-dev/html/group__button.html is in libratbag-doc 0.9-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

   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
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <!-- For Mobile Devices -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta name="generator" content="Doxygen 1.8.13"/>
        <script type="text/javascript" src="file:///usr/share/javascript/jquery/jquery.js"></script>
        <title>libratbag: Button configuration</title>
        <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
        <script type="text/javascript" src="dynsections.js"></script>
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
        <script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="file:///usr/share/javascript/mathjax/MathJax.js"></script>
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link href="bootstrap.css" rel="stylesheet" type="text/css"/>
        <link href="bootstrap.css" rel="stylesheet" type="text/css" />
        <script src="file:///usr/share/javascript/bootstrap/js/bootstrap.js"></script>
        <script type="text/javascript" src="doxy-boot.js"></script>
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="container">
                <div class="navbar-header">
                    <a class="navbar-brand">libratbag 0.9.0</a>
                </div>
            </div>
        </nav>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
                <div class="container">
                    <div class="row">
                        <div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
                            <div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Button configuration</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structratbag__button.html">ratbag_button</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a button on the device.  <a href="structratbag__button.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structratbag__macro.html">ratbag_macro</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a macro that can be assigned to a button.  <a href="structratbag__macro.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gafcdd5e2cf88f351085b341ffbb909fd2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gafcdd5e2cf88f351085b341ffbb909fd2">ratbag_button_type</a> { <br />
&#160;&#160;<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a7bca635d9025f6900dba449bccda3d3d">RATBAG_BUTTON_TYPE_UNKNOWN</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a8042afc70b84fdf7d7d21b7d949d4b9c">RATBAG_BUTTON_TYPE_LEFT</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2ad3a2abf81fcfd49b56134102a2653676">RATBAG_BUTTON_TYPE_MIDDLE</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a8de7a91e89376d03ac5f0851fab70600">RATBAG_BUTTON_TYPE_RIGHT</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a77288824bca980d8880e2317963176ab">RATBAG_BUTTON_TYPE_THUMB</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2aa878e5948b2b12d13a91f08f309cf1cb">RATBAG_BUTTON_TYPE_THUMB2</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2ac8ab5c27c077f614f4e3e7016425239b">RATBAG_BUTTON_TYPE_THUMB3</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2aedd64f753389d04fe881c8841fb45971">RATBAG_BUTTON_TYPE_THUMB4</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a4e7833dbcc430912bdbbbf04e6625662">RATBAG_BUTTON_TYPE_WHEEL_LEFT</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2abe71df878436dd40e96945b449f67f21">RATBAG_BUTTON_TYPE_WHEEL_RIGHT</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2ae97892b752aabd9811af1030bb91a995">RATBAG_BUTTON_TYPE_WHEEL_CLICK</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a3f34fbc88fcda99c49ab9b93bff1def0">RATBAG_BUTTON_TYPE_WHEEL_UP</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a6e403e17fb115525dba21cf59f2d1607">RATBAG_BUTTON_TYPE_WHEEL_DOWN</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a09d8e95699fa185af5a1aec61fa18b94">RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFT</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a822f6cc8b0ecbb3ae0c00ef83287a64a">RATBAG_BUTTON_TYPE_EXTRA</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a16e45fc796c4f3f398678b6d2b5fb5a3">RATBAG_BUTTON_TYPE_SIDE</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2ac259042c3f1e3706c03f2313d7707922">RATBAG_BUTTON_TYPE_PINKIE</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2ad47127aaee5e28f4644556f72d60d6fa">RATBAG_BUTTON_TYPE_PINKIE2</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a5a59741e9f83d956b2ed3f4a2c572dd2">RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UP</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a41a171b1c2ccdf23f683dedd01eb9bab">RATBAG_BUTTON_TYPE_RESOLUTION_UP</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a8174ea6fac3d7276678f878871302833">RATBAG_BUTTON_TYPE_RESOLUTION_DOWN</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2aa3a4a64a92a0ab82e6e38a782ce07dbb">RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UP</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2a49c607b930139e78180fcb89e6910844">RATBAG_BUTTON_TYPE_PROFILE_UP</a>, 
<a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2aac44c2a2f7c31266a8ffbe566efcc8b4">RATBAG_BUTTON_TYPE_PROFILE_DOWN</a>
<br />
 }<tr class="memdesc:gafcdd5e2cf88f351085b341ffbb909fd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Button types describing the physical button.  <a href="group__button.html#gafcdd5e2cf88f351085b341ffbb909fd2">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gafcdd5e2cf88f351085b341ffbb909fd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f5b77ec6305b4371baea749105bec13"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">ratbag_button_action_type</a> { <br />
&#160;&#160;<a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13aa086780609b50d838da775d6edcb8720">RATBAG_BUTTON_ACTION_TYPE_UNKNOWN</a>, 
<a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13af50bfdfab7f8cf69e06349f40aec9586">RATBAG_BUTTON_ACTION_TYPE_NONE</a>, 
<a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a">RATBAG_BUTTON_ACTION_TYPE_BUTTON</a>, 
<a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab969f0ad28a4e285454c3dd95414e02c">RATBAG_BUTTON_ACTION_TYPE_SPECIAL</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ae6a8937936a354d2536c55474591b90d">RATBAG_BUTTON_ACTION_TYPE_KEY</a>, 
<a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352">RATBAG_BUTTON_ACTION_TYPE_MACRO</a>
<br />
 }<tr class="memdesc:ga9f5b77ec6305b4371baea749105bec13"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type assigned to a button.  <a href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga9f5b77ec6305b4371baea749105bec13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8158a0f03a168268ec347f0a96699473"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga8158a0f03a168268ec347f0a96699473">ratbag_button_action_special</a> { <br />
&#160;&#160;<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473aec5fadf1f36a4ded8ecca313391108be">RATBAG_BUTTON_ACTION_SPECIAL_INVALID</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473ab2d432e782ef10e3989acdbfc1eec1e1">RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWN</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a8f35e47cdafb09262bab48e3eb6f0b5c">RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICK</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a3da43a68518921c1617be68c953d0c9f">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFT</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a18c8de16a7aefa0e943be16b241909dc">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHT</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a3b30fce388bb591483da08ac2042f122">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UP</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a0d0db353fdff8f2aaad5ca1e21c4b8c8">RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWN</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473ab74802c2069025c7b76431538a9a51ea">RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCH</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a992cf85a6d69128e42b2038ffe006740">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UP</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a22e1732b745a0a6de04fac2c65484a72">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWN</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473af61126c18363c2aa63cc626f94ec10f1">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UP</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a9ac6b495a4398b5d762e8241742562c9">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWN</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a36b89d5d86f8952b22070f53bca4bf25">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATE</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473af35a8207085784f0c199ce7c246a7269">RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULT</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a4eec5bccff9914efde9e020f195e482f">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UP</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a41d19cc4ffbc0817965b67f44e120c16">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWN</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473ae20a7f522c04f61aaa8c8f465d18aa01">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UP</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a1582729ba01270530482fb312fd26650">RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWN</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a46369e1a68c1516b94d4370a3bfa3d4d">RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODE</a>, 
<a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473a6eb414e7c080a5aee427dee1b7b65689">RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVEL</a>
<br />
 }</td></tr>
<tr class="separator:ga8158a0f03a168268ec347f0a96699473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga212d6f42b701a7795c73a5a1caba02fb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">ratbag_macro_event_type</a> { <br />
&#160;&#160;<a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fba1f860412a64de869a0a45d65cb009edf">RATBAG_MACRO_EVENT_INVALID</a>, 
<a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fba20c83bbdb34b15f779df6fd2f2055744">RATBAG_MACRO_EVENT_NONE</a>, 
<a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbae037921092a1d9a7cb2e2cea7edd4195">RATBAG_MACRO_EVENT_KEY_PRESSED</a>, 
<a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbaa48c811d550da53cf698132131fe1d51">RATBAG_MACRO_EVENT_KEY_RELEASED</a>, 
<br />
&#160;&#160;<a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbaf9b44f200255f432b9cbb9d261fc8a22">RATBAG_MACRO_EVENT_WAIT</a>
<br />
 }<tr class="memdesc:ga212d6f42b701a7795c73a5a1caba02fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro event types describing the event.  <a href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga212d6f42b701a7795c73a5a1caba02fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga332d7dde5121d3b34b1af6371c375c75"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga332d7dde5121d3b34b1af6371c375c75">ratbag_button_set_user_data</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, void *userdata)</td></tr>
<tr class="memdesc:ga332d7dde5121d3b34b1af6371c375c75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set caller-specific data associated with this button.  <a href="#ga332d7dde5121d3b34b1af6371c375c75">More...</a><br /></td></tr>
<tr class="separator:ga332d7dde5121d3b34b1af6371c375c75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57b7c5582b9a92c08cc70dffa7bbf3c9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga57b7c5582b9a92c08cc70dffa7bbf3c9">ratbag_button_get_user_data</a> (const struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:ga57b7c5582b9a92c08cc70dffa7bbf3c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the caller-specific data associated with this button, if any.  <a href="#ga57b7c5582b9a92c08cc70dffa7bbf3c9">More...</a><br /></td></tr>
<tr class="separator:ga57b7c5582b9a92c08cc70dffa7bbf3c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae25844ee57fc9ca22a9b33427ad066fb"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__button.html#gafcdd5e2cf88f351085b341ffbb909fd2">ratbag_button_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gae25844ee57fc9ca22a9b33427ad066fb">ratbag_button_get_type</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:gae25844ee57fc9ca22a9b33427ad066fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the type of the physical button.  <a href="#gae25844ee57fc9ca22a9b33427ad066fb">More...</a><br /></td></tr>
<tr class="separator:gae25844ee57fc9ca22a9b33427ad066fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabde4d3cbf659daec6309da81640463f4"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">ratbag_button_action_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gabde4d3cbf659daec6309da81640463f4">ratbag_button_get_action_type</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="separator:gabde4d3cbf659daec6309da81640463f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a3d6e7b1708d11912acab9732b2f91e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga1a3d6e7b1708d11912acab9732b2f91e">ratbag_button_has_action_type</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, enum <a class="el" href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">ratbag_button_action_type</a> action_type)</td></tr>
<tr class="memdesc:ga1a3d6e7b1708d11912acab9732b2f91e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a button supports a specific action type.  <a href="#ga1a3d6e7b1708d11912acab9732b2f91e">More...</a><br /></td></tr>
<tr class="separator:ga1a3d6e7b1708d11912acab9732b2f91e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d8d788732b2ffb5c328c27b6bf32ab9"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga1d8d788732b2ffb5c328c27b6bf32ab9">ratbag_button_get_button</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:ga1d8d788732b2ffb5c328c27b6bf32ab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a">RATBAG_BUTTON_ACTION_TYPE_BUTTON</a>, this function returns the logical button number this button is mapped to, starting at 1.  <a href="#ga1d8d788732b2ffb5c328c27b6bf32ab9">More...</a><br /></td></tr>
<tr class="separator:ga1d8d788732b2ffb5c328c27b6bf32ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30d5f9eb5b66d54686aa0f303cd45bc0"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga30d5f9eb5b66d54686aa0f303cd45bc0">ratbag_button_set_button</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, unsigned int btn)</td></tr>
<tr class="memdesc:ga30d5f9eb5b66d54686aa0f303cd45bc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="group__button.html#ga1d8d788732b2ffb5c328c27b6bf32ab9" title="If a button&#39;s action is RATBAG_BUTTON_ACTION_TYPE_BUTTON, this function returns the logical button nu...">ratbag_button_get_button()</a> for a description of the button number.  <a href="#ga30d5f9eb5b66d54686aa0f303cd45bc0">More...</a><br /></td></tr>
<tr class="separator:ga30d5f9eb5b66d54686aa0f303cd45bc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf0f65eefca1a380075718a96535cb6ef"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__button.html#ga8158a0f03a168268ec347f0a96699473">ratbag_button_action_special</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gaf0f65eefca1a380075718a96535cb6ef">ratbag_button_get_special</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:gaf0f65eefca1a380075718a96535cb6ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab969f0ad28a4e285454c3dd95414e02c">RATBAG_BUTTON_ACTION_TYPE_SPECIAL</a>, this function returns the special function assigned to this button.  <a href="#gaf0f65eefca1a380075718a96535cb6ef">More...</a><br /></td></tr>
<tr class="separator:gaf0f65eefca1a380075718a96535cb6ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2651e1b9603d22e7cf003a0ef9273a97"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga2651e1b9603d22e7cf003a0ef9273a97">ratbag_button_set_special</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, enum <a class="el" href="group__button.html#ga8158a0f03a168268ec347f0a96699473">ratbag_button_action_special</a> action)</td></tr>
<tr class="memdesc:ga2651e1b9603d22e7cf003a0ef9273a97"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the special function assigned to this button.  <a href="#ga2651e1b9603d22e7cf003a0ef9273a97">More...</a><br /></td></tr>
<tr class="separator:ga2651e1b9603d22e7cf003a0ef9273a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd6cb74791510fff4b81cdc4ec05dccb"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gacd6cb74791510fff4b81cdc4ec05dccb">ratbag_button_get_key</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, unsigned int *modifiers, size_t *sz)</td></tr>
<tr class="memdesc:gacd6cb74791510fff4b81cdc4ec05dccb"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ae6a8937936a354d2536c55474591b90d">RATBAG_BUTTON_ACTION_TYPE_KEY</a>, this function returns the key or button configured for this button.  <a href="#gacd6cb74791510fff4b81cdc4ec05dccb">More...</a><br /></td></tr>
<tr class="separator:gacd6cb74791510fff4b81cdc4ec05dccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c23b964b5d0a4296af343786c128033"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga7c23b964b5d0a4296af343786c128033">ratbag_button_set_key</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, unsigned int key, unsigned int *modifiers, size_t sz)</td></tr>
<tr class="separator:ga7c23b964b5d0a4296af343786c128033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a68272f2ee379d44e1c96ae1096481f"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga7a68272f2ee379d44e1c96ae1096481f">ratbag_button_disable</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="separator:ga7a68272f2ee379d44e1c96ae1096481f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadad04a96fcf421dea448c9dea95b1a39"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gadad04a96fcf421dea448c9dea95b1a39">ratbag_button_macro_get_name</a> (struct ratbag_button_macro *macro)</td></tr>
<tr class="separator:gadad04a96fcf421dea448c9dea95b1a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaccdc81330ea5eae6204a670865769e65"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gaccdc81330ea5eae6204a670865769e65">ratbag_button_macro_get_num_events</a> (struct ratbag_button_macro *macro)</td></tr>
<tr class="separator:gaccdc81330ea5eae6204a670865769e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1bd7c610e5dfc0d9316be2c9f73e891f"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">ratbag_macro_event_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga1bd7c610e5dfc0d9316be2c9f73e891f">ratbag_button_macro_get_event_type</a> (struct ratbag_button_macro *macro, unsigned int index)</td></tr>
<tr class="memdesc:ga1bd7c610e5dfc0d9316be2c9f73e891f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the macro event type configured for the event at the given index.  <a href="#ga1bd7c610e5dfc0d9316be2c9f73e891f">More...</a><br /></td></tr>
<tr class="separator:ga1bd7c610e5dfc0d9316be2c9f73e891f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa4f923df7f8228334ca202a404df7af3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gaa4f923df7f8228334ca202a404df7af3">ratbag_button_macro_get_event_key</a> (struct ratbag_button_macro *macro, unsigned int index)</td></tr>
<tr class="memdesc:gaa4f923df7f8228334ca202a404df7af3"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the event stored at the given index is <a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbae037921092a1d9a7cb2e2cea7edd4195">RATBAG_MACRO_EVENT_KEY_PRESSED</a> or <a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbaa48c811d550da53cf698132131fe1d51">RATBAG_MACRO_EVENT_KEY_RELEASED</a>, this function returns the key code configured for the event at the given index.  <a href="#gaa4f923df7f8228334ca202a404df7af3">More...</a><br /></td></tr>
<tr class="separator:gaa4f923df7f8228334ca202a404df7af3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59bf9309c5c5566c970e24f5e8b00aaa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga59bf9309c5c5566c970e24f5e8b00aaa">ratbag_button_macro_get_event_timeout</a> (struct ratbag_button_macro *macro, unsigned int index)</td></tr>
<tr class="memdesc:ga59bf9309c5c5566c970e24f5e8b00aaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the event stored at the given index is <a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbaf9b44f200255f432b9cbb9d261fc8a22">RATBAG_MACRO_EVENT_WAIT</a>, this function returns the timeout configured for the event at the given index.  <a href="#ga59bf9309c5c5566c970e24f5e8b00aaa">More...</a><br /></td></tr>
<tr class="separator:ga59bf9309c5c5566c970e24f5e8b00aaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0171d0aa19b40efc480890440baed39"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gab0171d0aa19b40efc480890440baed39">ratbag_button_set_macro</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button, const struct ratbag_button_macro *macro)</td></tr>
<tr class="memdesc:gab0171d0aa19b40efc480890440baed39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the button's action to <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352">RATBAG_BUTTON_ACTION_TYPE_MACRO</a> and assigns the given macro to this button.  <a href="#gab0171d0aa19b40efc480890440baed39">More...</a><br /></td></tr>
<tr class="separator:gab0171d0aa19b40efc480890440baed39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b3efb01e2183e55e6589bc6d1486be9"><td class="memItemLeft" align="right" valign="top">struct ratbag_button_macro *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga4b3efb01e2183e55e6589bc6d1486be9">ratbag_button_macro_new</a> (const char *name)</td></tr>
<tr class="memdesc:ga4b3efb01e2183e55e6589bc6d1486be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a new button macro.  <a href="#ga4b3efb01e2183e55e6589bc6d1486be9">More...</a><br /></td></tr>
<tr class="separator:ga4b3efb01e2183e55e6589bc6d1486be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ac445a5532b67ab03f8447a41881faf"><td class="memItemLeft" align="right" valign="top">struct ratbag_button_macro *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga7ac445a5532b67ab03f8447a41881faf">ratbag_button_get_macro</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:ga7ac445a5532b67ab03f8447a41881faf"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352">RATBAG_BUTTON_ACTION_TYPE_MACRO</a>, this function returns the current button macro.  <a href="#ga7ac445a5532b67ab03f8447a41881faf">More...</a><br /></td></tr>
<tr class="separator:ga7ac445a5532b67ab03f8447a41881faf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f7b7270177e9da69b9fdf8d72034f4a"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga8f7b7270177e9da69b9fdf8d72034f4a">ratbag_button_macro_set_event</a> (struct ratbag_button_macro *macro, unsigned int index, enum <a class="el" href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">ratbag_macro_event_type</a> type, unsigned int data)</td></tr>
<tr class="memdesc:ga8f7b7270177e9da69b9fdf8d72034f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the macro's event at the given index to the given type with the key code or timeout given.  <a href="#ga8f7b7270177e9da69b9fdf8d72034f4a">More...</a><br /></td></tr>
<tr class="separator:ga8f7b7270177e9da69b9fdf8d72034f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6937bdc91d208ac46b91966c34205879"><td class="memItemLeft" align="right" valign="top">struct ratbag_button_macro *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga6937bdc91d208ac46b91966c34205879">ratbag_button_macro_ref</a> (struct ratbag_button_macro *macro)</td></tr>
<tr class="memdesc:ga6937bdc91d208ac46b91966c34205879"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a reference to the macro.  <a href="#ga6937bdc91d208ac46b91966c34205879">More...</a><br /></td></tr>
<tr class="separator:ga6937bdc91d208ac46b91966c34205879"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf57897e6fc96fc6ff321c244b501f752"><td class="memItemLeft" align="right" valign="top">struct ratbag_button_macro *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gaf57897e6fc96fc6ff321c244b501f752">ratbag_button_macro_unref</a> (struct ratbag_button_macro *macro)</td></tr>
<tr class="memdesc:gaf57897e6fc96fc6ff321c244b501f752"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference the ratbag button macro.  <a href="#gaf57897e6fc96fc6ff321c244b501f752">More...</a><br /></td></tr>
<tr class="separator:gaf57897e6fc96fc6ff321c244b501f752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacbe158e5e95c8efb524406d2b9c6b4eb"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#gacbe158e5e95c8efb524406d2b9c6b4eb">ratbag_button_ref</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:gacbe158e5e95c8efb524406d2b9c6b4eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a reference to the button.  <a href="#gacbe158e5e95c8efb524406d2b9c6b4eb">More...</a><br /></td></tr>
<tr class="separator:gacbe158e5e95c8efb524406d2b9c6b4eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga259f5ad3d0566bec161c48a285a0206e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga259f5ad3d0566bec161c48a285a0206e">ratbag_button_unref</a> (struct <a class="el" href="structratbag__button.html">ratbag_button</a> *button)</td></tr>
<tr class="memdesc:ga259f5ad3d0566bec161c48a285a0206e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference the ratbag button.  <a href="#ga259f5ad3d0566bec161c48a285a0206e">More...</a><br /></td></tr>
<tr class="separator:ga259f5ad3d0566bec161c48a285a0206e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga8158a0f03a168268ec347f0a96699473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8158a0f03a168268ec347f0a96699473">&#9670;&nbsp;</a></span>ratbag_button_action_special</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#ga8158a0f03a168268ec347f0a96699473">ratbag_button_action_special</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473aec5fadf1f36a4ded8ecca313391108be"></a>RATBAG_BUTTON_ACTION_SPECIAL_INVALID&#160;</td><td class="fielddoc"><p>This button is not set up for a special action. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473ab2d432e782ef10e3989acdbfc1eec1e1"></a>RATBAG_BUTTON_ACTION_SPECIAL_UNKNOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a8f35e47cdafb09262bab48e3eb6f0b5c"></a>RATBAG_BUTTON_ACTION_SPECIAL_DOUBLECLICK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a3da43a68518921c1617be68c953d0c9f"></a>RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_LEFT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a18c8de16a7aefa0e943be16b241909dc"></a>RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_RIGHT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a3b30fce388bb591483da08ac2042f122"></a>RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a0d0db353fdff8f2aaad5ca1e21c4b8c8"></a>RATBAG_BUTTON_ACTION_SPECIAL_WHEEL_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473ab74802c2069025c7b76431538a9a51ea"></a>RATBAG_BUTTON_ACTION_SPECIAL_RATCHET_MODE_SWITCH&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a992cf85a6d69128e42b2038ffe006740"></a>RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a22e1732b745a0a6de04fac2c65484a72"></a>RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_CYCLE_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473af61126c18363c2aa63cc626f94ec10f1"></a>RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a9ac6b495a4398b5d762e8241742562c9"></a>RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a36b89d5d86f8952b22070f53bca4bf25"></a>RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_ALTERNATE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473af35a8207085784f0c199ce7c246a7269"></a>RATBAG_BUTTON_ACTION_SPECIAL_RESOLUTION_DEFAULT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a4eec5bccff9914efde9e020f195e482f"></a>RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a41d19cc4ffbc0817965b67f44e120c16"></a>RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_CYCLE_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473ae20a7f522c04f61aaa8c8f465d18aa01"></a>RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a1582729ba01270530482fb312fd26650"></a>RATBAG_BUTTON_ACTION_SPECIAL_PROFILE_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a46369e1a68c1516b94d4370a3bfa3d4d"></a>RATBAG_BUTTON_ACTION_SPECIAL_SECOND_MODE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga8158a0f03a168268ec347f0a96699473a6eb414e7c080a5aee427dee1b7b65689"></a>RATBAG_BUTTON_ACTION_SPECIAL_BATTERY_LEVEL&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<a id="ga9f5b77ec6305b4371baea749105bec13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f5b77ec6305b4371baea749105bec13">&#9670;&nbsp;</a></span>ratbag_button_action_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">ratbag_button_action_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The type assigned to a button. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9f5b77ec6305b4371baea749105bec13aa086780609b50d838da775d6edcb8720"></a>RATBAG_BUTTON_ACTION_TYPE_UNKNOWN&#160;</td><td class="fielddoc"><p>Button action is unknown. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9f5b77ec6305b4371baea749105bec13af50bfdfab7f8cf69e06349f40aec9586"></a>RATBAG_BUTTON_ACTION_TYPE_NONE&#160;</td><td class="fielddoc"><p>Button is disabled. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a"></a>RATBAG_BUTTON_ACTION_TYPE_BUTTON&#160;</td><td class="fielddoc"><p>Button sends numeric button events. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9f5b77ec6305b4371baea749105bec13ab969f0ad28a4e285454c3dd95414e02c"></a>RATBAG_BUTTON_ACTION_TYPE_SPECIAL&#160;</td><td class="fielddoc"><p>Button triggers a mouse-specific special function. </p>
<p>This includes resolution changes and profile changes. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9f5b77ec6305b4371baea749105bec13ae6a8937936a354d2536c55474591b90d"></a>RATBAG_BUTTON_ACTION_TYPE_KEY&#160;</td><td class="fielddoc"><p>Button sends a key or key + modifier combination. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352"></a>RATBAG_BUTTON_ACTION_TYPE_MACRO&#160;</td><td class="fielddoc"><p>Button sends a user-defined key or button sequence. </p>
</td></tr>
</table>

</div>
</div>
<a id="gafcdd5e2cf88f351085b341ffbb909fd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafcdd5e2cf88f351085b341ffbb909fd2">&#9670;&nbsp;</a></span>ratbag_button_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#gafcdd5e2cf88f351085b341ffbb909fd2">ratbag_button_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Button types describing the physical button. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a7bca635d9025f6900dba449bccda3d3d"></a>RATBAG_BUTTON_TYPE_UNKNOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a8042afc70b84fdf7d7d21b7d949d4b9c"></a>RATBAG_BUTTON_TYPE_LEFT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2ad3a2abf81fcfd49b56134102a2653676"></a>RATBAG_BUTTON_TYPE_MIDDLE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a8de7a91e89376d03ac5f0851fab70600"></a>RATBAG_BUTTON_TYPE_RIGHT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a77288824bca980d8880e2317963176ab"></a>RATBAG_BUTTON_TYPE_THUMB&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2aa878e5948b2b12d13a91f08f309cf1cb"></a>RATBAG_BUTTON_TYPE_THUMB2&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2ac8ab5c27c077f614f4e3e7016425239b"></a>RATBAG_BUTTON_TYPE_THUMB3&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2aedd64f753389d04fe881c8841fb45971"></a>RATBAG_BUTTON_TYPE_THUMB4&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a4e7833dbcc430912bdbbbf04e6625662"></a>RATBAG_BUTTON_TYPE_WHEEL_LEFT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2abe71df878436dd40e96945b449f67f21"></a>RATBAG_BUTTON_TYPE_WHEEL_RIGHT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2ae97892b752aabd9811af1030bb91a995"></a>RATBAG_BUTTON_TYPE_WHEEL_CLICK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a3f34fbc88fcda99c49ab9b93bff1def0"></a>RATBAG_BUTTON_TYPE_WHEEL_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a6e403e17fb115525dba21cf59f2d1607"></a>RATBAG_BUTTON_TYPE_WHEEL_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a09d8e95699fa185af5a1aec61fa18b94"></a>RATBAG_BUTTON_TYPE_WHEEL_RATCHET_MODE_SHIFT&#160;</td><td class="fielddoc"><p>A button to toggle the wheel from free-spinning to click-based. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a822f6cc8b0ecbb3ae0c00ef83287a64a"></a>RATBAG_BUTTON_TYPE_EXTRA&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a16e45fc796c4f3f398678b6d2b5fb5a3"></a>RATBAG_BUTTON_TYPE_SIDE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2ac259042c3f1e3706c03f2313d7707922"></a>RATBAG_BUTTON_TYPE_PINKIE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2ad47127aaee5e28f4644556f72d60d6fa"></a>RATBAG_BUTTON_TYPE_PINKIE2&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a5a59741e9f83d956b2ed3f4a2c572dd2"></a>RATBAG_BUTTON_TYPE_RESOLUTION_CYCLE_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a41a171b1c2ccdf23f683dedd01eb9bab"></a>RATBAG_BUTTON_TYPE_RESOLUTION_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a8174ea6fac3d7276678f878871302833"></a>RATBAG_BUTTON_TYPE_RESOLUTION_DOWN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2aa3a4a64a92a0ab82e6e38a782ce07dbb"></a>RATBAG_BUTTON_TYPE_PROFILE_CYCLE_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2a49c607b930139e78180fcb89e6910844"></a>RATBAG_BUTTON_TYPE_PROFILE_UP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ggafcdd5e2cf88f351085b341ffbb909fd2aac44c2a2f7c31266a8ffbe566efcc8b4"></a>RATBAG_BUTTON_TYPE_PROFILE_DOWN&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<a id="ga212d6f42b701a7795c73a5a1caba02fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga212d6f42b701a7795c73a5a1caba02fb">&#9670;&nbsp;</a></span>ratbag_macro_event_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">ratbag_macro_event_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Macro event types describing the event. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga212d6f42b701a7795c73a5a1caba02fba1f860412a64de869a0a45d65cb009edf"></a>RATBAG_MACRO_EVENT_INVALID&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga212d6f42b701a7795c73a5a1caba02fba20c83bbdb34b15f779df6fd2f2055744"></a>RATBAG_MACRO_EVENT_NONE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga212d6f42b701a7795c73a5a1caba02fbae037921092a1d9a7cb2e2cea7edd4195"></a>RATBAG_MACRO_EVENT_KEY_PRESSED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga212d6f42b701a7795c73a5a1caba02fbaa48c811d550da53cf698132131fe1d51"></a>RATBAG_MACRO_EVENT_KEY_RELEASED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga212d6f42b701a7795c73a5a1caba02fbaf9b44f200255f432b9cbb9d261fc8a22"></a>RATBAG_MACRO_EVENT_WAIT&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7a68272f2ee379d44e1c96ae1096481f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a68272f2ee379d44e1c96ae1096481f">&#9670;&nbsp;</a></span>ratbag_button_disable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_button_disable </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise. On success, the button's action is set to <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13af50bfdfab7f8cf69e06349f40aec9586">RATBAG_BUTTON_ACTION_TYPE_NONE</a>. </dd></dl>

</div>
</div>
<a id="gabde4d3cbf659daec6309da81640463f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabde4d3cbf659daec6309da81640463f4">&#9670;&nbsp;</a></span>ratbag_button_get_action_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">ratbag_button_action_type</a> ratbag_button_get_action_type </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The type of the action currently configured for this button </dd></dl>

</div>
</div>
<a id="ga1d8d788732b2ffb5c328c27b6bf32ab9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d8d788732b2ffb5c328c27b6bf32ab9">&#9670;&nbsp;</a></span>ratbag_button_get_button()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int ratbag_button_get_button </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a">RATBAG_BUTTON_ACTION_TYPE_BUTTON</a>, this function returns the logical button number this button is mapped to, starting at 1. </p>
<p>The button numbers are in sequence and do not correspond to any meaning other than its numeric value. It is up to the input stack how to map that logical button number, but usually buttons 1, 2 and 3 are mapped into left, middle, right.</p>
<p>If the button's action type is not <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a">RATBAG_BUTTON_ACTION_TYPE_BUTTON</a>, this function returns 0.</p>
<dl class="section return"><dt>Returns</dt><dd>The logical button number this button sends. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>This button is disabled or its action type is not <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a">RATBAG_BUTTON_ACTION_TYPE_BUTTON</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__button.html#ga30d5f9eb5b66d54686aa0f303cd45bc0" title="See ratbag_button_get_button() for a description of the button number. ">ratbag_button_set_button</a> </dd></dl>

</div>
</div>
<a id="gacd6cb74791510fff4b81cdc4ec05dccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd6cb74791510fff4b81cdc4ec05dccb">&#9670;&nbsp;</a></span>ratbag_button_get_key()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int ratbag_button_get_key </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int *&#160;</td>
          <td class="paramname"><em>modifiers</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>sz</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ae6a8937936a354d2536c55474591b90d">RATBAG_BUTTON_ACTION_TYPE_KEY</a>, this function returns the key or button configured for this button. </p>
<p>If the button's action type is not <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ae6a8937936a354d2536c55474591b90d">RATBAG_BUTTON_ACTION_TYPE_KEY</a>, this function returns 0 and leaves modifiers and sz untouched.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir"></td><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">modifiers</td><td>Will be filled with the modifiers required for this action. The modifiers are as defined in linux/input.h. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">sz</td><td>Takes the size of the modifiers array and returns the number of modifiers filled in. sz may be 0 if no modifiers are required.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The caller must ensure that modifiers is large enough to accomodate for the key combination.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The button number </dd></dl>

</div>
</div>
<a id="ga7ac445a5532b67ab03f8447a41881faf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7ac445a5532b67ab03f8447a41881faf">&#9670;&nbsp;</a></span>ratbag_button_get_macro()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct ratbag_button_macro* ratbag_button_get_macro </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352">RATBAG_BUTTON_ACTION_TYPE_MACRO</a>, this function returns the current button macro. </p>
<p>The macro is a copy of the one used on the device, changes to the macro are not reflected on the device until a subsequent call to <a class="el" href="group__button.html#gab0171d0aa19b40efc480890440baed39" title="Sets the button&#39;s action to RATBAG_BUTTON_ACTION_TYPE_MACRO and assigns the given macro to this butto...">ratbag_button_set_macro()</a>.</p>
<p>If a button's action is not <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352">RATBAG_BUTTON_ACTION_TYPE_MACRO</a>, this function returns NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaf0f65eefca1a380075718a96535cb6ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0f65eefca1a380075718a96535cb6ef">&#9670;&nbsp;</a></span>ratbag_button_get_special()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#ga8158a0f03a168268ec347f0a96699473">ratbag_button_action_special</a> ratbag_button_get_special </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If a button's action is <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab969f0ad28a4e285454c3dd95414e02c">RATBAG_BUTTON_ACTION_TYPE_SPECIAL</a>, this function returns the special function assigned to this button. </p>
<p>If the button's action type is not <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab969f0ad28a4e285454c3dd95414e02c">RATBAG_BUTTON_ACTION_TYPE_SPECIAL</a>, this function returns <a class="el" href="group__button.html#gga8158a0f03a168268ec347f0a96699473aec5fadf1f36a4ded8ecca313391108be">RATBAG_BUTTON_ACTION_SPECIAL_INVALID</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>The special function assigned to this button</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__button.html#ga30d5f9eb5b66d54686aa0f303cd45bc0" title="See ratbag_button_get_button() for a description of the button number. ">ratbag_button_set_button</a> </dd></dl>

</div>
</div>
<a id="gae25844ee57fc9ca22a9b33427ad066fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae25844ee57fc9ca22a9b33427ad066fb">&#9670;&nbsp;</a></span>ratbag_button_get_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#gafcdd5e2cf88f351085b341ffbb909fd2">ratbag_button_type</a> ratbag_button_get_type </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return the type of the physical button. </p>
<p>This function is intended to be used by configuration tools to provide a generic list of button names or handles to configure devices. The type describes the physical location of the button and remains constant for the lifetime of the device. For example, a button of type <a class="el" href="group__button.html#ggafcdd5e2cf88f351085b341ffbb909fd2ae97892b752aabd9811af1030bb91a995">RATBAG_BUTTON_TYPE_WHEEL_CLICK</a> may be mapped to a logical middle button, but the physical description is that of a wheel click.</p>
<p>For the button currently mapped to this physical button, see <a class="el" href="group__button.html#ga1d8d788732b2ffb5c328c27b6bf32ab9" title="If a button&#39;s action is RATBAG_BUTTON_ACTION_TYPE_BUTTON, this function returns the logical button nu...">ratbag_button_get_button()</a></p>
<dl class="section return"><dt>Returns</dt><dd>The type of the button </dd></dl>

</div>
</div>
<a id="ga57b7c5582b9a92c08cc70dffa7bbf3c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57b7c5582b9a92c08cc70dffa7bbf3c9">&#9670;&nbsp;</a></span>ratbag_button_get_user_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* ratbag_button_get_user_data </td>
          <td>(</td>
          <td class="paramtype">const struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the caller-specific data associated with this button, if any. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The caller-specific data previously assigned in <a class="el" href="group__button.html#ga332d7dde5121d3b34b1af6371c375c75" title="Set caller-specific data associated with this button. ">ratbag_button_set_user_data()</a>. </dd></dl>

</div>
</div>
<a id="ga1a3d6e7b1708d11912acab9732b2f91e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1a3d6e7b1708d11912acab9732b2f91e">&#9670;&nbsp;</a></span>ratbag_button_has_action_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ratbag_button_has_action_type </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="group__button.html#ga9f5b77ec6305b4371baea749105bec13">ratbag_button_action_type</a>&#160;</td>
          <td class="paramname"><em>action_type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check if a button supports a specific action type. </p>
<p>Not all devices allow all buttons to be assigned any action. Ability to change a button to a given action type does not guarantee that any specific action can be configured.</p>
<dl class="section note"><dt>Note</dt><dd>It is a client bug to pass in <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13aa086780609b50d838da775d6edcb8720">RATBAG_BUTTON_ACTION_TYPE_UNKNOWN</a> or <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13af50bfdfab7f8cf69e06349f40aec9586">RATBAG_BUTTON_ACTION_TYPE_NONE</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized button </td></tr>
    <tr><td class="paramname">action_type</td><td>An action type</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>non-zero if the action type is supported, zero otherwise. </dd></dl>

</div>
</div>
<a id="gaa4f923df7f8228334ca202a404df7af3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4f923df7f8228334ca202a404df7af3">&#9670;&nbsp;</a></span>ratbag_button_macro_get_event_key()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ratbag_button_macro_get_event_key </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If the event stored at the given index is <a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbae037921092a1d9a7cb2e2cea7edd4195">RATBAG_MACRO_EVENT_KEY_PRESSED</a> or <a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbaa48c811d550da53cf698132131fe1d51">RATBAG_MACRO_EVENT_KEY_RELEASED</a>, this function returns the key code configured for the event at the given index. </p>
<p>The behavior of this function for an index equal to or greater than the return value of <a class="el" href="group__button.html#gaccdc81330ea5eae6204a670865769e65">ratbag_button_macro_get_num_events()</a> is undefined.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized ratbag button macro </td></tr>
    <tr><td class="paramname">index</td><td>An index of the event within the macro we are interested in.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The key of the event at the given index </dd></dl>

</div>
</div>
<a id="ga59bf9309c5c5566c970e24f5e8b00aaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga59bf9309c5c5566c970e24f5e8b00aaa">&#9670;&nbsp;</a></span>ratbag_button_macro_get_event_timeout()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ratbag_button_macro_get_event_timeout </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If the event stored at the given index is <a class="el" href="group__button.html#gga212d6f42b701a7795c73a5a1caba02fbaf9b44f200255f432b9cbb9d261fc8a22">RATBAG_MACRO_EVENT_WAIT</a>, this function returns the timeout configured for the event at the given index. </p>
<p>The behavior of this function for an index equal to or greater than the return value of <a class="el" href="group__button.html#gaccdc81330ea5eae6204a670865769e65">ratbag_button_macro_get_num_events()</a> is undefined.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized ratbag button macro </td></tr>
    <tr><td class="paramname">index</td><td>An index of the event within the macro we are interested in.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The timeout of the event at the given index </dd></dl>

</div>
</div>
<a id="ga1bd7c610e5dfc0d9316be2c9f73e891f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1bd7c610e5dfc0d9316be2c9f73e891f">&#9670;&nbsp;</a></span>ratbag_button_macro_get_event_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">ratbag_macro_event_type</a> ratbag_button_macro_get_event_type </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the macro event type configured for the event at the given index. </p>
<p>The behavior of this function for an index equal to or greater than the return value of <a class="el" href="group__button.html#gaccdc81330ea5eae6204a670865769e65">ratbag_button_macro_get_num_events()</a> is undefined.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized ratbag button macro </td></tr>
    <tr><td class="paramname">index</td><td>An index of the event within the macro we are interested in.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The type of the event at the given index </dd></dl>

</div>
</div>
<a id="gadad04a96fcf421dea448c9dea95b1a39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadad04a96fcf421dea448c9dea95b1a39">&#9670;&nbsp;</a></span>ratbag_button_macro_get_name()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ratbag_button_macro_get_name </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized ratbag button macro</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The name of the macro </dd></dl>

</div>
</div>
<a id="gaccdc81330ea5eae6204a670865769e65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaccdc81330ea5eae6204a670865769e65">&#9670;&nbsp;</a></span>ratbag_button_macro_get_num_events()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int ratbag_button_macro_get_num_events </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized ratbag button macro</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The maximum number of events that can be assigned to this macro </dd></dl>

</div>
</div>
<a id="ga4b3efb01e2183e55e6589bc6d1486be9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b3efb01e2183e55e6589bc6d1486be9">&#9670;&nbsp;</a></span>ratbag_button_macro_new()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct ratbag_button_macro* ratbag_button_macro_new </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize a new button macro. </p>
<p>The macro is refcounted with an initial value of at least 1. Use <a class="el" href="group__button.html#gaf57897e6fc96fc6ff321c244b501f752" title="Dereference the ratbag button macro. ">ratbag_button_macro_unref()</a> to release the macro.</p>
<p>Note that some devices have limited storage for the macro names. libratbag silently shortens macro names to the longest string the device is capable of storing.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name to assign to this macro.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An "empty" button macro </dd></dl>

</div>
</div>
<a id="ga6937bdc91d208ac46b91966c34205879"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6937bdc91d208ac46b91966c34205879">&#9670;&nbsp;</a></span>ratbag_button_macro_ref()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct ratbag_button_macro* ratbag_button_macro_ref </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a reference to the macro. </p>
<p>A macro is destroyed whenever the reference count reaches 0. See <a class="el" href="group__button.html#gaf57897e6fc96fc6ff321c244b501f752">ratbag_button_macro_unref</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized valid ratbag button macro </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The passed ratbag macro </dd></dl>

</div>
</div>
<a id="ga8f7b7270177e9da69b9fdf8d72034f4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8f7b7270177e9da69b9fdf8d72034f4a">&#9670;&nbsp;</a></span>ratbag_button_macro_set_event()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_button_macro_set_event </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="group__button.html#ga212d6f42b701a7795c73a5a1caba02fb">ratbag_macro_event_type</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the macro's event at the given index to the given type with the key code or timeout given. </p>
<p>The behavior of this function for an index equal to or greater than the return value of <a class="el" href="group__button.html#gaccdc81330ea5eae6204a670865769e65">ratbag_button_macro_get_num_events()</a> is undefined. </p>

</div>
</div>
<a id="gaf57897e6fc96fc6ff321c244b501f752"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf57897e6fc96fc6ff321c244b501f752">&#9670;&nbsp;</a></span>ratbag_button_macro_unref()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct ratbag_button_macro* ratbag_button_macro_unref </td>
          <td>(</td>
          <td class="paramtype">struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Dereference the ratbag button macro. </p>
<p>When the internal refcount reaches zero, all resources associated with this object are released. The object must be considered invalid once unref is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">macro</td><td>A previously initialized ratbag button macro </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Always NULL </dd></dl>

</div>
</div>
<a id="gacbe158e5e95c8efb524406d2b9c6b4eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacbe158e5e95c8efb524406d2b9c6b4eb">&#9670;&nbsp;</a></span>ratbag_button_ref()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structratbag__button.html">ratbag_button</a>* ratbag_button_ref </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a reference to the button. </p>
<p>A button is destroyed whenever the reference count reaches 0. See <a class="el" href="group__button.html#ga259f5ad3d0566bec161c48a285a0206e">ratbag_button_unref</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized valid ratbag button </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The passed ratbag button </dd></dl>

</div>
</div>
<a id="ga30d5f9eb5b66d54686aa0f303cd45bc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30d5f9eb5b66d54686aa0f303cd45bc0">&#9670;&nbsp;</a></span>ratbag_button_set_button()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_button_set_button </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>btn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <a class="el" href="group__button.html#ga1d8d788732b2ffb5c328c27b6bf32ab9" title="If a button&#39;s action is RATBAG_BUTTON_ACTION_TYPE_BUTTON, this function returns the logical button nu...">ratbag_button_get_button()</a> for a description of the button number. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
    <tr><td class="paramname">btn</td><td>The logical button number to assign to this button. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise. On success, the button's action is set to <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab08c3d054f1d6e7ecc4fdb9b9b20484a">RATBAG_BUTTON_ACTION_TYPE_BUTTON</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__button.html#ga1d8d788732b2ffb5c328c27b6bf32ab9" title="If a button&#39;s action is RATBAG_BUTTON_ACTION_TYPE_BUTTON, this function returns the logical button nu...">ratbag_button_get_button</a> </dd></dl>

</div>
</div>
<a id="ga7c23b964b5d0a4296af343786c128033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7c23b964b5d0a4296af343786c128033">&#9670;&nbsp;</a></span>ratbag_button_set_key()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_button_set_key </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int *&#160;</td>
          <td class="paramname"><em>modifiers</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>sz</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
    <tr><td class="paramname">key</td><td>The button number to assign to this button, one of BTN_* as defined in linux/input.h </td></tr>
    <tr><td class="paramname">modifiers</td><td>The modifiers required for this action. The modifiers are as defined in linux/input.h, in the order they should be pressed. </td></tr>
    <tr><td class="paramname">sz</td><td>The size of the modifiers array. sz may be 0 if no modifiers are required.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise. On success, the button's action is set to <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ae6a8937936a354d2536c55474591b90d">RATBAG_BUTTON_ACTION_TYPE_KEY</a>. </dd></dl>

</div>
</div>
<a id="gab0171d0aa19b40efc480890440baed39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0171d0aa19b40efc480890440baed39">&#9670;&nbsp;</a></span>ratbag_button_set_macro()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_button_set_macro </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const struct ratbag_button_macro *&#160;</td>
          <td class="paramname"><em>macro</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the button's action to <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13a89b777e45740ba18398c528d85351352">RATBAG_BUTTON_ACTION_TYPE_MACRO</a> and assigns the given macro to this button. </p>
<p>libratbag does not use the macro struct passed in, it extracts the required information from the struct. Changes to the macro after a call to <a class="el" href="group__button.html#gab0171d0aa19b40efc480890440baed39" title="Sets the button&#39;s action to RATBAG_BUTTON_ACTION_TYPE_MACRO and assigns the given macro to this butto...">ratbag_button_set_macro()</a> are not reflected in the device until a subsequent call to <a class="el" href="group__button.html#gab0171d0aa19b40efc480890440baed39" title="Sets the button&#39;s action to RATBAG_BUTTON_ACTION_TYPE_MACRO and assigns the given macro to this butto...">ratbag_button_set_macro()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously intialized ratbag button </td></tr>
    <tr><td class="paramname">macro</td><td>A fully initialized macro</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or nonzero otherwise </dd></dl>

</div>
</div>
<a id="ga2651e1b9603d22e7cf003a0ef9273a97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2651e1b9603d22e7cf003a0ef9273a97">&#9670;&nbsp;</a></span>ratbag_button_set_special()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__base.html#ga778f6aa9aeee462860007415895baec1">ratbag_error_code</a> ratbag_button_set_special </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="group__button.html#ga8158a0f03a168268ec347f0a96699473">ratbag_button_action_special</a>&#160;</td>
          <td class="paramname"><em>action</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the special function assigned to this button. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
    <tr><td class="paramname">action</td><td>The special action to assign to this button. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code otherwise. On success, the button's action is set to <a class="el" href="group__button.html#gga9f5b77ec6305b4371baea749105bec13ab969f0ad28a4e285454c3dd95414e02c">RATBAG_BUTTON_ACTION_TYPE_SPECIAL</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__button.html#ga1d8d788732b2ffb5c328c27b6bf32ab9" title="If a button&#39;s action is RATBAG_BUTTON_ACTION_TYPE_BUTTON, this function returns the logical button nu...">ratbag_button_get_button</a> </dd></dl>

</div>
</div>
<a id="ga332d7dde5121d3b34b1af6371c375c75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga332d7dde5121d3b34b1af6371c375c75">&#9670;&nbsp;</a></span>ratbag_button_set_user_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ratbag_button_set_user_data </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>userdata</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set caller-specific data associated with this button. </p>
<p>libratbag does not manage, look at, or modify this data. The caller must ensure the data is valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized button </td></tr>
    <tr><td class="paramname">userdata</td><td>Caller-specific data passed to the various callback interfaces. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga259f5ad3d0566bec161c48a285a0206e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga259f5ad3d0566bec161c48a285a0206e">&#9670;&nbsp;</a></span>ratbag_button_unref()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structratbag__button.html">ratbag_button</a>* ratbag_button_unref </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structratbag__button.html">ratbag_button</a> *&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Dereference the ratbag button. </p>
<p>When the internal refcount reaches zero, all resources associated with this object are released. The object must be considered invalid once unref is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>A previously initialized ratbag button </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Always NULL </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 10 2018 18:56:06 for libratbag by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.