S60 3rd Edition API Reference: CSenBaseAttribute Class Reference

CSenBaseAttribute Class Reference

API published in: S60 3rd Ed

Link against: senxml.lib

Capability Information

Required Capabilities

None

#include <senbaseattribute.h>

Detailed Description

Class offers basic implementation of an XML attribute XML attribute is a name-value pair type value object, which may or may not have a namespace prefix.

Note that both name and value may contain a namespace prefix.


Public Member Functions

virtual IMPORT_C ~CSenBaseAttribute ()
 Destructor.
virtual const TDesC8 & Name () const
 Getter for the attribute name.
virtual const TDesC8 & Value () const
 Getter for the attribute value.
virtual const TDesC8 & SetValueL (const TDesC8 &aValue)
 Setter for the attribute value.

Static Public Member Functions

static IMPORT_C CSenBaseAttribute * NewL (const TDesC8 &aName, const TDesC8 &aValue)
 Basic two-phased constructor.
static IMPORT_C CSenBaseAttribute * NewL (const TDesC8 &aQName, const TDesC8 &aName, const TDesC8 &aValue)
 Basic constructor.

Protected Member Functions

IMPORT_C CSenBaseAttribute ()
 C++ default constructor.
IMPORT_C void BaseConstructL (const TDesC8 &aName, const TDesC8 &aValue)
 Following BaseConstructL methods should be called from the deriving classes ConstructL() methods.
IMPORT_C void BaseConstructL (const TDesC8 &aName, const TDesC8 &aQName, const TDesC8 &aValue)

Constructor & Destructor Documentation

virtual IMPORT_C CSenBaseAttribute::~CSenBaseAttribute (   )  [virtual]
 

Destructor.

IMPORT_C CSenBaseAttribute::CSenBaseAttribute (   )  [protected]
 

C++ default constructor.

Member Function Documentation

IMPORT_C void CSenBaseAttribute::BaseConstructL ( const TDesC8 &  aName,
const TDesC8 &  aQName,
const TDesC8 &  aValue
)  [protected]
 
Parameters:
aName is the name of this attribute. Cannot contain characters that are illegal in XML (like basic entities in decoded form)
aQName is the qualified, prefixed name of this XML attribute. Cannot contain characters which are illegal in XML.
aValue is the value of this attribute. Cannot contain characters that are illegal in XML (like basic entities in decoded form)
IMPORT_C void CSenBaseAttribute::BaseConstructL ( const TDesC8 &  aName,
const TDesC8 &  aValue
)  [protected]
 

Following BaseConstructL methods should be called from the deriving classes ConstructL() methods.

Parameter info is found in the corresponding NewL-methods.

Parameters:
aName is the name of this attribute. Cannot contain characters that are illegal in XML (like basic entities in decoded form)
aValue is the value of this attribute. Cannot contain characters that are illegal in XML (like basic entities in decoded form)
virtual const TDesC8& CSenBaseAttribute::Name (   )  const [virtual]
 

Getter for the attribute name.

Returns:
the attribute name.
static IMPORT_C CSenBaseAttribute* CSenBaseAttribute::NewL ( const TDesC8 &  aQName,
const TDesC8 &  aName,
const TDesC8 &  aValue
)  [static]
 

Basic constructor.

Parameters:
aQName,: Qualified name of the attribute
aName,: Name of the attribute
aValue,: Attribute's value. Leave codes: KErrSenInvalidCharacters if aName or aQName contain illegal characters. KErrSenZeroLengthDescriptor if aLocalName or aQName is zero length.
static IMPORT_C CSenBaseAttribute* CSenBaseAttribute::NewL ( const TDesC8 &  aName,
const TDesC8 &  aValue
)  [static]
 

Basic two-phased constructor.

Parameters:
aName,: Name of the attribute
aValue,: Attribute's value. Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName or aQName is zero length.
virtual const TDesC8& CSenBaseAttribute::SetValueL ( const TDesC8 &  aValue  )  [virtual]
 

Setter for the attribute value.

Parameters:
aValue,: value to be set
Returns:
the new value.
virtual const TDesC8& CSenBaseAttribute::Value (   )  const [virtual]
 

Getter for the attribute value.

Returns:
the attribute value.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top