BrlAPI  0.8
brlapi_param.h
Go to the documentation of this file.
1 /*
2  * libbrlapi - A library providing access to braille terminals for applications.
3  *
4  * Copyright (C) 2002-2020 by
5  * Samuel Thibault <Samuel.Thibault@ens-lyon.org>
6  * Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
7  *
8  * libbrlapi comes with ABSOLUTELY NO WARRANTY.
9  *
10  * This is free software, placed under the terms of the
11  * GNU Lesser General Public License, as published by the Free Software
12  * Foundation; either version 2.1 of the License, or (at your option) any
13  * later version. Please see the file LICENSE-LGPL for details.
14  *
15  * Web Page: http://brltty.app/
16  *
17  * This software is maintained by Dave Mielke <dave@mielke.cc>.
18  */
19 
23 #ifndef BRLAPI_INCLUDED_PARAM
24 #define BRLAPI_INCLUDED_PARAM
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29 
30 #include "brlapi_keycodes.h"
31 
36 typedef enum {
37 //Connection Parameters
41 //Device Parameters
51 /* TODO: status area */
52 
53 //Input Parameters
56 //Braille Rendering Parameters
64 //Navigation Parameters
68 //Clipboard Parameters
71 //TTY Mode Parameters
81 //Raw Mode Parameters
91 //Braille Translation Parameters
101 /* TODO: dot-to-unicode as well */
102 
103  /* TODO: help strings */
104 
107 
108 /* brlapi_param_subparam_t */
110 typedef uint64_t brlapi_param_subparam_t;
111 
112 /* brlapi_param_bool_t */
114 typedef uint8_t brlapi_param_bool_t;
115 
116 /* brlapi_param_serverVersion_t */
119 
120 /* brlapi_param_clientPriority_t */
123 
124 /* BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT */
126 #define BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT 50
127 
128 /* brlapi_param_driverName_t */
131 
132 /* brlapi_param_driverCode_t */
135 
136 /* brlapi_param_driverVersion_t */
139 
140 /* brlapi_param_deviceModel_t */
143 
144 /* brlapi_param_deviceCellSize_t */
147 
148 /* brlapi_param_displaySize_t */
150 typedef struct {
151  uint32_t columns;
152  uint32_t rows;
154 
155 /* brlapi_param_deviceIdentifier_t */
158 
159 /* brlapi_param_deviceSpeed_t */
161 typedef uint32_t brlapi_param_deviceSpeed_t;
162 
163 /* brlapi_param_deviceOnline_t */
166 
167 /* brlapi_param_retainDots_t */
170 
171 /* brlapi_param_computerBrailleCellSize_t */
174 
175 /* brlapi_param_literaryBraille_t */
178 
179 /* brlapi_param_cursorDots_t */
182 
183 /* brlapi_param_cursorBlinkPeriod_t */
186 
187 /* brlapi_param_cursorBlinkPercentage_t */
190 
191 /* brlapi_param_renderedCells_t */
194 
195 /* brlapi_param_skipIdenticalLines_t */
198 
199 /* brlapi_param_audibleAlerts_t */
202 
203 /* brlapi_param_clipboardContent_t */
206 
207 /* brlapi_param_commandCode_t */
210 
211 /* brlapi_param_commandShortName_t */
214 
215 /* brlapi_param_commandLongName_t */
218 
219 /* brlapi_param_keyCode_t */
222 
223 /* brlapi_param_keyShortName_t */
226 
227 /* brlapi_param_keyLongName_t */
230 
231 /* brlapi_param_computerBrailleRowsMask_t */
234 
235 /* brlapi_param_computerBrailleRowCells_t */
237 typedef struct {
238  uint8_t cells[0X100];
239  uint8_t defined[0X100 / 8];
241 
242 /* brlapi_param_computerBrailleTable_t */
245 
246 /* brlapi_param_literaryBrailleTable_t */
249 
250 /* brlapi_param_messageLocale_t */
253 
255 typedef enum {
264 
266 typedef struct {
268  uint16_t count;
269  uint8_t isArray;
270  uint8_t hasSubparam;
272 
274 /* brlapi_getParameterProperties */
282 
285 #ifdef __cplusplus
286 }
287 #endif /* __cplusplus */
288 
289 #endif /* BRLAPI_INCLUDED_PARAM */
uint8_t brlapi_param_cursorDots_t
Definition: brlapi_param.h:181
char * brlapi_param_commandShortName_t
Definition: brlapi_param.h:213
uint8_t hasSubparam
Definition: brlapi_param.h:270
uint8_t * brlapi_param_renderedCells_t
Definition: brlapi_param.h:193
Definition: brlapi_param.h:59
char * brlapi_param_keyShortName_t
Definition: brlapi_param.h:225
char * brlapi_param_commandLongName_t
Definition: brlapi_param.h:217
uint8_t brlapi_param_cursorBlinkPercentage_t
Definition: brlapi_param.h:189
uint32_t columns
Definition: brlapi_param.h:151
Definition: brlapi_param.h:46
uint8_t brlapi_param_deviceCellSize_t
Definition: brlapi_param.h:146
char * brlapi_param_deviceIdentifier_t
Definition: brlapi_param.h:157
Definition: brlapi_param.h:92
char * brlapi_param_clipboardContent_t
Definition: brlapi_param.h:205
char * brlapi_param_computerBrailleTable_t
Definition: brlapi_param.h:244
Definition: brlapi_param.h:44
Definition: brlapi_param.h:95
Definition: brlapi_param.h:258
Definition: brlapi_param.h:60
Definition: brlapi_param.h:261
Definition: brlapi_param.h:58
Definition: brlapi_param.h:45
uint32_t rows
Definition: brlapi_param.h:152
Definition: brlapi_param.h:262
Definition: brlapi_param.h:100
Definition: brlapi_param.h:257
char * brlapi_param_deviceModel_t
Definition: brlapi_param.h:142
Definition: brlapi_param.h:54
char * brlapi_param_driverName_t
Definition: brlapi_param.h:130
Definition: brlapi_param.h:38
Definition: brlapi_param.h:42
uint8_t isArray
Definition: brlapi_param.h:269
Definition: brlapi_param.h:237
Definition: brlapi_param.h:266
Definition: brlapi_param.h:84
Definition: brlapi_param.h:50
Definition: brlapi_param.h:259
brlapi_param_bool_t brlapi_param_literaryBraille_t
Definition: brlapi_param.h:177
Definition: brlapi_param.h:57
Definition: brlapi_param.h:87
Definition: brlapi_param.h:82
Definition: brlapi_param.h:74
brlapi_param_bool_t brlapi_param_deviceOnline_t
Definition: brlapi_param.h:165
char * brlapi_param_literaryBrailleTable_t
Definition: brlapi_param.h:248
uint64_t brlapi_keyCode_t
Definition: brlapi_keycodes.h:90
uint32_t brlapi_param_clientPriority_t
Definition: brlapi_param.h:122
brlapi_keyCode_t brlapi_param_commandCode_t
Definition: brlapi_param.h:209
brlapi_param_t
Definition: brlapi_param.h:36
const brlapi_param_properties_t * brlapi_getParameterProperties(brlapi_param_t parameter)
Definition: brlapi_param.h:150
Definition: brlapi_param.h:99
Definition: brlapi_param.h:49
Definition: brlapi_param.h:98
uint8_t brlapi_param_computerBrailleCellSize_t
Definition: brlapi_param.h:173
Definition: brlapi_param.h:69
Definition: brlapi_param.h:47
Definition: brlapi_param.h:72
Definition: brlapi_param.h:43
Definition: brlapi_param.h:39
char * brlapi_param_keyLongName_t
Definition: brlapi_param.h:229
brlapi_param_bool_t brlapi_param_retainDots_t
Definition: brlapi_param.h:169
uint8_t brlapi_param_computerBrailleRowsMask_t[544]
Definition: brlapi_param.h:233
uint32_t brlapi_param_serverVersion_t
Definition: brlapi_param.h:118
uint8_t brlapi_param_bool_t
Definition: brlapi_param.h:114
brlapi_param_bool_t brlapi_param_audibleAlerts_t
Definition: brlapi_param.h:201
Definition: brlapi_param.h:48
char * brlapi_param_driverVersion_t
Definition: brlapi_param.h:138
Definition: brlapi_param.h:260
Definition: brlapi_param.h:256
Definition: brlapi_param.h:65
brlapi_param_type_t type
Definition: brlapi_param.h:267
char * brlapi_param_driverCode_t
Definition: brlapi_param.h:134
Definition: brlapi_param.h:77
char * brlapi_param_messageLocale_t
Definition: brlapi_param.h:252
Definition: brlapi_param.h:61
uint64_t brlapi_param_subparam_t
Definition: brlapi_param.h:110
brlapi_param_type_t
Definition: brlapi_param.h:255
uint32_t brlapi_param_deviceSpeed_t
Definition: brlapi_param.h:161
uint32_t brlapi_param_cursorBlinkPeriod_t
Definition: brlapi_param.h:185
brlapi_param_bool_t brlapi_param_skipIdenticalLines_t
Definition: brlapi_param.h:197
Definition: brlapi_param.h:62
brlapi_keyCode_t brlapi_param_keyCode_t
Definition: brlapi_param.h:221
Definition: brlapi_param.h:66
uint16_t count
Definition: brlapi_param.h:268
Definition: brlapi_param.h:105