FCL/sf/app/phone: comparison phoneplugins/infowidgetplugin/infowidget/src/infowidget.cpp

equal deleted inserted replaced

-:6b911d05207e
+:bc5a64e5bc3c
 */
 // Local constants
 const int INFOWIDGET_DEFAULT_HEIGHT = 100;
 const int INFOWIDGET_DEFAULT_WIDTH = 200;
+const int INFOWIDGET_MARQUEE_START_DELAY = 5000;
 const char *TS_FILE_OPERATOR_WIDGET = "operator_widget";
 const char *TS_FILE_COMMON = "common";
 const char *BACKGROUND_FRAME_NAME = "qtg_fr_hswidget_normal";
 /*!
-InfoWidget::InfoWidget()
+Constructor.
 */
 InfoWidget::InfoWidget(QGraphicsItem* parent, Qt::WindowFlags flags)
 : HbWidget(parent, flags),
 m_animationState(AnimationIdle),
 m_engine(NULL),
 m_layoutChanging(false),
 m_dragEvent(false),
 m_initialized(false)
 {
 INSTALL_TRACE_MSG_HANDLER;
+DPRINT;
-DPRINT << ": IN";
 // Localization file loading
 installTranslator(TS_FILE_OPERATOR_WIDGET);
 installTranslator(TS_FILE_COMMON);
 // transferred for frame item
 m_backgroundFrameItem = new HbFrameItem(
 backgroundFrameDrawer.take(), this);
 setBackgroundItem(m_backgroundFrameItem);
+}
-DPRINT << ": OUT";
-}
+/*!
+Destructor.
-/*!
-InfoWidget::~InfoWidget()
 */
 InfoWidget::~InfoWidget()
 {
-DPRINT << ": IN";
+DPRINT;
 // Force layout manager to delete widgets
 // before InfoWidget is destroyed
 m_layoutManager->destroyWidgets();
 // Remove and delete language translators
 removeTranslators();
-DPRINT << ": OUT";
 UNINSTALL_TRACE_MSG_HANDLER;
 }
 /*!
-InfoWidget::onInitialize()
 Called by HS framework, saved preference data
 is available when onInitialize() is called and
-meta-object data reading should be done here
+meta-object data reading should be done here.
 */
 void InfoWidget::onInitialize()
 {
-DPRINT << ": IN";
+DPRINT;
 m_initialized = true;
 // Initialize preferences from meta-object data
 if (!readPersistentPreferences()) {
 // Reading failed, initialize default values
 m_preferences->setPreference(InfoWidgetPreferences::DisplaySpn,
 m_backgroundFrameItem->resize(size());
 // Listen for model changes
 QObject::connect(m_engine.data(), SIGNAL(modelChanged()),
 this, SLOT(readModel()), Qt::UniqueConnection);
+}
-DPRINT << ": OUT";
-}
+/*!
+This slot is called by HomeScreen framework
-/*!
+when the widget is uninstalled.
-InfoWidget::onUninitialize()
 */
 void InfoWidget::onUninitialize()
 {
-DPRINT << ": IN";
+DPRINT;
 stopMarquees();
 m_initialized = false;
 m_engine->suspend();
-DPRINT << ": OUT";
+}
-}
+/*!
-/*!
+This slot is called by HomeScreen framework
-InfoWidget::onShow()
+when the widget visibility is gained.
 */
 void InfoWidget::onShow()
 {
 DPRINT;
 if (m_initialized) {
 updateInfoDisplay();
 }
 }
 /*!
-InfoWidget::onHide()
+This slot is called by HomeScreen framework
+when the widget visibility is lost.
 */
 void InfoWidget::onHide()
 {
 DPRINT;
 if (m_initialized) {
 stopMarquees();
 }
 }
 /*!
-InfoWidget::timerEvent()
+Handles timer events.
 */
 void InfoWidget::timerEvent(QTimerEvent *event)
 {
 Q_UNUSED(event);
 m_timerId = 0;
 }
 }
 /*!
-InfoWidget::installTranslator()
+Install widget translator for given translation file.
 */
 bool InfoWidget::installTranslator(QString translationFile)
 {
-DPRINT << ": IN";
+DPRINT;
 QString lang = QLocale::system().name();
 QString path = "z:/resource/qt/translations/";
 bool translatorLoaded(false);
 QScopedPointer<QTranslator> widgetTranslator;
 if (translatorLoaded) {
 qApp->installTranslator(widgetTranslator.data());
 m_translators.append(widgetTranslator.take());
 DPRINT << ": translator installed: " << translationFile;
 }
-DPRINT << ": OUT";
 return translatorLoaded;
 }
 /*!
-InfoWidget::removeTranslators()
+Remove translators. No need to call
+QApplication::removeTranslator,
-Remove translators from qApp and delete objects
+QTranslator object removes itself before deletion.
 */
 void InfoWidget::removeTranslators()
 {
-DPRINT << ": IN";
+DPRINT;
-foreach (QTranslator *translator, m_translators) {
-qApp->removeTranslator(translator);
-}
 qDeleteAll(m_translators);
 m_translators.clear();
+}
-DPRINT << ": OUT";
-}
+/*!
+Returns bounding rect.
-/*!
-InfoWidget::boundingRect()
 */
 QRectF InfoWidget::boundingRect() const
 {
 return rect();
 }
 /*!
-InfoWidget::sizeHint()
+Calculate widget size hint based on visible row count.
-Calculate size hint based on visible rows count
 */
 QSizeF InfoWidget::sizeHint(Qt::SizeHint which, const QSizeF & constraint) const
 {
 Q_UNUSED(which);
 Q_UNUSED(constraint);
 DPRINT << ": returning size: " << requiredSize;
 return requiredSize;
 }
 /*!
-InfoWidget::sizePolicy()
+Returns size polizy for the widget.
 */
 QSizePolicy InfoWidget::sizePolicy () const
 {
 DPRINT;
 return QSizePolicy(
 QSizePolicy::Fixed,
 QSizePolicy::Fixed);
 }
 /*!
-InfoWidget::updateItemsVisibility()
+Update item visibility based on display preferences.
 */
 void InfoWidget::updateItemsVisibility()
 {
-DPRINT <<": IN";
+DPRINT;
 int layoutRows = 0;
-QList<QGraphicsWidget *> widgetsToHide;
 // Update layout according to item visibility settings
 if (m_preferences->preference(InfoWidgetPreferences::DisplaySpn).compare(
 DISPLAY_SETTING_ON) == 0) {
 layoutRows++;
 } else {
 m_layoutManager->removeWidget(InfoWidgetLayoutManager::RoleSatMarqueeItem);
 m_layoutManager->removeWidget(InfoWidgetLayoutManager::RoleSatTextIcon);
 }
-DPRINT << ": visible layout rows count: " << layoutRows;
+if (m_animatingItems.count() == 0) {
+m_animatingItem = NULL;
+}
 m_layoutManager->setLayoutRows(layoutRows);
 }
 /*!
-InfoWidget::layoutInfoDisplay()
+Layout info display.
-Layout info display
 */
 void InfoWidget::layoutInfoDisplay()
 {
-DPRINT << ": IN";
+DPRINT;
 QGraphicsLayout *infoDisplayLayout =
 m_layoutManager->layoutInfoDisplay();
 if (!m_layout->count()) {
 QGraphicsWidget *contentWidget =
 if (contentWidget) {
 // Add content widget to main layout
 m_layout->addItem(contentWidget);
 }
 }
 updateItemsVisibility();
 endChanges();
-DPRINT << ": OUT";
+}
-}
+/*!
-/*!
+Layout and display settings dialog.
-InfoWidget::layoutSettingsDialog()
-Layout and display settings dialog
 */
 void InfoWidget::layoutSettingsDialog()
 {
-DPRINT << ": IN";
+DPRINT;
 startChanges();
 m_layoutManager->reloadWidgets(InfoWidgetLayoutManager::SettingsDialog);
 QGraphicsLayout *settingDialogLayout =
 m_layoutManager->layoutSettingsDialog();
 HbDialog *settingsDialog = qobject_cast<HbDialog *>(
 m_layoutManager->getWidget(InfoWidgetLayoutManager::
 RoleSettingsDialog));
 if (settingsDialog) {
-DPRINT << ": settingsDialog has been returned from layout manager";
 initializeSettingsDialogItems();
 settingsDialog->setDismissPolicy(HbDialog::NoDismiss);
 settingsDialog->setTimeout(HbDialog::NoTimeout);
 settingsDialog->open(this,
 SLOT(settingsDialogClosed(HbAction *)));
 }
 }
