console/kabcclient

VCardOutput Class Reference

#include <outputformatimpls.h>

Inheritance diagram for VCardOutput:

[legend]

List of all members.

Detailed Description

Output formatter for VCard data.

Writes the contacts formatted according to the VCard specification. Delegates the formatting to KABC::VCardConverter

Available through FormatFactory::outputFormat(), name "vcard"

Author:: Kevin Krammer, <kevin.krammer@gmx.at>

See also:: Handling of various input and output formats

Definition at line 80 of file outputformatimpls.h.


Public Member Functions
virtual QString	description () const
virtual QString	optionUsage () const
virtual bool	setCodec (QTextCodec *codec)
virtual bool	setOptions (const QByteArray &options)
	VCardOutput ()
virtual bool	writeAddressee (const KABC::Addressee &addressee, std::ostream &stream)
virtual bool	writeAddresseeList (const KABC::AddresseeList &addresseeList, std::ostream &stream)
virtual	~VCardOutput ()

Constructor & Destructor Documentation

VCardOutput::VCardOutput ( )

Definition at line 109 of file outputformatimpls.cpp.

VCardOutput::~VCardOutput ( ) [virtual]

Definition at line 116 of file outputformatimpls.cpp.

Member Function Documentation

QString VCardOutput::description ( ) const [virtual]

Returns a translate description of the output format.

Returns a translated description of the formatter and its general capabilities.

Returns:: a short descriptive string how addressee data will be formatted

Note:: Implementations should not include the optional settings a formatter understands, this is what optionUsage() is for. As the description is displayed after the format name, it is recommended to add two tabs after each newline for aligned output

Implements OutputFormat.

Definition at line 123 of file outputformatimpls.cpp.

QString VCardOutput::optionUsage ( ) const [virtual]

Returns a translate message about the available format options.

The option description string contains each option and its respective description for displaying to the user.

Returns:: a short description of each option or QString() if the output format does not allow configuration options

Note:

Implementations can return any formatting in the string, but it is recommended to stay consistent with the other format implementations and return the following format: one line per option and each line formatted like this

 option-name tabs option-description

where tabs is either one or two tab characters depending on the length of the option-name, e.g. two tabs for length < 8. Default implementation returns QString()

Reimplemented from OutputFormat.

Definition at line 142 of file outputformatimpls.cpp.

bool VCardOutput::setCodec ( QTextCodec * codec ) [virtual]

Sets the text codec to use.

This allows to have the text recoded to a specific text encoding. Depending on the format's specifications not all technically available codecs might be valid. e.g. VCards in version 3.0 are expected to be encoded in UTF-8

Warning:: Always set a codec, the output formats need it!

Parameters:

codec

the text encoding handler to use

Returns:: true if the output format accepts this codec. i.e. can work with it reasonably. Otherwise returns false

Implements OutputFormat.

Definition at line 158 of file outputformatimpls.cpp.

bool VCardOutput::setOptions ( const QByteArray & options ) [virtual]

Configures the output format.

Sets formatter options, e.g. which parts of the addressee data to use or which markup to apply.

Parameters:

options

a string as taken from the commandline

Returns:: false if the options are not valid or if the input format doesn't support options. true if the options where valid

Note:: Implementations can use any format in their options string. However it is recommended to stay consistent with the other format implementations and use a comma separated list

Implements OutputFormat.

Definition at line 130 of file outputformatimpls.cpp.

bool VCardOutput::writeAddressee	(	const KABC::Addressee &	addressee,
		std::ostream &	stream
	)			`[virtual]`

Writes the data of a given addressee to the given output stream.

Depending on the formatter and its settings it will write all or portions of the available addressee data to the stream.

Warning:: a format could require either header or footer around related addressees so use this only for single addressee output, i.e. not when iterating over a list of related addressees.

Parameters:

	addressee	the addressee object to take data from
	stream	the standard output stream to write to

Note:: Implementations that do not need to handle addressee relations can of course implement the writing in this method and just call it from writeAddresseeList() when iterating over the list

See also:

writeAddresseeList()

KABC::Addressee

setCodec()

std::ostream

Implements OutputFormat.

Definition at line 180 of file outputformatimpls.cpp.

bool VCardOutput::writeAddresseeList	(	const KABC::AddresseeList &	addresseeList,
		std::ostream &	stream
	)			`[virtual]`

Writes the data from each addressee in the given list to the given output stream.

Depending on the formatter and its settings it will write all or portions of the available addressee data to the stream.

Parameters:

	addresseeList	a list of addressee objects
	stream	the standard output stream to write to

Note:: Implementations that do not need to handle each addressee differently for example numbering them, can call the writeAddressee() method on each entry of the given list

See also:

writeAddressee()

KABC::Addressee

setCodec()

std::ostream

Implements OutputFormat.

Definition at line 210 of file outputformatimpls.cpp.

The documentation for this class was generated from the following files:

console/kabcclient

VCardOutput Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

console/kabcclient

kdepim