devicediagnosticsfw/diagframework/inc/diagcommondialog.h
branchRCL_3
changeset 26 19bba8228ff0
parent 0 b497e44ab2fc
equal deleted inserted replaced
25:b183ec05bd8c 26:19bba8228ff0
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  List of common dialog types
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGCOMMONDIALOG_H
       
    20 #define DIAGCOMMONDIALOG_H
       
    21 
       
    22 
       
    23 /**
       
    24 *  Diagnostics Common Dialog Types
       
    25 *
       
    26 *  This is a list of common dialogs that can be used by plug-ins.
       
    27 * 
       
    28 */
       
    29 enum TDiagCommonDialog
       
    30     {
       
    31     /**
       
    32     * EDiagCommonDialogConfirmCancelAll
       
    33     * Dialog that asks the user if all tests should be cancelled or not.
       
    34     *
       
    35     * aInitData:       No init data needed.  Always pass NULL.
       
    36     * Return:          Standard dialog.  Use CAknDialog.
       
    37     * Execution:       Call RunLD().
       
    38     * RunLD() returns: - EAknSoftkeyYes, if the user confirmed the request to
       
    39     *                    cancel all test execution.  Plugins should not do
       
    40     *                    any further execution and should return immediately.
       
    41     *                  - EAknSoftkeyNo, if the user dismissed the dialog and
       
    42     *                    decided not to cancel all test execution.
       
    43     *                  - 0, if the dialog is forced closed.  Generally,
       
    44     *                    plugins should not distinguish between EAknSoftkeyNo
       
    45     *                    and 0 (i.e., they should *only* check for
       
    46     *                    EAknSoftkeyYes), unless there is good reason to.
       
    47     *
       
    48     * @code
       
    49     *
       
    50     *    CAknDialog* dlg = ExecutionParam().Engine().CreateCommonDialogLC(
       
    51     *        EDiagCommonDialogConfirmCancelAll,
       
    52     *        NULL );
       
    53     *
       
    54     *    TInt result = 0;
       
    55     *    if ( !RunWaitingDialogL( dlg, result ) ||
       
    56     *         result == EAknSoftkeyYes )
       
    57     *        {
       
    58     *        // Do not continue executing.  Either the dialog has been deleted
       
    59     *        // or the user has cancelled all execution.
       
    60     *        return;
       
    61     *        }
       
    62     *
       
    63     *    dlg = NULL;
       
    64     *
       
    65     *    // Loop and display the plugin query again.
       
    66     *    askAgain = ETrue;
       
    67     *
       
    68     */
       
    69     EDiagCommonDialogConfirmCancelAll = 1,
       
    70     EDiagCommonDialogConfirmSkipAll =2
       
    71     };
       
    72 
       
    73 #endif // DIAGCOMMONDIALOG_H
       
    74 
       
    75 // End of File
       
    76