KABPrinting::PrintStyle Class Reference

#include <printstyle.h>

Inherits TQObject.

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

Public Member Functions
	PrintStyle (PrintingWizard *parent, const char *name=0)
virtual void	print (const TDEABC::Addressee::List &contacts, PrintProgress *)=0
const TQPixmap &	preview ()
void	hidePages ()
void	showPages ()
TDEABC::Field *	preferredSortField ()
bool	preferredSortType ()

Protected Member Functions
bool	setPreview (const TQString &fileName)
void	setPreview (const TQPixmap &image)
void	setPreferredSortOptions (TDEABC::Field *field, bool ascending=true)
PrintingWizard *	wizard ()
void	addPage (TQWidget *page, const TQString &title)

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(TQString). 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.

Member Function Documentation

addPage()

void PrintStyle::addPage ( TQWidget *  page, const TQString &  title  )

protected

Add additional page to the wizard e.g.

a configuration page for the style.

Definition at line 77 of file printstyle.cpp.

hidePages()

void PrintStyle::hidePages

(

)

Hide all style specific pages in the wizard.

Definition at line 99 of file printstyle.cpp.

preferredSortField()

TDEABC::Field * PrintStyle::preferredSortField

(

)

Returns the preferred sort criterion field.

Definition at line 111 of file printstyle.cpp.

preferredSortType()

bool PrintStyle::preferredSortType

(

)

Returns the preferred sort type.

true = ascending false = descending

Definition at line 116 of file printstyle.cpp.

preview()

const TQPixmap & PrintStyle::preview

(

)

Reimplement this method to provide a preview of what will be printed.

It returns an invalid TQPixmap by default, resulting in a message that no preview is available.

Definition at line 44 of file printstyle.cpp.

print()

virtual void KABPrinting::PrintStyle::print ( const TDEABC::Addressee::List &  contacts, PrintProgress *    )

pure virtual

Reimplement this method to actually print.

setPreferredSortOptions()

void PrintStyle::setPreferredSortOptions ( TDEABC::Field *  field, bool  ascending = true  )

protected

Set preferred sort options for this printing style.

Definition at line 105 of file printstyle.cpp.

setPreview() [1/2]

void PrintStyle::setPreview ( const TQPixmap &  image )

protected

Set the preview image.

Definition at line 49 of file printstyle.cpp.

setPreview() [2/2]

bool PrintStyle::setPreview ( const TQString &  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.

showPages()

void PrintStyle::showPages

(

)

Show all style specific pages in the wizard.

Definition at line 85 of file printstyle.cpp.

wizard()

PrintingWizard * PrintStyle::wizard ( )

protected

Return the wizard object.

Definition at line 72 of file printstyle.cpp.

---

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

• printstyle.h
• printstyle.cpp