homescreenapp/stateplugins/hsmenuworkerstateplugin/src/hsdialogcontroller.cpp
author hgs
Mon, 20 Sep 2010 10:19:07 +0300
changeset 90 3ac3aaebaee5
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
90
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description: Dialog controller
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#include <HbAction>
hgs
parents:
diff changeset
    19
#include <QString>
hgs
parents:
diff changeset
    20
#include <HbMessageBox>
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include "hsdialogcontroller.h"
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
/*!
hgs
parents:
diff changeset
    25
 \class HsDialogController
hgs
parents:
diff changeset
    26
 \ingroup group_hsworkerstateplugin
hgs
parents:
diff changeset
    27
 \brief Dialog utility.
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
 Manages dialog lifetime depending on entry removal or
hgs
parents:
diff changeset
    30
 signal arrival, forwards dialog originating actions to user specified callbacks.
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/*!
hgs
parents:
diff changeset
    34
    \fn void acceptActionTriggered(QAction* action)
hgs
parents:
diff changeset
    35
    \param action Pointer to action which triggered the signal.
hgs
parents:
diff changeset
    36
    Emitted when controlled  dialog closed with \a accept action.
hgs
parents:
diff changeset
    37
*/
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
/*!
hgs
parents:
diff changeset
    41
    \fn rejectActionTriggered(QAction* action)
hgs
parents:
diff changeset
    42
    \param action Pointer to action which triggered the signal.
hgs
parents:
diff changeset
    43
    Emitted when controlled dialog is closed with \a reject action.
hgs
parents:
diff changeset
    44
*/
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
/*!
hgs
parents:
diff changeset
    47
   \fn void dialogCompleted()
hgs
parents:
diff changeset
    48
   Emitted whenever controlled dialog is closed.
hgs
parents:
diff changeset
    49
*/
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
/*!
hgs
parents:
diff changeset
    52
  \param message Dialog's message.
hgs
parents:
diff changeset
    53
  \param options Dialog type indicator.
hgs
parents:
diff changeset
    54
  \see HsMenuDialogFactory
hgs
parents:
diff changeset
    55
  Creates dialog controller instance with prediefinded dialog type.
hgs
parents:
diff changeset
    56
  */
hgs
parents:
diff changeset
    57
HsDialogController::HsDialogController(
hgs
parents:
diff changeset
    58
        const QString &message,
hgs
parents:
diff changeset
    59
        HsMenuDialogFactory::Options options):
hgs
parents:
diff changeset
    60
    mDialog(HsMenuDialogFactory().create(message, options)),
hgs
parents:
diff changeset
    61
    mAcceptActionIndex(HsMenuDialogFactory::acceptActionIndex()),
hgs
parents:
diff changeset
    62
    mRejectActionIndex(HsMenuDialogFactory::rejectActionIndex())
hgs
parents:
diff changeset
    63
{
hgs
parents:
diff changeset
    64
}
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
/*!
hgs
parents:
diff changeset
    67
  \param dialog Instance of the dialog to be displayed.
hgs
parents:
diff changeset
    68
  Ownership of the dialog is taken by this object.
hgs
parents:
diff changeset
    69
  \param acceptActionIndex Index of an \a accept action in a dialog action list
hgs
parents:
diff changeset
    70
     Actions indices are 0 based. (\see QGraphicsWidget).
hgs
parents:
diff changeset
    71
  \param rejectActionIndex Index of a \a reject action in a dialog action list.
hgs
parents:
diff changeset
    72
  Actions indices are 0 based.(\see QGraphicsWidget).
hgs
parents:
diff changeset
    73
  Creates dialog controller instance with custom dialog type.
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
  */
hgs
parents:
diff changeset
    76
HsDialogController::HsDialogController(HbDialog *dialog,
hgs
parents:
diff changeset
    77
                                       int acceptActionIndex,
hgs
parents:
diff changeset
    78
                                       int rejectActionIndex):
hgs
parents:
diff changeset
    79
    mDialog(dialog),
