vmbx/vmbxengine/inc/mvmbxuiutilities.h
branchRCL_3
changeset 20 987c9837762f
parent 19 7d48bed6ce0c
child 21 0a6dd2dc9970
equal deleted inserted replaced
19:7d48bed6ce0c 20:987c9837762f
     1 /*
       
     2 * Copyright (c) 2009-2010 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 #include "voicemailboxdefsinternal.h"
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30  *  MVmbxUiUtilities
       
    31  *
       
    32  *  @lib vmbxengine.lib
       
    33  *
       
    34  */
       
    35 NONSHARABLE_CLASS ( MVmbxUiUtilities )
       
    36     {
       
    37 
       
    38 public:
       
    39     /**
       
    40      * Show mailbox query
       
    41      *
       
    42      * @param in aType TVmbxType type
       
    43      * @param in aMode TVmbxQueryMode mode
       
    44      * @param out aNumber the voice mailbox number
       
    45      */
       
    46     virtual void ShowQueryL( const TVmbxType& aType,
       
    47                     const TVmbxQueryMode& aMode,
       
    48                     TDes& aNumber ) = 0;
       
    49 
       
    50     /**
       
    51      * Show mailbox query dialog
       
    52      * Leaves if user cancel selected.
       
    53      *
       
    54      * @param aType in TVmbxType type
       
    55      * @param aMode Tin VmbxQueryMode mode
       
    56      * @param aNumber the voice mailbox number
       
    57      * @param aResult out the result of dialog
       
    58      */
       
    59     virtual void ShowQueryDialogL( const TVmbxType& aType,
       
    60         const TVmbxQueryMode & aMode, TDes& aNumber, TInt& aResult ) = 0;
       
    61 
       
    62     /**
       
    63      * Show informationd note
       
    64      *
       
    65      * @param aType in TVmbxNoteType type
       
    66      */
       
    67     virtual void ShowInformationdNoteL(const TVmbxNoteType aType) = 0;
       
    68 
       
    69 
       
    70     /**
       
    71      * Show define number in selection dialog
       
    72      *
       
    73      * @param in aType vmbx type
       
    74      * @param out aResult the result of dialog
       
    75      */
       
    76     virtual void ShowDefineSelectionDialogL( TVmbxType& aType, TInt& aResult ) = 0;
       
    77 
       
    78     /**
       
    79      * Show call number in selection dialog
       
    80      * Leaves if user cancel selected.
       
    81      *
       
    82      * @param in aArray array of the defined voice mailbox entry
       
    83      * @param in aIcons icons of the defined voice mailbox
       
    84      * @param out aParams the type TVoiceMailboxParams which should include
       
    85      *          the service id and the type of seclected TVmbxType
       
    86      * @param out aResult the result user seclected
       
    87      */
       
    88     virtual void ShowCallSelectionDialogL( 
       
    89                 const RPointerArray<CVoiceMailboxEntry>& aArray, 
       
    90                     TVoiceMailboxParams& aParams, TInt& aResult ) = 0;
       
    91 
       
    92     /**
       
    93      * Tries to close all open dialogs
       
    94      *
       
    95      */
       
    96     virtual void DismissDialogL() = 0;
       
    97 
       
    98 
       
    99     /**
       
   100      * Get Mailbox type default image.
       
   101      * If get unseccessful, Leaves with Symbian OS error code
       
   102      * 
       
   103      * @param aParams Mailbox type for which image is needed.
       
   104      * @return aImage New image. Ownership is transferred.
       
   105      */
       
   106     //virtual CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams ) = 0;
       
   107 
       
   108     /**
       
   109      * Show not allowed editing dialog
       
   110      *
       
   111      */
       
   112     virtual void ShowNotAllowedEditingDialogL() = 0;
       
   113 
       
   114     /**
       
   115      * Show Invalid Warning dialog.
       
   116      *
       
   117      */
       
   118     virtual void ShowInvalidWarningDialogL() = 0;
       
   119     };
       
   120 
       
   121 #endif // M_VMBXUIUTILITIES_H