FCL/sf/mw/hb: comparison src/hbwidgets/sliders/hbratingslider.cpp

equal deleted inserted replaced

-:730c025d4b77
+:f378acbc9cfb
 **
 ** If you have questions regarding the use of this file, please contact
 ** Nokia at developer.feedback@nokia.com.
 **
 ****************************************************************************/
+#include "hbratingslider_p.h"
 #include <hbratingslider.h>
-#include "hbratingslider_p.h"
 #include <hbtooltip.h>
 #include <hbstyleoptionratingslider_p.h>
 #include <QGraphicsItem>
 #include <QGraphicsSceneMouseEvent>
 #include <hbtoucharea.h>
+#include <hbwidgetfeedback.h>
 #ifdef HB_GESTURE_FW
 #include <hbtapgesture.h>
 #include <hbpangesture.h>
 #endif
 }
 /*!
 \class HbRatingSlider
-\brief A control for user to do rating.
+\brief This is a widget that enables a user to rate contents like videos , music etc.
+\image html ratingslider.png  "A Rating Slider with rating done"
-This is a general rating widget where user will be able to do different
-ratings for things like Music ,Video etc.
+The default version of Rating Slider contains 5 repeated icons drawn side by side, using a single themed graphics.
+The application can replace the themed graphic with a custom graphic.
-By default there are 5 ratings ( 5 stars ). This can be configured also.
+The custom graphics should contain only one icon (eg one star)  which will be multipled by the API \a setNumberOfIcons().
-The interval , number of icons etc can be configured.
+By default it is 5 and maximum number of icons are 10.
-Apart from rating the this can used for showing cumulative rating also.
+Along with the rating Rating Slider can be used to show the cumulative rating also.
-example code example:
+To use HbRatingSlider with default settings it just needs to be created.
+example code:
 \code
 HbRatingSlider *object = new HbRatingSlider(parent);
 \endcode
-The below  code can be used to show some rating e.g. 2.5/5
+HbRatingSlider emits below signals
-by default the  stepcount =5
+void ratingDone(int ratingValue);
+void ratingChanged(int ratingValue);
+ratingDone is emitted when the user does the rating and releases the finger.
+ratingChanged is emitted when the user presses and drags the finger on Rating Slider.
+To use HbRatingSlider with default settings it just needs to be created.
+example code:
+\code
+HbMainWindow window;
+HbRatingSlider *rs = new HbRatingSlider();
+window.addView(rs);
+\endcode
+HbRatingSlider supports integer ratings.But using the API \a setStepCount() fraction ratings can also be
+shown on Rating Slider
+The below  code can be used to show some rating e.g. 2.5/5
 \code
+//2.5/5 can be set as  25/50
 HbRatingSlider *slider = new HbRatingSlider();
-slider->setStepCount(100); //5 *20//
+slider->setStepCount(50); //5 *10//
-slider->setCurrentRating(50); //2.5*20 it shows 50 / 100 which is same as 2.5/5
+slider->setCurrentRating(25); //2.5*10 it shows 25/50 which is same as 2.5/5
 \endcode
-This will show as 2.5/5. Now if one the same ratingslider
+This will show as 2.5/5. Now if on the same ratingslider
-if the Application wants to configure a rating slider with range 1-5
+the Application wants to configure a Rating Slider with range 1-5
-on emitting the signal rating changed it can set to
+on emitting the signal rating changed it can set to 5.
-slider->setStepCount(5);
-slider->setCurrentRating(0)
-When the rating is done it emits a signal called ratingDone and when rating is
-changed by the user by draging the pointer ratingChanged signal is emitted.
 */
