KDE 4.2 API Reference console/kabcclient
VCardInput Class Reference
#include <inputformatimpls.h>
Detailed Description
Input parser for VCard data.Treats input as contact data formatted according to the VCard specification. Delegates actual parsing to KABC::VCardConverter
Available through FormatFactory::inputFormat(), name "vcard"
Definition at line 78 of file inputformatimpls.h.
Public Member Functions | |
| virtual QString | description () const |
| virtual KABC::Addressee | readAddressee (std::istream &stream) |
| virtual bool | setCodec (QTextCodec *codec) |
| virtual bool | setOptions (const QByteArray &options) |
| VCardInput () | |
| virtual | ~VCardInput () |
Constructor & Destructor Documentation
| VCardInput::VCardInput | ( | ) |
Definition at line 95 of file inputformatimpls.cpp.
| VCardInput::~VCardInput | ( | ) | [virtual] |
Definition at line 109 of file inputformatimpls.cpp.
Member Function Documentation
| QString VCardInput::description | ( | ) | const [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
Implements InputFormat.
Definition at line 102 of file inputformatimpls.cpp.
| KABC::Addressee VCardInput::readAddressee | ( | std::istream & | stream | ) | [virtual] |
Reads a single contact from the input stream.
Aggregates lines from input until it encounters "END:VCARD". When it does, it delegates parsing of the accumulated string to KABC::VCardConverter::parseVCard()
- Parameters:
-
stream the standard input stream to read text from
- Returns:
- a KABC::Addressee object containing the read data
Implements InputFormat.
Definition at line 146 of file inputformatimpls.cpp.
| bool VCardInput::setCodec | ( | QTextCodec * | codec | ) | [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:
trueif the input format accepts this codec. i.e. can work with it reasonably. Otherwise returnsfalse
Implements InputFormat.
Definition at line 124 of file inputformatimpls.cpp.
| bool VCardInput::setOptions | ( | const QByteArray & | options | ) | [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:
falseif the options are not valid or if the input format doesn't support options.trueif 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 InputFormat.
Definition at line 116 of file inputformatimpls.cpp.
The documentation for this class was generated from the following files:
