1 /*

     2 * Copyright (c) 2002 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:  UI Call Back Interface for login,logout

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MCAUILOGINCMDCB_H

    21 #define MCAUILOGINCMDCB_H

    22 

    23 //  INCLUDES

    24 #include <e32std.h>

    25 

    26 

    27 // FORWARD DECLARATIONS

    28 class MIMPSConnProcessUi;

    29 class TPEngWVCspServicesTree2;

    30 // CLASS DECLARATION

    31 

    32 /**

    33 *  UI Call Back Interface for login,logout

    34 */

    35 class MCAUiLoginCmdCB

    36     {

    37     public:// Enums

    38 

    39         /**

    40          * Use to ask if cmd is for login ,logout or exit

    41          * ELogin:  Login

    42          * ELogout: Logout

    43          * EExit: Exit

    44          */

    45 

    46         enum TLoginParams

    47             {

    48             ELogin = 0,

    49             ELogout,

    50             EQueryLogin,

    51             EExit

    52 

    53             };

    54 

    55 

    56     public:

    57         /**

    58         * Used by the command to check if it is a login,logout or exit command

    59         * @param aLoginParams is set with enum value for login or logout or exit

    60         */

    61         virtual void GetParameters( TLoginParams& aLoginParams ) = 0;

    62 

    63         /**

    64         * Updates status pane icon according to session state

    65         * @param aLandscapeOnly If ETrue, set the icons only in landscape mode

    66         */

    67         virtual void SetStatusPaneIconsL( TBool aLandscapeOnly = EFalse ) = 0;

    68 

    69         /**

    70         * Changes UI brand for selected logged in server

    71         * @since 2.1

    72         * @param aRefreshView Refresh current view after changing brand.

    73         *                     This closes dialogs so make sure that no dialogs

    74         *                     are open when this is called with ETrue

    75         * @param aServerName  If given, then branding will be done based on

    76                               given server, otherwise current server will be

    77                               retrieved from connectionUI/SAPSettingsStore

    78         * return Did branding actually change anything.

    79         */

    80         virtual TBool BrandUIL( TBool aRefreshView = ETrue,

    81                                 const TDesC& aServerName = KNullDesC ) = 0;

    82 

    83         /**

    84          * Shows Post Login Notes if not always online case

    85          * @param aCurrentLoginIsFirst is true if the current login is first login

    86          * @param aManualLogin is true if login is manual else false

    87          */

    88         virtual void ShowPostLoginNotesL ( TBool aCurrentLoginIsFirst,

    89                                            TBool aManualLogin ) = 0;

    90 

    91         /**

    92          * Asks alias and updates presence, etc.

    93          */

    94         virtual void AskAliasL() = 0;

    95 

    96         /**

    97         * Refreshes current view

    98         * @since 2.1

    99         * @return ETrue, if refresh view launched. EFalse if not.

   100         */

   101         virtual TBool RefreshCurrentViewL() = 0;

   102 

   103 

   104         /**

   105         * Checks if there is default server information available, and launches

   106         * server-query, if not.

   107         * @param aShowNote If ETrue, show an error note in error situations

   108         * @return Tells if server information is available after call

   109         */

   110         virtual TBool CheckCurrentServerDataL(

   111             TBool aShowNote = ETrue ) = 0;

   112 

   113         /**

   114         * Notifes observer from SAP access events.

   115         * (Connection UI is logging into or logging

   116         * out from certain network server.)

   117         * @see MIMPSConnProcessUi.

   118         *

   119         * @since 2.1

   120         * @param aServerName The accessed server name.

   121         * @param aServerURL The accessed server URL.

   122         * @param aConnProcessUi Connection process UI.

   123         * If connection process is executed in environment

   124         * which doesn't have UI, aConnProcessUi is NULL.

   125         * Else aConnProcessUi is a valid pointer to

   126         * Connection Process UI interface.

   127         */

   128         //Callback from Command Session Handler

   129 

   130         virtual void HandleSapAccessEventEventL( const TDesC& aServerName,

   131                                                  const TDesC& aServerURL,

   132                                                  MIMPSConnProcessUi* aConnProcessUi ) = 0;

   133         /**

   134          * @return iCancelLogin value

   135          */

   136         virtual TBool CancelLoginValue() = 0;

   137 

   138 

   139         /**

   140         * Clears Universal Indication Pane's IM-icon

   141         */

   142         virtual void IMUIPIConForcedClear() = 0;

   143 

   144         /**

   145          * Closes all open dialogs on forced logout.

   146          */

   147         virtual void ShutDialogsL() = 0;

   148 

   149         /**

   150          * Capture events if needed

   151          */

   152         virtual void CaptureEventsL() = 0;

   153 

   154         /**

   155          * Releases events capturing

   156          */

   157         virtual void ReleaseCapturingL() = 0;

   158 

   159         /**

   160          * Refresh View After Login

   161          */

   162         virtual void RefreshViewAfterLoginL() = 0;

   163 

   164         /**

   165          * Shows wait dialog. Remember to call CleanupStack::Pop and DismissWaitDialogL

   166          * after this! Call CleanupStack::Pop first. Leaves one item in cleanup stack.

   167          * @param aTextResource Resource ID of text to be displayed

   168          * @param aShowImmediately Should the dialog be shown immediately

   169          */

   170         virtual void ShowProcessingNoteLC() = 0;

   171 

   172 

   173         /**

   174          * DismissProcessingNoteL . Remember to call DismissWaitDialogL

   175          * @param aError error to show

   176          */

   177         virtual void DismissProcessingNoteL( TInt aError, TBool aValue ) = 0 ;

   178 

   179         /**

   180          * Finalize construction of chat

   181          * @since 3.0

   182          */

   183         virtual void FinalizeChatConstructionL() = 0;

   184 

   185         /**

   186          * Sets the ImpsServices on UISessionManager by SessionHandler Cmd

   187          * @param aImpsServices - the Supported IMPS services

   188          * @param aBrandUIFlag - if true BrandUIL fn would be called else not

   189          * @param aRefreshFlag - if true refreshing of the view would be done in BrandUIL() else not

   190          */

   191         virtual void SetIMPSServices( TPEngWVCspServicesTree2 aImpsServices,

   192                                       TBool aBrandUIFlag = EFalse,

   193                                       TBool aRefreshFlag = EFalse ) = 0 ;

   194 

   195 

   196 

   197 

   198     };

   199 

   200 #endif      // MCAUILOGINCMDCB_H

   201 

   202 // End of File