KDE 4.2 API Reference console/kabcclient
UIDOutput Class Reference
#include <outputformatimpls.h>
Detailed Description
Output formatter for KABC UIDs.Writes each contact's unique identifier, one per line
Available through FormatFactory::outputFormat(), name "uid"
Definition at line 46 of file outputformatimpls.h.
Public Member Functions | |
| virtual QString | description () const |
| virtual bool | setCodec (QTextCodec *codec) |
| virtual bool | setOptions (const QByteArray &options) |
| virtual bool | writeAddressee (const KABC::Addressee &addressee, std::ostream &stream) |
| virtual bool | writeAddresseeList (const KABC::AddresseeList &addresseeList, std::ostream &stream) |
Member Function Documentation
| QString UIDOutput::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 52 of file outputformatimpls.cpp.
| bool UIDOutput::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:
trueif the output format accepts this codec. i.e. can work with it reasonably. Otherwise returnsfalse
Implements OutputFormat.
Definition at line 67 of file outputformatimpls.cpp.
| bool UIDOutput::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:
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 OutputFormat.
Definition at line 59 of file outputformatimpls.cpp.
| bool UIDOutput::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
std::ostream
Implements OutputFormat.
Definition at line 78 of file outputformatimpls.cpp.
| bool UIDOutput::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
std::ostream
Implements OutputFormat.
Definition at line 89 of file outputformatimpls.cpp.
The documentation for this class was generated from the following files:
