1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/interface/Input.h hrev32748 10 * src/kits/interface/Input.cpp hrev46376 11 */ 12 13 14///// TO THEY WHO DOCUMENT ///// 15// The BeBook puts this class and its functions under the category 'Input Server' 16// grouped together with BInputServerDevice, BInputServerFilter and BInputServerMethod 17// Not sure if we should follow that choice. 18 19/*! 20 \file Input.h 21 \ingroup interface 22 \brief Undocumented file. 23 24 \since Haiku R1 25*/ 26 27 28/*! 29 \class BInputDevice 30 \ingroup interface 31 \ingroup libbe 32 \brief Undocumented class. 33 34 \since Haiku R1 35*/ 36 37 38/*! 39 \fn BInputDevice::~BInputDevice() 40 \brief Undocumented public method 41 42 \return Undocumented 43 \retval <value> Undocumented 44 45 \since Haiku R1 46*/ 47 48 49/*! 50 \fn const char* BInputDevice::Name() const 51 \brief Undocumented public method 52 53 \return Undocumented 54 \retval <value> Undocumented 55 56 \since Haiku R1 57*/ 58 59 60/*! 61 \fn input_device_type BInputDevice::Type() const 62 \brief Undocumented public method 63 64 \return Undocumented 65 \retval <value> Undocumented 66 67 \since Haiku R1 68*/ 69 70 71/*! 72 \fn bool BInputDevice::IsRunning() const 73 \brief Undocumented public method 74 75 \return Undocumented 76 \retval <value> Undocumented 77 78 \since Haiku R1 79*/ 80 81 82/*! 83 \fn status_t BInputDevice::Start() 84 \brief Undocumented public method 85 86 \return Undocumented 87 \retval <value> Undocumented 88 89 \since Haiku R1 90*/ 91 92 93/*! 94 \fn status_t BInputDevice::Stop() 95 \brief Undocumented public method 96 97 \return Undocumented 98 \retval <value> Undocumented 99 100 \since Haiku R1 101*/ 102 103 104/*! 105 \fn status_t BInputDevice::Control(uint32 code, BMessage *message) 106 \brief Undocumented public method 107 108 \param code Undocumented 109 \param message Undocumented 110 111 \return Undocumented 112 \retval <value> Undocumented 113 114 \since Haiku R1 115*/ 116 117 118/*! 119 \fn static static status_t BInputDevice::Start(input_device_type type) 120 \brief Undocumented public method 121 122 \param type Undocumented 123 124 \return Undocumented 125 \retval <value> Undocumented 126 127 \since Haiku R1 128*/ 129 130 131/*! 132 \fn static static status_t BInputDevice::Stop(input_device_type type) 133 \brief Undocumented public method 134 135 \param type Undocumented 136 137 \return Undocumented 138 \retval <value> Undocumented 139 140 \since Haiku R1 141*/ 142 143 144/*! 145 \fn static static status_t BInputDevice::Control(input_device_type type, uint32 code, BMessage *message) 146 \brief Undocumented public method 147 148 \param type Undocumented 149 \param code Undocumented 150 \param message Undocumented 151 152 \return Undocumented 153 \retval <value> Undocumented 154 155 \since Haiku R1 156*/ 157 158 159/*! 160 \enum input_method_op 161 \ingroup <kit name> 162 \brief Undocumented enum. 163 164 \since Haiku R1 165*/ 166 167 168/*! 169 \var input_method_op B_INPUT_METHOD_STARTED 170 \brief Undocumented enum value. 171 172 \since Haiku R1 173*/ 174 175 176/*! 177 \var input_method_op B_INPUT_METHOD_STOPPED 178 \brief Undocumented enum value. 179 180 \since Haiku R1 181*/ 182 183 184/*! 185 \var input_method_op B_INPUT_METHOD_CHANGED 186 \brief Undocumented enum value. 187 188 \since Haiku R1 189*/ 190 191 192/*! 193 \var input_method_op B_INPUT_METHOD_LOCATION_REQUEST 194 \brief Undocumented enum value. 195 196 \since Haiku R1 197*/ 198 199 200/*! 201 \enum input_device_type 202 \ingroup <kit name> 203 \brief Undocumented enum. 204 205 \since Haiku R1 206*/ 207 208 209/*! 210 \var input_device_type B_POINTING_DEVICE 211 \brief Undocumented enum value. 212 213 \since Haiku R1 214*/ 215 216 217/*! 218 \var input_device_type B_KEYBOARD_DEVICE 219 \brief Undocumented enum value. 220 221 \since Haiku R1 222*/ 223 224 225/*! 226 \var input_device_type B_UNDEFINED_DEVICE 227 \brief Undocumented enum value. 228 229 \since Haiku R1 230*/ 231 232 233/*! 234 \enum input_device_notification 235 \ingroup <kit name> 236 \brief Undocumented enum. 237 238 \since Haiku R1 239*/ 240 241 242/*! 243 \var input_device_notification B_INPUT_DEVICE_ADDED 244 \brief Undocumented enum value. 245 246 \since Haiku R1 247*/ 248 249 250/*! 251 \var input_device_notification B_INPUT_DEVICE_STARTED 252 \brief Undocumented enum value. 253 254 \since Haiku R1 255*/ 256 257 258/*! 259 \var input_device_notification B_INPUT_DEVICE_STOPPED 260 \brief Undocumented enum value. 261 262 \since Haiku R1 263*/ 264 265 266/*! 267 \var input_device_notification B_INPUT_DEVICE_REMOVED 268 \brief Undocumented enum value. 269 270 \since Haiku R1 271*/ 272 273 274/*! 275 \fn BInputDevice* find_input_device(const char *name) 276 \brief Undocumented function 277 278 \param name Undocumented 279 280 \return Undocumented 281 \retval <value> Undocumented 282 283 \since Haiku R1 284*/ 285 286 287/*! 288 \fn status_t get_input_devices(BList *list) 289 \brief Undocumented function 290 291 \param list Undocumented 292 293 \return Undocumented 294 \retval <value> Undocumented 295 296 \since Haiku R1 297*/ 298 299 300/*! 301 \fn status_t watch_input_devices(BMessenger target, bool start) 302 \brief Undocumented function 303 304 \param target Undocumented 305 \param start Undocumented 306 307 \return Undocumented 308 \retval <value> Undocumented 309 310 \since Haiku R1 311*/ 312