kaddressbook
KABPrinting::PrintStyle Class Reference
#include <printstyle.h>
Inheritance diagram for KABPrinting::PrintStyle:

Detailed Description
The class PrintStyle implements the abstract interface to the PrintingWizards style objects.To implement a print style, derive from this class and read the information in printingwizard.h to see how this two pieces work together. Basically, the print style gets the contacts it is supposed to print from the PrintingWizard is will not change this set - neither its content nor its order. To register your new style in the printing wizard, you need to define a PrintStyleFactory that handles how your objects are created and deleted. See the existing print styles for examples. A print style should have a preview image that gives the user a basic impression on how it will look. Add this image to the printing folder (right here :-), and edit Makefile.am to have it installed along with kaddressbook. Load it using setPreview(QString). Your print style is supposed to add its options as pages to the printing wizard. The method wizard() gives you a pointer to the wizard object.
Definition at line 60 of file printstyle.h.
Public Member Functions | |
PrintStyle (PrintingWizard *parent, const char *name=0) | |
virtual | ~PrintStyle () |
virtual void | print (const KABC::Addressee::List &contacts, PrintProgress *)=0 |
const QPixmap & | preview () |
void | hidePages () |
void | showPages () |
KABC::Field * | preferredSortField () |
bool | preferredSortType () |
Protected Member Functions | |
bool | setPreview (const QString &fileName) |
void | setPreview (const QPixmap &image) |
void | setPreferredSortOptions (KABC::Field *field, bool ascending=true) |
PrintingWizard * | wizard () |
void | addPage (QWidget *page, const QString &title) |
Member Function Documentation
virtual void KABPrinting::PrintStyle::print | ( | const KABC::Addressee::List & | contacts, | |
PrintProgress * | ||||
) | [pure virtual] |
Reimplement this method to actually print.
Implemented in KABPrinting::DetailledPrintStyle, and KABPrinting::MikesStyle.
const QPixmap & PrintStyle::preview | ( | ) |
Reimplement this method to provide a preview of what will be printed.
It returns an invalid QPixmap by default, resulting in a message that no preview is available.
Definition at line 44 of file printstyle.cpp.
void PrintStyle::hidePages | ( | ) |
void PrintStyle::showPages | ( | ) |
KABC::Field * PrintStyle::preferredSortField | ( | ) |
bool PrintStyle::preferredSortType | ( | ) |
Returns the preferred sort type.
true = ascending false = descending
Definition at line 116 of file printstyle.cpp.
bool PrintStyle::setPreview | ( | const QString & | fileName | ) | [protected] |
Load the preview image from the kaddressbook data directory.
The image should be located in the subdirectory "printing". Give only the file name without any prefix as the parameter.
Definition at line 54 of file printstyle.cpp.
void PrintStyle::setPreview | ( | const QPixmap & | image | ) | [protected] |
void PrintStyle::setPreferredSortOptions | ( | KABC::Field * | field, | |
bool | ascending = true | |||
) | [protected] |
PrintingWizard * PrintStyle::wizard | ( | ) | [protected] |
void PrintStyle::addPage | ( | QWidget * | page, | |
const QString & | title | |||
) | [protected] |
Add additional page to the wizard e.g.
a configuration page for the style.
Definition at line 77 of file printstyle.cpp.
The documentation for this class was generated from the following files: