CCPrintInfo Class Reference

To provide a custom Print Info class. More...

#include <prdlgctl.h>

List of all members.

Public Member Functions
	CCPrintInfo ()
	Default constructor.
	CCPrintInfo (Document *pDoc, CCamView *pCCamView)
	Main constructor.
	~CCPrintInfo ()
	Default destructor.
BOOL	StartPrinting ()
	This informs the print info object that you are about to do some printing.
BOOL	MorePaper () const
	Call this to determin when to finish the print run of paper NB: You must call StartPrinting() before calling this func as part of your print loop.
BOOL	GetNextPaper ()
	Call this for each piece of paper to be printed to. NB: You must call StartPrinting() before calling this func as part of your print loop.
BOOL	GetNextPatch (PrintPatchInfo *pPatchInfo)
	If this call returns TRUE, then the given PrintPatchInfo has been set up with all the data needed to print the given patch.
BOOL	ReprintPaper ()
	This allows you to print on the same piece of paper again.
BOOL	EndPrinting ()
	This informs the print info object that you have finished printing. It also closes the print progress dialog (if there is one).
BOOL	StartPlatePrinting (PrintView *pPrintView, UINT32 *const pErrID)
	Fast error checking connection functions to the PrintControl associated class functions. See the headers for these functions for details.
BOOL	MorePlates ()
BOOL	SetNextPlate (PrintView *pPrintView)
void	EndPlatePrinting (PrintView *pPrintView)
void	SetSliderSubRangeMax (INT32 Max)
	Defines the maximum value you will call SetSliderSubRange() with. The slider is split up into sub-ranges, each range represents a patch (or tile) that will be printed. The slider is automatically set to the start of a sub-range when GetNextPatch() is called.
void	SetSliderSubRangePos (INT32 Pos)
	Sets the slider so that it represents this value within the current sub-range. Before Pos is used, it is brought into range such that 0 <= Pos <= MaxSubRange ('MaxSubRange' is set via SetSliderSubRangeMax()).
void	SetAnalysing ()
	This tells the associated print progress dlg that we are not yet printing the doc, we are currently running some analysis on it. This will display "Analysing <doc name>" instead of "Printing <doc name>".
void	SetPrinting ()
	This tells the associated print progress dlg that we have started printing the doc. This will display "Printing <doc name>" instead of "Analysing <doc name>".
INT32	SetAbortProc (CDC *pCDC)
	Calls pCDC->SetAbortProc() with the appropriate abort proc.
BOOL	Abort ()
	Calls the print progress dlg's abort proc to see if the user has aborted the print job.
BOOL	SetUpDocInfo (DOCINFO **pDocInfo)
	Creates and sets up a DOCINFO structure, ready for a call to StartDoc(). If printing to file, this func will ensure that the lpszOutput member points to a valid file name.
PrintControl *	GetPrintControl ()
void	LockProgressUpdate (BOOL Locked)
	Locks/Unlocks the print progress dialogue (if any) to make sure it doesn't update the progress slider etc during some critical operation.
wxDC *	MakeDCFromPrintData (wxPrintData *pPrintData)
	Generates a wxPostscriptDC even though the print dialog may not have wanted to give us one. Also fills in m_pNativePrintData with the necessary print data.
Document *	GetDocument ()
void	SavePrintDialogData ()
BOOL	OnPreparePrinting (BOOL bPrintSetupOnly=FALSE)
	Brings up a print dialog.
BOOL	UpdatePrinterSettings (BOOL RedrawPrintBorders=TRUE)
	Updates the static members that represent the current printer settings Camelot is interested in, such a paper size, orientation, etc. It uses the DEVMODE structure returned by GetDevMode(), plus member funcs for driver, device and port names.
CCDC *	GetCCDC () const
CNativeDC *	GetDC () const
	Utility function to get to the underlying DC.
Static Public Member Functions
static CCPrintInfo *	GetCurrent ()
static BOOL	HasPrintSetup ()
Public Attributes
wxPrintData *	m_pNativePrintData
BOOL	m_bContinuePrinting
wxRect	m_rectDraw
Private Attributes
BOOL	Initialised
BOOL	Printing
CCPrintDialog *	pOurPD
wxPrintDialog *	pOriginalPD
Document *	pDocument
String_256	DocTitle
PrintControl *	pPrCtrl
PrintProgressDlg *	pPrgDlg
CCDC *	pCCDC
Static Private Attributes
static CCPrintInfo *	pCurrent = NULL
static wxPrintDialogData	m_DefaultDialogData
static BOOL	m_HaveSavedDefaultDialogData = FALSE

