pressrv_plat/simple_documents_api/inc/msimplewinfo.h
changeset 0 c8caa15ef882
equal deleted inserted replaced
-1:000000000000 0:c8caa15ef882
       
     1 /*
       
     2 * Copyright (c) 2006 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:    SIMPLE Engine watcher info data (WINFO)
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef M_simplewinfo_H
       
    22 #define M_simplewinfo_H
       
    23 
       
    24 #include <e32std.h>
       
    25 #include <msimpleelement.h>
       
    26 
       
    27 // FORWARD DECLARATION
       
    28 class MSimpleNamespace;
       
    29 class RWriteStream;
       
    30 
       
    31 /**
       
    32  *  MSimpleWinfo
       
    33  *
       
    34  *  SIMPLE Engine watcher info data (WINFO)
       
    35  *
       
    36  *  @lib simplexmlutils
       
    37  *  @since S60 3.2
       
    38  */
       
    39 
       
    40 class MSimpleWinfo : public MSimpleElement
       
    41     {
       
    42 
       
    43 public:
       
    44 
       
    45     /**
       
    46      * WINFO's default namespace accessor.
       
    47      *
       
    48      * @since S60 3.2
       
    49      * @return default namespace URI
       
    50      */
       
    51     virtual TPtrC8 DefaultNamespace() = 0;
       
    52 
       
    53     /**
       
    54      * Add new newspace
       
    55      *
       
    56      * @since S60 3.2
       
    57      * @param aPrefix:  Namespace prefix
       
    58      * @param aUri: Namespace URI
       
    59      */
       
    60     virtual void AddNamespaceL( const TDesC8& aPrefix,
       
    61                                 const TDesC8& aUri) = 0;
       
    62 
       
    63     /**
       
    64      * Gets all extra namespaces of this element in an array.
       
    65      *
       
    66      * @since S60 3.2
       
    67      * @return array of namespaces. Array will be empty if element has
       
    68      *         no namespaces.
       
    69      *         Do NOT call ResetAndDestroy() for the array,
       
    70      *         you may call Reset() only. The array is valid only till
       
    71      *         the next call of this method in this entity.
       
    72      *         AddNamespaceL() modifications are not visible without
       
    73      *         new call of this method.
       
    74      */
       
    75     virtual RPointerArray<MSimpleNamespace>& NamespacesL() = 0;
       
    76 
       
    77     /**
       
    78      * Externalize the document into write stream.
       
    79      *
       
    80      * @since S60 3.2
       
    81      * @param aStream write stream
       
    82      */
       
    83     virtual void ExternalizeL( RWriteStream& aStream ) = 0;
       
    84 
       
    85     };
       
    86 
       
    87 #endif
       
    88 
       
    89 // End of File