+/*!
-/*!
+@beta
-@beta
+Constructs a Rating Slider bar with the given parent.
-Constructor of  RatingSlider.
+\param parent Parent Item.
-\param parent. Parent widget
+*/
-*/
 HbRatingSlider::HbRatingSlider(QGraphicsItem *parent) :
 HbWidget(*new HbRatingSliderPrivate,parent)
 {
 Q_D( HbRatingSlider );
 }
 /*!
 @beta
-Constructor of  RatingSlider.
+Protected constructor
-\param parent. Parent widget
 */
 HbRatingSlider::HbRatingSlider(HbRatingSliderPrivate &dd,QGraphicsItem *parent) :
 HbWidget( dd,parent)
 {
 Q_D( HbRatingSlider );
 }
 /*!
 @beta
-Sets the number of icons. In a Rating scenario you may have number of repeated icons. This API can be used to set
+Sets the number of icons. There can be n number of repeated icons. This method can be used to set
-the number of icons required. For Example the default image is "*" and you have 5 stars. You can set the number of
+the number of icons required.The default image is "*" and has 5 stars.
-stars  using this. By default this value is 5.
 \param number. A value between 1 and 10
 \sa numberOfIcons()
 */
 return d->mNumberOfIcons;
 }
 /*!
 @beta
-Sets the step count for the rating slider. If the number of icons is 5 and step count is 10 then it is possible to have 10 ratings.
+Sets the step count for the Rating Slider.This indicates the interval of the rating. Eg. If step count is 10
-one rating will be half star (by default). If the number of icons is 5 and step count is 5 then 5 ratings are possible. In this
+then 10 rating is possible.
-case one rating will be one complete star. By default this value is 5.
 \param count. A value between 1 and 100. This can be considerd as the maximum rating possible.
 \sa numberOfIcons()
 }
 /*!
 @beta
-It sets the unrated graphics name.This is the graphics shown when rating slider is displayed.
+It sets the unrated graphics name.This is the graphics shown when Rating Slider is displayed.
-the grpahics can be a single star kind of or multi star image. If it is single star then use setNumberOfIcons for
+the graphicscan be a single star kind of or multi star image. If it is single star then use setNumberOfIcons for
 setting number of stars.
 \param name. The graphics name along with the path.
 \sa unRatedIconName()
 */
 /*!
 @beta
 It sets the rated graphics name.This is the graphics shown when rating is on going.
-the grpahics can be a single star kind of or multi star image. If it is single star then use setNumberOfIcons for
+the graphicscan be a single star kind of or multi star image. If it is single star then use setNumberOfIcons for
 setting number of stars.
 \param name. The graphics name along with the path.
 \sa unRatedIconName()
 */
 event->ignore();
 return;
 }
 d->mMousePressed = true;
 event->accept();
+updatePrimitives();
 }
 }
 /*!
 QRectF rect = d->mTouchArea->boundingRect();
 int rating=0;
 if(rect.contains(xVal,0 )) {
 rating = d->calculateProgressValue(xVal);
-if(toolTip() != QString()) {
+if(!toolTip().isNull()) {
 HbToolTip::showText(toolTip(),this);
 }
 setCurrentRating(rating);
 emit ratingChanged (d->mCurrentValue);
 event->accept();
 QRectF rect = d->mTouchArea->boundingRect();
 int rating=0;
 if(rect.contains(xVal,0 )) {
 rating = d->calculateProgressValue(xVal);
-if(toolTip() != QString()) {
+if(!toolTip().isNull()) {
 HbToolTip::showText(toolTip(),this);
 }
 setCurrentRating(rating);
 if(d->mCurrentValue) {
 emit ratingDone (d->mCurrentValue);
 }
 event->accept();
 d->mMousePressed = false;
 }
+updatePrimitives();
 }
 }
 #else
+/*!
+\reimp
+*/
 void HbRatingSlider::mousePressEvent(QGraphicsSceneMouseEvent *event)
 {
 Q_UNUSED(event)
 }
 #endif
 #ifdef HB_GESTURE_FW
+/*!
+\reimp
+*/
 void HbRatingSlider::gestureEvent(QGestureEvent *event)
 {
 Q_D (HbRatingSlider);
 if(event->gesture(Qt::TapGesture)) {
 HbTapGesture *tap = qobject_cast<HbTapGesture *>(event->gesture(Qt::TapGesture));
 }
 if(d->mReadOnly) {
 event->ignore();
 return;
 }
+QRectF rect = d->mTouchArea->boundingRect();
-d->mMousePressed = true;
+if(rect.contains(xVal,0 )) {
-event->accept();
+HbWidgetFeedback::triggered(this, Hb::InstantPressed);
+d->mMousePressed = true;
+updatePrimitives();
+rating = d->calculateProgressValue(xVal);
+setCurrentRating(rating);
+event->accept();
+}
+else {
+event->ignore();
+}
 }
 break;
 case Qt::GestureFinished: // Reset state
 {
 return;
 }
 rating = d->calculateProgressValue(xVal);