---

Detailed Description

To provide a custom Print Info class.

Author:

Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>

Date:

29/3/95

Definition at line 135 of file prdlgctl.h.

---

Constructor & Destructor Documentation

CCPrintInfo::CCPrintInfo (   )

Default constructor. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/3/95 Parameters: -  [INPUTS] Returns: - See also: CCPrintInfo::CCPrintInfo(Document* pDoc) Definition at line 1916 of file prdlgctl.cpp. { ERROR3("Default constructor called. Use other constructor"); pOurPD = NULL; pOriginalPD = NULL; Initialised = FALSE; pDocument = NULL; pCCDC = NULL; m_bContinuePrinting = TRUE; m_pNativePrintData = NULL; if (m_HaveSavedDefaultDialogData) *((wxPrintDialogData *)this) = m_DefaultDialogData; }

CCPrintInfo::CCPrintInfo (  Document *  pDoc, CCamView *  pCCamVw )

Main constructor. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/3/95 Parameters: pDoc  = ptr to doc associated with the print operation [INPUTS] pCCamVw = ptr to the cam view that's doing the print job Returns: - This replaces the m_pPD ptr created by the base CPrintInfo class with a ptr to a CCPrintDialog See also: - Definition at line 1950 of file prdlgctl.cpp. { CAM_USE(pCCamVw); // Unused parameter in wxOil - used in WinOil pOurPD = NULL; pOriginalPD = NULL; Initialised = FALSE; Printing = FALSE; pDocument = pDoc; pPrCtrl = NULL; pPrgDlg = NULL; pCCDC = NULL; m_bContinuePrinting = TRUE; m_pNativePrintData = NULL; if (m_HaveSavedDefaultDialogData) *((wxPrintDialogData *)this) = m_DefaultDialogData; EnableHelp(TRUE); EnablePageNumbers(FALSE); // Make this TRUE to enable multiple pages EnablePrintToFile(TRUE); EnableSelection(TRUE); // we should test here whether or not there is a selection PORTNOTE("printing", "Disabled creation of a print dialog inside a CCPrintInfo structure") #ifndef EXCLUDE_FROM_XARALX if (pDocument != NULL) { pOurPD = new CCPrintDialog(pDocument); if (pOurPD != NULL) { pOriginalPD = m_pPD; m_pPD = pOurPD; Initialised = TRUE; } else { ERROR3("Unable to create a CCPrintDialog object"); } } #else Initialised = TRUE; #endif ERROR3IF(pDocument == NULL,"CCPrintInfo has NULL document ptr"); ERROR3IF(CCPrintInfo::pCurrent != NULL,"Constructing a new CCPrintInfo before destructing the old one"); CCPrintInfo::pCurrent = this; }

CCPrintInfo::~CCPrintInfo (   )

