28 #include <QTime>

    29 #include <hbdeviceprofile.h>

    30 

    31 /*!

    32 @stable

    33 @hbinput

    34 \class HbInputButton

    35 \brief Provides vkb button definitions used by HbInputButtonGroup

    36 

    37 \sa HbInputButtonGroup

    38 */

    39 

    41 

    42 // Defines how much the button size should be increased from its original size.

    43 const qreal HbInputThresholdMultiplier = 0.25;

    44 

    45 // Threshold for touch point position comparison

    46 const qreal HbInputTouchThreshold = 5.0;

    47 

    48 // Timeout for increased touch down region

    49 const int HbInputInstantTouchTimeout = 500;

    50 

    51 // Threshold for increased touch down region in mm

    52 const qreal HbInputInstantTouchThreshold = 3.5;

    53 

    54 const QPoint HbInputInvalidPoint = QPoint(-1, -1);

    69     HbInputButton::HbInputButtonState mPreviousState;

    78     QPointF mTouchPoint;

    79     QPointF mLastInteractionPoint;

    80     bool mTap;

    81     QTime mTouchTime;

    82     qreal mTouchThreshold;

    98 

    99     // Convert millimeters to pixels

   100     mTouchThreshold = HbDeviceProfile::current().ppmValue() * HbInputInstantTouchThreshold;

   134 

   135     // Convert millimeters to pixels

   136     mTouchThreshold = HbDeviceProfile::current().ppmValue() * HbInputInstantTouchThreshold;

   168 

   169     // Convert millimeters to pixels

   170     mTouchThreshold = HbDeviceProfile::current().ppmValue() * HbInputInstantTouchThreshold;

   203 

   204 /*!

   205     \enum HbInputButton::HbInputButtonKeyCode

   206 

   207     This enum defines a set of predefined key codes for input button. ButtonKeyCodeCustom should

   208     always be the last item so that all values bigger than ButtonKeyCodeCustom can be interpreted

   209     as custom key codes

   210  */

   211 

   212 /*!

   213     \enum HbInputButton::HbInputButtonType

   214 

   215     This enum defines different button types. Button's graphics, text layout and functionality

   216     depend of the this type. ButtonTypeCount should always be the last value.

   217  */

   218 

   219 /*!

   220     \enum HbInputButton::HbInputButtonState

   221 

   222     This enum defines button states. State mostly affects the button's visual look in addition

   223     to what can be done with the button (i.e. no interaction with disabled buttons, released and

   224     latched buttons can be pressed). ButtonStateCount should always be the last value.

   225  */

   226 

   227 /*!

   228     \enum HbInputButton::HbInputButtonTextIndex

   229 

   230     This enum defines set of text indices that can be used when setting texts to different parts of

   231     a button using setText function. ButtonTextIndexCount should always be the last value.

   232  */

   233 

   234 /*!

   235     \enum HbInputButton::HbInputButtonIconIndex

   236 

   237     This enum defines set of icon indices that can be used when setting icons to different parts of

   238     a button using setIcon function. ButtonIconIndexCount should always be the last value.

   239  */

   296 State change sequence latched, pressed, released will result

   297 in a latched state. Otherwise the new state will be the given state.

   617 /*!

   618 \brief Returns an active touch area for current button.

   619 

   620 Button contains bounding rectangle for actual size of the item, while touch area

   621 can actually extend over buttons physical boundaries. This is to make interacting

   622 with button easier.

   623 

   624 \return Active touch area as a rectangle, centered to its button.

   625 \sa setBoundingRect

   626 */

   627 QRectF HbInputButton::activeTouchArea() const

   628 {

   629     Q_D(const HbInputButton);

   630 

   631     QRectF threshold(d->mBoundingRect);

   632 

   633     qreal mod_w = d->mBoundingRect.width() * HbInputThresholdMultiplier;

   634     qreal mod_h = d->mBoundingRect.height() * HbInputThresholdMultiplier;

   635     threshold.adjust(-mod_w, -mod_h, mod_w, mod_h);

   636 

   637     return threshold;

   638 }

   639 

   640 /*!

   641 \brief Set position where last user interaction occurred.

   642 */

   643 void HbInputButton::setLastTriggeredPosition(const QPointF &position)

   644 {

   645     Q_D(HbInputButton);

   646 

   647     d->mLastInteractionPoint = position;

   648 }

   649 

   650 /*!

   651 \brief Clear last user interaction data.

   652 */

   653 void HbInputButton::clearLastTriggeredPosition()

   654 {

   655     Q_D(HbInputButton);

   656 

   657     d->mLastInteractionPoint = HbInputInvalidPoint;

   658 }

   659 

   660 /*!

   661 Checks whether the new touch point position is close enough to the previous

   662 one that hit this button so that the new touch point can

   663 be interpreted as the same as the old one.

   664 */

   665 bool HbInputButton::wasTriggeredAt(const QPointF &position) const

   666 {

   667     Q_D(const HbInputButton);

   668 

   669     QRectF rect(d->mLastInteractionPoint.x() - HbInputTouchThreshold, d->mLastInteractionPoint.y() - HbInputTouchThreshold,

   670                 2 * HbInputTouchThreshold, 2 * HbInputTouchThreshold);

   671 

   672     return rect.contains(position);

   673 }

   674 

   675 /*!

   676 \brief Set position where the button was first touched.

   677 */

   678 void HbInputButton::setTouchPointPosition(const QPointF &position)

   679 {

   680     Q_D(HbInputButton);

   681 

   682     d->mTouchPoint = position;

   683     d->mTap = true;

   684     d->mTouchTime.start();

   685 }

   686 

   687 /*!

   688 Returns the current touch position which in case of

   689 a short tap is the touch down position and otherwise the

   690 last triggered position.

   691 */

   692 QPointF HbInputButton::currentTouchPointPosition() const

   693 {

   694     Q_D(const HbInputButton);

   695 

   696     if (d->mTap) {

   697         return d->mTouchPoint;

   698     }

   699     return d->mLastInteractionPoint;

   700 }

   701 

   702 /*!

   703 \brief Checks whether move to given \a position should be ignored or processed normally

   704 

   705 True is returned if given position is close enough to touch down point during

   706 short timeout after the button has been pressed or after timeout if the

   707 position is inside button's active touch area. Otherwise false is returned and

   708 move event should be handled normally.

   709 */

   710 bool HbInputButton::suppressMoveEvent(const QPointF &position)

   711 {

   712     Q_D(HbInputButton);

   713 

   714     // Check if the timeout from the touch down event has passed

   715     if (d->mTap && d->mTouchTime.elapsed() < HbInputInstantTouchTimeout) {

   716         // Create rectangle around touch down position

   717         QRectF rect(d->mTouchPoint.x() - d->mTouchThreshold, d->mTouchPoint.y() - d->mTouchThreshold,

   718                     2 * d->mTouchThreshold, 2 * d->mTouchThreshold);

   719 

   720         // If inside created rectangle, update last position and ignore the event

   721         if (rect.contains(position)) {

   722             setLastTriggeredPosition(position);

   723             return true;

   724         }

   725     // Check if new position is still inside active button

   726     } else if (activeTouchArea().contains(position)) {

   727         setLastTriggeredPosition(position);

   728         d->mTap = false;

   729         return true;

   730     }

   731 

   732     d->mTap = false;

   733     return false;

   734 }

   735