hgs
parents:
diff changeset
    80
    mAcceptActionIndex(acceptActionIndex),
hgs
parents:
diff changeset
    81
    mRejectActionIndex(rejectActionIndex)
hgs
parents:
diff changeset
    82
{
hgs
parents:
diff changeset
    83
    Q_ASSERT(mDialog != NULL);
hgs
parents:
diff changeset
    84
    mDialog->setAttribute(Qt::WA_DeleteOnClose);
hgs
parents:
diff changeset
    85
}
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
/*!
hgs
parents:
diff changeset
    88
  Destroys controlled dialog.
hgs
parents:
diff changeset
    89
  */
hgs
parents:
diff changeset
    90
HsDialogController::~HsDialogController()
hgs
parents:
diff changeset
    91
{
hgs
parents:
diff changeset
    92
    QT_TRY {
hgs
parents:
diff changeset
    93
        mDialog->deleteLater();
hgs
parents:
diff changeset
    94
    } QT_CATCH (...) {
hgs
parents:
diff changeset
    95
    }
hgs
parents:
diff changeset
    96
}
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
/*!
hgs
parents:
diff changeset
   100
  \param entryId Id of the entry which removal will close the dialog.
hgs
parents:
diff changeset
   101
  Opens dialog.
hgs
parents:
diff changeset
   102
 */
hgs
parents:
diff changeset
   103
void HsDialogController::openDialog(int entryId)
hgs
parents:
diff changeset
   104
{
hgs
parents:
diff changeset
   105
    HsMenuEntryRemovedHandler *entryRemovedHandler =
hgs
parents:
diff changeset
   106
        new HsMenuEntryRemovedHandler(entryId, mDialog, SLOT(close()));
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
    QT_TRY {
hgs
parents:
diff changeset
   109
        // this object should be deleted when controlled dialog is deleted
hgs
parents:
diff changeset
   110
        setParent(mDialog);
hgs
parents:
diff changeset
   111
    } QT_CATCH (const std::bad_alloc &) {
hgs
parents:
diff changeset
   112
        delete entryRemovedHandler;
hgs
parents:
diff changeset
   113
        QT_RETHROW;
hgs
parents:
diff changeset
   114
    }
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
    mDialog->open(this, SLOT(onDialogFinished(HbAction*)));
hgs
parents:
diff changeset
   117
}
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
/*!
hgs
parents:
diff changeset
   120
  This slot closes dialog.
hgs
parents:
diff changeset
   121
  */
hgs
parents:
diff changeset
   122
void HsDialogController::dismissDialog()
hgs
parents:
diff changeset
   123
{
hgs
parents:
diff changeset
   124
    mDialog->close();
hgs
parents:
diff changeset
   125
}
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
/*!
hgs
parents:
diff changeset
   128
  \param action Identifies dialog's action.
hgs
parents:
diff changeset
   129
  Sends signals appropriate for \a action. Irrespective of the action,
hgs
parents:
diff changeset
   130
  always sends \a dialogCompleted signal.
hgs
parents:
diff changeset
   131
  */
hgs
parents:
diff changeset
   132
void HsDialogController::onDialogFinished(HbAction* action)
hgs
parents:
diff changeset
   133
{
hgs
parents:
diff changeset
   134
    mDialog->disconnect();
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
    const int actionIndex = mDialog->actions().indexOf(action);
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
    if (actionIndex == mAcceptActionIndex)
hgs
parents:
diff changeset
   139
    {
hgs
parents:
diff changeset
   140
        emit acceptActionTriggered(action);
hgs
parents:
diff changeset
   141
    } else if (actionIndex == mRejectActionIndex) {
hgs
parents:
diff changeset
   142
        emit rejectActionTriggered(action);
hgs
parents:
diff changeset
   143
    }
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
    emit dialogCompleted();
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
    mDialog->disconnect();
hgs
parents:
diff changeset
   148
}
hgs
parents:
diff changeset
   149
hgs
parents:
diff changeset
   150