FCL/sf/mw/hb: comparison src/hbwidgets/popups/hbnotificationdialog.cpp

equal deleted inserted replaced

-:f7ac710697a9
+:06ff229162e9
 #ifdef HB_EFFECTS
 #include "hbeffectinternal_p.h"
 #endif
-#include <hbstyleoptionnotificationdialog.h>
+#include <hbstyleoptionnotificationdialog_p.h>
 #include "hbnotificationdialogcontent_p.h"
 #define H_MARGIN QString("hb-param-margin-gene-middle-horizontal")
 #define V_MARGIN QString("hb-param-margin-gene-middle-vertical")
 {
 return notificationDialogSequentialShowInstance();
 }
 /*!
+@beta
+@hbwidgets
 \class HbNotificationDialog
-\brief HbNotificationDialog is a non-modal dialog displayed on top of applications.
+\brief HbNotificationDialog can be used to notify users of system
-Notification dialog is a dialog that can be used for notifying users of the system
+generated or user activated events in the UI.
-generated or user activated events in the UI. These notifications do not require
+HbNotificationDialog is a non-modal dialog displayed on top of applications.
+These notifications do not require
 user input.
-If wanted, some action can be activated with a tap to the notification dialog. The user
+Optionally, an action can be activated with a tap to the notification dialog. This is enabled
-of notification dialog can do this by first enabling the touch activation with
+by first enabling the touch activation with
 enableTouchActivation() and then starting the action with the signal
-HbNotificationDialog::activated()
+HbNotificationDialog::activated().
 HbNotificationDialog is a concrete class. For the content, you can use the default content
-widgets which provides two rows of text (title only, or title and text) and optionally an icon.
+widgets which provides two rows of text (title spanning both lines, or title and text) and optionally an icon.
 	You can use the default content widget by invoking the HbNotificationDialog with its
-static launch-methods or by using the methods setText, setTitle, setIcon.
+static launch-methods or by using the methods setText(), setTitle() and setIcon().
-Alternatively, you can create a separate widget, and set it to the dialog with inherited method
+Alternatively, you can create a separate widget, and set it to the dialog with the inherited method
 HbNotificationDialog::setContentWidget().
-To display a notification dialog, show() or exec() has to be called. By default, notifications
+To display a notification dialog, show() or open() must be called. By default, notifications
-are synchronized with device dialogs. Showing of notification dialogs are delayed until there
+are synchronized with device dialogs. The display of notification dialogs is delayed until there
 are no device dialogs on display. Notifications are also synchronized with each other.
-If several notifications are shown at the same time with show() function, they are shown
+If several notifications are shown at the same time with the show() function, they are shown
-sequentially instead of on top of each other. Sequential show and device dialog
+sequentially instead of on top of each other. The synchronization of dialogs and sequential display of dialogs
-synchronization can be disabled by setSequentialShow() function.
+can be disabled using the setSequentialShow() function.
-\beta
-\hbwidgets
 */
 /*!
 \fn void HbNotificationDialog::activated();
-This signal is emitted when the dialog is closed with a pointer tap
+This signal is emitted when the dialog is closed with a pointer tap.
 */
 /*!
-\enum HbNotificationDialog::WrapMode
+Constructor.
-\deprecated HbNotificationDialog::WrapMode
+*/
-is deprecated and will be removed in future.
-*/
 HbNotificationDialog::HbNotificationDialog() : HbDialog(*new HbNotificationDialogPrivate, 0)
 {
 Q_D(HbNotificationDialog);
 d->q_ptr = this;
 setFocusPolicy(Qt::NoFocus);
 if ((style()->parameter(H_MARGIN, hMargin)) &&
 (style()->parameter(V_MARGIN, vMargin))) {
 setPreferredPos(QPointF(hMargin, vMargin));
 }
-// todo: priority
+//d->setPriority(1);
-d->setPriority(1);
 setModal(false);
 setBackgroundFaded(false);
 setDismissPolicy(HbPopup::NoDismiss);
 HbEffectInternal::add(this, "notificationdialog_appear", "appear");
 HbEffectInternal::add(this, "notificationdialog_disappear", "disappear");
 #endif
 }
