epoc32/include/mw/rsendocument.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:        Class extends RDocument, enabling handle counting
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
williamr@2
    26
#ifndef R_SEN_DOCUMENT
williamr@2
    27
#define R_SEN_DOCUMENT
williamr@2
    28
williamr@2
    29
#include <xmlengdocument.h>
williamr@2
    30
#include <xmlengdomimplementation.h>
williamr@2
    31
williamr@2
    32
typedef struct
williamr@2
    33
    {
williamr@2
    34
    TInt* ipOpenDocuments;
williamr@2
    35
    void* iInternal;
williamr@2
    36
    RXmlEngDOMImplementation iDomImpl;
williamr@2
    37
    } TSenDocumentData;
williamr@2
    38
williamr@2
    39
class RSenDocument : public RXmlEngDocument
williamr@2
    40
    {
williamr@2
    41
    public:
williamr@2
    42
williamr@2
    43
williamr@2
    44
        /**
williamr@2
    45
         * Default constructor.
williamr@2
    46
         *
williamr@2
    47
         * @since S60 v3.1
williamr@2
    48
         */
williamr@2
    49
        /*inline RSenDocument():RDocument()
williamr@2
    50
            {
williamr@2
    51
            ipOpenDocuments = new (ELeave) TInt(1);
williamr@2
    52
            }*/
williamr@2
    53
williamr@2
    54
        /**
williamr@2
    55
        * Create new document.
williamr@2
    56
        *
williamr@2
    57
        * @since S60 v3.1
williamr@2
    58
        */
williamr@2
    59
        IMPORT_C static RSenDocument NewL();
williamr@2
    60
williamr@2
    61
        /**
williamr@2
    62
        * Create new document and put it on cleanup stack.
williamr@2
    63
        *
williamr@2
    64
        * @since S60 v3.1
williamr@2
    65
        */
williamr@2
    66
        IMPORT_C static RSenDocument NewLC();
williamr@2
    67
williamr@2
    68
        /**
williamr@2
    69
        * Create new document.
williamr@2
    70
        *
williamr@2
    71
        * @since S60 v3.1
williamr@2
    72
        * @param aInternal Document pointer
williamr@2
    73
        */
williamr@2
    74
        IMPORT_C static RSenDocument NewL(void* aInternal);
williamr@2
    75
williamr@2
    76
        /**
williamr@2
    77
        * Create new document and put it on cleanup stack.
williamr@2
    78
        *
williamr@2
    79
        * @since S60 v3.1
williamr@2
    80
        * @param aInternal Document pointer
williamr@2
    81
        */
williamr@2
    82
        IMPORT_C static RSenDocument NewLC(void* aInternal);
williamr@2
    83
williamr@2
    84
        /**
williamr@2
    85
        * Copies a RSenDocument.
williamr@2
    86
        * Both the original and the copy must be separately closed.
williamr@2
    87
        *
williamr@2
    88
        * @since S60 v3.1
williamr@2
    89
        * @return Copy of this RSenDocument
williamr@2
    90
        */
williamr@2
    91
        IMPORT_C RSenDocument Copy();
williamr@2
    92
        
williamr@2
    93
        /**
williamr@2
    94
        * Closes a RSenDocument.
williamr@2
    95
        *
williamr@2
    96
        * You must close (or destroy) every RSenDocument you create using NewL or NewLC.
williamr@2
    97
        * In other words, every call to RSenDocument::Copy(), RSenDocument::NewL() and
williamr@2
    98
        * RSenDocument::NewLC() must be matched by a close or destroy.
williamr@2
    99
        * Note: Also Destroy() method can be used to close RSenDocument.
williamr@2
   100
        *
williamr@2
   101
        * @since S60 v3.1
williamr@2
   102
        * @see RSenDocument::Destroy()
williamr@2
   103
        */        
williamr@2
   104
        IMPORT_C void Close();
williamr@2
   105
        
williamr@2
   106
        /**
williamr@2
   107
        * Closes a RSenDocument.
williamr@2
   108
        *
williamr@2
   109
        * You must destroy (or close) every RSenDocument you create using NewL or NewLC.
williamr@2
   110
        * In other words, every call to RSenDocument::Copy(), RSenDocument::NewL() and
williamr@2
   111
        * RSenDocument::NewLC() must be matched by a close or destroy.
williamr@2
   112
        * Note: Also Close() method can be used to destroy RSenDocument.
williamr@2
   113
        *
williamr@2
   114
        * @since S60 v3.1
williamr@2
   115
        * @see RSenDocument::Close()
williamr@2
   116
        */        
williamr@2
   117
        IMPORT_C void Destroy();
williamr@2
   118
        
williamr@2
   119
        /**
williamr@2
   120
        * Sets the Tls
williamr@2
   121
        *
williamr@2
   122
        * @return KErrNone
williamr@2
   123
        *		  KErrUnknown if the Tls is unknown
williamr@2
   124
        *		  KErrAlreadyExists	if the Tls already exist.
williamr@2
   125
        */
williamr@2
   126
        IMPORT_C static TInt ManualXmlEngineTlsAttachL();
williamr@2
   127
williamr@2
   128
        /**
williamr@2
   129
        * Frees the Tls
williamr@2
   130
        *
williamr@2
   131
        * @return KErrNone
williamr@2
   132
        *		  KErrNotFound if the Tls is not found
williamr@2
   133
        */
williamr@2
   134
        IMPORT_C static TInt ManualXmlEngineTlsCleanup();
williamr@2
   135
williamr@2
   136
    public:
williamr@2
   137
    	TSenDocumentData* ipData;
williamr@2
   138
    };
williamr@2
   139
williamr@2
   140
#endif // R_SEN_DOCUMENT
williamr@2
   141
williamr@2
   142
// End of File
williamr@2
   143
williamr@2
   144