Default destructor. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/3/95 Parameters: -  [INPUTS] Returns: - This tidies up by restoring the m_pPD member back to how the base class constructed it and destroys the CCPrintDialog it made on initialisation See also: - Definition at line 2015 of file prdlgctl.cpp. { ERROR3IF(!Initialised,"CCPrintInfo being destructed without successful construction"); if (Initialised) { PORTNOTE("printing", "Disabled deletion of a print dialog inside printinfo structure") #ifndef EXCLUDE_FROM_XARALX // restore base classes original CPrintDialog ptr m_pPD = pOriginalPD; #endif // Delete our CCPrintDialog if (pOurPD != NULL) delete pOurPD; // Delete our print progress dialog if (pPrgDlg != NULL) pPrgDlg->Done(); // this deletes it } if (pCCDC) { delete pCCDC; pCCDC=NULL; } if (m_pNativePrintData) delete m_pNativePrintData; CCPrintInfo::pCurrent = NULL; }

---

Member Function Documentation

BOOL CCPrintInfo::Abort (   )

Calls the print progress dlg's abort proc to see if the user has aborted the print job. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the user has aborted the print job, FALSE otherwise NB: The return value is the reverse of the origin logic used in the first working print code See also: - Definition at line 2773 of file prdlgctl.cpp. { return PrintProgressDlg::AbortProc(); }

void CCPrintInfo::EndPlatePrinting (  PrintView *  pPrintView  )

Definition at line 2607 of file prdlgctl.cpp. { ERROR3IF(!Printing,"EndPlatePrinting() called before StartPrinting()"); ERROR3IF(pPrCtrl == NULL,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); pPrCtrl->EndPlatePrinting(pPrintView); }

BOOL CCPrintInfo::EndPrinting (   )

This informs the print info object that you have finished printing. It also closes the print progress dialog (if there is one). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/95 Parameters: -  [INPUTS] Returns: TRUE if all OK, FALSE otherwise See also: StartPrinting(); Definition at line 2412 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"EndPrinting() called before StartPrinting()"); Printing = FALSE; // End the print control structure ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); BOOL ok = pPrCtrl->EndPrinting(); pPrCtrl = NULL; // End the print marks manager too PrintMarksMan* pMarksMan = GetApplication()->GetMarksManager(); if (pMarksMan) pMarksMan->EndPrinting(); // now destroy the print dialogue if (pPrgDlg != NULL) { pPrgDlg->Done(); pPrgDlg = NULL; } return (ok); }

CCDC* CCPrintInfo::GetCCDC (   )  const [inline]

Definition at line 200 of file prdlgctl.h. {return pCCDC;}

static CCPrintInfo* CCPrintInfo::GetCurrent (   )  [inline, static]

Definition at line 167 of file prdlgctl.h. { return pCurrent; }

CNativeDC * CCPrintInfo::GetDC (   )  const

Utility function to get to the underlying DC. Author: Alex Bligh <alex@alex.org.uk> Date: 22/6/2006 Parameters: -  [INPUTS] Returns: The CNativeDC See also: - Definition at line 2063 of file prdlgctl.cpp. { return pCCDC?pCCDC->GetDC():NULL; }

Document* CCPrintInfo::GetDocument (   )  [inline]

Definition at line 173 of file prdlgctl.h. {return pDocument;}

BOOL CCPrintInfo::GetNextPaper (   )

Call this for each piece of paper to be printed to. NB: You must call StartPrinting() before calling this func as part of your print loop. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/95 Parameters: -  [INPUTS] Returns: TRUE if you should print on another piece of paper FALSE if the print job should end See also: StartPrinting(); Definition at line 2452 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"GetNextPaper() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); return (pPrCtrl->GetNextPaper()); }

BOOL CCPrintInfo::GetNextPatch (  PrintPatchInfo *  pPatchInfo  )

If this call returns TRUE, then the given PrintPatchInfo has been set up with all the data needed to print the given patch. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/95 Parameters: pPatchInfo  = ptr to object to store patch info in [INPUTS] -  [OUTPUTS] Returns: TRUE if you should print another page on the paper FALSE if the piece of paper printed to is finished. NB: You must call GetNextPaper() before calling this func as part of your print loop It automatically updates any relevent fields within the print progress dialog, if there is one. See also: StartPrinting(), GetNextPaper() Definition at line 2532 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"GetNextPatch() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); BOOL ok = pPrCtrl->GetNextPatch(pPatchInfo); if (ok && pPrgDlg != NULL) { // Determine how many printing plates we're doing, and which one we're up to... INT32 MaxPlates = 0; // If doing a composite print, we pass in 0 INT32 CurrentPlate = 1; String_128 PlateName(TEXT("-")); if (GetPrintControl() != NULL) { TypesetInfo *TSInfo = GetPrintControl()->GetTypesetInfo(); if (TSInfo != NULL && TSInfo->AreSeparating()) { MaxPlates = (INT32) TSInfo->GetNumPrintPlates(); CurrentPlate = MaxPlates - TSInfo->NumPrintPlatesRemaining(); ColourPlate *ThisPlate = TSInfo->GetCurrentPrintPlate(); if (ThisPlate != NULL) ThisPlate->GetDescription((StringBase *) &PlateName); } } // And set the page, plate, and tile numbers pPrgDlg->SetPageNumber( pPatchInfo->PaperNumber, pPatchInfo->MaxPaperNumber, CurrentPlate, MaxPlates, (TCHAR *) PlateName, pPatchInfo->PatchNumber, pPatchInfo->MaxPatchNumber); } return ok; }

PrintControl* CCPrintInfo::GetPrintControl (   )  [inline]

Definition at line 165 of file prdlgctl.h. { return pPrCtrl; }

BOOL CCPrintInfo::HasPrintSetup (   )  [static]

Author: Alex Bligh <alex@alex.org.uk> Date: 22/6/2006 Parameters: -  [INPUTS] Returns: TRUE if a print setup dialog can be brought up See also: - Definition at line 2280 of file prdlgctl.cpp. { wxPrintFactory* factory = wxPrintFactory::GetFactory(); return (factory->HasPrintSetupDialog()); }

void CCPrintInfo::LockProgressUpdate (  BOOL  Locked  )

Locks/Unlocks the print progress dialogue (if any) to make sure it doesn't update the progress slider etc during some critical operation. Author: Alex Bligh <alex@alex.org.uk> Date: 22/6/2006 Parameters: Locked  - to lock the progress update [INPUTS] Returns: See also: - Definition at line 2301 of file prdlgctl.cpp. { if (pPrgDlg != NULL) pPrgDlg->LockProgressUpdate(Locked); }

wxDC * CCPrintInfo::MakeDCFromPrintData (  wxPrintData *  pPrintData  )

Generates a wxPostscriptDC even though the print dialog may not have wanted to give us one. Also fills in m_pNativePrintData with the necessary print data. Author: Alex Bligh <alex@alex.org.uk> Date: 22/6/2006 Parameters: pPrintData  - pointer to the dialog's print data [INPUTS] Returns: A DC suitable for printing to See also: - Definition at line 2203 of file prdlgctl.cpp. { // Make a new wxPostscriptDC based on the print data if (m_pNativePrintData) { delete m_pNativePrintData; m_pNativePrintData = NULL; } // We don't use the copy constructor to copy things over here because this copies // wxPrintNativeData etc. which is print factory specific. We also have to switch // print factories around so we get a new print factory with the correct private // data in (what a bore). #if wxUSE_LIBGNOMEPRINT wxPrintFactory::SetPrintFactory(new wxNativePrintFactory); #endif wxPrintData * pNewData = new wxPrintData; if (!pNewData) { #if wxUSE_LIBGNOMEPRINT // restore the print factory wxPrintFactory::SetPrintFactory(new wxGnomePrintFactory); #endif ERROR2(NULL, "CCPrintInfo::OnPreparePrinting() could not get new print data"); } // Now copy through the bits we care about pNewData->SetPrinterName(pPrintData->GetPrinterName()); pNewData->SetNoCopies(pPrintData->GetNoCopies()); pNewData->SetCollate(pPrintData->GetCollate()); pNewData->SetOrientation(pPrintData->GetOrientation()); pNewData->SetColour(pPrintData->GetColour()); pNewData->SetDuplex(pPrintData->GetDuplex()); pNewData->SetPaperId(pPrintData->GetPaperId()); pNewData->SetPaperSize(pPrintData->GetPaperSize()); pNewData->SetQuality(pPrintData->GetQuality()); pNewData->SetBin(pPrintData->GetBin()); pNewData->SetPrintMode(pPrintData->GetPrintMode()); pNewData->SetFilename(pPrintData->GetFilename()); wxDC * dc=new wxPostScriptDC(*pNewData); // this has been copied, so it can safely be deleted m_pNativePrintData = pNewData; #if wxUSE_LIBGNOMEPRINT // restore the print factory wxPrintFactory::SetPrintFactory(new wxGnomePrintFactory); #endif if (!(dc->IsKindOf(CLASSINFO(wxPostScriptDC)))) { delete dc; ERROR2(NULL, "Something is obstinately refusing to give us a wxPostScriptDC"); } return dc; }

BOOL CCPrintInfo::MorePaper (   )  const

Call this to determin when to finish the print run of paper NB: You must call StartPrinting() before calling this func as part of your print loop. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 11/6/96 Parameters: -  [INPUTS] Returns: TRUE if there is another piece of paper to come FALSE if the print job should end See also: StartPrinting(); Definition at line 2475 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"MorePaper() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); return (pPrCtrl->MorePaper()); }

BOOL CCPrintInfo::MorePlates (   )

Definition at line 2593 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"MorePlates() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); return (pPrCtrl->MorePlates()); }

BOOL CCPrintInfo::OnPreparePrinting (  BOOL  bPrintSetupOnly = FALSE  )

Brings up a print dialog. Author: Alex Bligh <alex@alex.org.uk> Date: 22/6/2006 Parameters: bPrintSetupOnly  - true to just bring up the print setup dialog [INPUTS] Returns: TRUE to print, FALSE to not print See also: - Definition at line 2082 of file prdlgctl.cpp. { wxPostScriptDC::SetResolution(600); // temporary bodge // Zap any existing print dialog if (pOurPD) { delete pOurPD; pOurPD = NULL; } EnablePrintToFile(true); EnableSelection(true); EnablePageNumbers(false); pOurPD = new CCPrintDialog(this, pDocument); if (!pOurPD) { return FALSE; } // Get rid of any existing CCDC if (!pCCDC) delete pCCDC; pCCDC = NULL; // Bring up a native print setup dialog if possible wxPrintFactory* factory = wxPrintFactory::GetFactory(); // Use the print dialog if we can if (bPrintSetupOnly && factory->HasPrintSetupDialog()) { // The print setup dialog should change the // print data in-place if not cancelled. wxDialog *dialog = factory->CreatePrintSetupDialog( NULL, &(pOurPD->GetPrintDialogData().GetPrintData()) ); if (dialog->ShowModal() == wxID_OK) { *((wxPrintDialogData *)this)=pOurPD->GetPrintDialogData(); SavePrintDialogData(); UpdatePrinterSettings(TRUE); } // If we are to ignore the printer data (because the selected printer has been deleted, renamed, etc) // then we must reset the global memory handles that hold the data, as the settings they contain // no longer refer to a printer known by the host system if (CCPrintDialog::IgnorePrintData()) { PORTNOTE("printing", "don't do FreeGlobalHandle") #ifndef EXCLUDE_FROM_XARALX CCPrintDialog::FreeGlobalHandle(&m_hDevMode); CCPrintDialog::FreeGlobalHandle(&m_hDevNames); #endif CCPrintDialog::ResetIgnorePrintData(); } dialog->Destroy(); delete pOurPD; pOurPD = NULL; return FALSE; } ResourceID ret = pOurPD->ShowModal(); if ( (ret == wxID_CANCEL) || !pOurPD->GetPrintDialogData().Ok()) { delete pOurPD; pOurPD = NULL; return FALSE; } // They pressed print wxDC * dc = pOurPD->GetPrintDC(); // we now own the DC. if (dc) delete dc; // ignore your nasty dc, which may be a non-wxPostScript DC // Overwrite our own settings *((wxPrintDialogData *)this)=pOurPD->GetPrintDialogData(); SavePrintDialogData(); UpdatePrinterSettings(TRUE); pCCDC = NULL; dc = MakeDCFromPrintData(&(pOurPD->GetPrintDialogData().GetPrintData())); if (!dc) { delete pOurPD; pOurPD = NULL; ERROR2(FALSE, "CCPrintInfo::OnPreparePrinting() could not get a wxPostScriptDC"); } pCCDC = new PSPrintDC(dc); if (!pCCDC) { delete dc; delete pOurPD; pOurPD = NULL; return FALSE; } pCCDC->SetDC(dc, TRUE); // now deleting the CCDC will delete the DC too return TRUE; }

BOOL CCPrintInfo::ReprintPaper (   )

This allows you to print on the same piece of paper again. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/95 Parameters: -  [INPUTS] Returns: TRUE if all OK, FALSE otherwise If you call this func after a call to GetNextPaper(), then the next time you call GetNextPaper() you will actually be starting the print on the same piece of paper. See also: GetNextPaper() Definition at line 2501 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"ReprintPaper() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); return (pPrCtrl->ReprintPaper()); }

void CCPrintInfo::SavePrintDialogData (   )  [inline]

Definition at line 175 of file prdlgctl.h. {m_DefaultDialogData = *(wxPrintDialogData *)this; m_HaveSavedDefaultDialogData = TRUE;}

INT32 CCPrintInfo::SetAbortProc (  CDC *  pCDC  )

Calls pCDC->SetAbortProc() with the appropriate abort proc. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/95 Parameters: pCDC  = ptr to CDC used for printing [INPUTS] -  [OUTPUTS] Returns: 0 means OK, non-zero means ERROR See also: CDC::SetAbortProc() Definition at line 2743 of file prdlgctl.cpp. { PORTNOTE("printing", "Disabled SetAbortProc bits") #ifndef EXCLUDE_FROM_XARALX ERROR2IF(pCDC == NULL,SP_ERROR,"Given NULL CDC ptr"); return (pCDC->SetAbortProc(PrintProgressDlg::AbortProc)); #else return 0; #endif }

void CCPrintInfo::SetAnalysing (   )

This tells the associated print progress dlg that we are not yet printing the doc, we are currently running some analysis on it. This will display "Analysing <doc name>" instead of "Printing <doc name>". Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/5/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: - Definition at line 2693 of file prdlgctl.cpp. { if (pPrgDlg != NULL) { pPrgDlg->SetAnalysing(); if (pDocument != NULL) pPrgDlg->SetDocName(pDocument->GetTitle()); } }

BOOL CCPrintInfo::SetNextPlate (  PrintView *  pPrintView  )

Definition at line 2600 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"SetNextPlate() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); return (pPrCtrl->SetNextPlate(pPrintView)); }

void CCPrintInfo::SetPrinting (   )

This tells the associated print progress dlg that we have started printing the doc. This will display "Printing <doc name>" instead of "Analysing <doc name>". Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/5/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: - Definition at line 2719 of file prdlgctl.cpp. { if (pPrgDlg != NULL) { pPrgDlg->SetPrinting(); if (pDocument != NULL) pPrgDlg->SetDocName(pDocument->GetTitle()); } }

void CCPrintInfo::SetSliderSubRangeMax (  INT32  Max  )

Defines the maximum value you will call SetSliderSubRange() with. The slider is split up into sub-ranges, each range represents a patch (or tile) that will be printed. The slider is automatically set to the start of a sub-range when GetNextPatch() is called. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/95 Parameters: Max  = The maximum value the sub-range will reach [INPUTS] -  [OUTPUTS] Returns: - After GetNextPatch() is called, call this func to define the range of values for the slider sub-range to represent. Then call SetSliderSubRanngePos() each time the progress of the patch changes. This will only have an effect if StartPrinting() has been successfully called. If there isn't a progress bar (for what ever reason) this function does nothing (not even error). See also: StartPrinting(), SetSliderSubRangePos() Definition at line 2643 of file prdlgctl.cpp. { if (pPrgDlg != NULL) pPrgDlg->SetSliderSubRangeMax(Max); }

void CCPrintInfo::SetSliderSubRangePos (  INT32  Pos  )

Sets the slider so that it represents this value within the current sub-range. Before Pos is used, it is brought into range such that 0 <= Pos <= MaxSubRange ('MaxSubRange' is set via SetSliderSubRangeMax()). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/95 Parameters: Pos  = value for the current sub-range [INPUTS] -  [OUTPUTS] Returns: - This will only have an effect if StartPrinting() has been successfully called. If there isn't a progress bar (for what ever reason) this function does nothing (not even error). See also: StartPrinting(), SetSliderSubRangeMax() Definition at line 2670 of file prdlgctl.cpp. { if (pPrgDlg != NULL) pPrgDlg->SetSliderSubRangePos(Pos); }

BOOL CCPrintInfo::SetUpDocInfo (  DOCINFO **  ppDocInfo  )

Creates and sets up a DOCINFO structure, ready for a call to StartDoc(). If printing to file, this func will ensure that the lpszOutput member points to a valid file name. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/95 Parameters: ppDocInfo  = ptr to place to put a ptr to a DOCINFO structure [INPUTS] ppDocInfo  = contains ptr to an initialised DOCINFO struct. [OUTPUTS] Returns: TRUE if ok, FALSE otherwise pDocInfo contains the ptr to the DOCINFO on exit. It is up to the caller to delete this object when no longer needed See also: - Definition at line 2799 of file prdlgctl.cpp. { ERROR2IF(ppDocInfo == NULL,FALSE,"ppDocInfo param is NULL"); ERROR2IF(pDocument == NULL,FALSE,"pDocument is NULL"); // Create a new DOCINFO struct so that we are compatible across all OSs NEW_DOCINFO* pNewDocInfo = new NEW_DOCINFO; BOOL ok = (pNewDocInfo != NULL); if (ok) { // Zero all struct members memset(pNewDocInfo,0,sizeof(NEW_DOCINFO)); pNewDocInfo->cbSize = sizeof(NEW_DOCINFO); // set up document title DocTitle = pDocument->GetTitle(); pNewDocInfo->lpszDocName = DocTitle; pNewDocInfo->lpszOutput = NULL; ERROR2IF(pOurPD == NULL,FALSE,"NULL CCPrintDialog ptr"); // Get ptr to the PrintControl object if (pPrCtrl == NULL) pPrCtrl = pOurPD->GetPrintControl(); ERROR3IF(pPrCtrl == NULL,"Unable to get ptr to the PrintControl object"); PORTNOTE("printing", "Disabled print to file") #ifndef EXCLUDE_FROM_XARALX if (pPrCtrl != NULL && pPrCtrl->GetPrintToFile()) { // Keep Control Helper system informed ControlHelper::InformModalDialogOpened(); String_256 Filt(_R(IDS_PRDLGCTL_PRINT_FILES_FILT_DLG)); CCPrintToFileDialog PrintToFileDlg("prn", (TCHAR *)Filt); if (PrintToFileDlg.DoModal() == IDOK) pNewDocInfo->lpszOutput = PrintToFileDlg.GetFullPathNamePtr(); else ok = FALSE; // Abort printing if Cancel is clicked // Keep Control Helper system informed ControlHelper::InformModalDialogClosed(); } #endif } if (!ok && pNewDocInfo != NULL) { delete pNewDocInfo; pNewDocInfo = NULL; } ERROR2IF(ok && pNewDocInfo == NULL,FALSE,"Returning TRUE but we have a NULL DOCINFO ptr"); *ppDocInfo = (DOCINFO*)pNewDocInfo; return ok; }

BOOL CCPrintInfo::StartPlatePrinting (  PrintView *  pPrintView, UINT32 *const   pErrID )

Fast error checking connection functions to the PrintControl associated class functions. See the headers for these functions for details. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 11/6/96 Parameters: -  [INPUTS] Returns: - Definition at line 2586 of file prdlgctl.cpp. { ERROR2IF(!Printing,FALSE,"StartPlatePrinting() called before StartPrinting()"); ERROR2IF(pPrCtrl == NULL,FALSE,"Called with NULL PrintControl ptr. Have you called StartPrinting()?"); return (pPrCtrl->StartPlatePrinting(pPrintView, pErrID)); }

BOOL CCPrintInfo::StartPrinting (   )

This informs the print info object that you are about to do some printing. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 25/4/95 Parameters: -  [INPUTS] Returns: TRUE if all OK, FALSE otherwise It also creates and displays the print progress dialog. This is purely to set up the print layout mechanism. It will work out how many pieces of paper will be printed to, and how many times the page will be printed on each piece of of paper (for multiple fit printing). CCPrintInfo just provides easy access to the functions provided by the PrintControl class. It means you don't have to worry about getting hold of the right PrintControl object from the right document - this is all taken care of for you. The mechanism works like this: if (StartPrinting()) { while (GetNextPaper()) { while (GetNextPatch()) { Use access funcs to get hold of data set up by GetNextPath(), e.g. scale, translation, etc if (SelectedOnly) print all selected objects that lie within the ClipRect area in the spread else print all objects that lie within the ClipRect area in the spread } } EndPrinting() } See also: GetNextPaper(), GetNextPath() Definition at line 2351 of file prdlgctl.cpp. { ERROR2IF(Printing,FALSE,"StartPrinting() called before EndPrinting()"); Printing = TRUE; // If not initialised properly, don't start printing ERROR2IF(!Initialised,FALSE,"Not initialised"); ERROR2IF(pOurPD == NULL,FALSE,"NULL CCPrintDialog ptr"); ERROR2IF(pDocument == NULL,FALSE,"Document ptr is NULL"); // Get ptr to the PrintControl object pPrCtrl = pOurPD->GetPrintControl(); ERROR2IF(pPrCtrl == NULL,FALSE,"The print dialog can't find attached print control object"); if (!pPrCtrl->StartPrinting()) { pPrCtrl = NULL; return FALSE; } // Start up the print marks manager too PrintMarksMan* pMarksMan = GetApplication()->GetMarksManager(); if (pMarksMan) pMarksMan->StartPrinting(); ERROR3IF(pPrgDlg != NULL,"StartPrinting() called with non-NULL pPrgDlg. Did you call EndPrinting() last time?"); OpDescriptor* pOpDesc = (OpDescriptor*)OpDescriptor::FindOpDescriptor( OPTOKEN_PRINT_PROGRESS ); if ( pOpDesc ) pOpDesc->Invoke(); // Create and initialise the print progress dialog pPrgDlg = PrintProgressDlg::Get(); if (pPrgDlg == NULL) { pPrCtrl->EndPrinting(); pPrCtrl = NULL; return FALSE; } //pPrgDlg->SetDocName(pDocument->GetTitle()); pPrgDlg->SetPrinterName(GetPrintData().GetPrinterName()); // pPrgDlg->SetPortName(GetPrintData().GetPrinterCommand()); pPrgDlg->SetSliderPos(0); return TRUE; }

BOOL CCPrintInfo::UpdatePrinterSettings (  BOOL  RedrawPrintBorders = TRUE  )

Updates the static members that represent the current printer settings Camelot is interested in, such a paper size, orientation, etc. It uses the DEVMODE structure returned by GetDevMode(), plus member funcs for driver, device and port names. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 14/4/95 Parameters: RedrawPrintBorders  = TRUE if you want any visible print borders redrawing [INPUTS] Returns: TRUE if ok, FALSE otherwise This sets the static member GotPrinterSettings to TRUE if successful See also: static BOOL UpdatePrinterSettings() Definition at line 780 of file prdlgctl.cpp. { wxDC * dc = MakeDCFromPrintData(&GetPrintData()); BOOL ret=CCPrintDialog::UpdatePrinterSettings(m_pNativePrintData,dc,pDocument,RedrawPrintBorders); delete dc; return ret; }

---

Member Data Documentation

String_256 CCPrintInfo::DocTitle [private]

Definition at line 183 of file prdlgctl.h.

BOOL CCPrintInfo::Initialised [private]

Definition at line 178 of file prdlgctl.h.

BOOL CCPrintInfo::m_bContinuePrinting

Definition at line 203 of file prdlgctl.h.

wxPrintDialogData CCPrintInfo::m_DefaultDialogData [static, private]

Definition at line 190 of file prdlgctl.h.

BOOL CCPrintInfo::m_HaveSavedDefaultDialogData = FALSE [static, private]

Definition at line 191 of file prdlgctl.h.

wxPrintData* CCPrintInfo::m_pNativePrintData

Definition at line 172 of file prdlgctl.h.

wxRect CCPrintInfo::m_rectDraw

Definition at line 205 of file prdlgctl.h.

CCDC* CCPrintInfo::pCCDC [private]

Definition at line 187 of file prdlgctl.h.

CCPrintInfo * CCPrintInfo::pCurrent = NULL [static, private]

Definition at line 189 of file prdlgctl.h.

Document* CCPrintInfo::pDocument [private]

Definition at line 182 of file prdlgctl.h.

wxPrintDialog* CCPrintInfo::pOriginalPD [private]

Definition at line 181 of file prdlgctl.h.

CCPrintDialog* CCPrintInfo::pOurPD [private]

Definition at line 180 of file prdlgctl.h.

PrintControl* CCPrintInfo::pPrCtrl [private]

Definition at line 184 of file prdlgctl.h.

PrintProgressDlg* CCPrintInfo::pPrgDlg [private]

Definition at line 185 of file prdlgctl.h.

BOOL CCPrintInfo::Printing [private]

Definition at line 179 of file prdlgctl.h.

---

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

• wxOil/prdlgctl.h (r1785/r1742)
• wxOil/prdlgctl.cpp (r1785/r1742)

---