PluginNativeFilter Class Reference

This is the plugin import/export filter that passes Xar format data to an external object for further processing. More...

#include <xpfilter.h>

Inheritance diagram for PluginNativeFilter:

List of all members.

Public Member Functions
	PluginNativeFilter ()
	Constructor for the Native save/load filter.
	~PluginNativeFilter ()
	Tidies up when the filter is destroyed.
BOOL	Init (xmlNode *pFilterNode)
	Initalises the Filter ready for use. Will fail if it can not get enough memory to work with.
virtual INT32	HowCompatible (PathName &Filename, ADDR HeaderStart, UINT32 HeaderSize, UINT32 FileSize)
virtual BOOL	DoImport (SelOperation *, CCLexFile *, Document *, BOOL AutoChosen=FALSE, ImportPosition *Pos=NULL, KernelBitmap **ppImportedBitmap=NULL, DocCoord *pPosTranslate=NULL, String_256 *=NULL)
	Read the data from the specified file.
virtual BOOL	DoExport (Operation *, CCLexFile *, PathName *, Document *, BOOL)
	Exports the current document out to file. Uses the virtual functions of this class. Do not override unless really necessary.
virtual BOOL	StartCompression ()
	Function to turn Compression on when we are writing to the file. It asks the underlying CCFile and CXaraFile to start the compression process up.
virtual BOOL	StopCompression ()
	Function to turn Compression off when we are writing to the file. It asks the underlying CCFile and CXaraFile to stop the compression process.
virtual BOOL	GetExportOptions (WebPrefsDlgParam *pPrefs)
	Overrides base class so we can do our own thing.
virtual BOOL	IsWebFilter ()
virtual BOOL	IsCompactNativeFilter ()
virtual INT32	GetBitmapCompression ()
	Public access to the current bitmap compression which the user has requested to use when saving bitmaps in the web format. 0 means maximum compression e.g. use JPEG filter at 0% lossy compression 100 means minimum compression e.g. use JPEG filter at 100% lossy compression 101 - 200 means lossless compression e.g. us PNG filter. Could use the no bitmap compression at all e.g. use BMP filter. Unused at present. (Very much like the JPEG compression percentage). Note: This overrides the baseclass version to save in the proper native state.
virtual BOOL	GetPreviewBitmapExport ()
	Public access to the current export preview bitmap which the user has requested to use when saving bitmaps in the web format. True means export a preview bitmap, False means do not. Note: This overrides the baseclass version to save in the proper native state.
virtual BOOL	GetConvertTextToOutlines ()
	Public access to the current convert text to outlines which the user has requested to use when saving in the web format. True means convert text to outlines, False means do not. Note: This overrides the baseclass version to save in the proper native state.
virtual BOOL	GetRemoveInvisibleLayers ()
	Public access to the current remove invisible layers which the user has requested to use when saving in the web format. True means remove invisible layers, False means do not. Note: This overrides the baseclass version to save in the proper native state.
virtual BOOL	GetRemoveUnusedColours ()
	Public access to the current remove unused colours which the user has requested to use when saving in the web format. True means remove unused colours, False means do not. Note: This overrides the baseclass version to save in the proper native state.
virtual BOOL	GetSaveXPEBitmaps ()
virtual BOOL	SetSaveXPEBitmaps (BOOL NewSaveXPEBitmaps)
virtual INT32	HowCompatibleIsFileType (char *pFileType)
virtual double	GetSimilarPathTolerance (NodePath *pPath)
virtual INT32	GetMaxPathLookUp ()
	The max number pf paths that should be looked at by the function FindSimilarPath().
virtual WebPrefsDlgParam *	GetCachedExportOptions ()
virtual BOOL	WriteSpecificRegularShapes ()
virtual BoundsWriteLevel	GetBoundsWriteLevel ()
BOOL	SetProgressBarCount (UINT32 n)
void	AddBitmapToList (KernelBitmap *pBmp)
String_256	GetNewBitmapName ()
Protected Member Functions
virtual char *	GetExportFileType ()
BOOL	GenerateExportData (CapabilityTree *pPlugCaps)
BOOL	DoConversionPassN (CapabilityTree *pPlugCaps, INT32 ConvertPass)
BOOL	DoBitmapResamplePass (CapabilityTree *pPlugCaps)
virtual Node *	GetExportNode ()
	Returns a pointer to the first node to export.
virtual BOOL	BeginDocumentExport ()
	Creates the relevant NULL filter Scope: Protected.This function is called just before document-related records are written out to the file.
virtual BOOL	EndDocumentExport ()
	This function is called after document-related records have been are written out to the file. BeginDocumentExport() is called before the doc records are saved.
virtual BOOL	WriteCurrentAttributes ()
	Write out all current attributes.
Protected Attributes
UINT32	FilterNameID
UINT32	FilterInfoID
UINT32	ExportingMsgID
Node *	m_pNewTree
UINT32	m_ProgressOffset
BOOL	m_bSaveXPEBitmaps
BOOL	m_bPreviewBitmap
BoundsWriteLevel	m_BoundsLevel
INT32	m_BitmapCompression
List	m_BitmapList
INT32	m_BitmapCount
Private Member Functions
	CC_DECLARE_DYNAMIC (PluginNativeFilter)

---

Detailed Description

This is the plugin import/export filter that passes Xar format data to an external object for further processing.

Author:

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

Date:

26/01/05

