FCL/sf/mw/hb: comparison src/hbwidgets/widgets/hbcheckbox.cpp

equal deleted inserted replaced

-:b7da29130b0e
+:80e4d18b72f5
 mIconItem = HbStylePrivate::createPrimitive( HbStylePrivate::P_CheckBox_icon, q );
 }
 }
 /*!
-@beta
 @hbwidgets
 \class HbCheckBox
-\brief The HbCheckBox widget provides a checkbox with a text label.
+\brief The HbCheckBox class provides a check box widget with a text label.
-\image html checkbox_unchecked.png A checkbox with unchecked state.
+A check box is an option button that can be in checked, unchecked, and
+partially checked states as shown in the pictures below. Check boxes are
-\image html checkbox_checked.png A checkbox with checked state.
+typically used to represent application features that can be enabled or
+disabled without affecting other features, but you can also subclass it to
-\image html checkbox_partiallychecked.png A checkbox with partiallychecked state.
+implement different behavior.
-A HbCheckBox is an option button that can be switched on (checked)
+\image html checkbox_unchecked.png A check box in unchecked state.
-or off (unchecked). Checkboxes are typically used to represent
-features in an application that can be enabled or disabled without
+\image html checkbox_checked.png A check box in checked state.
-affecting others, but different types of behavior can be
-implemented.
+\image html checkbox_partiallychecked.png A check box in partially checked state.
-Whenever a checkbox is checked or cleared it emits the signal
+When a user checks or unchecks a check box, it emits the stateChanged()
-stateChanged(). Connect to this signal if you want to trigger an
+signal. Connect a slot to this signal if you want to trigger an action every
-action each time the checkbox changes state. You can use
+time the check box state changes. You can use isChecked() to query whether a
-isChecked() to query whether or not a checkbox is checked.
+check box is checked or not.
-In addition to checked and unchecked states, HbCheckBox
+In addition to checked and unchecked states, %HbCheckBox provides
-optionally provides a third state which is PartiallyChecked. This
+an optional partially checked state. This state is useful when you handle
-is useful for Hierarchical list item. If you need this third state,
+hierarchical list items, for example. If you need the partially checked
-enable it with setTristate(), and use checkState() to query the current
+state, enable it with setTristate() and query the state of the check box
-toggle state.
+with checkState().
-Checkbox has default icon for checked,unchecked and partiallyChecked states.
+A check box has default icons for checked, unchecked, and partially checked
-The text can be set in the constructor or with setText().For long text checkbox will show
+states. The text can be set in the constructor or with setText(). If the
-multiline text,default checkbox will have text up to three lines.
+check box text is long, it is shown in multiple lines. By default a check box
+can have up to three lines of text.
-Example usage:
+\section _usecases_hbcheckbox Using the HbCheckBox class
+\subsection _uc_hbcheckbox_001 Creating a check box.
+The following code snippet creates a check box in the layout.
 \code
 HbCheckBox *checkbox = new HbCheckBox(QString("checkbox_text"));
 layout->addItem(checkbox);
 \endcode
 */
 /*!
 \fn void HbCheckBox::stateChanged(int state)
-This signal is emitted whenever the check box's state changes,
-i.e. whenever the user checks or unchecks it.
+This signal is emitted when the user checks or unchecks a check box causing a
-\a state contains the check box's new Qt::CheckState.
+state change of the check box.
-*/
+\param  state The new state (Qt::CheckState) of the check box.
+\sa Qt
-/*!
-@beta
+*/
-Constructor an object of HbCheckBox with default parameters.
-By default the state of check box will be Unchecked, text will
-be empty and tristate will be false.
+/*!
+Constructs a check box with the following default values:
+- \a state is \c Qt::CheckState::Unchecked.
+- \a text is empty.
+- \a tristate is \c false.
+\sa Qt
 */
 HbCheckBox::HbCheckBox( QGraphicsItem *parent )
 : HbAbstractButton( *new HbCheckBoxPrivate, parent )
 {
 Q_D( HbCheckBox );
 #endif
 }
 /*!
-@beta
-Constructor an object of HbCheckBox with \a text passed.
+Constructs a check box with \a text and the following default values:
-By default the state of check box will be Unchecked.
+- \a state is \c Qt::CheckState::Unchecked.
-Tristate will be false by default.
+- \a tristate is \c false.
+\sa Qt
 */
 HbCheckBox::HbCheckBox( const QString &text, QGraphicsItem *parent )
 : HbAbstractButton( *new HbCheckBoxPrivate, parent )
 {
 Q_D( HbCheckBox );
 HbCheckBox::~HbCheckBox( )
 {
 }
 /*!
-@beta
-Sets the text of checkbox.
+Sets the \a text shown on a check box.
-UpdatePrimitive is called by this functions once the text is changed.
 \sa text()
 */
 void HbCheckBox::setText( const QString &text )
 {
 Q_D( HbCheckBox );
 }
 }
 }
 /*!
-@beta
-Returns the text of checkbox.
+Returns the text of a check box.
 \sa setText()
 */
 QString HbCheckBox::text( ) const
 {
 Q_D( const HbCheckBox );
 return d->mText;
 }
 /*!
-@beta
-Sets tristate support for checkbox based upon \a flag.
+Sets a check box to:
-By default tristate is false and checkbox has got only two states.
+- tristate-enabled mode if \a isTristate is \c true.
+- twostate-enabled mode if \a isTristate is \c false (default).
 \sa isTristate( )
 */
 void HbCheckBox::setTristate( bool isTristate )
 {
 Q_D( HbCheckBox );
 d->mTristate = isTristate;
 }
 /*!
-@beta
-Returns whether tristate is enabled for checkbox or not.
+Checks whether a check box can have two or three states.
+\return \c true if a check box is tristate-enabled.
+\return \c false if a check box is twostate-enabled.
 \sa setTristate( )
 */
 bool HbCheckBox::isTristate( ) const
 {
 Q_D( const HbCheckBox );
 return d->mTristate;
 }
 /*!
-@beta
-Returns the current state of HbCheckBox.
+Returns the current state (checked, unchecked, or partially checked) of a
+check box.
 */
 Qt::CheckState HbCheckBox::checkState() const
 {
 Q_D( const HbCheckBox );
 if ( d->mTristate &&  d->mNoChange ) {
 return 0;
 }
 }
 /*!
-@beta
-Sets the state of HbCheckBox to the \a state passed.
+Sets the state of a check box to \a state and emits the stateChanged()
-Calls updatePrimitive when state is changed.
+signal. If the check box state changes, updatePrimitives() is called
-Emits signal stateChanged(state).
 */
 void HbCheckBox::setCheckState( Qt::CheckState state )
 {
 Q_D( HbCheckBox );
 if (state == Qt::PartiallyChecked) {
 emit stateChanged( state );
 }
 }
 /*!
-Updates the icon and text primitives.
+Updates the icon and the text primitives of a check box.
 */
 void HbCheckBox::updatePrimitives( )
 {
 HbWidget::updatePrimitives( );
 Q_D( HbCheckBox );
 HbStylePrivate::updatePrimitive( d->mTouchArea, HbStylePrivate::P_CheckBox_toucharea, &checkBoxOption );
 }
 }
 /*!
-Initializes the style for check box with the \a option passed.
+Initializes the style of a check box with the \a option style.
 */
 void HbCheckBox::initStyleOption(HbStyleOptionCheckBox *option) const
 {
 Q_D( const HbCheckBox );
 option->state.operator = ( d->checked ? QStyle::State_On : QStyle::State_Off );
 }
 }
 /*!
-Updates the primitive as per new size.
 */
 void HbCheckBox::resizeEvent( QGraphicsSceneResizeEvent *event )
 {
 HbAbstractButton::resizeEvent( event );
 }
 /*!
-Overloaded hit detection to include touch area
 */
 bool HbCheckBox::hitButton( const QPointF &pos ) const
 {
 Q_D(const HbCheckBox);
 QRectF compRect = d->mTouchArea->boundingRect( );
 compRect.translate( d->mTouchArea->pos( ) );
 return compRect.contains( pos );
 }
 /*!
-\reimp.
 */
 void HbCheckBox::checkStateSet( )
 {
 Q_D(HbCheckBox);
 d->mNoChange = false;
 emit stateChanged( state );
 }
 }
 /*!
-\reimp.
 */
 void HbCheckBox::nextCheckState( )
 {
 if( checkState( ) == Qt::PartiallyChecked ) {
 HbAbstractButton::nextCheckState( );
 HbCheckBox::checkStateSet( );
 }
 #ifndef HB_GESTURE_FW
 /*!
-\reimp.
 */
 void HbCheckBox::mouseReleaseEvent( QGraphicsSceneMouseEvent *event )
 {
 HbAbstractButton::mouseReleaseEvent( event );
 updatePrimitives();
 }
 /*!
-\reimp.
 */
 void HbCheckBox::mouseMoveEvent( QGraphicsSceneMouseEvent *event )
 {
 Q_UNUSED( event );
 // To show the tooltip on press,move outside and come back to same button.
 {
 HbAbstractButton::gestureEvent( event );
 }
 #endif
 /*!
-\reimp.
 */
 void HbCheckBox::keyPressEvent(QKeyEvent *keyEvent)
 {
 switch ( keyEvent->key( ) ) {
 case Qt::Key_Select:
 HbAbstractButton::keyPressEvent( keyEvent );
 }
 }
 /*!
-\reimp
 */
 QVariant HbCheckBox::itemChange( GraphicsItemChange change, const QVariant &value )
 {
 switch ( change ) {
 case ItemEnabledHasChanged:

changeset 30	80e4d18b72f5
parent 23	e6ad4ef83b23