|
1 /* |
|
2 * Copyright (c) 2008 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: Client side interface of ATEXT common functionality |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef R_ATEXTCOMMON_H |
|
20 #define R_ATEXTCOMMON_H |
|
21 |
|
22 #include <e32base.h> |
|
23 #include <atextcommonbase.h> |
|
24 |
|
25 /** |
|
26 * Client side interface of ATEXT common functionality |
|
27 * |
|
28 * @lib atextcommon.lib |
|
29 * @since S60 v5.0 |
|
30 */ |
|
31 NONSHARABLE_CLASS( RATExtCommon ) : public RSessionBase |
|
32 { |
|
33 |
|
34 public: |
|
35 |
|
36 /** |
|
37 * Connects to ATEXT server and creates a new session |
|
38 * |
|
39 * @since S60 5.0 |
|
40 * @param aName Connection identifier name |
|
41 * @return Symbian error code on error, KErrNone otherwise |
|
42 */ |
|
43 IMPORT_C TInt Connect( const TDesC8& aName ); |
|
44 |
|
45 /** |
|
46 * Synchronously closes the session |
|
47 * Optional: client can do either Close() or SynchronousClose()+Close() |
|
48 * |
|
49 * @since S60 v5.0 |
|
50 * @return Symbian error code on error, KErrNone otherwise |
|
51 */ |
|
52 IMPORT_C TInt SynchronousClose(); |
|
53 |
|
54 /** |
|
55 * Gets current mode status |
|
56 * |
|
57 * @since S60 5.0 |
|
58 * @param aMode Current mode (see explanation in atextcommonbase.h) |
|
59 * @param aMask Mask for current mode |
|
60 * @return Symbian error code on error, KErrNone otherwise |
|
61 */ |
|
62 IMPORT_C TInt GetMode( TUint& aMask, TUint& aMode ); |
|
63 |
|
64 /** |
|
65 * Receives mode status change |
|
66 * |
|
67 * @since S60 5.0 |
|
68 * @param aStatus The request status |
|
69 * @param aMode Current mode (see explanation in atextcommonbase.h) |
|
70 * This must be of type TPckgBuf<TUint> |
|
71 * @return Symbian error code on error, KErrNone otherwise |
|
72 */ |
|
73 IMPORT_C TInt ReceiveModeStatusChange( TRequestStatus& aStatus, |
|
74 TPckg<TUint>& aMode ); |
|
75 |
|
76 /** |
|
77 * Cancels a pending receiving request |
|
78 * |
|
79 * @since S60 5.0 |
|
80 * @return Symbian error code on error, KErrNone otherwise |
|
81 */ |
|
82 IMPORT_C TInt CancelReceiveModeStatusChange(); |
|
83 |
|
84 /** |
|
85 * Gets current NVRAM status |
|
86 * |
|
87 * @since S60 5.0 |
|
88 * @param aNvram Current NVRAM status. The current settings |
|
89 * (delimited by "|") must differ from the Hayes |
|
90 * defaults. |
|
91 * @return Symbian error code on error, KErrNone otherwise |
|
92 */ |
|
93 IMPORT_C TInt GetNvramStatus( TBuf8<KDefaultNvramBufLength>& aNvram ); |
|
94 |
|
95 /** |
|
96 * Receives NVRAM status change |
|
97 * |
|
98 * @since S60 5.0 |
|
99 * @param aStatus The request status |
|
100 * @param aNvram New NVRAM status. The new settings (delimited by "|") |
|
101 * must differ from the defaults. |
|
102 * @return Symbian error code on error, KErrNone otherwise |
|
103 */ |
|
104 IMPORT_C TInt ReceiveNvramStatusChange( TRequestStatus& aStatus, |
|
105 TBuf8<KDefaultNvramBufLength>& aNvram ); |
|
106 |
|
107 /** |
|
108 * Cancels a pending NVRAM receive request |
|
109 * |
|
110 * @since S60 5.0 |
|
111 * @return Symbian error code on error, KErrNone otherwise |
|
112 */ |
|
113 IMPORT_C TInt CancelReceiveNvramStatusChange(); |
|
114 |
|
115 }; |
|
116 |
|
117 #endif // R_ATEXTCOMMON_H |