+/*!
+Destructor.
+*/
 HbNotificationDialog::~HbNotificationDialog()
 {
 Q_D(HbNotificationDialog);
 if (d->sequentialShow) {
 sequentialShowInstance()->remove(this);
 }
 }
 /*!
 Enable user interaction on dialog.
-\param enable - When enabled, activated() signal is emitted on user action.
+\param enabled - When enabled, the activated() signal is emitted on user action.
 \sa isTouchActivating()
 */
 void HbNotificationDialog::enableTouchActivation(bool enabled)
 {
 Q_D(HbNotificationDialog);
 d->content->enableTouchActivation(enabled);
 }
 }
 /*!
-returns true if the use interaction is enabled.
+Returns true if user interaction is enabled.
 \sa enableTouchActivation()
 */
 bool HbNotificationDialog::isTouchActivating() const
 {
 Q_D(const HbNotificationDialog);
 return d->isTouchActivating;
 }
 /*!
 Convenience method for using HbNotificationDialog. Shows a notification dialog with
 the given parameters. The dialog is owned by HbNotificationDialog.
 */
 void HbNotificationDialog::launchDialog(const QString &title, const QString &text, QGraphicsScene* scene)
 {
 HbNotificationDialog *self = new HbNotificationDialog();
 if (scene) {
 self->setTitle(title);
 self->show();
 }
 /*!
 Convenience method for using HbNotificationDialog. Shows a notification dialog with
 the given parameters. The dialog is owned by NotificationDialog.
+*/
-\deprecated HbNotificationDialog::launchDialog(const HbIcon&, QGraphicsScene*)
+void HbNotificationDialog::launchDialog(const QString &title, QGraphicsScene* scene)
-is deprecated. Showing only icon is not supported by the layout. Use other launchDialog-methods instead.
-*/
-void HbNotificationDialog::launchDialog(const HbIcon &icon, QGraphicsScene* scene)
 {
 HbNotificationDialog *self = new HbNotificationDialog();
 if (scene) {
 scene->addItem(self);
 }
 self->setAttribute(Qt::WA_DeleteOnClose, true);
-self->setIcon(icon);
-self->show();
-}
-/*!
-Convenience method for using HbNotificationDialog. Shows a notification dialog with
-the given parameters. The dialog is owned by NotificationDialog.
-*/
-void HbNotificationDialog::launchDialog(const QString &title, QGraphicsScene* scene)
-{
-HbNotificationDialog *self = new HbNotificationDialog();
-if (scene) {
-scene->addItem(self);
-}
-self->setAttribute(Qt::WA_DeleteOnClose, true);
 self->setTitle(title);
 self->show();
 }
 /*!
 Convenience method for using HbNotificationDialog. Shows a notification dialog with
 the given parameters. The dialog is owned by HbNotificationDialog.
 */
 void HbNotificationDialog::launchDialog(const HbIcon &icon, const QString &title,
 const QString &text, QGraphicsScene* scene)
 {
 HbNotificationDialog *self = new HbNotificationDialog();
 self->setTitle(title);
 self->show();
 }
 /*!
-\property HbNotificationDialog::title
+Returns the title text.
-\brief title text
 If a default content widget doesn't exist, it is created.
-*/
-/*!
+\sa setTitle()
-returns title text.
-\sa setTitle()
 */
 QString HbNotificationDialog::title() const
 {
 Q_D(const HbNotificationDialog);
 if(d->content) {
 return QString();
 }
 }
 /*!
-set title text
+Set the dialog title text.
-\sa title()
+\sa title()
 */
 void HbNotificationDialog::setTitle(const QString& title)
 {
 Q_D(HbNotificationDialog);
 d->checkAndCreateContentWidget();
-d->content->setTitle( title );
+d->content->setTitle(title);
 d->setNotificationDialogContent();
 }
 /*!
-\property HbNotificationDialog::text
+Returns the text for the dialog.
-\brief text for the dialog
 If a default content widget doesn't exist, it is created.
-*/
-/*!
+\sa setText()
-returns text for the dialog.
-\sa setText()
 */
 QString HbNotificationDialog::text() const
 {
 Q_D(const HbNotificationDialog);
 if(d->content) {
 return QString();
 }
 }
 /*!
-set text for the dialog.
+Set the text for the dialog.
-\sa text()
+\sa text()
 */
 void HbNotificationDialog::setText(const QString& text)
 {
 Q_D(HbNotificationDialog);
 d->checkAndCreateContentWidget();
 d->content->setText( text );
 d->setNotificationDialogContent();
 }
 /*!
-\property HbNotificationDialog::icon
+Returns the icon for the dialog.
-\brief icon
 If a default content widget doesn't exist, it is created.
-*/
-/*!
+\sa setIcon()
-returns the icon.
-\sa setIcon()
 */
 HbIcon HbNotificationDialog::icon() const
 {
 Q_D(const HbNotificationDialog);
 if(d->content) {
 return QString();
 }
 }
 /*!
-set the icon.
+Set the icon.
-\sa icon()
+\sa icon()
 */
 void HbNotificationDialog::setIcon(const HbIcon& icon)
 {
 Q_D(HbNotificationDialog);
 d->checkAndCreateContentWidget();
 d->content->setIcon( icon );
 d->setNotificationDialogContent();
 }
 /*!
-\deprecated HbNotificationDialog::setWrapMode(int)
+Returns the style of text wrapping for the title.
-is deprecated. Please use setTitleTextWrapping(Hb::TextWrapping wrapping) instead.
-*/
+The title can wrap only if there is no other text for the dialog. The title can wrap to a maximum of two lines.
-void HbNotificationDialog::setWrapMode(int mode)
+The default is Hb::TextWordWrap.
-{
-if (mode == NoWrap) {
+\sa setTitleTextWrapping(), HbNotificationDialog::title, HbNotificationDialog::text
-setTitleTextWrapping(Hb::TextNoWrap);
-} else {
-setTitleTextWrapping(Hb::TextWordWrap);
-}
-}
-/*!
-\property HbNotificationDialog::titleTextWrapping
-\brief sets the wrapping for title.
-The title can wrap to two lines only if the text is empty.
-\sa HbNotificationDialog::title, HbNotificationDialog::text
-*/
-/*!
-Returns the wrapping mode. The title can wrap to two lines only if the text is empty.
-\sa setTitleTextWrapping()
 */
 Hb::TextWrapping HbNotificationDialog::titleTextWrapping() const
 {
 Q_D(const HbNotificationDialog);
 return d->titleWrapping;
 }
 /*!
-\brief sets the wrapping for title.
+Sets whether the text for the title is wrapped.
-The title can wrap to two lines only if the text is empty.
+The title can wrap only if there is no text for the dialog. The title can wrap to a maximum of two lines.
 \sa titleTextWrapping()
 */
 void HbNotificationDialog::setTitleTextWrapping(Hb::TextWrapping wrapping)
 {
 Q_D(HbNotificationDialog);
 d->doLayout();
 }
 }
 /*!
-Enables or disables sequential showing of Notification Dialog. Notification dialogs are by
+Enables or disables sequential display of the Notification Dialog.
-default shown sequentially. Several dialogs displayed by show() at the same time are shown
-one after another instead of on top of each other. Showing of the dialogs are also synchronized
+When enabled, notification dialogs are shown sequentially. If multiple calls to show() occur at the same time then the dialogs are displayed
-with device dialogs by delaying until none of them are shown. With sequential show disabled,
+in sequence instead of on top of each other. The display of the dialogs is also synchronized
+with the device dialogs such that the notification dialogs do not appear until there are no device dialogs being displayed.
+With sequential show disabled,
 HbNotificationDialog behaves like other popups. While a dialog is waiting to be shown,
-setVisible(), hide() or show() has no effect. setSequentialShow(false) removes a dialog from the
+setVisible(), hide() and show() have no effect. To remove a dialog from the wait queue, call setSequentialShow(false).
-wait queue.
+This setting is enabled by default.
 \sa isSequentialShow()
 */
 void HbNotificationDialog::setSequentialShow(bool sequentially)
 {
 }
 d->sequentialShow = sequentially;
 }
 /*!
-Returns sequential show setting.
+Returns the sequential show setting.
 \sa setSequentialShow()
 */
 bool HbNotificationDialog::isSequentialShow() const
 {
 Q_D(const HbNotificationDialog);
 return d->sequentialShow;
-}
-/*!
-\deprecated HbNotificationDialog::wrapMode() const
-is deprecated. Please use titleTextWrapping() const instead.
-*/
-int HbNotificationDialog::wrapMode() const
-{
-return NoWrap;
 }
 /*!
 Constructor required by the shared d-pointer paradigm.
 */
 HbNotificationDialog::HbNotificationDialog(HbNotificationDialogPrivate &dd, QGraphicsItem *parent) :
 HbDialog(dd, parent)
 {
+}
+/*!
+\reimp
+*/
+QGraphicsItem *HbNotificationDialog::primitive(const QString &itemName) const
+{
+Q_D(const HbNotificationDialog);
+if (itemName == "") {
+return 0;
+} else {
+if(d->content) {
+return d->content->primitive(itemName);
+} else {
+return HbWidget::primitive(itemName);
+}
+}
 }
 void HbNotificationDialog::gestureEvent(QGestureEvent *event)
 {
 Q_D(HbNotificationDialog);

changeset 2	06ff229162e9
parent 1	f7ac710697a9
child 7	923ff622b8b9