-DPRINT << ": OUT";
+}
-}
+/*!
-/*!
-InfoWidget::initializeSettingsDialogItems()
 Set up initial check box states
-and connect signals to local slots
+and connect signals to local slots.
 */
 void InfoWidget::initializeSettingsDialogItems()
 {
-DPRINT << ": IN";
+DPRINT;
 // Connect display setting check boxes
 HbCheckBox *spnCheckBox =
 qobject_cast<HbCheckBox *>(m_layoutManager->getWidget(
 InfoWidgetLayoutManager::RoleSpnCheckBox));
 if (spnCheckBox) {
 QObject::connect(satTextCheckBox, SIGNAL(stateChanged(int)),
 this, SLOT(satDisplaySettingChanged(int)),
 Qt::UniqueConnection);
 }
+}
-DPRINT << ": OUT";
-}
+/*!
-/*!
-InfoWidget::updateInfoDisplayItem()
 Fetch widget based on item role and update
 item specific data.
 */
 void InfoWidget::updateInfoDisplayItem(
 InfoWidgetLayoutManager::LayoutItemRole itemRole,
 if (marqueeItem) {
 marqueeItem->setText(text);
 marqueeItem->setTextColor( HbColorScheme::color(
 "qtc_hs_list_item_title_normal"));
-// Update widget effective size if not already set
+// Update widget effective size
 marqueeItem->adjustSize();
 if (!m_layoutManager->textFitsToRect(
 text,
 marqueeItem->font(),
 marqueeItem->rect())) {
 DPRINT << ": enable marquee animation";
 }
 }
 }
 /*!
-InfoWidget::updateInfoDisplay()
 Model or visibility data has changed,
 update info display widgets accordingly.
 */
 void InfoWidget::updateInfoDisplay()
 {
-DPRINT << ": IN";
+DPRINT;
 if (m_initialized) {
 stopMarquees();
 if (m_layoutManager->currentDisplayRole() ==
-InfoWidgetLayoutManager::InfoDisplay )
+InfoWidgetLayoutManager::InfoDisplay) {
-{
-QString text;
 InfoWidgetEngine::ModelData modelData = m_engine->modelData();
 // Update service provider name item
-text = modelData.serviceProviderName();
+QString text = modelData.serviceProviderName();
-updateInfoDisplayItem(InfoWidgetLayoutManager::RoleSpnMarqueeItem, text);
+updateInfoDisplayItem(
+InfoWidgetLayoutManager::RoleSpnMarqueeItem, text);
 // Update MCN name item
 text = modelData.mcnName();
-updateInfoDisplayItem(InfoWidgetLayoutManager::RoleMcnMarqueeItem, text);
+updateInfoDisplayItem(
+InfoWidgetLayoutManager::RoleMcnMarqueeItem, text);
 // Update SAT display text item
 text = modelData.satDisplayText();
-updateInfoDisplayItem(InfoWidgetLayoutManager::RoleSatMarqueeItem, text);
+updateInfoDisplayItem(
+InfoWidgetLayoutManager::RoleSatMarqueeItem, text);
 }
 if (m_animatingItems.count() > 0) {
-startMarquees(StartDelayed);
+startMarquees();
 }
 }
 }
 /*!
-InfoWidget::readModel()
+Read model data.
+Model's modelChanged - signal is connected to this slot.
-Read model data. Model's modelChanged - signal is connected to this slot.
 */
 void InfoWidget::readModel()
 {
-DPRINT << ": IN";
+DPRINT;
 if (m_layoutManager->currentDisplayRole() ==
 InfoWidgetLayoutManager::InfoDisplay) {
 updateInfoDisplay();
 }
-DPRINT << ": OUT";
+}
-}
+/*!
-/*!
+Model error signal is connected to this slot.
-InfoWidget::handleModelError()
-Model error signal is connected to this slot
 */
 void InfoWidget::handleModelError(int operation,int errorCode)
 {
-DWARNING << ": operation: " << operation << " error: " << errorCode;
+DWARNING << ": operation: " << operation <<
-}
+" error: " << errorCode;
+}
-/*!
-InfoWidget::mousePressEvent()
+/*!
+Mouse press handler.
 */
 void InfoWidget::mousePressEvent(QGraphicsSceneMouseEvent *event)
 {
 Q_UNUSED(event);
 // Clear flag
 m_dragEvent = false;
 }
 /*!
-InfoWidget::mouseReleaseEvent()
+Mouse release handler.
 */
 void InfoWidget::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
 {
 Q_UNUSED(event);
+// If widget wasn't dragged
-// If in info display and widget wasn't dragged
 // layout and open settings dialog
 if ((!m_dragEvent) &&
 m_layoutManager->currentDisplayRole() ==
 InfoWidgetLayoutManager::InfoDisplay) {
 DPRINT << ": layout and display settings dialog";
 layoutSettingsDialog();
 }
 // Clear flag
 m_dragEvent = false;
+}
-}
+/*!
-/*!
+Mouse move handler.
-InfoWidget::mouseMoveEvent()
 */
 void InfoWidget::mouseMoveEvent(QGraphicsSceneMouseEvent *event)
 {
 Q_UNUSED(event);
 // Mouse is moving
 // after mouse press event
 m_dragEvent = true;
 }
 /*!
-InfoWidget::spnDisplaySettingChanged()
+Slot for handling Spn display setting change.
 */
 void InfoWidget::spnDisplaySettingChanged(int state)
 {
 DPRINT << ": state: " << state;
 if (state == Qt::Checked){
 InfoWidgetPreferences::DisplaySpn, DISPLAY_SETTING_OFF);
 }
 }
 /*!
-InfoWidget::mcnDisplaySettingChanged()
+Slot for handling Mcn display setting change.
 */
 void InfoWidget::mcnDisplaySettingChanged(int state)
 {
 DPRINT << ": state: " << state;
 if (state == Qt::Checked){
 InfoWidgetPreferences::DisplayMcn, DISPLAY_SETTING_OFF);
 }
 }
 /*!
-InfoWidget::satDisplaySettingChanged()
+Slot for handling SAT display setting change.
 */
 void InfoWidget::satDisplaySettingChanged(int state)
 {
 DPRINT << ": state: " << state;
 if (state == Qt::Checked){
 InfoWidgetPreferences::DisplaySatText, DISPLAY_SETTING_OFF);
 }
 }
 /*!
-InfoWidget::mcnDisplay()
 Getter function for Meta-object property "mcnDisplay"
 */
 QString InfoWidget::mcnDisplay()
 {
 DPRINT;
 return m_preferences->preference(
 InfoWidgetPreferences::DisplayMcn);
 }
 /*!
-InfoWidget::setMcnDisplay()
 Setter function for Meta-object property "mcnDisplay"
 */
 void InfoWidget::setMcnDisplay(QString value)
 {
 DPRINT;
 m_preferences->setPreference(
 InfoWidgetPreferences::DisplayMcn, value);
 }
 /*!
-InfoWidget::homeZoneDisplay()
 Getter function for Meta-object property "homeZoneDisplay"
 */
 QString InfoWidget::homeZoneDisplay()
 {
 DPRINT;
 return m_preferences->preference(
 InfoWidgetPreferences::DisplayHomeZone);
 }
 /*!
-InfoWidget::setHomeZoneDisplay()
 Setter function for Meta-object property "homeZoneDisplay"
 */
 void InfoWidget::setHomeZoneDisplay(QString value)
 {
 DPRINT;
 m_preferences->setPreference(
 InfoWidgetPreferences::DisplayHomeZone, value);
 }
 /*!
-InfoWidget::activeLineDisplay()
 Getter function for Meta-object property "activeLineDisplay"
 */
 QString InfoWidget::activeLineDisplay()
 {
 DPRINT;
 return m_preferences->preference(
 InfoWidgetPreferences::DisplayActiveLine);
 }
 /*!
-InfoWidget::setActiveLineDisplay()
 Setter function for Meta-object property "activeLineDisplay"
 */
 void InfoWidget::setActiveLineDisplay(QString value)
 {
 DPRINT;
 return m_preferences->preference(
 InfoWidgetPreferences::DisplaySatText);
 }
 /*!
-InfoWidget::setSatDisplay()
 Setter function for Meta-object property "satDisplay"
 */
 void InfoWidget::setSatDisplay(QString value)
 {
 DPRINT;
 m_preferences->setPreference(
 InfoWidgetPreferences::DisplaySatText, value);
 }
 /*!
-InfoWidget::spnDisplay()
 Getter function for Meta-object property "spnDisplay"
 */
 QString InfoWidget::spnDisplay()
 {
 DPRINT;
 return m_preferences->preference(
 InfoWidgetPreferences::DisplaySpn);
 }
 /*!
-InfoWidget::setSpnDisplay()
 Setter function for Meta-object property "spnDisplay"
 */
 void InfoWidget::setSpnDisplay(QString value)
 {
 DPRINT;
 m_preferences->setPreference(
 InfoWidgetPreferences::DisplaySpn, value);
 }
 /*!
-InfoWidget::readPersistentPreferences()
 Read Meta-object properties and store to preference handler.
 Restores preferences from previous session.
 */
 bool InfoWidget::readPersistentPreferences()
 {
 return changed;
 }
 /*!
-InfoWidget::initializeCheckBoxStates()
 Read display settings from preference store
 and set check box initial states accordingly.
 */
 void InfoWidget::initializeCheckBoxStates()
 {
 DPRINT;
 HbCheckBox *spnCheckBox = qobject_cast<HbCheckBox *>(m_layoutManager->getWidget(
 InfoWidgetLayoutManager::RoleSpnCheckBox));
 if (spnCheckBox) {
 spnCheckBox->setChecked(m_preferences->isPreferenceSet(
 InfoWidgetPreferences::DisplaySpn));
 }
 HbCheckBox *mcnCheckBox = qobject_cast<HbCheckBox *>(m_layoutManager->getWidget(
 InfoWidgetLayoutManager::RoleMcnCheckBox));
 InfoWidgetPreferences::DisplaySatText));
 }
 }
 /*!
-InfoWidget::settingsEditingFinished()
+Handles settings validating and storing
+when the settings dialog is closed with Ok action.
 */
 void InfoWidget::settingsEditingFinished()
 {
-DPRINT << ": IN";
+DPRINT;
-// Save settings data if validation succeeds
 if (m_preferences->validate()) {
-DPRINT << ": switching to info display";
 // Signal HS framework to store Meta-object
-// preferences if changed
+// preferences if preferences have changed.
 if (m_preferences->storePreferences()) {
 emit setPreferences(
 m_preferences->preferenceNames());
 }
 m_layoutManager->removeWidget(
 InfoWidgetLayoutManager::RoleSettingsDialog,
 true);
 } else {
-DPRINT << ": settings validation failed";
 // Cancel edit mode
 settingsEditingCancelled();
 // Display warning note
 settingsValidationFailed();
 }
+}
-DPRINT << ": OUT";
-}
+/*!
-/*!
-InfoWidget::settingsEditingCancelled()
 Slot to be called when settings editing
 shouldn't cause change set of visible items.
 Restores previous state.
 */
 void InfoWidget::settingsEditingCancelled()
 InfoWidgetLayoutManager::RoleSettingsDialog,
 true);
 }
 /*!
-InfoWidget::settingsDialogClosed()
+Slot to be called when settings dialog is about to close.
-Slot to be called when settings dialog is about to close
 */
 void InfoWidget::settingsDialogClosed(HbAction* action)
 {
-DPRINT << ": IN";
+DPRINT;
 if (action) {
 if (action->text() == hbTrId("txt_common_button_ok")) {
 settingsEditingFinished();
-} else if (action->text() == hbTrId("txt_common_button_cancel") ) {
+} else if (action->text() == hbTrId("txt_common_button_cancel")) {
 settingsEditingCancelled();
 }
 } else {
-DPRINT << ": null action";
 settingsEditingCancelled();
 }
 // Switch to info display
 layoutInfoDisplay();
-DPRINT << ": OUT";
+}
-}
+/*!
-/*!
+Handle start of changes, called when settings dialog
-InfoWidget::startChanges()
+is shown and layout changes are expected.
 */
 void InfoWidget::startChanges()
 {
 DPRINT;
 m_layoutChanging = true;
 if (m_animationState != AnimationIdle) {
 stopMarquees();
 }
 }
 /*!
-InfoWidget::endChanges()
+Handle end of changes, called when settings dialog
+is closed and layout changes are to be finished.
 */
 void InfoWidget::endChanges()
 {
 DPRINT;
 updateGeometry();
 updateInfoDisplay();
 m_layoutChanging = false;
 }
 /*!
 \reimp
 }
 HbWidget::changeEvent(event);
 }
 /*!
-InfoWidget::settingsValidationFailed()
 Slot to be called when preference validation has failed.
-Displays warning message box
 */
 void InfoWidget::settingsValidationFailed()
 {
 DPRINT;
 if (m_initialized) {
 hbTrId("txt_operatorwidget_info_select_one"));
 }
 }
 /*!
-InfoWidget::startMarquees()
 Start marquee animations.
 First find existing marquee items and
-enable marquee sequence
+enable marquee sequence.
 */