Definition at line 119 of file xpfilter.h.

---

Constructor & Destructor Documentation

PluginNativeFilter::PluginNativeFilter (   )

Constructor for the Native save/load filter. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/5/96 Definition at line 140 of file xpfilter.cpp. { m_pNewTree = NULL; m_ProgressOffset = 0; m_bSaveXPEBitmaps = TRUE; // For now we will default this to saving out the bitmaps m_bPreviewBitmap = FALSE; m_BoundsLevel = BWL_NONE; m_BitmapCompression = 200; // Default to full PNG quality m_BitmapCount = 0; }

PluginNativeFilter::~PluginNativeFilter (   )

Tidies up when the filter is destroyed. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/5/96 Definition at line 164 of file xpfilter.cpp. { }

---

Member Function Documentation

void PluginNativeFilter::AddBitmapToList (  KernelBitmap *  pBmp  )  [inline]

Definition at line 189 of file xpfilter.h. { KernelBmpListItem* pItem = new KernelBmpListItem(pBmp); if (pItem) m_BitmapList.AddTail(pItem); }

BOOL PluginNativeFilter::BeginDocumentExport (   )  [protected, virtual]

Creates the relevant NULL filter Scope: Protected.This function is called just before document-related records are written out to the file. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 30/7/96 Parameters: -  [INPUTS] Returns: TRUE if successful, FALSE otherwise The native filter writes out a TAG_DOCUMENT record to signify the start of the document. See also: CamelotNativeFilter::EndDocumentExport() Scope: Protected Reimplemented from CamelotNativeFilter. Definition at line 1153 of file xpfilter.cpp. { BOOL ok = TRUE; // Writes out a document rec followed by a down rec // This will ensure that all doc-related records appear as a child of the doc record if (ok) ok = WriteZeroSizedRecord(TAG_DOCUMENT); if (ok) ok = WriteZeroSizedRecord(TAG_DOWN); return ok; }

PluginNativeFilter::CC_DECLARE_DYNAMIC (  PluginNativeFilter   )  [private]

BOOL PluginNativeFilter::DoBitmapResamplePass (  CapabilityTree *  pPlugCaps  )  [protected]

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 04/08/2006 Parameters: pPlugCaps  - pointer to a CapabilityTree [INPUTS] Returns: TRUE if ok, FALSE if bother Definition at line 731 of file xpfilter.cpp. { if (!pPlugCaps->GetBitmapResample()) return(TRUE); TRACE(_T("DoBitmapResamplePass")); Document* pDoc = Document::GetCurrent(); ERROR2IF(pDoc == NULL, FALSE, "No current document in DoBitmapResamplePass"); BitmapList* pBmpList = pDoc->GetBitmapList(); ERROR2IF(pDoc == NULL, FALSE, "No bitmap list in DoBitmapResamplePass"); // For each bitmap in the document's bitmap list KernelBitmap* pBitmap = (KernelBitmap*)(pBmpList->GetHead()); while (pBitmap) { double MinDPI = 1e9; List NodeList; // Scan through new document tree finding all uses of the bitmap Node* pNode = m_pNewTree->FindFirstDepthFirst(); while (pNode) { UINT32 Count = 0; BOOL bAdd = FALSE; KernelBitmap* pTestBitmap = pNode->EnumerateBitmaps(Count); while (pTestBitmap) { if (pTestBitmap == pBitmap) { bAdd = TRUE; // Add this node to the list double DPI = pNode->GetEffectiveBitmapMinDPI(pTestBitmap); if (DPI < MinDPI) MinDPI = DPI; } // Get the next bitmap from the node Count++; pTestBitmap = pNode->EnumerateBitmaps(Count); } if (bAdd) { NodeListItem* pItem = new NodeListItem(pNode); if (pItem) NodeList.AddTail(pItem); } // Get the next node pNode = pNode->FindNextDepthFirst(m_pNewTree); } // If a minimum has been found for this bitmap if (MinDPI < 1e9) { TRACE(_T("MinDPI = %f"), MinDPI); double ratio = pPlugCaps->GetRasteriseDPI() / MinDPI; // If the minimum dpi is above the resample dpi then if (ratio < 0.9) { TRACE(_T("Resample bitmap")); // Generate new bitmap with size so that minimum dpi is resample dpi TRACE(_T("Actual size = (%d, %d)"), pBitmap->GetWidth(), pBitmap->GetHeight()); INT32 OutWidth = (INT32)(((double)pBitmap->GetWidth() * ratio) + 0.5); INT32 OutHeight = (INT32)(((double)pBitmap->GetHeight() * ratio) + 0.5); TRACE(_T("Needed size = (%d, %d)"), OutWidth, OutHeight); KernelBitmap* pNewBitmap = NULL; { View* pView = View::GetCurrent(); Spread* pSpread = NULL; BOOL bAlpha = pBitmap->IsTransparent(); Matrix ViewTrans; FIXED16 TempScale(1.0); double Dpi = 96.0; DocRect BoundsRect(0, 0, OutWidth * 750, OutHeight * 750); GRenderBitmap BitmapRR(BoundsRect, ViewTrans, TempScale, 32, Dpi); if (bAlpha) BitmapRR.m_DoCompression = TRUE; BitmapRR.SetUsingSmoothedBitmaps(TRUE); // Make sure we do high quality BitmapRR.AttachDevice(pView, NULL, pSpread); // Start rendering into the bitmap if (!BitmapRR.StartRender()) { ERROR2(FALSE, "StartRender failed in DoBitmapResamplePass"); } BitmapRR.SaveContext(); // Best quality please QualityAttribute *pQualAttr = new QualityAttribute(); pQualAttr->QualityValue.SetQuality(QUALITY_MAX); BitmapRR.SetQuality(pQualAttr, TRUE); // Simple bitmap fill which fills the whole shape BitmapFillAttribute* pBitmapAttr = new BitmapFillAttribute; pBitmapAttr->GetBitmapRef()->SetBitmap(pBitmap); pBitmapAttr->StartPoint = BoundsRect.lo; pBitmapAttr->EndPoint = DocCoord(BoundsRect.hi.x, BoundsRect.lo.y); pBitmapAttr->EndPoint2 = DocCoord(BoundsRect.lo.x, BoundsRect.hi.y); // Set bitmap attribute, and get the render region to throw it away when it's finished // with (hence the TRUE parameter). BitmapRR.SetFillGeometry(pBitmapAttr, TRUE); BitmapRR.SetLineColour(COLOUR_NONE); Path RectPath; if (RectPath.Initialise()) { // Start at bottom left corner RectPath.InsertMoveTo(BoundsRect.lo); RectPath.InsertLineTo(DocCoord(BoundsRect.hi.x, BoundsRect.lo.y)); RectPath.InsertLineTo(BoundsRect.hi); RectPath.InsertLineTo(DocCoord(BoundsRect.lo.x, BoundsRect.hi.y)); RectPath.InsertLineTo(BoundsRect.lo); // Close the path properly RectPath.CloseSubPath(); RectPath.IsFilled = TRUE; RectPath.IsStroked = FALSE; BitmapRR.DrawPath(&RectPath); } BitmapRR.RestoreContext(); // Stop rendering BitmapRR.StopRender(); OILBitmap* pFullBitmap = BitmapRR.ExtractBitmap(); String_256 sName = GetNewBitmapName(); pFullBitmap->SetName(sName); pNewBitmap = KernelBitmap::MakeKernelBitmap(pFullBitmap); // Attach the bitmap to this document or a copy will be created when // it is used in the attribute BitmapList* pBmpList = NULL; Document* pCurDoc = Document::GetCurrent(); if (pCurDoc) pBmpList = pCurDoc->GetBitmapList(); // and then attach the bitmap (doesn't matter if BmpList is NULL) pNewBitmap->Attach(pBmpList); // Make sure we preserve the lossy flag pNewBitmap->SetAsLossy(pBitmap->IsLossy()); } if (pNewBitmap) { TRACE(_T("New bitmap = (%d, %d)"), pNewBitmap->GetWidth(), pNewBitmap->GetHeight()); // Loop through NodeList asking each node to replace the // specified bitmap with this new one NodeListItem* pItem = (NodeListItem*)(NodeList.GetHead()); while (pItem) { if (pItem->pNode) { if (!pItem->pNode->ReplaceBitmap(pBitmap, pNewBitmap)) { TRACE(_T("Failed to replace bitmap")); } } pItem = (NodeListItem*)(NodeList.GetNext(pItem)); } } else { TRACE(_T("Failed to create new bitmap")); } } } NodeList.DeleteAll(); pBitmap = (KernelBitmap*)(pBmpList->GetNext(pBitmap)); } return(TRUE); }

BOOL PluginNativeFilter::DoConversionPassN (  CapabilityTree *  pPlugCaps, INT32  ConvertPass )  [protected]

Definition at line 657 of file xpfilter.cpp. { TRACE( _T("DoConversionPassN(%d)\n"), ConvertPass); // Run a render loop and get the render callback to // check the attrs in the render region for each renderable object // and add any that require the bitmapfill conversion View *pView = View::GetCurrent(); ERROR2IF(pView == NULL, FALSE, "No current DocView in DoConversionPassN"); Node* pChapter = m_pNewTree->FindFirstChild(CC_RUNTIME_CLASS(Chapter)); ERROR2IF(pChapter == NULL, FALSE, "No chapter node in DoConversionPassN"); // Loop through each spread Node* pChild = pChapter->FindFirstChild(); while (pChild) { if (IS_A(pChild, Spread)) { Spread* pSpread = (Spread*)pChild; // Create and set up a new XPFRenderRegion XPFRenderRegion XPFRegion(this, pPlugCaps); // Attach a device to the scanning render region // Since this rr does no real rendering, it does not need a Device context XPFRegion.AttachDevice(pView, NULL, pSpread); // Start the render region and return if it fails if (XPFRegion.StartRender()) { // Create a render callback object to do the tricky stuff XPFRenderCallback XPFCallback(this, &XPFRegion, pPlugCaps, ConvertPass); // Call RenderTree to do the rendering XPFRegion.RenderTree(pSpread, FALSE, FALSE, &XPFCallback); // Thats all the nodes rendered, so stop rendering XPFRegion.StopRender(); // Now we need to convert all the nodes in the list if (!XPFCallback.ConvertNodes()) { return(FALSE); } } else { ERROR2(FALSE, "StartRender failed"); } } // Get the next child node of the chapter pChild = pChild->FindNext(); } return(TRUE); }

BOOL PluginNativeFilter::DoExport (  Operation *  pOp, CCLexFile *  pFile, PathName *  pPath, Document *  pDoc, BOOL  ShowOptions )  [virtual]

Exports the current document out to file. Uses the virtual functions of this class. Do not override unless really necessary. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 27/01/2005 Parameters: pOp  - the operation that started the export off [INPUTS] pFile - the file to put the exported data into pPath - the pathname of the file to be exported to pDoc - the document to export ShowOptions - Are the export options needed? Returns: TRUE if worked, FALSE if failed. See also: GetExportOptions; PrepareToExport; CleanUpAfterExport; Reimplemented from BaseCamelotFilter. Definition at line 345 of file xpfilter.cpp. { ERROR2IF(pOp == NULL, FALSE,"PluginNativeFilter::DoExport no export operation"); ERROR2IF(pFile == NULL, FALSE,"PluginNativeFilter::DoExport no file to export to"); ERROR2IF(pPath == NULL, FALSE,"PluginNativeFilter::DoExport no export pathname"); ERROR2IF(pDoc == NULL, FALSE,"PluginNativeFilter::DoExport no document to export"); // Set up document pointer in the baseclass // This is required so that GetExportNode will work TheDocument = pDoc; PluginOILFilter* pPluginOILFilter = (PluginOILFilter*)pOILFilter; // Make sure the OIL filter gets cleaned up on exit AutoCleanOILFilter TidyFilter(pPluginOILFilter); // Call OIL layer to get a new CCLexFile derived object that the Xar data // must be exported to CCLexFile* pNewFile = NULL; if (!pPluginOILFilter->GetExportFile(pPath, &pNewFile)) { TRACEUSER( "Gerry", _T("Failed to get an output file\n")); return(FALSE); } // Make sure the new file object gets deleted on exit AutoDeleteCCObject TidyFile(pNewFile); CapabilityTree PlugCaps; // Call OIL layer to set up the capabilities control object if (!pPluginOILFilter->GetCapabilities(pFile, pPath, &PlugCaps)) { TRACEUSER( "Gerry", _T("Failed to get capabilities object\n")); return(FALSE); } // Make sure the bitmap list is empty m_BitmapList.DeleteAll(); // Update our bounds write level m_BoundsLevel = PlugCaps.GetBoundsLevel(); // Update our bitmap compression setting m_BitmapCompression = PlugCaps.GetBitmapCompression(); // Update the preview bitmap setting m_bPreviewBitmap = PlugCaps.GetPreviewBitmap(); KernelBitmap::SetCreateTracker(&m_BitmapList); // Convert the document according to the capabilites BOOL ok = GenerateExportData(&PlugCaps); KernelBitmap::SetCreateTracker(NULL); if (!ok) { TRACEUSER( "Gerry", _T("Failed to generate export data\n")); // Clean up any partial tree we have created if (m_pNewTree) { m_pNewTree->CascadeDelete(); delete m_pNewTree; m_pNewTree = NULL; } return(FALSE); } // Reset the max progress bar limit to an approximation of the size of the Xar data SetTotalProgressBarCount(256*1024); ForceStatusExportMessage(_R(IDS_SAVING_XAR_DATA)); // Call the baseclass DoExport method passing the new file object // This will call the GetExportData virtual function to get the // document tree to be exported ok = CamelotNativeFilter::DoExport(pOp, pNewFile, pPath, pDoc, FALSE); UnforceStatusExportMessage(); // Now cleanup the copy of the document if (m_pNewTree) { m_pNewTree->CascadeDelete(); delete m_pNewTree; m_pNewTree = NULL; } // Now we must clean up the bitmap list // First we remove the head item KernelBmpListItem* pItem = (KernelBmpListItem*)m_BitmapList.RemoveHead(); while (pItem) { // Delete the KernelBitmap to remove it from the document's list // and remove the reference on the OILBitmap if (pItem->m_pBmp) delete pItem->m_pBmp; // Delete the ListItem delete pItem; // Remove the next item from the list pItem = (KernelBmpListItem*)m_BitmapList.RemoveHead(); } // Free up any unused bitmaps in the global list // (just deleting the KernelBitmaps doesn't seem to do it) Camelot.GetGlobalBitmapList()->DeleteAllUnusedBitmaps(); // Make sure this is closed if (pNewFile->isOpen()) pNewFile->close(); if (!ok) { TRACEUSER( "Gerry", _T("Failed in baseclass DoExport\n")); return(FALSE); } String_64 Str(_R(IDS_EXPORTING_DOCUMENT)); StartProgressBar(&Str); SetProgressBarCount(0); SetTotalProgressBarCount(100); // Call OIL layer to do the translation if (!pPluginOILFilter->DoExport(pNewFile, pPath)) { TRACEUSER( "Gerry", _T("Failed to translate exported data\n")); return(FALSE); } EndProgressBar(); return(TRUE); }

BOOL PluginNativeFilter::DoImport (  SelOperation *  pOp, CCLexFile *  pFile, Document *  pDestDoc, BOOL  AutoChosen = FALSE, ImportPosition *  pPos = NULL, KernelBitmap **  ppImportedBitmap = NULL, DocCoord *  pPosTranslate = NULL, String_256 *  URL = NULL )  [virtual]

Read the data from the specified file. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 27/01/2005 Parameters: Op  - pointer to the operation that this input process is associated with. [INPUTS] pFile - The file that we should load the document from DestDoc - The Document object which should hold the data read in from the file. AutoChosen - pPos - Pos - ppImportedBitmap - this is used mainly in the bitfltr.cpp for the HTML import filter. HTMLFilter::DoImport() needs a pointer to a kernel bitmap to set the background bitmap up into Camelot. pPosTranslate - This is used too by the HTMLFilter in order to do a formatting. Returns: TRUE if the input operation worked ok, FALSE if not. Errors: Fails (returns FALSE) if the document structure is incorrect, or if there is a problem with the file. Assumes the caller will fail and end the operation if False is returned. Reimplemented from BaseCamelotFilter. Definition at line 285 of file xpfilter.cpp. { ERROR2IF(FALSE, pOp == NULL,"PluginNativeFilter::DoImport null operation!"); ERROR2IF(FALSE, pFile == NULL,"PluginNativeFilter::DoImport null file!"); ERROR2IF(FALSE, pDestDoc == NULL,"PluginNativeFilter::DoImport null document!"); TRACEUSER( "Gerry", _T("PluginNativeFilter::DoImport")); PluginOILFilter* pPluginOILFilter = (PluginOILFilter*)pOILFilter; // Make sure the OIL filter gets cleaned up on exit AutoCleanOILFilter TidyFilter(pPluginOILFilter); // Call OIL layer to create a new CCLexFile derived object containing the // translated data CCLexFile* pNewFile = NULL; if (!pPluginOILFilter->GetImportFile(pFile, &pNewFile)) { TRACEUSER( "Gerry", _T("Failed to get import file\n")); return(FALSE); } // Make sure the new file object gets deleted on exit AutoDeleteCCObject TidyFile(pNewFile); TRACEUSER( "Gerry", _T("Calling CamelotNativeFilter::DoImport\n")); // Call the baseclass DoImport method passing the new file if (!CamelotNativeFilter::DoImport(pOp, pNewFile, pDestDoc, AutoChosen, pPos, ppImportedBitmap, pPosTranslate, URL)) { TRACEUSER( "Gerry", _T("Failed in baseclass DoImport\n")); return(FALSE); } return(TRUE); }

BOOL PluginNativeFilter::EndDocumentExport (   )  [protected, virtual]

This function is called after document-related records have been are written out to the file. BeginDocumentExport() is called before the doc records are saved. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 30/7/96 Parameters: -  [INPUTS] Returns: TRUE if successful, FALSE otherwise This should be called for each document that is saved out to the file. See also: CamelotNativeFilter::BeginDocumentExport() Scope: Protected Reimplemented from CamelotNativeFilter. Definition at line 1183 of file xpfilter.cpp. { BOOL ok = TRUE; // Writes out an up rec // This will ensure that all doc-related records appear as a child of the doc record // by matching the down rec written out by BeginDocumentExport() if (ok) ok = WriteZeroSizedRecord(TAG_UP); return ok; }

BOOL PluginNativeFilter::GenerateExportData (  CapabilityTree *  pPlugCaps  )  [protected]

Definition at line 485 of file xpfilter.cpp. { BOOL ok = TRUE; // Reset the count for GetNewBitmapName m_BitmapCount = 0; // Disable bitmap caching but remember the old state so we can set it back ScopedFlagSetter fsBitmapCacheing(NodeRenderableBounded::bEnableCacheing, FALSE); String_64 Str(_R(IDS_CONVERTING_DOCUMENT)); StartProgressBar(&Str); SetTotalProgressBarCount(600); m_ProgressOffset = 0; // UINT32 ThisPassCount = 0; // UINT32 ThisPassTotal = 0; // UINT32 NextPassCount = 0; // First we create a copy of the chapter node Node* pChapter = CamelotNativeFilter::GetExportNode(); ERROR2IF(!IS_A(pChapter, Chapter), FALSE, "Export node is not a Chapter"); Node* pParent = pChapter->FindParent(); ERROR2IF(!IS_A(pParent, NodeDocument), FALSE, "Parent is not a NodeDocument"); // Copy the NodeDocument as the root of our new tree m_pNewTree = pParent->PublicCopy(); // Copy all of the children upto pChapter Node* pNode = pParent->FindFirstChild(); while (pNode && pNode != pChapter) { pNode->CopyNode(m_pNewTree, LASTCHILD); pNode = pNode->FindNext(); } Node* pNewChapter = pChapter->PublicCopy(); if (pNewChapter) pNewChapter->AttachNode(m_pNewTree, LASTCHILD); XPFView* pXPFView = new XPFView(); if (!pXPFView || !pXPFView->Init(pPlugCaps->GetRasteriseDPI())) { TRACEUSER( "Gerry", _T("Failed to create or init XPFView\n")); return(FALSE); } // Remember the current view and set the new view as current View* pOldView = View::GetCurrent(); if (!pXPFView->SetCurrent()) { TRACEUSER( "Gerry", _T("Failed to set XPFView as current\n")); return(FALSE); } View *pView = View::GetCurrent(); if (pView) { // Must force background rendering off as otherwise we might get a partly // rendered drawing or object if it is complex. // ForceBackgroundRedrawOff(pView); } else { ERROR2(FALSE, "PluginNativeFilter::GenerateExportData no current view"); } // Then we loop through each spread // BOOL bFirstSpread = TRUE; Node* pChild = pChapter->FindFirstChild(); while (pChild) { if (IS_A(pChild, Spread)) { Spread* pSpread = (Spread*)pChild; // Spread* pNewSpread = NULL; // If spreads are being converted to bitmap then render a bitmap // and build a NodeBitmap to represent it // If spreads are being done natively then handle via XPFRenderRegion // Create and set up a new XPFRenderRegion XPFRenderRegion XPFRegion(this, pPlugCaps); // Attach a device to the scanning render region // Since this rr does no real rendering, it does not need a Device context XPFRegion.AttachDevice(pView, NULL, pSpread); // Get it ready to render // XPFRegion.SetMatrix(ViewTrans); // XPFRegion.SetClipRect(ClipRect); // Start the render region and return if it fails if (XPFRegion.StartRender()) { XPFRenderCallback XPFCallback(this, &XPFRegion, pPlugCaps, 1); XPFCallback.SetAttachContext(pNewChapter, LASTCHILD); // Call RenderTree to do the rendering XPFRegion.RenderTree(pSpread, FALSE, FALSE, &XPFCallback); // Thats all the nodes rendered, so stop rendering XPFRegion.StopRender(); } } else { ok = pChild->CopyNode(pNewChapter, LASTCHILD); } // Get the next child node of the chapter pChild = pChild->FindNext(); } if (ok) { // Now handle conversion pass 2 for the stroked conversion type m_ProgressOffset = 100; SetProgressBarCount(0); ok = DoConversionPassN(pPlugCaps, 2); } if (ok) { // Now handle conversion pass 3 for the bitmapfill conversion type m_ProgressOffset = 200; SetProgressBarCount(0); ok = DoConversionPassN(pPlugCaps, 3); } if (ok) { // Now handle conversion pass 4 for the bitmap conversion type m_ProgressOffset = 300; SetProgressBarCount(0); ok = DoConversionPassN(pPlugCaps, 4); } if (ok) { // Now handle conversion pass 5 for the bitmapspan conversion type m_ProgressOffset = 400; SetProgressBarCount(0); ok = DoConversionPassN(pPlugCaps, 5); } if (ok) { // Now handle the bitmap resampling pass m_ProgressOffset = 500; SetProgressBarCount(0); ok = DoBitmapResamplePass(pPlugCaps); } SetProgressBarCount(100); EndProgressBar(); // Kill progess bar // Reset this so that the progress bar works for the rest of the export m_ProgressOffset = 0; if (pOldView) pOldView->SetCurrent(); delete pXPFView; return(ok); }

INT32 PluginNativeFilter::GetBitmapCompression (   )  [virtual]

Public access to the current bitmap compression which the user has requested to use when saving bitmaps in the web format. 0 means maximum compression e.g. use JPEG filter at 0% lossy compression 100 means minimum compression e.g. use JPEG filter at 100% lossy compression 101 - 200 means lossless compression e.g. us PNG filter. Could use the no bitmap compression at all e.g. use BMP filter. Unused at present. (Very much like the JPEG compression percentage). Note: This overrides the baseclass version to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Parameters: -  [INPUTS] Returns: The current state of the bitmap compression. Reimplemented from CamelotNativeFilter. Definition at line 988 of file xpfilter.cpp. { // Always use a lossless format such as PNG in native files return m_BitmapCompression; }

virtual BoundsWriteLevel PluginNativeFilter::GetBoundsWriteLevel (   )  [inline, virtual]

Reimplemented from BaseCamelotFilter. Definition at line 185 of file xpfilter.h. { return(m_BoundsLevel); }

virtual WebPrefsDlgParam* PluginNativeFilter::GetCachedExportOptions (   )  [inline, virtual]

Reimplemented from CamelotNativeFilter. Definition at line 179 of file xpfilter.h. { return NULL; }

BOOL PluginNativeFilter::GetConvertTextToOutlines (   )  [virtual]

Public access to the current convert text to outlines which the user has requested to use when saving in the web format. True means convert text to outlines, False means do not. Note: This overrides the baseclass version to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Parameters: -  [INPUTS] Returns: The current state of the convert text to outlines. Reimplemented from CamelotNativeFilter. Definition at line 1030 of file xpfilter.cpp. { // In native files ensure text is not converted to outlines return FALSE; }

char * PluginNativeFilter::GetExportFileType (   )  [protected, virtual]

Reimplemented from CamelotNativeFilter. Definition at line 1203 of file xpfilter.cpp. { return EXPORT_FILETYPE_NATIVE; }

Node * PluginNativeFilter::GetExportNode (   )  [protected, virtual]

Returns a pointer to the first node to export. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 01/02/2005 Returns: NULL in times of grief Reimplemented from BaseCamelotFilter. Definition at line 935 of file xpfilter.cpp. { if (m_pNewTree) { Node* pChapter = m_pNewTree->FindFirstChild(CC_RUNTIME_CLASS(Chapter)); if (pChapter) return(pChapter); } return(CamelotNativeFilter::GetExportNode()); }

BOOL PluginNativeFilter::GetExportOptions (  WebPrefsDlgParam *  pPrefs  )  [virtual]

Overrides base class so we can do our own thing. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 26/01/2005 Parameters: pPrefs  - pointer to a WebPrefsDlgParam [INPUTS] Returns: TRUE if ok, FALSE if bother Reimplemented from BaseCamelotFilter. Definition at line 961 of file xpfilter.cpp. { // May want to call PrepareExport here return TRUE; }

INT32 PluginNativeFilter::GetMaxPathLookUp (   )  [virtual]

The max number pf paths that should be looked at by the function FindSimilarPath(). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 19/9/96 Parameters: -  [INPUTS] Returns: 100 always See also: BaseCamelotFilter::GetMaxPathLookUp; Scope: Protected Reimplemented from CamelotNativeFilter. Definition at line 1228 of file xpfilter.cpp. { return -1;//100; }

String_256 PluginNativeFilter::GetNewBitmapName (   )

Definition at line 1291 of file xpfilter.cpp. { String_256 Str; Str._MakeMsg(_T("#1%d"), ++m_BitmapCount); return(Str); }

BOOL PluginNativeFilter::GetPreviewBitmapExport (   )  [virtual]

Public access to the current export preview bitmap which the user has requested to use when saving bitmaps in the web format. True means export a preview bitmap, False means do not. Note: This overrides the baseclass version to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Parameters: -  [INPUTS] Returns: The current state of the export preview bitmap. Reimplemented from CamelotNativeFilter. Definition at line 1009 of file xpfilter.cpp. { // Return TRUE if the plugin wants a preview bitmap and FALSE otherwise return m_bPreviewBitmap; }

BOOL PluginNativeFilter::GetRemoveInvisibleLayers (   )  [virtual]

Public access to the current remove invisible layers which the user has requested to use when saving in the web format. True means remove invisible layers, False means do not. Note: This overrides the baseclass version to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Parameters: -  [INPUTS] Returns: The current state of the remove invisible layers. Reimplemented from CamelotNativeFilter. Definition at line 1051 of file xpfilter.cpp. { // In native files retain inivisible layers return FALSE; }

BOOL PluginNativeFilter::GetRemoveUnusedColours (   )  [virtual]

Public access to the current remove unused colours which the user has requested to use when saving in the web format. True means remove unused colours, False means do not. Note: This overrides the baseclass version to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Parameters: -  [INPUTS] Returns: The current state of the remove unused colours. Reimplemented from CamelotNativeFilter. Definition at line 1072 of file xpfilter.cpp. { // In native files retain unused colours return FALSE; }

BOOL PluginNativeFilter::GetSaveXPEBitmaps (   )  [virtual]

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 13/09/05 Parameters: -  [INPUTS] Returns: The current state of the save XPE bitmaps. Reimplemented from BaseCamelotFilter. Definition at line 1090 of file xpfilter.cpp. { // In native files retain unused colours return m_bSaveXPEBitmaps; }

double PluginNativeFilter::GetSimilarPathTolerance (  NodePath *  pPath  )  [virtual]

Reimplemented from CamelotNativeFilter. Definition at line 1208 of file xpfilter.cpp. { return 0.0; }

INT32 PluginNativeFilter::HowCompatible (  PathName &  Filename, ADDR  HeaderStart, UINT32  HeaderSize, UINT32  FileSize )  [virtual]

Reimplemented from BaseCamelotFilter. Definition at line 236 of file xpfilter.cpp. { // We ignore the passed in buffer and just pass the filename to the external object INT32 HowCompatible = 0; // If we don't have a filename then don't bother for now String_256 sFilename = Filename.GetPath(); if (!sFilename.IsEmpty()) { PluginOILFilter* pPluginOILFilter = (PluginOILFilter*)pOILFilter; HowCompatible = pPluginOILFilter->HowCompatible(Filename); } // Return the found value to the caller. TRACEUSER( "Gerry", _T("PluginNativeFilter::HowCompatible returning = %d\n"), HowCompatible); return HowCompatible; }

INT32 PluginNativeFilter::HowCompatibleIsFileType (  char *  pFileType  )  [virtual]

Reimplemented from CamelotNativeFilter. Definition at line 1195 of file xpfilter.cpp. { if (strcmp(pFileType,GetExportFileType()) == 0) return 10; else return 9; }

BOOL PluginNativeFilter::Init (  xmlNode *  pFilterNode  )

Initalises the Filter ready for use. Will fail if it can not get enough memory to work with. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/5/96 Returns: TRUE if it worked, FALSE if it failed Definition at line 180 of file xpfilter.cpp. { // Get the OILFilter object PluginOILFilter* pPluginOILFilter = new PluginOILFilter(this); pOILFilter = pPluginOILFilter; if (pOILFilter == NULL) return FALSE; if (!pPluginOILFilter->Init( pFilterNode )) return(FALSE); Flags.CanImport = pPluginOILFilter->IsImport(); Flags.CanExport = pPluginOILFilter->IsExport(); // Load the description strings FilterName = pPluginOILFilter->FilterName; FilterInfo = _T("Temp Info String"); BOOL ok = CreateRecordHandlers(); /* if (Camelot.DeclareSection("Filters", 10)) { // Preference to turn native file compression on or off Camelot.DeclarePref( NULL, "CompressV2Format", &BaseCamelotFilter::CompressNative, 0, 1 ); // Preference to turn xpe bitmap saving on or off Camelot.DeclarePref( NULL, "SaveXPEBitmaps", &BaseCamelotFilter::SaveXPEBitmaps, 0, 1 ); // Preference to decide what bitmap format to use for preview bitmaps Camelot.DeclarePref( NULL, "PreviewBitmapFilterType", &BaseCamelotFilter::PreviewBitmapFilterType, 0, 4 ); // Preference for the optional export as web pathname when native saving Camelot.DeclarePref( NULL, "DefaultWebExportFilterPath", &BaseCamelotFilter::DefaultExportPath); // Preference to turn native file checking for similar paths on or off Camelot.DeclarePref( NULL, "NativeCheckSimilarPaths", &BaseCamelotFilter::NativeCheckSimilarPaths, 0, 1 ); }*/ return ok; }

virtual BOOL PluginNativeFilter::IsCompactNativeFilter (   )  [inline, virtual]

Reimplemented from CamelotNativeFilter. Definition at line 152 of file xpfilter.h. { return FALSE; }

virtual BOOL PluginNativeFilter::IsWebFilter (   )  [inline, virtual]

Reimplemented from CamelotNativeFilter. Definition at line 151 of file xpfilter.h. { return FALSE; }

BOOL PluginNativeFilter::SetProgressBarCount (  UINT32  n  )

Definition at line 1266 of file xpfilter.cpp. { TRACE( _T("PluginNativeFilter::SetProgressBarCount(%d)\n"), n); TRACE(_T("Offset = %d"), m_ProgressOffset); TRACE(_T("pProgress = 0x%08x"), pProgress); TRACE(_T("Total = %d"), TotalProgressBarCount); ProgressBarCount = m_ProgressOffset + n; if (pProgress != NULL && TotalProgressBarCount > 0) { if (ProgressBarCount > TotalProgressBarCount) ProgressBarCount = TotalProgressBarCount; INT32 Percentage = INT32((ProgressBarCount*100) / TotalProgressBarCount); // TRACE( _T("Setting progress to %d\n"), Percentage); EscapePressed = !pProgress->Update(Percentage); return !EscapePressed; } return TRUE; }

BOOL PluginNativeFilter::SetSaveXPEBitmaps (  BOOL  NewSaveXPEBitmaps  )  [virtual]

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 13/09/05 Parameters: NewSaveXPEBitmaps  - New value [INPUTS] Returns: The previous state of the save XPE bitmaps. Reimplemented from BaseCamelotFilter. Definition at line 1108 of file xpfilter.cpp. { BOOL bOld = m_bSaveXPEBitmaps; m_bSaveXPEBitmaps = NewSaveXPEBitmaps; return bOld; }

virtual BOOL PluginNativeFilter::StartCompression (   )  [inline, virtual]

Function to turn Compression on when we are writing to the file. It asks the underlying CCFile and CXaraFile to start the compression process up. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/96 Parameters: -  [INPUTS] Returns: TRUE if ok FALSE otherwise Errors: - See also: StopCompression(); CXaraFile::StartCompression(); Reimplemented from BaseCamelotFilter. Definition at line 146 of file xpfilter.h. { return(TRUE); }

virtual BOOL PluginNativeFilter::StopCompression (   )  [inline, virtual]

Function to turn Compression off when we are writing to the file. It asks the underlying CCFile and CXaraFile to stop the compression process. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/96 Parameters: -  [INPUTS] Returns: TRUE if ok FALSE otherwise Errors: - See also: StartCompression(); CXaraFile::StopCompression() Reimplemented from BaseCamelotFilter. Definition at line 147 of file xpfilter.h. { return(TRUE); }

BOOL PluginNativeFilter::WriteCurrentAttributes (   )  [protected, virtual]

Write out all current attributes. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 19/03/2004 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if worked, FALSE otherwise Errors: - See also: - Reimplemented from CamelotNativeFilter. Definition at line 1251 of file xpfilter.cpp. { BOOL ok = TRUE; if (ok && TheDocument) { AttributeManager* pAttrMgr = &(TheDocument->GetAttributeMgr()); if (pAttrMgr) ok = pAttrMgr->WriteCurrentAttributes(this); } return (ok); }

virtual BOOL PluginNativeFilter::WriteSpecificRegularShapes (   )  [inline, virtual]

Reimplemented from BaseCamelotFilter. Definition at line 181 of file xpfilter.h. { return(TRUE); }

---

Member Data Documentation

UINT32 PluginNativeFilter::ExportingMsgID [protected]

Reimplemented from CamelotNativeFilter. Definition at line 218 of file xpfilter.h.

UINT32 PluginNativeFilter::FilterInfoID [protected]

Reimplemented from CamelotNativeFilter. Definition at line 213 of file xpfilter.h.

UINT32 PluginNativeFilter::FilterNameID [protected]

Reimplemented from CamelotNativeFilter. Definition at line 212 of file xpfilter.h.

INT32 PluginNativeFilter::m_BitmapCompression [protected]

Definition at line 227 of file xpfilter.h.

INT32 PluginNativeFilter::m_BitmapCount [protected]

Definition at line 230 of file xpfilter.h.

List PluginNativeFilter::m_BitmapList [protected]

Definition at line 229 of file xpfilter.h.

BoundsWriteLevel PluginNativeFilter::m_BoundsLevel [protected]

Definition at line 226 of file xpfilter.h.

BOOL PluginNativeFilter::m_bPreviewBitmap [protected]

Definition at line 224 of file xpfilter.h.

BOOL PluginNativeFilter::m_bSaveXPEBitmaps [protected]

Definition at line 223 of file xpfilter.h.

Node* PluginNativeFilter::m_pNewTree [protected]

Definition at line 220 of file xpfilter.h.

UINT32 PluginNativeFilter::m_ProgressOffset [protected]

Definition at line 222 of file xpfilter.h.

---

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

• Kernel/xpfilter.h (r1785/r1708)
• Kernel/xpfilter.cpp (r1785/r1771)

---