InputFormat Class Reference

#include <inputformat.h>

Inheritance diagram for InputFormat:

Public Member Functions
virtual	~InputFormat ()
virtual QString	description () const =0
virtual QString	optionUsage () const
virtual KABC::Addressee	readAddressee (std::istream &stream)=0
virtual bool	setCodec (QTextCodec *codec)=0
virtual bool	setOptions (const QByteArray &options)=0

Detailed Description

Interface for input format parsers.

This is the interface for input format parsers.

Note

Implementations should return a KABC::Addressee object on each call to their readAddressee() method. If the parsing failes they are supposed to return an empty object. readAddressee() will be called repeatetly until the input stream is at its end (istream::eof() returns true) or it the stream is in condition bad (istream::bad() returns true)

Author

Kevin Krammer, kevin.nosp@m..kra.nosp@m.mmer@.nosp@m.gmx..nosp@m.at

See also

OutputFormat

Definition at line 51 of file inputformat.h.

Constructor & Destructor Documentation

virtual InputFormat::~InputFormat ( )

inlinevirtual

Destroys the instance Defined here because the class contains virtual methods.

Definition at line 58 of file inputformat.h.

Member Function Documentation

virtual QString InputFormat::description ( ) const

pure virtual

Returns a translate description of the input format.

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

Returns

a short descriptive string what kind of input format it can handle

Note

Implementations should not include the optional settings a parser 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

Implemented in DialogInput, CSVInput, NameInput, SearchInput, EmailInput, VCardInput, and UIDInput.

virtual QString InputFormat::optionUsage ( ) const

inlinevirtual

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 input 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 in CSVInput.

Definition at line 135 of file inputformat.h.

virtual KABC::Addressee InputFormat::readAddressee ( std::istream &  stream )

pure virtual

Reads one addressee from the input stream.

Creates a single KABC::Addressee object from the data available in the given input stream according to the parsers formatting rules.

Parameters

stream

the standard input stream to read text from

Returns

a KABC::Addressee object containing the read data

See also

KABC::Addressee

setCodec()

std::ios_base

Note

This method is called until the stream is either at its end or gone bad, so if an implementation has more than one addressee to return it has to make sure neither of this conditions is met. If the data available in the stream is not sufficient to create an addressee according to the implementations format rules, it should return an empty object, i.e. the one creates by the Addressee class' default constructor.

Implemented in DialogInput, CSVInput, NameInput, SearchInput, EmailInput, VCardInput, and UIDInput.

virtual bool InputFormat::setCodec ( QTextCodec *  codec )

pure virtual

Sets the text codec to use.

This allows to have the text read from the input stream interpreted according to a specific text encoding. Depending on the format's specifications not all technically available codecs might be valid

Warning

Always set a codec, the input formats need it!

Parameters

codec

the text encoding handler to use

Returns

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

Implemented in DialogInput, CSVInput, NameInput, SearchInput, EmailInput, VCardInput, and UIDInput.

virtual bool InputFormat::setOptions ( const QByteArray &  options )

pure virtual

Configures the input format.

Sets parser options, i.e. format specific settings that change how the input format treats the input text.

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

Implemented in DialogInput, CSVInput, NameInput, SearchInput, EmailInput, VCardInput, and UIDInput.

---

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

• inputformat.h