-bool InfoWidget::startMarquees(AnimationStartDelay delay)
+bool InfoWidget::startMarquees()
 {
 DPRINT;
 bool started(true);
 if (m_animationState == AnimationOngoing ||
 return false;
 }
 int animatingItemsCount = m_animatingItems.count();
 if (animatingItemsCount > 0) {
-HbMarqueeItem *marqueeItem(NULL);
+foreach (HbMarqueeItem *marqueeItem, m_animatingItems) {
-foreach (marqueeItem, m_animatingItems) {
+if (marqueeItem) {
 if (animatingItemsCount > 1) {
 // Multiple items, connect to marqueeNext()
 // sequence logic
 QObject::connect(
-marqueeItem,SIGNAL(animationStopped()),
+marqueeItem, SIGNAL(animationStopped()),
 this, SLOT(marqueeNext()),
-Qt::UniqueConnection);
+Qt::QueuedConnection);
 marqueeItem->setLoopCount(1);
-} else if (animatingItemsCount ==1 ){
+} else if (animatingItemsCount == 1){
 // Single item, set continuous marquee mode
 marqueeItem->setLoopCount(-1);
+}
 }
 }
 // Store marquee sequence start item
 m_animatingItem = m_animatingItems.first();
+m_animationState = AnimationStarting;
-if (delay == StartNoDelay) {
+m_timerId = startTimer(INFOWIDGET_MARQUEE_START_DELAY);
-m_animationState = AnimationOngoing;
-m_animatingItem->startAnimation();
-} else if (delay == StartDelayed && !m_timerId) {
-m_animationState = AnimationStarting;
-m_timerId = startTimer(100);
-}
 } else {
-// No animating items, not started
+DPRINT << ": not started, no animating items";
-DWARNING << ": not done, no animating items";
 m_animatingItem = NULL;
 started = false;
 }
 return started;
 }
 /*!
-InfoWidget::stopMarquees()
 Stop all marquee animations and reset
-animation state
+animation state.
 */
 void InfoWidget::stopMarquees()
 {
 DPRINT;
 if (m_animationState != AnimationIdle &&
 m_animatingItems.count() > 0) {
-HbMarqueeItem *marqueeItem(NULL);
+foreach (HbMarqueeItem *marqueeItem, m_animatingItems) {
+if (marqueeItem) {
-foreach (marqueeItem, m_animatingItems) {
-// Disconnect if more than one item,
-// single animator doesn't connect to animationStopped()
-if (m_animatingItems.count() > 1) {
 QObject::disconnect(
 marqueeItem, SIGNAL(animationStopped()),
 this, SLOT(marqueeNext()));
-}
+if (marqueeItem->isAnimating()) {
-if (marqueeItem->isAnimating()) {
+marqueeItem->stopAnimation();
-marqueeItem->stopAnimation();
+}
 }
 }
 }
 // Stop timer
 m_animatingItems.clear();
 m_animatingItem = NULL;
 }
 /*!
-InfoWidget::marqueeNext()
 Starts marquee animation for
 next item in sequence.
 */
 void InfoWidget::marqueeNext()
 {
 m_animatingItem->setLoopCount(1);
 m_animatingItem->startAnimation();
 }
 }
 }
 }
 // End of File.

changeset 46	bc5a64e5bc3c
parent 45	6b911d05207e
child 50	377c906a8701
child 56	5bcb308bd24d