CXdmEngine Class Reference
class CXdmEngine : public CActive
|
Constructor & Destructor Documentation
CXdmEngine()
C++ default constructor is private
~CXdmEngine()
IMPORT_C
|
~CXdmEngine
|
(
|
)
|
[virtual]
|
Member Functions Documentation
CancelUpdate(CXdmDocument *)
Cancel an update operation on a document
CancelUpdate(CXdmDirectory *)
Cancel an update operation on a directory
ConstructL(CXdmProtocolInfo &)
Symbian OS second-phase constructor
ConvertToUTF8L(const TDesC &)
HBufC8
*
|
ConvertToUTF8L
|
(
|
const
TDesC
&
|
aUnicodeDesc
|
)
|
[static]
|
Convert data from UNICODE to UTF-8
Parameters
const
TDesC
& aUnicodeDesc
|
|
CreateDirectoryModelL(const TDesC &)
Create a new document model
Parameters
const
TDesC
& aDirectoryPath
|
|
CreateDocumentModelL(const TDesC &, const TXdmDocType)
IMPORT_C
CXdmDocument
*
|
CreateDocumentModelL
|
(
|
const
TDesC
&
|
aDocumentName,
|
|
const
TXdmDocType
|
aDocumentType
|
|
)
|
|
Create a new document model
NOTE! It is important to keep in mind that the Xdm Engine DOES NOT maintain the documents created on this engine object. It is the responsibility of the client application to deallocate the documents it creates by calling CXdmEngine::DeleteDocumentModelL( model ). The engine does keep track of the documents that are constructed on it, but it does not own them in the sense which would suggest deallocation of the memory reserved for them.
Parameters
const
TDesC
& aDocumentName
|
|
const
TXdmDocType
aDocumentType
|
|
CreateDocumentNodeL()
Create a new element.
The returning
CXdmDocumentNode
object does not yet belong to any document. Therefore it is the responsibility of the client application to deallocate the memory reserved for the element.
The new element can be "attached" to a document by using AppendToModelL() or ReplaceInModelL(). It is important to note that even after calling either of these methods, the ownership of the object does not change.
DeleteDirectoryModelL(const CXdmDirectory *)
IMPORT_C void
|
DeleteDirectoryModelL
|
(
|
const
CXdmDirectory
*
|
aDocument
|
)
|
|
Create a new document model
DeleteDocumentModelL(const CXdmDocument *)
IMPORT_C void
|
DeleteDocumentModelL
|
(
|
const
CXdmDocument
*
|
aDocument
|
)
|
|
Create a new document model
DirectoryCollection()
Get the list of directories created on this instance
DoCancel()
void
|
DoCancel
|
(
|
)
|
[private, virtual]
|
DocumentCollection()
Get the list of documents created on this instance
NewL(const CXdmProtocolInfo &)
Create an instance of the Engine object
RunL()
void
|
RunL
|
(
|
)
|
[private, virtual]
|
UpdateL(CXdmDocument *, TRequestStatus &)
Update the changes to the specified document model
UpdateL(TRequestStatus &, CXdmDirectory *, TDirUpdatePhase)
Update the contents of the specified directory model
WriteToLog(TRefByValue< const TDesC8 >, ...)
XdmProtocol()
Return the protocol this engine uses
XdmSettingsLC(RArray< TInt > &)
Fetch the IDs of the XDM Settings which have been configured to this device.
Member Enumerations Documentation
Enum TXdmEngineState
Enumerators
EXdmEngineIdle = 0
|
|
EXdmEngineStartDocUpdate
|
|
EXdmEngineStartDirUpdate
|
|
Member Data Documentation
TRequestStatus * iClientStatus
CXdmDirectory * iCurrentDir
CXdmDocument * iCurrentDoc
RPointerArray< CXdmDirectory > iDirUpdateQueue
RPointerArray< CXdmDirectory > iDirectoryQueue
RPointerArray< CXdmDocument > iDocUpdateQueue
RPointerArray< CXdmDocument > iDocumentQueue
CXdmLogWriter * iLogWriter
CXdmProtocol * iXdmProtocol
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.