Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::CommonPrintDialog Class Reference

A class for displaying a common print dialog. More...

#include <vcf/ApplicationKit/CommonPrintDialog.h>

Inheritance diagram for VCF::CommonPrintDialog:

VCF::CommonDialog VCF::Component VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 CommonPrintDialog (Control *owner)
virtual ~CommonPrintDialog ()
virtual bool execute ()
 Displays the print dialog.
String getTitle ()
void setTitle (const String &title)
 Sets the title of the dialog.
void setNumberOfCopies (const uint32 &val)
 Sets the number of copies of the document you'd like to make.
uint32 getNumberOfCopies ()
void setStartPage (const uint32 &val)
 Sets the start page for the print dialog.
uint32 getStartPage ()
void setEndPage (const uint32 &val)
 Sets the end page for the print dialog.
uint32 getEndPage ()
void setPrintJobType (PrintSession::PrintJob val)
PrintSession::PrintJob getPrintJobType ()
 This is the type of print job the user selected/ This is an enum which can be either Selected Page, Page Range, or All Pages.
PrintInfoHandle getPrintInfo ()
void setPrintInfo (PrintInfoHandle info)

Protected Attributes

String title_
CommonPrintDialogPeerpeer_

Detailed Description

A class for displaying a common print dialog.


Constructor & Destructor Documentation

VCF::CommonPrintDialog::CommonPrintDialog Control owner  ) 
 

virtual VCF::CommonPrintDialog::~CommonPrintDialog  )  [virtual]
 


Member Function Documentation

virtual bool VCF::CommonPrintDialog::execute  )  [virtual]
 

Displays the print dialog.

If the user hit's OK, the function will return true and you can start a print session, otherwise it will return false.

Implements VCF::CommonDialog.

uint32 VCF::CommonPrintDialog::getEndPage  ) 
 

uint32 VCF::CommonPrintDialog::getNumberOfCopies  ) 
 

PrintInfoHandle VCF::CommonPrintDialog::getPrintInfo  ) 
 

PrintSession::PrintJob VCF::CommonPrintDialog::getPrintJobType  ) 
 

This is the type of print job the user selected/ This is an enum which can be either Selected Page, Page Range, or All Pages.

uint32 VCF::CommonPrintDialog::getStartPage  ) 
 

String VCF::CommonPrintDialog::getTitle  ) 
 

void VCF::CommonPrintDialog::setEndPage const uint32 val  ) 
 

Sets the end page for the print dialog.

If you have a document with 200 pages, and the start is set to 1, and the end to 10, then only pages 1 through 10 will be printed.

void VCF::CommonPrintDialog::setNumberOfCopies const uint32 val  ) 
 

Sets the number of copies of the document you'd like to make.

This value may be changed by the user.

void VCF::CommonPrintDialog::setPrintInfo PrintInfoHandle  info  ) 
 

void VCF::CommonPrintDialog::setPrintJobType PrintSession::PrintJob  val  ) 
 

void VCF::CommonPrintDialog::setStartPage const uint32 val  ) 
 

Sets the start page for the print dialog.

void VCF::CommonPrintDialog::setTitle const String title  ) 
 

Sets the title of the dialog.


Member Data Documentation

CommonPrintDialogPeer* VCF::CommonPrintDialog::peer_ [protected]
 

String VCF::CommonPrintDialog::title_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information