-if(toolTip() != QString()) {
+if(!toolTip().isNull()) {
 HbToolTip::showText(toolTip(),this);
 }
 setCurrentRating(rating);
+HbWidgetFeedback::triggered(this, Hb::InstantReleased);
 if(d->mCurrentValue) {
 emit ratingDone (d->mCurrentValue);
 }
 event->accept();
 d->mMousePressed = false;
-}
+updatePrimitives();
+}
+else {
+d->mMousePressed = false;
+updatePrimitives();
+if(xVal <rect.x() )  {
+setCurrentRating(0);
+emit ratingDone (d->mCurrentValue);
+}
+}
 }
 break;
 default: break;
 }
 }else if(event->gesture(Qt::PanGesture)) {
 return;
 }
 rating = d->calculateProgressValue(xVal);
-if(toolTip() != QString()) {
+if(!toolTip().isNull()) {
 HbToolTip::showText(toolTip(),this);
 }
 setCurrentRating(rating);
+HbWidgetFeedback::continuousTriggered(this, Hb::ContinuousDragged);
 emit ratingChanged (d->mCurrentValue);
 event->accept();
 }
 else {
 setCurrentRating(0);
 break;
 case Qt::GestureFinished: // Reset state
 {
 qreal xVal = mapFromScene(event->mapToGraphicsScene( pan->startPos()+pan->offset())).x();
 QRectF rect = d->mTouchArea->boundingRect();
+d->mMousePressed = false;
+updatePrimitives();
 int rating=0;
 if(rect.contains(xVal,0 )) {
 if(d->mReadOnly) {
 event->ignore();
 return;
 }
 }
-if(!d->mMousePressed) {
+if(xVal <0) {
-return;
+setCurrentRating(0);
-}
+emit ratingDone (d->mCurrentValue);
+return;
-if(xVal <0) {
+}
-setCurrentRating(0);
-emit ratingDone (d->mCurrentValue);
+rating = d->calculateProgressValue(xVal);
-return;
+setCurrentRating(rating);
-}
+HbWidgetFeedback::triggered(this, Hb::InstantReleased);
+if(d->mCurrentValue) {
-rating = d->calculateProgressValue(xVal);
+emit ratingDone (d->mCurrentValue);
-setCurrentRating(rating);
+}
-if(d->mCurrentValue) {
+event->accept();
-emit ratingDone (d->mCurrentValue);
 }
-d->mMousePressed = false;
-event->accept();
-}
+					default:
-default:
+break;
-break;
 }
 }
 }
 #endif
 Q_D(HbRatingSlider);
 HbWidget::setGeometry(rect);
 updatePrimitives();
 d->createLookupTable();
 }
+/*!
+\reimp
+*/
 void HbRatingSlider::initStyleOption(HbStyleOption *hboption) const
 {
 Q_D( const HbRatingSlider );
 HbWidget::initStyleOption(hboption);
 HbStyleOptionRatingSlider *option = 0;
 option->noOfStars = d->mNumberOfIcons;
 option->noOfIntervals = d->mStepCount;
 option->unRatedGraphicsName = d->mUnratedIconName;
 option->ratedGraphicsName = d->mRatedIconName;
 option->progressValue = d->mCurrentValue;
+option->disableState = !isEnabled();
+option->pressedState = d->mMousePressed;
 }
 }
 /*!
 return d->mLayoutItem;
 default:
 return 0;
 }
 }
+/*!
+\reimp
+*/
 void HbRatingSlider::changeEvent(QEvent *event)
 {
 HbWidget::changeEvent(event);
 switch (event->type()) {
 case QEvent::LayoutDirectionChange:
 updatePrimitives();
 break;
+case QEvent::EnabledChange:
+updatePrimitives();
+break;
 default:
 break;
 }
 }
+/*!
+\reimp
+*/
 void HbRatingSlider::updatePrimitives()
 {
 Q_D(HbRatingSlider);
 HbStyleOptionRatingSlider option;
 initStyleOption(&option);
 if (d->mTouchArea) {
 style()->updatePrimitive(d->mTouchArea, HbStyle::P_CheckBox_toucharea, &option);
 }
 }
+/*!
+\reimp
+*/
 QVariant HbRatingSlider::itemChange(GraphicsItemChange change, const QVariant &value)
 {
 if(change == ItemVisibleHasChanged && value.toBool()){
 updatePrimitives();
 }

branch	GCC_SURGE
changeset 15	f378acbc9cfb
parent 7	923ff622b8b9
child 21	4633027730f5
child 34	ed14f46c0e55