Versit API

Usage

The following example goes through the process of reading a vCard and importing it to QContact format, then exporting and writing it back out.

First, let's create some data to read. In this case, we create a QBuffer as a demonstration, but any QIODevice will work.

        QBuffer input;
        input.open(QBuffer::ReadWrite);
        QByteArray inputVCard =
            "BEGIN:VCARD\r\nVERSION:2.1\r\nFN:John Citizen\r\nN:Citizen;John;Q;;\r\nEND:VCARD\r\n";
        input.write(inputVCard);
        input.seek(0);

QVersitReader can be used to parse a vCard or iCalendar from an I/O device to produce a list of QVersitDocuments.

        // Note: we could also use the more convenient QVersitReader(QByteArray) constructor.
        QVersitReader reader;
        reader.setDevice(&input);
        reader.startReading(); // Remember to check the return value
        reader.waitForFinished();
        QList<QVersitDocument> inputDocuments = reader.results();

QVersitDocuments aren't very useful to the QtContacts API. They need to be imported using the QVersitContactImporter.

        QVersitContactImporter importer;
        if (!importer.importDocuments(inputDocuments))
            return;
        QList<QContact> contacts = importer.contacts();
        // Note that the QContacts are not saved yet.
        // Use QContactManager::saveContacts() for saving if necessary

Conversely, QVersitContactExporter can be used to convert from QContacts to QVersitDocuments.

        QVersitContactExporter exporter;
        if (!exporter.exportContacts(contacts, QVersitDocument::VCard30Type))
            return;
        QList<QVersitDocument> outputDocuments = exporter.documents();

To complete the exporting process, QVersitWriter can be used to write to an I/O device.

        // Note: we could also use the more convenient QVersitWriter(QByteArray*) constructor.
        QBuffer output;
        output.open(QBuffer::ReadWrite);
        QVersitWriter writer;
        writer.setDevice(&output);
        writer.startWriting(outputDocuments); // Remember to check the return value
        writer.waitForFinished();
        // output.buffer() now contains a vCard