1 /*

     2 * Copyright (c) 2009 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:  Public APIs of VmbxUiUtilities to internal class

    15 *  Interface   : Internal, MVmbxUiutilities

    16 *

    17 */

    18 

    19 

    20 #ifndef M_VMBXUIUTILITIES_H

    21 #define M_VMBXUIUTILITIES_H

    22 

    23 // INCLUDES

    24 #include <cvoicemailbox.h>

    25 

    26 // CLASS DECLARATION

    27 

    28 /**

    29  *  MVmbxUiUtilities

    30  *

    31  *  @since S60 v5.2

    32  *  @lib vmbxengine.lib

    33  *

    34  */

    35 NONSHARABLE_CLASS ( MVmbxUiUtilities )

    36     {

    37 

    38 public:

    39     /**

    40      * Show mailbox query

    41      *

    42      * @since S60 v5.2

    43      * @param in aType TVmbxType type

    44      * @param in aMode TVmbxQueryMode mode

    45      * @param out aNumber the voice mailbox number

    46      */

    47     virtual void ShowQueryL( const TVmbxType& aType,

    48                     const TVmbxQueryMode& aMode,

    49                     TDes& aNumber ) = 0;

    50 

    51     /**

    52      * Show mailbox query dialog

    53      * Leaves if user cancel selected.

    54      *

    55      * @since S60 v5.2

    56      * @param aType in TVmbxType type

    57      * @param aMode Tin VmbxQueryMode mode

    58      * @param aNumber the voice mailbox number

    59      * @param aResult out the result of dialog

    60      */

    61     virtual void ShowQueryDialogL( const TVmbxType& aType,

    62         const TVmbxQueryMode & aMode, TDes& aNumber, TInt& aResult ) = 0;

    63 

    64     /**

    65      * Show confirmation dialog when save number to phone

    66      *

    67      * @since S60 v5.2

    68      */

    69     virtual void ShowSaveToPhoneNote() = 0;

    70 

    71     /**

    72      * Show confirmation dialog when save number to SIM

    73      *

    74      * @since S60 v5.2

    75      */

    76     virtual void ShowSaveToSimNote() = 0;

    77 

    78     /**

    79      * Show confirmation dialog when save video number

    80      *

    81      * @since S60 v5.2

    82      */

    83     virtual void ShowVideoSavedNote() = 0;

    84 

    85     /**

    86      * Show define number in selection dialog

    87      * Leaves if user cancel selected.

    88      *

    89      * @since S60 v5.2

    90      * @param in aType vmbx type

    91      * @param out aResult the result of dialog

    92      */

    93     virtual void ShowDefineSelectionDialogL( TVmbxType& aType, TInt& aResult ) = 0;

    94 

    95     /**

    96      * Show call number in selection dialog

    97      * Leaves if user cancel selected.

    98      *

    99      * @since S60 v5.2

   100      * @param in aArray array of the defined voice mailbox entry

   101      * @param in aIcons icons of the defined voice mailbox

   102      * @param out aParams the type TVoiceMailboxParams which should include

   103      *          the service id and the type of seclected TVmbxType

   104      * @param out aResult the result user seclected

   105      */

   106     virtual void ShowCallSelectionDialogL( 

   107                 const RPointerArray<CVoiceMailboxEntry>& aArray, 

   108                // CArrayPtr<CGulIcon>* aIcons,

   109                     TVoiceMailboxParams& aParams, TInt& aResult ) = 0;

   110 

   111     /**

   112      * Tries to close all open dialogs

   113      *

   114      * @since S60 v5.2

   115      */

   116     virtual void DismissDialogL() = 0;

   117 

   118     /**

   119      * To get mailbox entry value

   120      * Leaves with Symbian OS error code

   121      *

   122      * @since S60 v5.2

   123      * @param aType TVmbxType type

   124      */

   125     virtual void ShowSaveEmptyNoteL( const TVmbxType& aType ) = 0;

   126 

   127     /**

   128      * Get Mailbox type default image.

   129      * If get unseccessful, Leaves with Symbian OS error code

   130      * 

   131      * @since S60 v5.2

   132      * @param aParams Mailbox type for which image is needed.

   133      * @return aImage New image. Ownership is transferred.

   134      */

   135     //virtual CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams ) = 0;

   136 

   137     /**

   138      * Show error dialog

   139      *

   140      * @since S60 v5.2

   141      */

   142     virtual void ShowErrorDialogL() = 0;

   143 

   144     /**

   145      * Show Invalid Warning dialog.

   146      *

   147      * @since S60 v5.2

   148      */

   149     virtual void ShowInvalidWarningDialogL() = 0;

   150     };

   151 

   152 #endif // M_VMBXUIUTILITIES_H