diff options
Diffstat (limited to 'FL/core')
| -rw-r--r-- | FL/core/pen_events.H | 284 |
1 files changed, 107 insertions, 177 deletions
diff --git a/FL/core/pen_events.H b/FL/core/pen_events.H index 48ce47034..39310e4cb 100644 --- a/FL/core/pen_events.H +++ b/FL/core/pen_events.H @@ -26,31 +26,26 @@ #include <FL/Fl_Export.H> // for FL_EXPORT #include <FL/core/function_types.H> // widget callbacks and services -#include <cstdint> +#include <stdint.h> class Fl_Widget; -namespace Fl { - -/** FLTK Pen/Stylus/Tablet input driver API. */ -namespace Pen { - /** \defgroup fl_pen_events Pen and tablet event handling \ingroup fl_events - \brief This chapter documents the Fl::Pen namespace API, declared in <FL/core/pen_events.H> + \brief This chapter documents the Fl_Pen API, declared in <FL/core/pen_events.H> - The FL::Pen namespace contains everything needed to work with a pen type input + The Fl_Pen prefix contains everything needed to work with a pen type input device, either in connection with an external tablet, or as a stylus for drawing directly onto a screen. - To receive pen input, call Fl::Pen::subscribe() for one or more widgets. The - widget will receive a Fl::Pen::ENTER event when the stylus enters the widget - area. By returning 1 to Fl::Pen::ENTER, all further pen events are sent to - this widget, and no mouse events are generated until Fl::Pen::LEAVE. + To receive pen input, call Fl_Pen_subscribe() for one or more widgets. The + widget will receive a FL_PEN_ENTER event when the stylus enters the widget + area. By returning 1 to FL_PEN_ENTER, all further pen events are sent to + this widget, and no mouse events are generated until FL_PEN_LEAVE. - Returning 0 Fl::Pen::ENTER tells FLTK to suppress further pen events until - Fl::Pen::LEAVE, and convert them into mouse events instead. + Returning 0 to FL_PEN_ENTER tells FLTK to suppress further pen events until + FL_PEN_LEAVE, and convert them into mouse events instead. Pen events also set Fl::event_x(), Fl::event_y(), Fl::event_x_root(), Fl::event_y_root(), Fl::event_is_click(), and Fl::event_clicks(). @@ -60,137 +55,77 @@ namespace Pen { /** \brief Bitfield of traits. - This is used in Fl::Pen::driver_traits() and Fl::Pen::pen_traits(). + This is used in Fl_Pen_driver_traits() and Fl_Pen_pen_traits(). */ -enum class Trait : uint32_t { +typedef uint32_t Fl_Pen_Trait; +enum { /// No bits set - NONE = 0x0000, + FL_PEN_TRAIT_NONE = 0x0000, /// Set if FLTK supports tablets and pens on this platform - DRIVER_AVAILABLE = 0x0001, + FL_PEN_TRAIT_DRIVER_AVAILABLE = 0x0001, /// Set after the system detected a pen, stylus, or tablet. This bit may not be /// set until a pen is brought into proximity of the tablet. - DETECTED = 0x0002, + FL_PEN_TRAIT_DETECTED = 0x0002, /// If set, this is a digitizer for a display; if clear, this is a standalone tablet - DISPLAY = 0x0004, + FL_PEN_TRAIT_DISPLAY = 0x0004, /// Driver provides different device IDs for different pens - PEN_ID = 0x0008, + FL_PEN_TRAIT_PEN_ID = 0x0008, /// Pen may have an eraser tip - ERASER = 0x0010, + FL_PEN_TRAIT_ERASER = 0x0010, /// Pen returns a pressure value - PRESSURE = 0x0020, + FL_PEN_TRAIT_PRESSURE = 0x0020, /// Pen returns a barrel pressure value (tangential pressure) - BARREL_PRESSURE = 0x0040, + FL_PEN_TRAIT_BARREL_PRESSURE = 0x0040, /// Pen returns tilt in X direction - TILT_X = 0x0080, + FL_PEN_TRAIT_TILT_X = 0x0080, /// Pen returns tilt in Y direction - TILT_Y = 0x0100, + FL_PEN_TRAIT_TILT_Y = 0x0100, /// Pen returns a twist value - TWIST = 0x0200, + FL_PEN_TRAIT_TWIST = 0x0200, /// Pen returns a proximity value - PROXIMITY = 0x0400, + FL_PEN_TRAIT_PROXIMITY = 0x0400 }; -/** - \brief Bitwise OR operator for Trait enum. - \param lhs Left-hand side trait flags - \param rhs Right-hand side trait flags - \return Combined trait flags - */ -inline constexpr Trait operator|(Trait lhs, Trait rhs) { - return static_cast<Trait>(static_cast<uint32_t>(lhs) | static_cast<uint32_t>(rhs)); -} - -/** - \brief Bitwise AND operator for Trait enum. - \param lhs Left-hand side trait flags - \param rhs Right-hand side trait flags - \return Intersection of trait flags - */ -inline constexpr Trait operator&(Trait lhs, Trait rhs) { - return static_cast<Trait>(static_cast<uint32_t>(lhs) & static_cast<uint32_t>(rhs)); -} - -/** - \brief Bitwise OR assignment operator for Trait enum. - \param lhs Left-hand side trait flags (modified in place) - \param rhs Right-hand side trait flags - \return Reference to modified lhs - */ -inline Trait& operator|=(Trait& lhs, Trait rhs) { - lhs = lhs | rhs; - return lhs; -} - /** \brief Bitfield of pen state flags. - \see event_state(), event_trigger() + \see Fl_Pen_event_state(), Fl_Pen_event_trigger() */ -enum class State : uint32_t { +typedef uint32_t Fl_Pen_State; +enum { /// No button pressed - NONE = 0x0000, + FL_PEN_STATE_NONE = 0x0000, /// The tip hovers over the surface but does not touch it - TIP_HOVERS = 0x0001, + FL_PEN_STATE_TIP_HOVERS = 0x0001, /// The tip touches the surface - TIP_DOWN = 0x0002, + FL_PEN_STATE_TIP_DOWN = 0x0002, /// The eraser hovers over the surface but does not touch it - ERASER_HOVERS = 0x0004, + FL_PEN_STATE_ERASER_HOVERS = 0x0004, /// The eraser touches the surface - ERASER_DOWN = 0x0008, + FL_PEN_STATE_ERASER_DOWN = 0x0008, /// Barrel button 0, usually the lower button on a pen, is pressed - BUTTON0 = 0x0100, + FL_PEN_STATE_BUTTON0 = 0x0100, /// Barrel button 1, usually the upper button on a pen, is pressed - BUTTON1 = 0x0200, + FL_PEN_STATE_BUTTON1 = 0x0200, /// Barrel button 2 is pressed - BUTTON2 = 0x0400, + FL_PEN_STATE_BUTTON2 = 0x0400, /// Barrel button 3 is pressed - BUTTON3 = 0x0800, + FL_PEN_STATE_BUTTON3 = 0x0800, /// Mask for all buttons, tip, and eraser down - ANY_DOWN = BUTTON0 | BUTTON1 | BUTTON2 | BUTTON3 | TIP_DOWN | ERASER_DOWN, + FL_PEN_STATE_ANY_DOWN = 0x0100 | 0x0200 | 0x0400 | 0x0800 | 0x0002 | 0x0008 }; -/** - \brief Bitwise OR operator for State enum. - \param lhs Left-hand side state flags - \param rhs Right-hand side state flags - \return Combined state flags - */ -inline constexpr State operator|(State lhs, State rhs) { - return static_cast<State>(static_cast<uint32_t>(lhs) | static_cast<uint32_t>(rhs)); -} - -/** - \brief Bitwise AND operator for State enum. - \param lhs Left-hand side state flags - \param rhs Right-hand side state flags - \return Intersection of state flags - */ -inline constexpr State operator&(State lhs, State rhs) { - return static_cast<State>(static_cast<uint32_t>(lhs) & static_cast<uint32_t>(rhs)); -} - -/** - \brief Bitwise OR assignment operator for State enum. - \param lhs Left-hand side state flags (modified in place) - \param rhs Right-hand side state flags - \return Reference to modified lhs - */ -inline State& operator|=(State& lhs, State rhs) { - lhs = lhs | rhs; - return lhs; -} - /** \brief List of pen events. These events extend the standard Fl_Event enumeration. \see enum Fl_Event */ -enum Event { +enum { /** Pen entered the proximity of the tablet with a new pen. */ - DETECTED = 0x1000, + FL_PEN_DETECTED = 0x1000, /** Pen entered the proximity of the tablet with a known, but changed pen. @@ -198,63 +133,63 @@ enum Event { was disconnected (event_id() == -1). Pen IDs, if supported, are assigned by the tablet manufacturer. */ - CHANGED, + FL_PEN_CHANGED, /** Pen entered the proximity of the tablet with a known pen. */ - IN_RANGE, + FL_PEN_IN_RANGE, /** Pen left the proximity of the tablet. */ - OUT_OF_RANGE, + FL_PEN_OUT_OF_RANGE, /** Pen entered the widget area, either by moving in x/y, or by a proximity change (pen gets closer to the surface). - event_trigger() returns 0, TIP_HOVERS, or ERASER_HOVERS. + Fl_Pen_event_trigger() returns 0, FL_PEN_STATE_TIP_HOVERS, or FL_PEN_STATE_ERASER_HOVERS. */ - ENTER, + FL_PEN_ENTER, /** If no button is pressed, indicates that the pen left the widget area. While any pen button is held down, or the pen touches the surface, Fl::pushed() is set, and the pushed widgets receives DRAG events, even if the pen leaves the widget area. If all buttons are released outside the - widget area, a LEAVE event is sent as well as LIFT or BUTTON_RELEASE. + widget area, a LEAVE event is sent as well as FL_PEN_LIFT or FL_PEN_BUTTON_RELEASE. */ - LEAVE, + FL_PEN_LEAVE, /** Pen went from hovering to touching the surface. - event_trigger() returns TIP_DOWN or ERASER_DOWN. + Fl_Pen_event_trigger() returns FL_PEN_STATE_TIP_DOWN or FL_PEN_STATE_ERASER_DOWN. */ - TOUCH, + FL_PEN_TOUCH, /** Pen went from touching to hovering over the surface. - event_trigger() returns TIP_HOVERS or ERASER_HOVERS. + Fl_Pen_event_trigger() returns FL_PEN_STATE_TIP_HOVERS or FL_PEN_STATE_ERASER_HOVERS. */ - LIFT, + FL_PEN_LIFT, /** Pen moved without touching the surface and no button is pressed. */ - HOVER, + FL_PEN_HOVER, /** Pen moved while touching the surface, or any button is pressed. */ - DRAW, + FL_PEN_DRAW, /** A pen button was pushed. - event_trigger() returns BUTTON0, BUTTON1, BUTTON2, or BUTTON3. + Fl_Pen_event_trigger() returns FL_PEN_STATE_BUTTON0, FL_PEN_STATE_BUTTON1, FL_PEN_STATE_BUTTON2, or FL_PEN_STATE_BUTTON3. */ - BUTTON_PUSH, + FL_PEN_BUTTON_PUSH, /** A pen button was released. - event_trigger() returns BUTTON0, BUTTON1, BUTTON2, or BUTTON3. + Fl_Pen_event_trigger() returns FL_PEN_STATE_BUTTON0, FL_PEN_STATE_BUTTON1, FL_PEN_STATE_BUTTON2, or FL_PEN_STATE_BUTTON3. */ - BUTTON_RELEASE + FL_PEN_BUTTON_RELEASE }; @@ -264,67 +199,67 @@ enum Event { This function returns a bitfield of traits that are supported by the FLTK driver for this platform. If a trait is not supported, the corresponding event value will not return a useful value. Note that even if the FLTK driver support a - trait, the underlying pen device or driver may not. Fl::Pen will return a - known default for those event values. + trait, the underlying pen device or driver may not. The Fl_Pen API will return + a known default for those event values. The bitfield returned is static. \return a bitfield of supported traits - \see pen_traits() + \see Fl_Pen_pen_traits() */ -FL_EXPORT extern Trait driver_traits(); +FL_EXPORT Fl_Pen_Trait Fl_Pen_driver_traits(void); /** - \brief Return true if the corresponding bit is set in the driver traits. + \brief Return non-zero if the corresponding bit is set in the driver traits. \param[in] bits check for one or more trait bits - \return true if any bit is set + \return non-zero if any bit is set */ -inline bool driver_traits(Trait bits) { - return ((driver_traits() & bits) != Trait::NONE); +inline int Fl_Pen_driver_traits_check(Fl_Pen_Trait bits) { + return ((Fl_Pen_driver_traits() & bits) != FL_PEN_TRAIT_NONE); } /** \brief Query traits of the current pen or stylus. The value returned by this function may change when pens change or when more information becomes known about the currently used pen. - \param[in] pen_id a know pen ID as returned from event_pen_id(), + \param[in] pen_id a know pen ID as returned from Fl_Pen_event_pen_id(), or 0 for the current pen \return a bitfield of supported traits */ -FL_EXPORT extern Trait pen_traits(int pen_id = 0); +FL_EXPORT Fl_Pen_Trait Fl_Pen_pen_traits(int pen_id); /** - \brief Return true if the corresponding bit is set in the pen traits. + \brief Return non-zero if the corresponding bit is set in the pen traits. \param[in] bits check for one or more trait bits - \param[in] pen_id a know pen ID as returned from event_pen_id(), + \param[in] pen_id a know pen ID as returned from Fl_Pen_event_pen_id(), or 0 for the current pen - \return true if any bit is set + \return non-zero if any bit is set */ -inline bool pen_traits(Trait bits, int pen_id = 0) { - return ((pen_traits() & bits) != Trait::NONE); +inline int Fl_Pen_pen_traits_check(Fl_Pen_Trait bits, int pen_id) { + return ((Fl_Pen_pen_traits(pen_id) & bits) != FL_PEN_TRAIT_NONE); } /** - \brief Receives a Pen::ENTER event when the pen enters this widget. + \brief Receives a FL_PEN_ENTER event when the pen enters this widget. Multiple widgets may subscribe to pen events. Additional subscription requests for the same widget are ignored. \param widget The widget subscribing to pen events. */ -FL_EXPORT extern void subscribe(Fl_Widget* widget); +FL_EXPORT void Fl_Pen_subscribe(Fl_Widget* widget); /** - \brief Stop receiving Pen::ENTER for this widget. + \brief Stop receiving FL_PEN_ENTER for this widget. Deleting a widget will automatically unsubscribe it. \param widget Widget to unsubscribe from pen events */ -FL_EXPORT extern void unsubscribe(Fl_Widget* widget); +FL_EXPORT void Fl_Pen_unsubscribe(Fl_Widget* widget); /** Clear the "pushed" state and forward pen events as mouse events. Call this if another window is popped up during pen event handling, so mouse event handling can resume normal. */ -FL_EXPORT extern void release(); +FL_EXPORT void Fl_Pen_release(void); /// \name Query values during event handling /// @{ @@ -337,9 +272,9 @@ FL_EXPORT extern void release(); \return Pen position as floating-point coordinate, defaults to 0.0 \see Fl::event_x(), Fl::event_y() */ -FL_EXPORT extern double event_x(); -/** \brief Returns pen Y coordinate in widget space, see event_x(). */ -FL_EXPORT extern double event_y(); +FL_EXPORT double Fl_Pen_event_x(void); +/** \brief Returns pen Y coordinate in widget space, see Fl_Pen_event_x(). */ +FL_EXPORT double Fl_Pen_event_y(void); /** \brief Returns the pen x and y position in global coordinates as doubles. @@ -347,31 +282,31 @@ FL_EXPORT extern double event_y(); \return Pen position as floating-point coordinate in screen space, defaults to 0.0 \see Fl::event_x_root(), Fl::event_y_root() */ -FL_EXPORT extern double event_x_root(); -/** \brief Returns pen Y coordinate in screen space, see event_x_root(). */ -FL_EXPORT extern double event_y_root(); +FL_EXPORT double Fl_Pen_event_x_root(void); +/** \brief Returns pen Y coordinate in screen space, see Fl_Pen_event_x_root(). */ +FL_EXPORT double Fl_Pen_event_y_root(void); /** \brief Returns the ID of the pen used in the last event. \return Unique pen identifier, or -1 if pen was removed, defaults to 0 - \see Trait::PEN_ID + \see FL_PEN_TRAIT_PEN_ID */ -FL_EXPORT extern int event_pen_id(); +FL_EXPORT int Fl_Pen_event_pen_id(void); /** \brief Returns the pressure between the tip or eraser and the surface. \return pressure value from 0.0 (no pressure) to 1.0 (maximum pressure), defaults to 1.0. - \see Trait::PRESSURE + \see FL_PEN_TRAIT_PRESSURE */ -FL_EXPORT extern double event_pressure(); +FL_EXPORT double Fl_Pen_event_pressure(void); /** \brief Returns barrel pressure or tangential pressure. \return Pressure value from -1.0 to 1.0 , defaults to 0.0 . - \see Trait::BARREL_PRESSURE + \see FL_PEN_TRAIT_BARREL_PRESSURE */ -FL_EXPORT extern double event_barrel_pressure(); +FL_EXPORT double Fl_Pen_event_barrel_pressure(void); /** \brief Returns the tilt of the pen in the x and y directions between -1 and 1. @@ -384,61 +319,56 @@ FL_EXPORT extern double event_barrel_pressure(); it tilts toward the user. \return Tilt value from -1.0 to 1.0, defaults to 0.0 - \see Trait::TILT_X, Trait::TILT_Y + \see FL_PEN_TRAIT_TILT_X, FL_PEN_TRAIT_TILT_Y */ -FL_EXPORT extern double event_tilt_x(); -/** \brief Returns pen Y-axis tilt, see event_tilt_x() */ -FL_EXPORT extern double event_tilt_y(); +FL_EXPORT double Fl_Pen_event_tilt_x(void); +/** \brief Returns pen Y-axis tilt, see Fl_Pen_event_tilt_x() */ +FL_EXPORT double Fl_Pen_event_tilt_y(void); /** \brief Returns the pen's axial rotation in degrees. The twist angle is reported in degrees, with: - - 0° : pen’s “top” (the button side) facing upward - - +180° : twisted halfway clockwise, looking at the end of the pen toward the tip - - –180° → twisted half way counter clockwise - So the full range is usually –180° to +180°. + - 0 deg : pen's "top" (the button side) facing upward + - +180 deg : twisted halfway clockwise, looking at the end of the pen toward the tip + - -180 deg : twisted half way counter clockwise + So the full range is usually -180 to +180. \return Twist angle in degrees, defaults to 0.0. - \see Trait::TWIST + \see FL_PEN_TRAIT_TWIST */ -FL_EXPORT extern double event_twist(); +FL_EXPORT double Fl_Pen_event_twist(void); /** \brief Returns the proximity of the pen to the surface between 0 and 1. A proximity of 0 is closest to the surface, 1 is farthest away. \return Proximity value from 0.0 (touching) to 1.0 (far away), defaults to 0.0 . - \see Trait::PROXIMITY + \see FL_PEN_TRAIT_PROXIMITY */ -FL_EXPORT extern double event_proximity(); +FL_EXPORT double Fl_Pen_event_proximity(void); /** \brief Returns the state of the various buttons and tips. - \return Current state flags (combination of State values) + \return Current state flags (combination of Fl_Pen_State values) */ -FL_EXPORT extern State event_state(); +FL_EXPORT Fl_Pen_State Fl_Pen_event_state(void); /** - \brief Return true if any of the bits are set in the event state. + \brief Return non-zero if any of the bits are set in the event state. \param[in] bits check for one or more event state bits - \return true if any bit is set + \return non-zero if any bit is set */ -inline bool event_state(State bits) { - return ((event_state() & bits) != State::NONE); +inline int Fl_Pen_event_state_check(Fl_Pen_State bits) { + return ((Fl_Pen_event_state() & bits) != FL_PEN_STATE_NONE); } /** \brief Returns the state change that triggered the event. \return a state with one bit set for the action that triggered this event */ -FL_EXPORT extern State event_trigger(); +FL_EXPORT Fl_Pen_State Fl_Pen_event_trigger(void); /** @} */ // group fl_pen_events -} // namespace Pen - -} // namespace Fl - - /* Resources: |