qtmobility/src/sensors/qorientationsensor.cpp
changeset 8 71781823f776
parent 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
5:453da2cfceef 8:71781823f776
    48 
    48 
    49 /*!
    49 /*!
    50     \class QOrientationReading
    50     \class QOrientationReading
    51     \ingroup sensors_reading
    51     \ingroup sensors_reading
    52 
    52 
    53     \preliminary
       
    54     \brief The QOrientationReading class represents one reading from the
    53     \brief The QOrientationReading class represents one reading from the
    55            orientation sensor.
    54            orientation sensor.
    56 
    55 
    57     \section2 QOrientationReading Units
    56     \section2 QOrientationReading Units
    58     The orientation sensor returns the orientation of the device using
    57     The orientation sensor returns the orientation of the device using
    65 
    64 
    66     This enum represents the orientation of the device.
    65     This enum represents the orientation of the device.
    67 
    66 
    68     To explain the meaning of each value it is helpful to refer to the following diagram.
    67     To explain the meaning of each value it is helpful to refer to the following diagram.
    69 
    68 
    70 \code
    69     \image sensors-sides.jpg
    71                       Top
       
    72 
    70 
       
    71     The orientations are shown here in order: TopUp, TopDown, LeftUp, RightUp, FaceUp, FaceDown.
    73 
    72 
    74               ----------
    73     \image sensors-orientation.jpg
    75              /  NOKIA  /|
       
    76             /-------- / |
       
    77            //       //  /
       
    78           //       //  /
       
    79   Left   //  Face //  /    Right
       
    80         //       //  /
       
    81        //       //  /
       
    82       /---------/  /
       
    83      /    O    /  /
       
    84     /         /  /
       
    85     ----------  /
       
    86     |_________!/
       
    87 
       
    88 
       
    89       Bottom
       
    90 \endcode
       
    91 
    74 
    92     \value Undefined        The orientation is unknown.
    75     \value Undefined        The orientation is unknown.
    93     \value TopUp            The Top edge of the device is pointing up.
    76     \value TopUp            The Top edge of the device is pointing up.
    94     \value TopDown          The Bottom edge of the device is pointing up.
    77     \value TopDown          The Top edge of the device is pointing down.
    95     \value LeftUp           The Left edge of the device is pointing up.
    78     \value LeftUp           The Left edge of the device is pointing up.
    96     \value RightUp          The Right edge of the device is pointing up.
    79     \value RightUp          The Right edge of the device is pointing up.
    97     \value FaceUp           The Face of the device is pointing up.
    80     \value FaceUp           The Face of the device is pointing up.
    98     \value FaceDown         The Face of the device is pointing down.
    81     \value FaceDown         The Face of the device is pointing down.
    99 */
    82 */
   123 
   106 
   124 /*!
   107 /*!
   125     \class QOrientationFilter
   108     \class QOrientationFilter
   126     \ingroup sensors_filter
   109     \ingroup sensors_filter
   127 
   110 
   128     \preliminary
       
   129     \brief The QOrientationFilter class is a convenience wrapper around QSensorFilter.
   111     \brief The QOrientationFilter class is a convenience wrapper around QSensorFilter.
   130 
   112 
   131     The only difference is that the filter() method features a pointer to QOrientationReading
   113     The only difference is that the filter() method features a pointer to QOrientationReading
   132     instead of QSensorReading.
   114     instead of QSensorReading.
   133 */
   115 */
   144 
   126 
   145 /*!
   127 /*!
   146     \class QOrientationSensor
   128     \class QOrientationSensor
   147     \ingroup sensors_type
   129     \ingroup sensors_type
   148 
   130 
   149     \preliminary
       
   150     \brief The QOrientationSensor class is a convenience wrapper around QSensor.
   131     \brief The QOrientationSensor class is a convenience wrapper around QSensor.
   151 
   132 
   152     The only behavioural difference is that this class sets the type properly.
   133     The only behavioural difference is that this class sets the type properly.
   153 
   134 
   154     This class also features a reading() function that returns a QOrientationReading instead of a QSensorReading.
   135     This class also features a reading() function that returns a QOrientationReading instead of a QSensorReading.