localconnectivityservice/dun/utils/inc/DunNoteHandler.h
author hgs
Fri, 25 Jun 2010 16:54:01 +0800
changeset 29 3ae5cb0b4c02
child 35 c4c427c00f31
permissions -rw-r--r--
201025_07
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     1
/*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     3
* All rights reserved.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     8
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     9
* Initial Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    11
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    12
* Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    13
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    14
* Description:  Manages note showing in UI
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    15
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    16
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    17
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    18
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    19
#ifndef C_CDUNNOTEHANDLER_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    20
#define C_CDUNNOTEHANDLER_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    21
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    22
#include <e32base.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    23
#include <hbdevicemessageboxsymbian.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    24
#include "DunTransporter.h"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    25
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    26
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    27
 *  Class for managing note showing in UI
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    28
 *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    29
 *  @lib dunutils.lib
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    30
 *  @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    31
 */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    32
NONSHARABLE_CLASS( CDunNoteHandler ) : public CBase,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    33
                                       public MHbDeviceMessageBoxObserver
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    34
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    35
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    36
public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    37
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    38
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    39
     * Two-phased constructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    40
     * @return Instance of self
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    41
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    42
	static CDunNoteHandler* NewL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    43
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    44
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    45
    * Destructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    46
    */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    47
    virtual ~CDunNoteHandler();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    48
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    49
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    50
     * Resets data to initial values
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    51
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    52
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    53
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    54
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    55
    void ResetData();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    56
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    57
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    58
     * Issues request to start showing UI note
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    59
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    60
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    61
     * @return Symbian error code on error, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    62
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    63
    TInt IssueRequest();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    64
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    65
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    66
     * Stops showing UI note
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    67
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    68
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    69
     * @return Symbian error code on error, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    70
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    71
    TInt Stop();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    72
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    73
private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    74
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    75
    CDunNoteHandler();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    76
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    77
    void ConstructL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    78
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    79
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    80
     * Initializes this class
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    81
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    82
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    83
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    84
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    85
    void Initialize();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    86
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    87
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    88
     * Issues request to start showing UI note
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    89
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    90
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    91
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    92
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    93
    void DoIssueRequestL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    94
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    95
// from base class MHbDeviceMessageBoxObserver
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    96
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    97
	// TODO: ADD DESCRIPTION HERE!
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    98
    void MessageBoxClosed( const CHbDeviceMessageBoxSymbian* aMessageBox,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    99
                           CHbDeviceMessageBoxSymbian::TButtonId aButton );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   100
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   101
private:  // data
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   102
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   103
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   104
     * Note to show
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   105
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   106
    CHbDeviceMessageBoxSymbian* iNote;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   107
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   108
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   109
     * Current state of note showing: active or inactive
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   110
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   111
    TDunState iNoteState;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   112
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   113
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   114
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   115
#endif  // C_CDUNNOTEHANDLER_H