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