KDE PIM / Developers / API Docs / kaddressbook

KABPrinting::PrintStyle Class Reference

The class PrintStyle implements the abstract interface to the PrintingWizards style objects. More...

#include <printstyle.h>

Inherits QObject.

Inherited by KABPrinting::DetailledPrintStyle, KABPrinting::MikesStyle, and KABPrinting::RingBinderPrintStyle.

List of all members.

Public Member Functions

Protected Member Functions


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.


Member Function Documentation

virtual void KABPrinting::PrintStyle::print const KABC::Addressee::List &  contacts,
PrintProgress
[pure virtual]
 

Reimplement this method to actually print.

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.

void PrintStyle::hidePages  ) 
 

Hide all style specific pages in the wizard.

void PrintStyle::showPages  ) 
 

Show all style specific pages in the wizard.

KABC::Field * PrintStyle::preferredSortField  ) 
 

Returns the preferred sort criterion field.

bool PrintStyle::preferredSortType  ) 
 

Returns the preferred sort type.

true = ascending false = descending

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.

void PrintStyle::setPreview const QPixmap &  image  )  [protected]
 

Set the preview image.

void PrintStyle::setPreferredSortOptions KABC::Field *  field,
bool  ascending = true
[protected]
 

Set preferred sort options for this printing style.

PrintingWizard * PrintStyle::wizard  )  [protected]
 

Return the wizard object.

void PrintStyle::addPage QWidget *  page,
const QString &  title
[protected]
 

Add additional page to the wizard e.g.

a configuration page for the style.


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