qtmobility/src/sensors/qtapsensor.cpp
changeset 8 71781823f776
parent 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
5:453da2cfceef 8:71781823f776
    48 
    48 
    49 /*!
    49 /*!
    50     \class QTapReading
    50     \class QTapReading
    51     \ingroup sensors_reading
    51     \ingroup sensors_reading
    52 
    52 
    53     \preliminary
       
    54     \brief The QTapReading class represents one reading from the
    53     \brief The QTapReading class represents one reading from the
    55            tap sensor.
    54            tap sensor.
    56 
    55 
    57     \section2 QTapReading Units
    56     \section2 QTapReading Units
    58     The tap sensor registers tap events in one of the six directions.
    57     The tap sensor registers tap events in one of the six directions.
    59     There are 3 axes that originate from the phone. They are arranged as follows.
    58     There are 3 axes that originate from the phone. They are arranged as follows.
    60 \code
    59 
    61              +z
    60     \image sensors-coordinates2.jpg
    62               |
       
    63               |      +y
       
    64               |     /
       
    65               |----/----
       
    66              /| NOKIA  /|
       
    67             //|--/--- / |
       
    68            // | /   //  /
       
    69           //  |/   //  /
       
    70          //   '--------------- +x
       
    71         //       //  /
       
    72        //       //  /
       
    73       /---------/  /
       
    74      /    O    /  /
       
    75     /         /  /
       
    76     ----------  /
       
    77     |_________!/
       
    78 \endcode
       
    79 
    61 
    80     By default it returns double tap events. The QTapSensor::returnDoubleTapEvents property
    62     By default it returns double tap events. The QTapSensor::returnDoubleTapEvents property
    81     must be set to false to return individual tap events.
    63     must be set to false to return individual tap events.
    82 */
    64 */
    83 
    65 
   147 
   129 
   148 /*!
   130 /*!
   149     \class QTapFilter
   131     \class QTapFilter
   150     \ingroup sensors_filter
   132     \ingroup sensors_filter
   151 
   133 
   152     \preliminary
       
   153     \brief The QTapFilter class is a convenience wrapper around QSensorFilter.
   134     \brief The QTapFilter class is a convenience wrapper around QSensorFilter.
   154 
   135 
   155     The only difference is that the filter() method features a pointer to QTapReading
   136     The only difference is that the filter() method features a pointer to QTapReading
   156     instead of QSensorReading.
   137     instead of QSensorReading.
   157 */
   138 */
   168 
   149 
   169 /*!
   150 /*!
   170     \class QTapSensor
   151     \class QTapSensor
   171     \ingroup sensors_type
   152     \ingroup sensors_type
   172 
   153 
   173     \preliminary
       
   174     \brief The QTapSensor class is a convenience wrapper around QSensor.
   154     \brief The QTapSensor class is a convenience wrapper around QSensor.
   175 
   155 
   176     The only behavioural difference is that this class sets the type properly.
   156     The only behavioural difference is that this class sets the type properly.
   177 
   157 
   178     This class also features a reading() function that returns a QTapReading instead of a QSensorReading.
   158     This class also features a reading() function that returns a QTapReading instead of a QSensorReading.