Home · All Classes · All Functions ·

QVersitDocument Class Reference

The QVersitDocument class is a container for a list of versit properties. More...

    #include <QVersitDocument>

Public Types

enum VersitType { InvalidType, VCard21Type, VCard30Type }

Public Functions

QVersitDocument ()
QVersitDocument ( const QVersitDocument & other )
QVersitDocument ( VersitType type )
~QVersitDocument ()
void addProperty ( const QVersitProperty & property )
void clear ()
bool isEmpty () const
QList<QVersitProperty> properties () const
void removeProperties ( const QString & name )
void removeProperty ( const QVersitProperty & property )
void setType ( VersitType type )
VersitType type () const
bool operator!= ( const QVersitDocument & other ) const
QVersitDocument & operator= ( const QVersitDocument & other )
bool operator== ( const QVersitDocument & other ) const

Detailed Description

The QVersitDocument class is a container for a list of versit properties.

For example a vCard can be presented as a QVersitDocument that consists of a number of properties such as a name (N), a telephone number (TEL) and an email address (EMAIL) to name a few. Each of these properties is stored as an instance of a QVersitProperty in a QVersitDocument.

QVersitDocument supports implicit sharing.

See also QVersitProperty.


Member Type Documentation

enum QVersitDocument::VersitType

This enum describes a versit document type and version.

ConstantValueDescription
QVersitDocument::InvalidType0No type specified or a document with an invalid type was parsed
QVersitDocument::VCard21Type1vCard version 2.1
QVersitDocument::VCard30Type2vCard version 3.0


Member Function Documentation

QVersitDocument::QVersitDocument ()

Constructs a new empty document

QVersitDocument::QVersitDocument ( const QVersitDocument & other )

Constructs a document that is a copy of other

QVersitDocument::QVersitDocument ( VersitType type )

Constructs a new empty document with the type set to type

QVersitDocument::~QVersitDocument ()

Frees the memory used by the document

void QVersitDocument::addProperty ( const QVersitProperty & property )

Add property to the list of contained versit properties. The property is appended as the last property of the list.

void QVersitDocument::clear ()

Clears the document, removing all properties and metadata and resetting the codec to the default.

bool QVersitDocument::isEmpty () const

Returns true if the document is empty.

QList<QVersitProperty> QVersitDocument::properties () const

Gets the list of the contained versit properties. Note that the actual properties cannot be modified using the copy.

void QVersitDocument::removeProperties ( const QString & name )

Removes all the properties with the given name from the versit document.

void QVersitDocument::removeProperty ( const QVersitProperty & property )

Removes the property property from the versit document.

void QVersitDocument::setType ( VersitType type )

Sets the versit document type to type.

See also type().

VersitType QVersitDocument::type () const

Gets the versit document type.

See also setType().

bool QVersitDocument::operator!= ( const QVersitDocument & other ) const

Returns true if this is not equal to other; false otherwise.

QVersitDocument & QVersitDocument::operator= ( const QVersitDocument & other )

Assigns this document to other

bool QVersitDocument::operator== ( const QVersitDocument & other ) const

Returns true if this is equal to other; false otherwise.


Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.2