Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7d137fd96a
haiku/docs/user/interface/Input.dox

338 lines
6.0 KiB
Plaintext
Raw Normal View History

HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
/*
* Copyright 2019 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* Name, email@email.com
*
* Corresponds to:
* headers/os/interface/Input.h hrev32748
* src/kits/interface/Input.cpp hrev46376
*/
///// TO THEY WHO DOCUMENT /////
// The BeBook puts this class and its functions under the category 'Input Server'
// grouped together with BInputServerDevice, BInputServerFilter and BInputServerMethod
// Not sure if we should follow that choice.
/*!
\file Input.h
\ingroup interface
\brief Undocumented file.
\since Haiku R1
*/
/*!
\class BInputDevice
\ingroup interface
\ingroup libbe
\brief Undocumented class.
\since Haiku R1
*/
/*!
\fn BInputDevice::~BInputDevice()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const char* BInputDevice::Name() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn input_device_type BInputDevice::Type() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BInputDevice::IsRunning() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t BInputDevice::Start()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t BInputDevice::Stop()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t BInputDevice::Control(uint32 code, BMessage *message)
\brief Undocumented public method
\param code Undocumented
\param message Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn static static status_t BInputDevice::Start(input_device_type type)
\brief Undocumented public method
\param type Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn static static status_t BInputDevice::Stop(input_device_type type)
\brief Undocumented public method
\param type Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn static static status_t BInputDevice::Control(input_device_type type, uint32 code, BMessage *message)
\brief Undocumented public method
\param type Undocumented
\param code Undocumented
\param message Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\enum input_method_op
\ingroup <kit name>
\brief Undocumented enum.
\since Haiku R1
*/
/*!
\var input_method_op B_INPUT_METHOD_STARTED
\brief Undocumented enum value.
\since Haiku R1
*/
/*!
\var input_method_op B_INPUT_METHOD_STOPPED
\brief Undocumented enum value.
\since Haiku R1
*/
/*!
\var input_method_op B_INPUT_METHOD_CHANGED
\brief Undocumented enum value.
\since Haiku R1
*/
/*!
\var input_method_op B_INPUT_METHOD_LOCATION_REQUEST
\brief Undocumented enum value.
\since Haiku R1
*/
/*!
\enum input_device_type
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\ingroup interface
\brief Device types that the Input Server can recognize.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_type B_POINTING_DEVICE
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief Pointing devices like mice, drawing tablets, touch screens, etc.
These devices generate \c B_MOUSE_MOVED, \c B_MOUSE_UP, and \c B_MOUSE_DOWN
messages.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_type B_KEYBOARD_DEVICE
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief Key-based input devices like a keyboard, number pad, etc.
These devices generate \c B_KEY_DOWN, \c B_UNMAPPED_KEY_DOWN, \c B_KEY_UP,
\c B_UNMAPPED_KEY_UP, and \c B_MODIFIERS_CHANGED messages.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_type B_UNDEFINED_DEVICE
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief An undefined/unknown type of input device.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\enum input_device_notification
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\ingroup interface
\brief Constants for the \c be:opcode field of a \c B_INPUT_DEVICES_CHANGED
message.
These message constants reflect changes in the state of input devices that
the Input Server is aware of.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_notification B_INPUT_DEVICE_ADDED
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief An input device was added to the system.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_notification B_INPUT_DEVICE_STARTED
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief An input device was started.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_notification B_INPUT_DEVICE_STOPPED
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief An input device was stopped.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\var input_device_notification B_INPUT_DEVICE_REMOVED
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief An input device was removed from the system.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn BInputDevice* find_input_device(const char *name)
\brief Undocumented function
\param name Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t get_input_devices(BList *list)
\brief Undocumented function
\param list Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t watch_input_devices(BMessenger target, bool start)
input_server: Properly implement watch_input_devices() & add documentation Allow for multiple programs to watch for changes in the state of input devices connected to the system. Previously only one program at a time could watch input devices. While this functionality was not implemented in BeOS R5, it was at least documented in the BeBook. Also added some API documentation where necessary for the function and related constants. Change-Id: Icd927998cffcab212bb63bcf10c64c620e9da9a2 Reviewed-on: https://review.haiku-os.org/c/haiku/+/3872 Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-03-04 06:58:48 +03:00
\brief Start/stop watching input devices for state changes.
Informs the Input Server that \a target would like to start/stop receiving
\c B_INPUT_DEVICES_CHANGED messages, reflecting the state of input devices
the Input Server is aware of.
The \c B_INPUT_DEVICES_CHANGED message contains:
- \c be:opcode An \c input_device_notifcation constant that identifies
which event occured.
- \c be:device_name A string containing the device's name.
- \c be:device_type An \c input_device_type constant representing the
device's type.
\param target Where the device state change messages should or should not be
sent.
\param start Whether \a target should start/stop receiving device state
change messages.
\return A status code.
\retval B_OK Watching has successfully been started or stopped.
\retval B_BAD_VALUE \a target never started watching for device state
changes, though a request was made to stop watching for changes.
\retval Other errors depending on the state of the Input Server.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
Reference in New Issue Copy Permalink