epoc32/include/mw/senfacet.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@4
     2
* Copyright (c) 2002-2005 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@4
    14
* Description:    Parser base element class declaration        
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@4
    19
williamr@4
    20
williamr@4
    21
williamr@2
    22
#ifndef SEN_FACET_H
williamr@2
    23
#define SEN_FACET_H
williamr@2
    24
williamr@2
    25
// INCLUDES
williamr@2
    26
#include <SenBaseElement.h>
williamr@2
    27
williamr@2
    28
// CONSTANTS
williamr@2
    29
_LIT8(KSenFacet,        "Facet");
williamr@2
    30
_LIT8(KFacetAttrName,   "name");
williamr@2
    31
_LIT8(KFacetAttrType,   "type");
williamr@2
    32
williamr@2
    33
// CLASS DECLARATION
williamr@2
    34
class CSenFacet : public CSenBaseElement
williamr@2
    35
    {
williamr@2
    36
    public:
williamr@2
    37
        
williamr@2
    38
        /**
williamr@2
    39
        * Basic constructor.
williamr@2
    40
        */
williamr@2
    41
        IMPORT_C static CSenFacet* NewL();
williamr@2
    42
williamr@2
    43
        /**
williamr@2
    44
        * Basic constructor.
williamr@2
    45
        * @param    aCopiedSource   source to copy facet data from.
williamr@2
    46
        */
williamr@2
    47
        IMPORT_C static CSenFacet* NewL(CSenElement& aCopiedSource);
williamr@2
    48
williamr@2
    49
        /**
williamr@2
    50
        * Basic constructor.
williamr@2
    51
        * @param aNsUri     The namespace URI of the new element
williamr@2
    52
        * @param aLocalName The local name of the new element
williamr@2
    53
        * @param aQName     The qualified name of the new element
williamr@2
    54
        * @param aAttributes    The attributes of the new element
williamr@2
    55
        * Leave codes:  
williamr@2
    56
        *       KErrSenInvalidCharacters if aLocalName or aQName contains
williamr@2
    57
        *       illegal characters.     
williamr@2
    58
        *       KErrSenZeroLengthDescriptor if aLocalName or aQName is zero length.
williamr@2
    59
        */
williamr@2
    60
        IMPORT_C static CSenFacet* NewL(const TDesC8& aNsUri,
williamr@2
    61
                                        const TDesC8& aLocalName,
williamr@2
    62
                                        const TDesC8& aQName,
williamr@2
    63
                                        const RAttributeArray& aAttributes);
williamr@2
    64
williamr@2
    65
        IMPORT_C virtual ~CSenFacet();
williamr@2
    66
williamr@2
    67
        // New functions
williamr@2
    68
        
williamr@2
    69
        /**
williamr@2
    70
        * Setter for name.
williamr@2
    71
        * @param aName  the name to be set.
williamr@2
    72
        */
williamr@2
    73
        IMPORT_C virtual void SetNameL(const TDesC8& aName);
williamr@2
    74
williamr@2
    75
        /**
williamr@2
    76
        * Setter for type.
williamr@2
    77
        * @param aType  the type to be set.
williamr@2
    78
        */
williamr@2
    79
        IMPORT_C virtual void SetTypeL(const TDesC8& aType);
williamr@2
    80
williamr@2
    81
        /**
williamr@2
    82
        * Setter for value.
williamr@2
    83
        * @param aValue the value to be set.
williamr@2
    84
        */
williamr@2
    85
        IMPORT_C virtual void SetValueL(const TDesC8& aValue);
williamr@2
    86
williamr@2
    87
        /**
williamr@2
    88
        * Getter for name.
williamr@2
    89
        * @return the name of the facet
williamr@2
    90
        */
williamr@2
    91
        IMPORT_C virtual TPtrC8 Name();
williamr@2
    92
williamr@2
    93
        /**
williamr@2
    94
        * Getter for type.
williamr@2
    95
        * @return the type of the facet
williamr@2
    96
        */
williamr@2
    97
        IMPORT_C virtual TPtrC8 Type();
williamr@2
    98
    
williamr@2
    99
        /**
williamr@2
   100
        * Getter for value.
williamr@2
   101
        * @return the value of the facet
williamr@2
   102
        */
williamr@2
   103
        IMPORT_C virtual TPtrC8 Value();
williamr@2
   104
williamr@4
   105
        virtual void CopyFromL(CSenElement& aSource);
williamr@4
   106
williamr@2
   107
    protected:
williamr@2
   108
        
williamr@2
   109
        /**
williamr@2
   110
        * C++ default constructor.
williamr@2
   111
        */
williamr@2
   112
        IMPORT_C CSenFacet();
williamr@2
   113
        
williamr@2
   114
        /**
williamr@2
   115
        * By default Symbian 2nd phase constructors are private.
williamr@2
   116
        */
williamr@2
   117
        IMPORT_C void ConstructL(const TDesC8& aLocalName);
williamr@2
   118
        IMPORT_C void ConstructL(CSenElement& aCopiedSource);
williamr@2
   119
        IMPORT_C void ConstructL(const TDesC8& aNsUri,
williamr@2
   120
                                 const TDesC8& aLocalName,
williamr@2
   121
                                 const TDesC8& aQName,
williamr@2
   122
                                 const RAttributeArray& aAttributes);
williamr@2
   123
    };
williamr@2
   124
williamr@2
   125
#endif // SEN_FACET_H
williamr@2
   126
williamr@2
   127
// End of File