author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 2 | 2fe1408b6811 |
permissions | -rw-r--r-- |
2
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
1 |
/* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
2 |
* Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
3 |
* All rights reserved. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
4 |
* This component and the accompanying materials are made available |
4
837f303aceeb
Current Symbian^3 public API header files (from PDK 3.0.h)
William Roberts <williamr@symbian.org>
parents:
2
diff
changeset
|
5 |
* under the terms of "Eclipse Public License v1.0" |
2
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
6 |
* which accompanies this distribution, and is available |
4
837f303aceeb
Current Symbian^3 public API header files (from PDK 3.0.h)
William Roberts <williamr@symbian.org>
parents:
2
diff
changeset
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
2
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
8 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
9 |
* Initial Contributors: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
10 |
* Nokia Corporation - initial contribution. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
11 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
12 |
* Contributors: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
13 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
14 |
* Description: CPosLmCategoryManager class |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
15 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
16 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
17 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
18 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
19 |
#ifndef CPOSLMCATEGORYMANAGER_H |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
20 |
#define CPOSLMCATEGORYMANAGER_H |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
21 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
22 |
#include <e32base.h> |
4
837f303aceeb
Current Symbian^3 public API header files (from PDK 3.0.h)
William Roberts <williamr@symbian.org>
parents:
2
diff
changeset
|
23 |
#include "EPos_CPosLandmarkDatabase.h" |
837f303aceeb
Current Symbian^3 public API header files (from PDK 3.0.h)
William Roberts <williamr@symbian.org>
parents:
2
diff
changeset
|
24 |
#include "EPos_CPosLandmarkCategory.h" |
837f303aceeb
Current Symbian^3 public API header files (from PDK 3.0.h)
William Roberts <williamr@symbian.org>
parents:
2
diff
changeset
|
25 |
#include "EPos_CPosLmItemIterator.h" |
837f303aceeb
Current Symbian^3 public API header files (from PDK 3.0.h)
William Roberts <williamr@symbian.org>
parents:
2
diff
changeset
|
26 |
#include "EPos_CPosLmOperation.h" |
2
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
27 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
28 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
29 |
* Category management for a landmark database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
30 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
31 |
* A landmark database can contain a number of categories which can be |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
32 |
* assigned to the landmarks in the database. A landmark can be associated |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
33 |
* with multiple categories, e.g. a landmark can be a "Restaurant" and a "Pub". |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
34 |
* Categories also enable filtered searches, e.g. a client could search for |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
35 |
* nearby restaurants. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
36 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
37 |
* This class contains functions for managing landmark categories. This includes |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
38 |
* reading, listing, creating and updating landmark categories. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
39 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
40 |
* @p NetworkServices capability is required for remote databases. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
41 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
42 |
* @lib eposlandmarks.lib |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
43 |
* @since S60 3.0 |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
44 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
45 |
class CPosLmCategoryManager : public CBase |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
46 |
{ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
47 |
public: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
48 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
49 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
50 |
* Specifies the sort preference for landmark categories. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
51 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
52 |
enum TCategorySortPref |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
53 |
{ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
54 |
ECategorySortOrderNone = 0 /**< |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
55 |
Categories not sorted */, |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
56 |
ECategorySortOrderNameAscending /**< |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
57 |
Sorted ascending by category name. */, |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
58 |
ECategorySortOrderNameDescending /**< |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
59 |
Sorted descending by category name. */ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
60 |
}; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
61 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
62 |
public: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
63 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
64 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
65 |
* Two-phased constructor. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
66 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
67 |
* The client takes ownership of the category manager. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
68 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
69 |
* @param[in] aLandmarkDatabase The landmark database to manage categories in. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
70 |
* @returns A new instance of this class. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
71 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
72 |
IMPORT_C static CPosLmCategoryManager* NewL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
73 |
CPosLandmarkDatabase& aLandmarkDatabase |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
74 |
); |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
75 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
76 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
77 |
* Destructor. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
78 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
79 |
IMPORT_C virtual ~CPosLmCategoryManager(); |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
80 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
81 |
public: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
82 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
83 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
84 |
* Reads a landmark category from the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
85 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
86 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
87 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
88 |
* The client takes ownership of the returned category object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
89 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
90 |
* This function requires @p ReadUserData capability. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
91 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
92 |
* @param aCategoryId The ID of the landmark category to read. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
93 |
* @returns The requested landmark category. The category object is put |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
94 |
* on the cleanup stack. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
95 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
96 |
* @leave KErrNotFound The landmark category does not exist in the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
97 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
98 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
99 |
virtual CPosLandmarkCategory* ReadCategoryLC( TPosLmItemId aCategoryId ) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
100 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
101 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
102 |
* Returns an object for iterating the landmark categories in the |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
103 |
* database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
104 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
105 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
106 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
107 |
* The iterator object is reset, so that the first |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
108 |
* @ref CPosLmItemIterator::NextL call will return the first landmark |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
109 |
* category. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
110 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
111 |
* The client takes ownership of the returned iterator object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
112 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
113 |
* This function requires @p ReadUserData capability. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
114 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
115 |
* @param[in] aSortPref How to sort the categories. Default is no sorting. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
116 |
* @return The landmark iterator. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
117 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
118 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
119 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
120 |
* @panic "Landmarks Client"-EPosInvalidEnumValue |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
121 |
* Client specified invalid sort preference. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
122 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
123 |
virtual CPosLmItemIterator* CategoryIteratorL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
124 |
TCategorySortPref aSortPref = ECategorySortOrderNone |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
125 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
126 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
127 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
128 |
* Returns an object for iterating referenced landmark categories in |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
129 |
* the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
130 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
131 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
132 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
133 |
* A category is referenced if there are landmarks in the database which |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
134 |
* contains this category. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
135 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
136 |
* The iterator object is reset, so that the first |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
137 |
* @ref CPosLmItemIterator::NextL call will return the first landmark |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
138 |
* category. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
139 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
140 |
* The client takes ownership of the returned iterator object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
141 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
142 |
* This function requires @p ReadUserData capability. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
143 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
144 |
* @param[in] aSortPref How to sort the categories. Default is no sorting. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
145 |
* @return The landmark iterator. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
146 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
147 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
148 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
149 |
* @panic "Landmarks Client"-EPosInvalidEnumValue |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
150 |
* Client specified invalid sort preference. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
151 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
152 |
virtual CPosLmItemIterator* ReferencedCategoryIteratorL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
153 |
TCategorySortPref aSortPref = ECategorySortOrderNone |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
154 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
155 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
156 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
157 |
* Adds a landmark category to the database and returns its ID. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
158 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
159 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
160 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
161 |
* Note: Clients are not allowed to create global categories. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
162 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
163 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
164 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
165 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
166 |
* @post Category is added to the database and category object |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
167 |
* has database item set (CPosLandmarkCategory::CategoryId()). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
168 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
169 |
* @param[in,out] aCategory The landmark category to add. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
170 |
* @return The ID of the new category. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
171 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
172 |
* @leave KErrArgument 1) Input category does not have a name set or |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
173 |
* 2) if a global category is set in the category object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
174 |
* @leave KErrAlreadyExists A category with the same name |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
175 |
* already exists in the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
176 |
* @leave KErrAccessDenied The database is read-only. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
177 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
178 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
179 |
virtual TPosLmItemId AddCategoryL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
180 |
CPosLandmarkCategory& aCategory |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
181 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
182 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
183 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
184 |
* Updates a landmark category in the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
185 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
186 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
187 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
188 |
* Note: Clients are not allowed to change the global category identifier in |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
189 |
* the category object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
190 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
191 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
192 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
193 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
194 |
* @param[in] aCategory The new landmark category data. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
195 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
196 |
* @leave KErrArgument 1) Input category does not have a name set or |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
197 |
* 2) if a global category identifier is changed in the category object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
198 |
* @leave KErrAlreadyExists A category with the same name |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
199 |
* already exists in the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
200 |
* @leave KErrAccessDenied The database is read-only. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
201 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
202 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
203 |
virtual void UpdateCategoryL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
204 |
const CPosLandmarkCategory& aCategory |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
205 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
206 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
207 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
208 |
* Removes a landmark category from the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
209 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
210 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
211 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
212 |
* If the landmark category does not exist in the database, nothing |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
213 |
* happens. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
214 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
215 |
* This call will also remove the category from all landmarks which |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
216 |
* contained it. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
217 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
218 |
* The function returns an operation object which can be run in either |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
219 |
* synchronous or asynchronous mode. If it is run in asynchronous mode |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
220 |
* the client can supervise the progress of the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
221 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
222 |
* If the @ref CPosLmOperation object is deleted before the operation |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
223 |
* is complete, it is possible that the category has not been removed, |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
224 |
* but some landmarks may no longer contain this category |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
225 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
226 |
* The client takes ownership of the returned operation object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
227 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
228 |
* While removing the category, this operation will acquire a |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
229 |
* write-lock on the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
230 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
231 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
232 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
233 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
234 |
* @param aCategoryId The ID of the landmark category to delete. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
235 |
* @returns A handle to the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
236 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
237 |
* @leave KErrAccessDenied The database is read-only. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
238 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
239 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
240 |
virtual CPosLmOperation* RemoveCategoryL( TPosLmItemId aCategoryId ) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
241 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
242 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
243 |
* Remove a set of landmark categories from the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
244 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
245 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
246 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
247 |
* If any of the landmark categories does not exist in the database, it |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
248 |
* is ignored. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
249 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
250 |
* This call will also remove the categories from all landmarks which |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
251 |
* contained them. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
252 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
253 |
* The function returns an operation object which can be run in either |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
254 |
* synchronous or asynchronous mode. If it is run in asynchronous mode |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
255 |
* the client can supervise the progress of the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
256 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
257 |
* If the @ref CPosLmOperation object is deleted before the operation |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
258 |
* is complete, it is possible that only a subset of the landmark |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
259 |
* categories have been deleted. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
260 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
261 |
* The client takes ownership of the returned operation object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
262 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
263 |
* If the database is read only, the returned operation will fail with error |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
264 |
* code @p KErrAccessDenied. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
265 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
266 |
* This call will also remove the categories from all landmarks which |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
267 |
* contained them. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
268 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
269 |
* While removing the category, this operation will acquire a |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
270 |
* write-lock on the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
271 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
272 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
273 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
274 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
275 |
* @param aCategoryIdArray The IDs of the landmark categories to delete. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
276 |
* @returns A handle to the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
277 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
278 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
279 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
280 |
virtual CPosLmOperation* RemoveCategoriesL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
281 |
const RArray<TPosLmItemId>& aCategoryIdArray |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
282 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
283 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
284 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
285 |
* Adds a category to a set of landmarks. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
286 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
287 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
288 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
289 |
* If any of the specified landmarks does not exist, the category will |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
290 |
* be added to the other landmarks. No error will be reported though. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
291 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
292 |
* If the category is already contained in one of the landmarks, nothing |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
293 |
* will be further added to that landmark. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
294 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
295 |
* The function returns an operation object which can be run in either |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
296 |
* synchronous or asynchronous mode. If it is run in asynchronous mode |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
297 |
* the client can supervise the progress of the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
298 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
299 |
* If the @ref CPosLmOperation object is deleted before the operation |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
300 |
* is complete, it is possible that the category has only been added |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
301 |
* to a subset of the landmarks. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
302 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
303 |
* The client takes ownership of the returned operation object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
304 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
305 |
* Note: There is no need to call |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
306 |
* @p CPosLandmarkDatabase::UpdateLandmark for this change to take |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
307 |
* place. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
308 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
309 |
* If the database is read only, the returned operation will fail with error |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
310 |
* code @p KErrAccessDenied. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
311 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
312 |
* While adding the category to the landmarks, this operation will |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
313 |
* acquire a write-lock on the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
314 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
315 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
316 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
317 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
318 |
* @param[in] aCategoryId The category to add to the set of landmarks. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
319 |
* @param[in] aLandmarkIdArray The landmarks to add the category to. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
320 |
* @returns A handle to the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
321 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
322 |
* @leave KErrNotFound The specified category does not exist in database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
323 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
324 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
325 |
virtual CPosLmOperation* AddCategoryToLandmarksL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
326 |
TPosLmItemId aCategoryId, |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
327 |
RArray<TPosLmItemId>& aLandmarkIdArray |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
328 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
329 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
330 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
331 |
* Removes a category from a set of landmarks. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
332 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
333 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
334 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
335 |
* If any of the specified landmarks does not exist, the category will |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
336 |
* be removed from the other landmarks. No error will be reported though. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
337 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
338 |
* If the category is not found in one of the landmarks, nothing will |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
339 |
* happen for that landmark. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
340 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
341 |
* The function returns an operation object which can be run in either |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
342 |
* synchronous or asynchronous mode. If it is run in asynchronous mode |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
343 |
* the client can supervise the progress of the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
344 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
345 |
* If the @ref CPosLmOperation object is deleted before the operation |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
346 |
* is complete, it is possible that the category has only been removed |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
347 |
* from a subset of the landmarks. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
348 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
349 |
* The client takes ownership of the returned operation object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
350 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
351 |
* If the database is read only, the returned operation will fail with error |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
352 |
* code @p KErrAccessDenied. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
353 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
354 |
* While removing the category from the landmarks, this operation will |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
355 |
* acquire a write-lock on the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
356 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
357 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
358 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
359 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
360 |
* @param[in] aCategoryId The category to remove from the set of landmarks. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
361 |
* @param[in] aLandmarkIdArray The landmarks to remove the category from. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
362 |
* @returns A handle to the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
363 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
364 |
* @leave KErrNotFound The specified category does not exist in database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
365 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
366 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
367 |
virtual CPosLmOperation* RemoveCategoryFromLandmarksL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
368 |
TPosLmItemId aCategoryId, |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
369 |
RArray<TPosLmItemId>& aLandmarkIdArray |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
370 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
371 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
372 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
373 |
* Gets a category by name. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
374 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
375 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
376 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
377 |
* The category name must be unique in the database, so there cannot be |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
378 |
* multiple matches. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
379 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
380 |
* This function only looks for an exact match. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
381 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
382 |
* This function requires @p ReadUserData capability. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
383 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
384 |
* @param[in] aCategoryName The name of the category to get. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
385 |
* @return @p KPosLmNullItemId if the category was not found, otherwise |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
386 |
* the ID of the category item in the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
387 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
388 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
389 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
390 |
virtual TPosLmItemId GetCategoryL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
391 |
const TDesC& aCategoryName |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
392 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
393 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
394 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
395 |
* Gets the ID of a global category. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
396 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
397 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
398 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
399 |
* This function requires @p ReadUserData capability. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
400 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
401 |
* @param[in] aGlobalCategory The global category to look for. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
402 |
* @return @p KPosLmNullItemId if the category was not found, otherwise |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
403 |
* the ID of the category item in the database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
404 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
405 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
406 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
407 |
virtual TPosLmItemId GetGlobalCategoryL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
408 |
TPosLmGlobalCategory aGlobalCategory |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
409 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
410 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
411 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
412 |
* Gets the predefined name of a global category. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
413 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
414 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
415 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
416 |
* @param[in] aGlobalCategory The global category to get a name for. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
417 |
* @return The name of the global category or @p NULL if the category |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
418 |
* is not recognized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
419 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
420 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
421 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
422 |
virtual HBufC* GlobalCategoryNameL( |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
423 |
TPosLmGlobalCategory aGlobalCategory |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
424 |
) = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
425 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
426 |
/** |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
427 |
* Resets the information for all global categories. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
428 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
429 |
* @pre Database is initialized (see @ref CPosLandmarkDatabase::IsInitializingNeeded). |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
430 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
431 |
* Global categories usually has a default name and icon. The client |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
432 |
* can change the name and icon. This function resets the name and |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
433 |
* icon to the default ones. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
434 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
435 |
* The function returns an operation object which can be run in either |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
436 |
* synchronous or asynchronous mode. If it is run in asynchronous mode |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
437 |
* the client can supervise the progress of the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
438 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
439 |
* If the @ref CPosLmOperation object is deleted before the operation |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
440 |
* is complete, it is possible that that only a subset of the global |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
441 |
* categories have been resetted. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
442 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
443 |
* The client takes ownership of the returned operation object. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
444 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
445 |
* While resetting, this operation will acquire a write-lock on the |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
446 |
* database. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
447 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
448 |
* This function requires @p ReadUserData and @p WriteUserData |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
449 |
* capabilities. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
450 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
451 |
* @returns A handle to the operation. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
452 |
* |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
453 |
* @leave KErrAccessDenied The database is read-only. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
454 |
* @leave KErrPosLmNotInitialized Database is not yet initialized. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
455 |
*/ |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
456 |
virtual CPosLmOperation* ResetGlobalCategoriesL() = 0; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
457 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
458 |
protected: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
459 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
460 |
// C++ constructor. |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
461 |
IMPORT_C CPosLmCategoryManager(); |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
462 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
463 |
private: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
464 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
465 |
// Prohibit copy constructor |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
466 |
CPosLmCategoryManager( const CPosLmCategoryManager& ); |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
467 |
// Prohibit assigment operator |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
468 |
CPosLmCategoryManager& operator= ( const CPosLmCategoryManager& ); |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
469 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
470 |
private: |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
471 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
472 |
// Implementation UID |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
473 |
TUid iDtorIdKey; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
474 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
475 |
}; |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
476 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
477 |
#endif // CPOSLMCATEGORYMANAGER_H |
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
478 |
|
2fe1408b6811
Final list of Symbian^2 public API header files
William Roberts <williamr@symbian.org>
parents:
1
diff
changeset
|
479 |