|
1 /* |
|
2 * Copyright (c) 2006-2007 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: ECom search interface definition |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 #ifndef _C_CNOTESSEARCHPLUGINUTILS_H |
|
22 #define _C_CNOTESSEARCHPLUGINUTILS_H |
|
23 |
|
24 //SYSTEM INCLUDES |
|
25 #include <e32base.h> |
|
26 |
|
27 |
|
28 /** |
|
29 * This class is the utility calss for the notes plugin |
|
30 * |
|
31 * This class contains utility functions for searching the notes |
|
32 * |
|
33 * @lib notessearchplugin.lib |
|
34 */ |
|
35 class CNotesSearchPluginUtils : public CBase |
|
36 { |
|
37 public: |
|
38 |
|
39 /** |
|
40 * constructor |
|
41 * |
|
42 */ |
|
43 CNotesSearchPluginUtils(); |
|
44 |
|
45 /** |
|
46 * destructor |
|
47 * |
|
48 */ |
|
49 |
|
50 ~CNotesSearchPluginUtils(); |
|
51 |
|
52 /** |
|
53 * This function sets the content key |
|
54 * |
|
55 * |
|
56 * @param aContentKey - key value |
|
57 */ |
|
58 void SetContentKeyL( const TDesC8& aContentKey ); |
|
59 |
|
60 /** |
|
61 * This function sets the content key |
|
62 * |
|
63 * |
|
64 * @param aKeyintvalue - key value |
|
65 */ |
|
66 void SetContentKeyInt( const TInt & aKeyintvalue ); |
|
67 |
|
68 /** |
|
69 * This function sets the keyword position |
|
70 * |
|
71 * |
|
72 * @param aKeywordPos - keyword position |
|
73 */ |
|
74 void SetKeywordPosition(const TInt& aKeywordPos ); |
|
75 |
|
76 /** |
|
77 * This function returns the content key value |
|
78 * |
|
79 * |
|
80 */ |
|
81 HBufC8* ContentKey( ); |
|
82 |
|
83 /** |
|
84 * This function returns the content key value |
|
85 * |
|
86 * |
|
87 */ |
|
88 TInt ContentKeyInt( ); |
|
89 |
|
90 /** |
|
91 * This function Gives the KeyWordPosition for Snippet Creation |
|
92 * |
|
93 * |
|
94 */ |
|
95 TInt KeywordPosition( ); |
|
96 |
|
97 private: //Data memebers |
|
98 /** |
|
99 * The Content key |
|
100 * Own |
|
101 */ |
|
102 HBufC8* iContentKey; |
|
103 |
|
104 /** |
|
105 * The content key |
|
106 */ |
|
107 TInt iContentKeyInt; |
|
108 |
|
109 /** |
|
110 * The keyword position |
|
111 */ |
|
112 TInt iKeywordPosition; |
|
113 |
|
114 }; |
|
115 |
|
116 |
|
117 |
|
118 class PluginResourceReader //Not intent for derivation |
|
119 { |
|
120 public: |
|
121 /** |
|
122 * This function reads text from resource file |
|
123 * |
|
124 * |
|
125 */ |
|
126 HBufC8* GetTextFromResourceL( TInt aResourceId , const TDesC& aResourecFilePath ); |
|
127 }; |
|
128 |
|
129 |
|
130 |
|
131 #endif // _C_CNOTESSEARCHPLUGINUTILS_H |
|
132 |
|
133 |