BaseCamelotFilter Class Reference

This filter is for the new web file format which is the minimilistic form of the new version 2 native file filter. Derive off VectorFilter as this is what this file format defines. More...

#include <camfiltr.h>

Inheritance diagram for BaseCamelotFilter:

List of all members.

Public Member Functions
	BaseCamelotFilter ()
	Constructor for the base Camelot save/load filter off which are derived the v2 native file and web filters. This filter provides common functionality for these derived filters.
	~BaseCamelotFilter ()
	Tidies up when the filter is destroyed.
virtual BOOL	Init ()
	Initalises the Filter ready for use. Will fail if it can not get enough memory to work with. This is the base class filter and so should be overridden by the derived classes.
virtual void	Deinit ()
	Deinits the filter when the program shuts down.
virtual INT32	HowCompatible (PathName &Filename, ADDR HeaderStart, UINT32 HeaderSize, UINT32 FileSize)
virtual INT32	HowCompatibleIsFileType (char *pFileType)=0
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	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	IsWebFilter ()=0
virtual BOOL	IsCompactNativeFilter ()=0
virtual BOOL	IsImporting ()
	Used to see if the doc is being imported into an existing doc, loaded into a fresh doc.
virtual BOOL	IsImportingAtPosition ()
	This will return TRUE only if we are importing into an existing doc AND at a specific position.
virtual BOOL	IsDefaultDocRequired (const TCHAR *pcszPathName)
	Works out if opening a file of this type requires a default document to be loaded. If the file format supplies the document then return FALSE otherwise return TRUE. An example would be opening a bitmap file. This has no document defined in the file format and so we need to load the default document before importing the bitmap into this file. In this baseclass version return FALSE and hence assume that the filters that need to will override this function to return TRUE.
virtual INT32	GetMaxPathLookUp ()
	The max number pf paths that should be looked at by the function FindSimilarPath().
INT32	StartRecord (UINT32 Tag, INT32 Size)
INT32	StartStreamedRecord (UINT32 Tag, INT32 Size)
BOOL	EndRecord ()
BOOL	EndStreamedRecord ()
UINT32	GetRecordTag ()
INT32	GetRecordNum ()
void	SetCoordOrigin (const DocCoord &Origin)
	Sets the origin for all coords that are written to or read from the file.
DocCoord	GetCoordOrigin ()
	The Get function.
BOOL	Write (BYTE b)
BOOL	Write (UINT32 n)
BOOL	Write (INT32 n)
BOOL	Write (const DocCoord &Coord)
BOOL	Write (TCHAR *pStr)
BOOL	Write (BYTE *pBuf, UINT32 BufSize)
BOOL	Write (FLOAT f)
BOOL	WriteWCHAR (WCHAR w)
BOOL	WriteASCII (TCHAR *pStr)
BOOL	WriteUnicode (TCHAR *pStr)
BOOL	WriteZeroSizedRecord (UINT32 Tag)
	Helper function that makes it easy to write out a zero-sized record.
UINT32	Write (CXaraFileRecord *pRecord)
UINT32	WriteDefinitionRecord (CXaraFileRecord *pRecord)
BOOL	WriteCCPanose (const CCPanose &Panose)
INT32	WriteFontDefinition (WORD FontHandle, BOOL IsBold, BOOL IsItalic)
	Writes a font definition record to the file, and returns with the record number of the record.
BOOL	WriteBitmapSource (const BitmapSource &Source, UINT32 Height)
INT32	WriteRecord (DocColour *pDocColour)
	Writes out the given colour to the file, returning the record number.
INT32	WriteRecord (KernelBitmap *pBitmap)
	Writes out the given bitmap to the file, returning the record number.
ColourListComponent *	GetColourDocComponent ()
BitmapListComponent *	GetBitmapDocComponent ()
UnitListComponent *	GetUnitDocComponent ()
DocInfoComponent *	GetDocInfoComponent ()
ViewComponent *	GetViewDocComponent ()
PrintComponent *	GetPrintComponent ()
FontComponent *	GetFontComponent ()
FilePos	GetFilePos ()
UINT32	GetNumBytesWritten ()
virtual Document *	GetDocument ()
virtual Spread *	GetSpread ()
virtual void	GotError (UINT32 errorID)
	Sets an error using the given resource string All it does is call the mirror function in the attached CXaraFile.
virtual void	GotError (UINT32 errorID, const TCHAR *errorString)
	Sets an error using the given resource string All it does is call the mirror function in the attached CXaraFile.
virtual void	EndOfFile ()
virtual void	SetTotalNumBytesToRead (UINT32 s)
virtual BOOL	InvalidateRegion (Node *pNode)
	Invalidates the area of the document covered by the node, causing it to redraw.
virtual UINT32	GetCurrentRecordSize ()
	Function to get the current size of the record that has been read in by the CXaraFile and RecordHandlers and are currently processing. This can be used by streamed record handlers, such as bitmaps, which need to know the size of the recordso that they can update the progress bar size by a proportion of this amount on loading. (Not require on saving as the streamed record handlers can supply what value they like to the progress system and hence update with whatever value they require.
virtual BOOL	InsertNode (Node *pNode)
	This inserts the given node relative to the current context node.
virtual BOOL	IncInsertLevel ()
	Tells the tree building system that the next nodes should be added to the next level of the tree.
virtual BOOL	DecInsertLevel ()
	Tells the tree building system that the next nodes should be added to the previous level of the tree.
virtual Node *	GetInsertContextNode ()
	Returns the node to add the next node to.
virtual void	SetInsertContextNode (Node *pNode)
	Sets the context node to the node provided.
virtual void	InsertNextNodeAsChild ()
	This call ensures that the next node inserted via InsertNode() will be inserted as a child of the context node.
virtual void	InsertNextNodeAsSibling ()
	This call ensures that the next node inserted via InsertNode() will be inserted as a sibling of the context node.
virtual InsertTreeContext *	GetInsertContext (void)
	If you wish to use SetInsertcontextNode to alter where the filter imports to, then chances are you'll want to save & restore the insertion state so that subsequent importing can continue where it left off. If this is the case, bracket your subtree import with code like this: InsertTreeContext *pContext = pFilter->GetInsertContext(); ... import your subtree or whatever ... pFilter->RestoreInsertContext(pContext);.
virtual void	RestoreInsertContext (InsertTreeContext *pOldState)
	If you wish to use SetInsertcontextNode to alter where the filter imports to, then chances are you'll want to save & restore the insertion state so that subsequent importing can continue where it left off. If this is the case, bracket your subtree import with code like this: InsertTreeContext *pContext = pFilter->GetInsertContext(); ... import your subtree or whatever ... pFilter->RestoreInsertContext(pContext);.
virtual BOOL	IncProgressBarCount (UINT32 n)
	Func to incrementing the progress bar count. If there is a progress bar available, it is updated by this call. Scope: Protected.
virtual UINT32	GetProgressBarCount ()
virtual BOOL	SetTotalProgressBarCount (UINT32 n)
	Func to set total the progress bar count. If there is a progress bar available, it is updated by this call. Scope: Protected.
virtual WebPrefsDlgParam *	GetCachedExportOptions ()
BOOL	UnrecognisedTag (UINT32 Tag)
	Informs the filter that it didn't recognise the given tag.
BOOL	MergeSameNamedLayers ()
	We have imported layers of the same name in the document. Merge these layers together and if these layers are the special rollover layers make these button and bar names unique. See Also: SliceHelper::MeshImportedLayersWithExistingButtonBars.
void	AppendWarning (UINT32 WarningId)
	Appends a warning saying that it's come across some data it doesn't recognise. This allows the user to be warned about things like:- bitmap definitions not being loaded colour definitions not being loaded.
virtual BOOL	WriteNodes (Node *pNode)
	This is the main tree traversal routine that writes out the document in the v2 file format.
virtual BOOL	WriteNodeAndSubNodes (Node *pNode)
	This recursively writes the document, asking each node to write itself out, in the correct renderable order.
virtual BOOL	ReadPostChildren (Node *pNode)
	Informs a node that all its children have been imported Calls either the Native or Web varient of the function, depending on the type of filter this is.
virtual BOOL	ReadFileUntil (INT32 tag)
	Reads in the file until the specified tag is hit.
virtual char *	GetExportFileType ()=0
virtual void	SetImportFileType (char *pFileType)
	Sets the file type of the imported file.
virtual BOOL	IsOpeningMinimalWebFormat ()
	It will only return TRUE if the file is the minimal web format, and we are OPENING the file and NOT importing it into a new document.
SelOperation *	GetImportSelOp () const
void	AddAtomicTag (AtomicTagListItem *pItem)
	Adds the item to the list of atomic tags compiled during import.
void	AddEssentialTag (EssentialTagListItem *pItem)
	Adds the item to the list of Essential tags compiled during import.
BOOL	IsTagInAtomicList (UINT32 Tag)
	Searches the atomic tag list to see of the given tag is in the list.
BOOL	IsTagInEssentialList (UINT32 Tag)
	Searches the Essential tag list to see of the given tag is in the list.
TagDescriptionListItem *	GetTagDescription (UINT32 Tag)
	Searches the tag description list to see of the given tag is in the list.
virtual void	AddTagDescription (UINT32 Tag, UINT32 ID)
	Adds the description for the given tag export.
BOOL	SetDocumentNudgeSize (UINT32 newVal)
	Sets the nudge size for the current document.
virtual void	WriteTagDescriptionRecord ()
	WEBSTER - markn 11/2/97.
BOOL	WriteNudgeSizeRecord ()
	Writes out the documents nudge size.
BOOL	WriteBitmapSmoothingRecord ()
	Writes out the document's bitmap smoothing setting. The first byte is a flags byte. LSB bitmap smoothing flag bits 2-8 reserved There are 4 reserved bytes for future use (other bitmap settings).
BOOL	WriteDuplicationOffsetRecord ()
	Writes out the documents duplication offset.
BOOL	WriteRemainingAtomicTagDefinitions ()
	All compound nodes (e.g. bevels, contours, shadows, clipview) are now defined as being atomic. This is so that they can be backwards compatible with CX2.
UINT32	WriteXPEBitmapPlaceHolder (String_256 &strBitmapName)
	Writes out an XPE placeholder record to notify the loader to regenerate the bitmap from the XPE info in the bitmap properties.
virtual BOOL	AddTagDescription (TagDescriptionListItem *pItem)
	Adds the item to the list of tag descriptions compiled during import or export.
virtual void	AddPathRecordRefToList (NodePath *pNodePath, UINT32 RecordNumber)
	Adds a path record reference to the list.
virtual UINT32	FindPathRecordRefRecordNumber (NodePath *pNodePath)
	Finds the record number for the given path.
virtual NodePath *	FindPathRecordRefPath (UINT32 RecordNumber)
	Finds the path for the given record number.
virtual BOOL	FindSimilarPath (NodePath *pPath, UINT32 *pOtherPathRecNum, Matrix *pTransform)
	Finds a similar path to the one provided that has previously been output to the file.
virtual double	GetSimilarPathTolerance (NodePath *pPath)=0
virtual void	AddNodeGroupRefToList (Node *pNode, NodeGroup *pGroup)
	Adds a text story group reference to the listFinds the group associated with the text storyFinds the text story associated with the groupAdds a node/group reference to the list.
virtual NodeGroup *	FindGroupForThisNode (Node *pNode)
	Finds the group associated with the node.
virtual BOOL	WriteNodeAsOutlines (Node *pNode)
	Converts the node into a group of paths, and then outputs that group to the filter.
BOOL	SetLastRecordHandler (CXaraFileRecordHandler *pHandler, UINT32 Tag)
	Sets the handler used to handle the last record that was imported. It also sets the tag value of the last handled record.
Document *	GetLastDocumentInserted ()
Chapter *	GetLastChapterInserted ()
Spread *	GetLastSpreadInserted ()
Layer *	GetLastLayerInserted ()
NodePath *	GetLastNodePathInserted ()
NodeAttribute *	GetLastCurrentAttrInserted ()
void	SetLastDocumentInserted (Document *pNode)
void	SetLastChapterInserted (Chapter *pNode)
void	SetLastSpreadInserted (Spread *pNode)
void	SetLastLayerInserted (Layer *pNode)
void	SetLastNodePathInserted (NodePath *pNode)
void	SetLastCurrentAttrInserted (NodeAttribute *pNode)
UINT32	GetDocumentInsertedCount ()
UINT32	GetChapterInsertedCount ()
UINT32	GetSpreadInsertedCount ()
UINT32	GetLayerInsertedCount ()
UINT32	GetSetSentinelInsertedCount ()
void	IncDocumentInsertedCount ()
void	IncChapterInsertedCount ()
void	IncSpreadInsertedCount ()
void	IncLayerInsertedCount ()
void	IncSetSentinelInsertedCount ()
virtual void	ExportHTMLTag (PathName *ppthToUse)
	Exports an HTML tag to the clipboard that can be used in a page of HTML to embed the file that is being exported.
virtual void	SetInsertMode (InsertMode newInsertMode, CCRuntimeClass *pAttrGroup=NULL)
	Set Mode for AttachNode function.
virtual InsertMode	GetInsertMode ()
virtual SelectionType	GetSelType ()
virtual void	SetSelType (SelectionType ThisSelType)
virtual Layer *	GetFirstImportedLayer ()
virtual void	SetFirstImportedLayer (Layer *pLayer)
virtual BOOL	SetCompression (BOOL NewState)
	Function to turn Compression on or off on the underlying CCFile.
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	SetPreCompression (UINT32 Flags)
	Sets the precompression used in this file.
virtual UINT32	GetPreCompression ()
virtual CCLexFile *	GetCCFile ()
	Function to give public access to the underlying CCFile that is being used to save out the data. Note: only people who have a genuine reason need to access this - e.g. bitmap savers.
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: Virtual so that can be overriden in native filter to save in the proper native state.
virtual INT32	SetBitmapCompression (INT32 NewBmpComp)
	Set up a new state for the the current bitmap compression. 200 = no compression, 0 = full compression. (Very much like the JPEG compression percentage).
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: Virtual so that can be overriden in native filter to save in the proper native state.
virtual BOOL	SetPreviewBitmapExport (BOOL NewExportPreviewBmp)
	Set up a new state for the the current export preview bitmap. True means export a preview bitmap, False means do not.
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: Virtual so that can be overriden in native filter to save in the proper native state.
virtual BOOL	SetConvertTextToOutlines (BOOL NewConvertTextToOutlines)
	Set up a new state for the the convert text to outlines. True means convert text to outlines, False means do not.
virtual BOOL	GetConvertBlendsToOutlines ()
	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 blends to outlines, False means do not.
virtual BOOL	SetConvertBlendsToOutlines (BOOL NewConvertBlendsToOutlines)
	Set up a new state for the the convert blends to outlines. True means convert blends to outlines, False means do not.
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: Virtual so that can be overriden in native filter to save in the proper native state.
virtual BOOL	SetRemoveInvisibleLayers (BOOL NewRemoveInvisibleLayers)
	Set up a new state for the the remove invisible layers. True means remove invisible layers, False means do not.
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: Virtual so that can be overriden in native filter to save in the proper native state.
virtual BOOL	SetRemoveUnusedColours (BOOL NewRemoveUnusedColours)
	Set up a new state for the the remove unused colours. True means remove unused colours, False means do not.
virtual BOOL	GetMinimalWebFormat ()
	Public access function.
virtual BOOL	SetMinimalWebFormat (BOOL NewMinimalWebFormat)
	Set up a new state for the min web format flag.
virtual BOOL	GetSaveXPEBitmaps ()
	Public access function.
virtual BOOL	SetSaveXPEBitmaps (BOOL NewSaveXPEBitmaps)
	Set up a new state for the save XPE bitmaps flag.
virtual BOOL	ShouldExportHTMLTag ()
	Public access to the HTML to clipboard.
virtual BOOL	SetHTMLToClipboard (BOOL NewHTMLToClipboard)
	Set a new state for HTMLToClipboard.
virtual String_256	GetDontConvertTheseFontsToOutlinesString ()
	Access func to that fint list dude.
virtual BOOL	GetNativeCheckSimilarPaths ()
	Public access to the current Native check similar paths flag setting.
virtual MILLIPOINT	GetWebSimilarPathTolerence ()
	Public access to the current Web similar path tolerence setting. It is measured in millipoints.
virtual BOOL	WriteSpecificRegularShapes ()
virtual BoundsWriteLevel	GetBoundsWriteLevel ()
Static Public Member Functions
static BOOL	SkipToPreviewBitmap (CCLexFile *pFile, BOOL *IsNewNativeFile, UINT32 *pFilterId=NULL)
	Function used by the gallery thumb nail code to check the file is the native/web format and then get to the preview bitmap record and leave the file pointer sitting at the bitmap image. Assumes file is already opened and ready for reading at the start of the file. Notes: Added pFilterId argument for open dialog Martin-20/01/97.
static BOOL	SkipToIndexInformation (CCLexFile *pFile, String_256 *pString, BOOL *IsNewNativeFile)
	Function used by the gallery index generation code to check the file is the native/web format and then get to the index information record. Assumes file is already opened and ready for reading at the start of the file. Could share some common functionality with the above but we need speed so just duplicate the code. This function must also be different as we need to use the CXaraFile code as we need to read the string from the document comment record. Hence, we can get this to do some of the work such as checking the id is present etc.
static BOOL	WritePathsInRelativeFormat ()
static List *	GetRecordHandlers ()
static BOOL	SetNativeCompression (BOOL NewState)
	Set the preference as to whether we are to compress the native files or not.
static BOOL	GetNativeCompression ()
	Set the prefernece as to whether we are to compress the native files or not.
static BOOL	ShouldSaveXPEBitmaps ()
	Find out whether we should save XPE bitmap data or just the information needed to rebuild the bitmap.
Static Public Attributes
static String_256	DefaultExportPath
	String to hold the default path for the optional web export path.
static BOOL	ExportWebFile = TRUE
	Flag for whether the user has requested to export a web file when native saving.
Protected Member Functions
void	AppendIgnoredDataWarning (UINT32 Tag)
	Appends a warning saying that it's come across some data it doesn't recognise.
void	UnkownEssentialDataError (UINT32 Tag)
	Errors that a tag is not recognised, yet it is an essential tag (i.e. one that must be recognised in order to load the file correctly).
virtual BOOL	StartProgressBar (String_64 *pMessage)
	Starts up the progress bar. If it fails it returns FALSE, but it's no problem if you continue - i.e. you shouldn't about import/export just because you can't get a progress bar going.
virtual void	EndProgressBar ()
	If a progress bar already exists, it's deleted.
virtual void	ResetImportExportVars ()
	Resets all the vars that are common to both import & export. This should be the last thing that's called when import/export has finished.
virtual BOOL	PrepareImportExportVars ()
	Prepares all the vars that are common to both import & export. This should be the first thing that's called when import/export starts.
virtual CXaraFile *	CreateCXaraFile ()
	This is a central place where the CXaraFile object is created. It is a virtual func to allow derived classes to create different flavours of CXaraFile.
virtual BaseCamelotFilter *	CreateNULLFilter (Document *pDocument)=0
virtual BOOL	PrepareToExport (CCLexFile *pFile)
	Gets things ready for the export. This opens the CXaraFile object and writes out the file header.
virtual void	CleanUpAfterExport (BOOL Success)
	Cleans up the memory allocated by BaseCamelotFilter::PrepareToExport() - used when the export process ends, either normally or abnormally.
virtual BOOL	FindDocComponents ()
	Finds ptrs to all the doc components the filter is interested in. If it can't find all of them, FALSE will be returned.
virtual BOOL	StartExportDocComponents (BOOL BeforeCompression)
	Tells all the doc components attached to the document that we are about to export to either the web or native file format.
virtual BOOL	EndExportDocComponents (BOOL Success)
	Tells all the doc components attached to the document that we have finished exporting the document.
virtual BOOL	BeginDocumentExport ()
	This function is called just before document-related records are written out to the file. EndDocumentExport() is called after all the doc records have been saved.
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 Node *	GetExportNode ()
	Returns a pointer to the first node to export.
virtual BOOL	WriteDocument (Operation *pExportOp)
	Exports the document pointed to by TheDocument.
virtual BOOL	WritePreChildren (Node *pNode)
	Asks the node to write itself out. Calls either the Native or Web varient of the function, depending on the type of filter this is.
virtual BOOL	CanWriteChildren (Node *pNode)
	Asks the node if it's OK to automatically write out its children. Calls either the Native or Web varient of the function, depending on the type of filter this is.
virtual BOOL	WritePostChildren (Node *pNode)
	Asks the node to write itself out. Calls either the Native or Web varient of the function, depending on the type of filter this is.
virtual BOOL	WriteBeginChildRecords (Node *pNode)
	Informs a node that its child records are about to be written Calls either the Native or Web varient of the function, depending on the type of filter this is.
virtual BOOL	WriteEndChildRecords (Node *pNode)
	Informs a node that its child records have been written Calls either the Native or Web varient of the function, depending on the type of filter this is.
virtual BOOL	WriteCurrentAttributes ()
	Write out all current attributes.
virtual BOOL	WriteSelectedNodes (Operation *pExportOp, Node *pNode, SelRange *pSelection)
	Exports the selection and any additional nodes required, starting from pNode.
virtual BOOL	WriteSelectedLayerAndNodes (Operation *pExportOp, Node *pNode, SelRange *pSelection)
	Exports a layer node and everything selected below it (i.e. all it's selected children) out through the filter.
virtual BOOL	WriteHeader ()
	Writes out the header record to the file.
virtual BOOL	GetExportOptions (WebPrefsDlgParam *pPrefs)
	Allows the user to be prompted to get information for export. This overriden version returns True so that nothing happens. Scope: Protected.
virtual OpDescriptor *	GetDialogueOp (void)
	Obtains a pointer to the OpDescriptor to be used to access the relevant export dialogue.
virtual BOOL	ExportPreviewBitmap (CCLexFile *pFile, Operation *pOp, PathName *pPath, Document *pDoc)
	Exports a preview bitmap into the file in the correct format.
virtual BOOL	CorrectFileHeader (CCLexFile *pFile)
	Corrects the file header so that it contains the correct information now that we have correctly reached the end of the file.
virtual UINT32	CalcExportSize (Document *pDocument)
	Calcs the number of bytes that will be exported to the file. It is used to maintain a progress display.
BOOL	InitRecordHandlers ()
	Calls all the record handlers via their BeginImport() function. It also registers the list of handlers with the attached CXaraFile object.
BOOL	DeinitRecordHandlers ()
	Calls all the record handlers via their EndImport() function. It also registers the list of handlers with the attached CXaraFile object.
virtual BOOL	PrepareToImport (CCLexFile *pFile)
	To get this filter ready to import a file.
virtual void	CleanUpAfterImport (BOOL Successful)
	Happens at the end of the import to allow the filters to clean up after themselves.
virtual BOOL	PrepareTreeBuilding ()
	This does the setting up of the tree building functions (InsertNode(), etc).
virtual void	CleanUpTreeBuilding ()
	This deinits the tree building system.
virtual BOOL	EnsureFrameLayerIntegrity (Spread *pSpread)
	Happens at the end of the import to allow the layers to be cleaned up. Mainly used by Webster so that we can ensure that frame layers are the order of the day. Do now as the layers are stable and have all their flags present. We cannot decide when we get the layer record as we would need to wait until we have the layer details record. Then this would not be the complete information until we have seen or not seen as the case may be the frame properties record.
virtual BOOL	EnsureLayerIntegrity (Spread *pSpread)
	Happens at the end of the import to allow the layers to be cleaned up. Mainly used by Camelot so that we can see whether we are using a framed document or a layered document. We must check that:- If the document has frame layers in then we must convert all new layers into frames If the document has no frame layers in, then we must convert all frames into layers.
virtual BOOL	StartImportDocComponents ()
	Tells all the doc components attached to the document that we are about to Import to either the web or native file format.
virtual BOOL	EndImportDocComponents (BOOL Successful)
	Tells all the doc components attached to the document that we have finished Importing the document.
virtual BOOL	ReadFile ()
	Reads in the file.
virtual BOOL	SetFileCompressionState (BOOL NewState)
	Set a new file compression status into action.
virtual BOOL	GetFileCompressionState ()
	Get the current file compression state. True if compressing.
virtual BOOL	AttachNode (Node *pNewNode, Node *pContextNode, AttachNodeDirection Direction)
	Attachs one node to another. This will attach the node undoably when it has to. At the mo, insertion is only performed undoably when all the following conditions are met:-.
Static Protected Member Functions
static BOOL	CreateRecordHandlers ()
static void	DestroyRecordHandlers ()
	Destroys all the record handlers associated with the camelot v2 file format filters.
Protected Attributes
WebPrefsDlgParam *	pPrefs
UINT32	FilterNameID
UINT32	FilterInfoID
UINT32	ExportingMsgID
UINT32	BadFileMsgID
FilePos	FileStart
FilePos	FileEnd
FilePos	FileHeaderRecord
UINT32	FileSize
INT32	CompressionType
BOOL	CompressionOn
double	FileVersionNumber
double	BuildVersionNumber
BOOL	EndOfFileFlag
BOOL	EscapePressed
Node *	pInsertContextNode
BOOL	InsertNextAsChild
UINT32	InsertLevel
InsertLevelStack *	pInsertLevelStack
CXaraFile *	pCXaraFile
ColourListComponent *	pColComponent
BitmapListComponent *	pBmpComponent
UnitListComponent *	pUnitsComponent
DocInfoComponent *	pInfoComponent
ViewComponent *	pViewComponent
PrintComponent *	pPrintComponent
FontComponent *	pFontComponent
Spread *	pTheSpread
struct {
SelOperation *   pOp
ImportPosition *   pPos
}	ImportInfo
UINT32	ProgressBarCount
Progress *	pProgress
String_64	ProgressBarMessage
UINT32	TotalProgressBarCount
Static Protected Attributes
static List	RecordHandlerList
static BOOL	RecordHandlersCreated = FALSE
static BOOL	PreviewBitmapExport = FALSE
	Flag for whether the user has requested a preview bitmap when exporting as a web file. True means do export a preview bitmap.
static INT32	BitmapCompression = 75
	How much compression the user has requested when saving bitmaps. 0 means maximum compression e.g. use JPEG filter at 0% lossy compression 99 means minimum compression e.g. use JPEG filter at 99% lossy compression 101 - 201 means lossless compression e.g. us PNG filter. Range stores the old compression setting. Could use the BMPZIP filter instead. (Very much like the JPEG compression percentage).
static BOOL	CompressNative = TRUE
	Flag for whether we compress the native files saved from Xara Studio. True means do compress the files.
static BOOL	SaveXPEBitmaps = FALSE
	Flag for whether we compress the native files saved from Xara Studio. True means do save the XPE bitmaps. False means don't save them, just save the XPE info and rebuild when loading.
static BOOL	ConvertTextToOutlines = FALSE
	Flag for whether the user has requested a convert text to outlines when exporting as a web file. True means do convert text to outlines.
static INT32	PreviewBitmapFilterType = 1
	What type of preview bitmap filter we should be using when exporting as a web or native file. 0 - means BMP. 1 - means GIF. 2 - means JPEG. 3 - means PNG. 4 - means TIFF.
static BOOL	RemoveInvisibleLayers = 1
	Whether invisible layers should be removed or not when exporting as a web or native file.
static BOOL	RemoveUnusedColours = TRUE
	Whether unused colours should be removed or not when exporting as a web or native file.
static BOOL	HTMLToClipboard = FALSE
	Whether to export an HTML tag to the clipboard when exporting a Web file.
static BOOL	MinimalWebFormat = 0
	Whether we should use the minimal web format or not when exporting as a web file. The alternative is to be a lot closer to native format.
static BOOL	WriteRelativePaths = 1
	When this is 1, all paths will be written out in a relative format 0 means use an absolute format.
static String_256	DontConvertTheseFontsToOutlines
	This string defines the list of font typefaces that won't be converted to outlines when exporting to the web format.
static BOOL	NativeCheckSimilarPaths = 0
	When this is 1, the default, paths will be checked for similarities during saving. When 0 this check is not made.
static INT32	WebSimilarPathTolerence = 200
	This determines the tolerence that is used when checking for similar paths in web files. It is measured in millipoints.
static BOOL	ConvertBlendsToOutlines = FALSE
	Flag for whether the user has requested a convert text to outlines when exporting as a web file. True means do convert text to outlines.
static BOOL	ImportNonFramesOntoActivelayer = TRUE
	When this is 1, the default, import of non-frame layers will happen onto the active layer. When 0, import of non-frame layers will be onto the first non-frame layer in the import.
Private Member Functions
	CC_DECLARE_DYNAMIC (BaseCamelotFilter)
void	UpdateLastSafeToRenderNode (Node *pNode)
BOOL	IsThisASelectedTemplate (Node *pNode)
	Determines whether or not this node is a selected template node.
BOOL	DeleteNode (Node *pNode)
	deletes the given node by removing it from the tree
BOOL	PreExportShadows (Node *pRoot)
	Prep shadows for export. We do the following steps:.
BOOL	PostExportShadows (Node *pRoot)
	Repair the document tree after shadow export. We do the following steps:.
BOOL	PostImportShadows ()
	We factor out common attributes on all NodeShadowControllers in the document.
Private Attributes
Node *	pLastUnsafeToRenderNode
String_256	IgnoredDataString
String_256	WarningsString
char	ImportFileType [4]
AtomicTagList *	pAtomicTagList
EssentialTagList *	pEssentialTagList
TagDescriptionList *	pTagDescriptionList
CXaraFilePathRecordRefList *	pPathRecordRefList
CXaraFileNodeGroupRefList *	pNodeGroupRefList
Document *	pLastDocument
Chapter *	pLastChapter
Spread *	pLastSpread
Layer *	pLastLayer
NodePath *	pLastNodePath
NodeAttribute *	pLastCurrentAttr
UINT32	DocumentCount
UINT32	ChapterCount
UINT32	SpreadCount
UINT32	LayerCount
UINT32	SetSentinelCount
Layer *	pImportLayer
UINT32	PreCompFlags
InsertMode	m_InsertMode
CCRuntimeClass *	m_pCurrentAttrGroup
DocCoord	CoordOrigin
Layer *	m_pFirstImportedLayer
Layer *	m_pActiveLayerBeforeImport
SelectionType	SelType

---

Detailed Description

This filter is for the new web file format which is the minimilistic form of the new version 2 native file filter. Derive off VectorFilter as this is what this file format defines.

Author:

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

Date:

29/5/96

Definition at line 201 of file camfiltr.h.

---

Constructor & Destructor Documentation

BaseCamelotFilter::BaseCamelotFilter (   )

Constructor for the base Camelot save/load filter off which are derived the v2 native file and web filters. This filter provides common functionality for these derived filters. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Definition at line 607 of file camfiltr.cpp. { // We are a hidden filter which just contains common functionality // This filter should never be set up or seen, the derived classes just use it. // Items to handle the file compression CompressionType = 0; // type of compression in use (0 at present) CompressionOn = FALSE;// on/off flag FileVersionNumber = 0.0; BuildVersionNumber = 0.0; pColComponent = NULL; pBmpComponent = NULL; pUnitsComponent = NULL; pInfoComponent = NULL; pViewComponent = NULL; pPrintComponent = NULL; pFontComponent = NULL; pTheSpread = NULL; pUnitsComponent = NULL; pInfoComponent = NULL; pInsertContextNode = NULL; InsertNextAsChild = FALSE; pInsertLevelStack = NULL; pCXaraFile = NULL; pProgress = NULL; ProgressBarCount = 0; TotalProgressBarCount = 0; pPrefs = NULL; CoordOrigin = DocCoord(0,0); // Zero origin pLastDocument = NULL; pLastChapter = NULL; pLastSpread = NULL; pLastLayer = NULL; pLastNodePath = NULL; pLastCurrentAttr = NULL; DocumentCount = 0; ChapterCount = 0; SpreadCount = 0; LayerCount = 0; SetSentinelCount = 0; pImportLayer = NULL; EscapePressed = FALSE; pAtomicTagList = NULL; pEssentialTagList = NULL; pTagDescriptionList = NULL; pPathRecordRefList = NULL; // WEBSTER - markn 31/1/97 // Replaced with general system // pTextStoryGroupRefList = NULL; // WEBSTER - markn 29/1/97 // Part of the general form of the system used to convert text to outlines in v1.5 pNodeGroupRefList = NULL; PreCompFlags = 0; // WEBSTER - markn 15/2/97 // Bug fix for selection type save option SelType = DRAWING; // reset our import layer variables m_pFirstImportedLayer = NULL; m_pActiveLayerBeforeImport = NULL; // Make sure this is safely initialised as NodeSetSentinel hackery relies on it // being null except when really in use. ImportInfo.pOp = 0; // State variables that help to switch functionality of AttachNode from adding nodes // to the tree to making current attributes // Used by Current Attribute loading mechanism m_InsertMode = INSERTMODE_ATTACHTOTREE; m_pCurrentAttrGroup = NULL; }

BaseCamelotFilter::~BaseCamelotFilter (   )

Tidies up when the filter is destroyed. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Definition at line 706 of file camfiltr.cpp. { ResetImportExportVars(); // DestroyRecordHandlers(); // If we have our preferences class present, then destory it #ifdef DO_EXPORT if (pPrefs) { PORTNOTETRACE("other","BaseCamelotFilter::~BaseCamelotFilter - removed delete pPrefs"); #ifndef EXCLUDE_FROM_XARALX delete pPrefs; #endif pPrefs = NULL; } #endif }

---

Member Function Documentation

void BaseCamelotFilter::AddAtomicTag (  AtomicTagListItem *  pItem  )

Adds the item to the list of atomic tags compiled during import. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 16/8/96 Parameters: pItem  = ptr to an atomic list item [INPUTS] Returns: - See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6636 of file camfiltr.cpp. { if (pAtomicTagList == NULL) pAtomicTagList = new AtomicTagList; if (pAtomicTagList != NULL) pAtomicTagList->AddTail(pItem); }

void BaseCamelotFilter::AddEssentialTag (  EssentialTagListItem *  pItem  )

Adds the item to the list of Essential tags compiled during import. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 16/8/96 Parameters: pItem  = ptr to an Essential list item [INPUTS] Returns: - See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6660 of file camfiltr.cpp. { if (pEssentialTagList == NULL) pEssentialTagList = new EssentialTagList; if (pEssentialTagList != NULL) pEssentialTagList->AddTail(pItem); }

void BaseCamelotFilter::AddNodeGroupRefToList (  Node *  pNode, NodeGroup *  pGroup )  [virtual]

Adds a text story group reference to the listFinds the group associated with the text storyFinds the text story associated with the groupAdds a node/group reference to the list. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 29/1/97 Parameters: pNode  = ptr to a node in the tree [INPUTS] pGroup = ptr to a group of paths that represent the node, which is not linked into the tree Returns: - WEBSTER - markn 29/1/97 Part of the general form of the system used to convert text to outlines in v1.5 See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Reimplemented in CamelotNULLNativeFilter, and CamelotNULLWebFilter. Definition at line 7545 of file camfiltr.cpp. { ERROR3IF(pNode == NULL,"Null node entry param"); ERROR3IF(pGroup == NULL,"Null node group entry param"); if (pNodeGroupRefList == NULL) pNodeGroupRefList = new CXaraFileNodeGroupRefList; if (pNodeGroupRefList != NULL) { CXaraFileNodeGroupRefListItem* pItem = new CXaraFileNodeGroupRefListItem(pNode,pGroup); if (pItem != NULL) pNodeGroupRefList->AddTail(pItem); } }

void BaseCamelotFilter::AddPathRecordRefToList (  NodePath *  pNodePath, UINT32  RecordNumber )  [virtual]

Adds a path record reference to the list. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/8/96 Parameters: pNodePath  = ptr to a node path object [INPUTS] RecordNumber = the record number of the record that holds this path Returns: - See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 7142 of file camfiltr.cpp. { ERROR3IF(pNodePath == NULL,"Null entry param"); ERROR3IF(RecordNumber == 0,"Zero entry record number"); if (pPathRecordRefList == NULL) pPathRecordRefList = new CXaraFilePathRecordRefList; if (pPathRecordRefList != NULL) { CXaraFilePathRecordRefListItem* pItem = new CXaraFilePathRecordRefListItem(pNodePath,RecordNumber); if (pItem != NULL) pPathRecordRefList->AddTail(pItem); } }

BOOL BaseCamelotFilter::AddTagDescription (  TagDescriptionListItem *  pItem  )  [virtual]

Adds the item to the list of tag descriptions compiled during import or export. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 16/8/96 Parameters: pItem  = ptr to an Essential list item (if NULL it is just ignored_ [INPUTS] Returns: TRUE if added, FALSE if not WEBSTER - markn 11/2/97 Doesn't add a description if it's already there, and returns FALSE in this case. Also it copes nicely with a null pItem ptr Graeme (8-2-00) - Changed Mark's code so that repeated tags don't return FALSE, but are simply ignored. This fixes a problem that they're causing with some WebStyle templates. See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6692 of file camfiltr.cpp. { // WEBSTER - markn 11/2/96 // Check to see if a description for this tag has already been added if ( pItem != NULL ) { if (pTagDescriptionList == NULL) pTagDescriptionList = new TagDescriptionList; if (pTagDescriptionList != NULL) { // Graeme (8-2-00) - Moved the GetTagDescription line here, so that items are // only added if they're not a repeated tag. This should maintain compatability, // and prevent the errors being thrown as before. if ( GetTagDescription ( pItem->GetTag () ) == NULL ) { pTagDescriptionList->AddTail(pItem); } else { // MRH 10/5/00 - If we`re skipping it then we should be deleting it !!! delete pItem; pItem = NULL; } return TRUE; } } return FALSE; }

void BaseCamelotFilter::AddTagDescription (  UINT32  Tag, UINT32  ID )  [virtual]

Adds the description for the given tag export. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 11/2/97 Parameters: Tag  = tag of the record you're describing [INPUTS] ID = string ID of the resourced description text Returns: - WEBSTER - markn 11/2/97 See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Reimplemented in CamelotNULLNativeFilter, and CamelotNULLWebFilter. Definition at line 6764 of file camfiltr.cpp. { String_256* pDesc = new String_256(ID); if (pDesc != NULL) { TagDescriptionListItem* pItem = new TagDescriptionListItem(Tag,pDesc); if (pItem != NULL) { if (!AddTagDescription(pItem)) delete pItem; } } }

void BaseCamelotFilter::AppendIgnoredDataWarning (  UINT32  Tag  )  [protected]

Appends a warning saying that it's come across some data it doesn't recognise. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 19/8/96 Parameters: Tag  = tag of the record not recognised [INPUTS] Returns: - See also: BaseCamelotFilter::PrepareToExport; BaseCamelotFilter::DoExport Scope: Protected Definition at line 5366 of file camfiltr.cpp. { // We will only add items until we are close to the end of the string's capacity. // Otherwise, seeing half entries will look strange. if (IgnoredDataString.IsEmpty()) IgnoredDataString = String_256(_R(IDS_TAG_WARNING_IGNORED_DATA)); String_256 Sep(_R(IDS_TAG_ERROR_LIST_SEP)); TagDescriptionListItem* pDesc = GetTagDescription(Tag); String_256 Temp; if (pDesc != NULL && pDesc->GetString() != NULL) Temp = *(pDesc->GetString()); else Temp.MakeMsg(_R(IDS_TAG_ERROR_TAG_NUMBER),Tag); // Only add it if there is enough room to fit it all in if (Sep.Length() + Temp.Length() + IgnoredDataString.Length() < IgnoredDataString.MaxLength()) { IgnoredDataString += Sep; IgnoredDataString += Temp; } }

void BaseCamelotFilter::AppendWarning (  UINT32  WarningId  )

Appends a warning saying that it's come across some data it doesn't recognise. This allows the user to be warned about things like:- bitmap definitions not being loaded colour definitions not being loaded. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/8/96 Parameters: WarningId  = id of resource to be added [INPUTS] Returns: - See also: BaseCamelotFilter::PrepareToExport; BaseCamelotFilter::DoExport Scope: Public Definition at line 5332 of file camfiltr.cpp. { // We will only add items until we are close to the end of the string's capacity. // Otherwise, seeing half entries will look strange. if (WarningsString.IsEmpty()) WarningsString = String_256(_R(IDS_NATIVE_DATAWARNING)); String_256 Sep(_R(IDS_TAG_ERROR_LIST_SEP)); String_256 Temp(WarningId); // Only add it if there is enough room to fit it all in if (Sep.Length() + Temp.Length() + WarningsString.Length() < WarningsString.MaxLength()) { WarningsString += Sep; WarningsString += Temp; } }

BOOL BaseCamelotFilter::AttachNode (  Node *  pNewNode, Node *  pContextNode, AttachNodeDirection  Direction )  [protected, virtual]

Attachs one node to another. This will attach the node undoably when it has to. At the mo, insertion is only performed undoably when all the following conditions are met:-. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 5/8/96 Parameters: pNewNode  = ptr to node to attach to pContextNode [INPUTS] pContextNode = the context node Direction = how to attach it to pContextNode Returns: TRUE if ok, FALSE otherwise 1) We are importing, and not opening the file; 2) pNewNode is a layer, or pContextNode is a NodeSetSentinel and pNewNode is being attached/inserted as a child of it; 3) we have a ptr to an undoable op; See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6265 of file camfiltr.cpp. { // JCF: further bodged this already 'orrible bodge to allow undoable attaching of // child attributes of NodeSetSentinel. if (IsImporting() && ImportInfo.pOp != 0) { // Insert a layer with undo. if (pNewNode->IsLayer()) return ImportInfo.pOp->DoInsertNewNode((Layer*) pNewNode, pContextNode, Direction, FALSE); // If the context is the sentinel as parent then create a hide action. else if (IS_A(pContextNode, NodeSetSentinel) && (Direction == FIRSTCHILD || Direction == LASTCHILD)) { // Attach and create an action to hide the new child when we undo. HideNodeAction* pHideAct; pNewNode->AttachNode(pContextNode, Direction); if (AC_FAIL == HideNodeAction::Init(ImportInfo.pOp, ImportInfo.pOp->GetUndoActions(), pNewNode, TRUE, (Action**) &pHideAct)) { // Tidy up on fail. pNewNode->UnlinkNodeFromTree(); return FALSE; } return TRUE; } } pNewNode->AttachNode(pContextNode, Direction); return TRUE; }

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

This function is called just before document-related records are written out to the file. EndDocumentExport() is called after all the doc records have been 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: BaseCamelotFilter::EndDocumentExport() Scope: Protected Reimplemented in CamelotNativeFilter, CamelotWebFilter, and PluginNativeFilter. Definition at line 4888 of file camfiltr.cpp. { return TRUE; }

UINT32 BaseCamelotFilter::CalcExportSize (  Document *  pDocument  )  [protected, virtual]

Calcs the number of bytes that will be exported to the file. It is used to maintain a progress display. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 4/6/96 Parameters: -  [INPUTS] Returns: The estimated number of bytes that will be exported See also: GetExportOptions; PrepareToExport; CleanUpAfterExport; Definition at line 5181 of file camfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(pDocument == NULL,0,"pDocument is NULL"); UINT32 NumBytes = 0; BaseCamelotFilter* pFilter = CreateNULLFilter(pDocument); if (pFilter != NULL) { BOOL ok = TRUE; // Prepare to export if (ok) ok = pFilter->PrepareToExport(NULL); // Start doc components (before & after compression) if (ok) ok = pFilter->StartExportDocComponents(TRUE); if (ok) ok = pFilter->StartExportDocComponents(FALSE); String_64 Str(_R(IDS_PREPARING_TO_SAVE)); if (ok) StartProgressBar(&Str); // Update status bar // Export document tree if (ok) ok = pFilter->WriteDocument(NULL); if (ok) EndProgressBar(); // Kill progess bar // Tell doc components we have finished if (ok) ok = pFilter->EndExportDocComponents(TRUE); // All done - deallocate dynamic objects and return success. pFilter->CleanUpAfterExport(ok); // Set the main filter's progress total to the final progress count of the NULL filter SetTotalProgressBarCount(pFilter->GetProgressBarCount()); delete pFilter; pFilter = NULL; } return NumBytes; #else return 0; #endif }

BOOL BaseCamelotFilter::CanWriteChildren (  Node *  pNode  )  [protected, virtual]

Asks the node if it's OK to automatically write out its children. Calls either the Native or Web varient of the function, depending on the type of filter this is. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 22/5/96 Parameters: pNode  = ptr to a node to write [INPUTS] Returns: TRUE if yes, FALSE if no See also: BaseCamelotFilter::PrepareToExport; BaseCamelotFilter::DoExport Scope: Protected Definition at line 4560 of file camfiltr.cpp. { #ifdef DO_EXPORT if (IsWebFilter()) return pNode->CanWriteChildrenWeb(this); else return pNode->CanWriteChildrenNative(this); #else return FALSE; #endif }

BaseCamelotFilter::CC_DECLARE_DYNAMIC (  BaseCamelotFilter   )  [private]

void BaseCamelotFilter::CleanUpAfterExport (  BOOL  Success  )  [protected, virtual]

Cleans up the memory allocated by BaseCamelotFilter::PrepareToExport() - used when the export process ends, either normally or abnormally. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Parameters: Success  - True if everything went swimmingly, False if just a clean up is required. [INPUTS] See also: BaseCamelotFilter::PrepareToExport; BaseCamelotFilter::DoExport Scope: Protected Definition at line 4150 of file camfiltr.cpp. { #ifdef DO_EXPORT // Tell doc components we have finished // but only if there is a problem as otherwise this should be being called. // DoExport calls EndExportDocComponents before this as it needs to ensure that all // document components are exported BEFORE it stops compression so things like unused // colours are compressed. // As a double check check to see if the BMP and Colour components are null, if not // then this indicates the EndExportDocComponents has not been called. // CalcExportSize is an example where this happens if (!Success || pColComponent != NULL || pBmpComponent != NULL || pUnitsComponent != NULL || pInfoComponent != NULL || pViewComponent != NULL || pPrintComponent != NULL || pFontComponent != NULL) { EndExportDocComponents(Success); } // Get the exported file size FileSize = GetNumBytesWritten(); // Reset the vars ResetImportExportVars(); // If we have our preferences class allocated then delete it if (pPrefs) { delete pPrefs; pPrefs = NULL; } // WEBSTER - markn 11/2/97 // The tag description stuff can be used on export now if (pTagDescriptionList != NULL) { pTagDescriptionList->DeleteAll(); delete pTagDescriptionList; pTagDescriptionList= NULL; } // WEBSTER - markn 15/2/97 // Bug fix for selection type save option // Reset the default view area to DRAWING SetSelType(DRAWING); // Clean up the current attribute pointer and array. DeleteCurrentAttrs (); #endif }

void BaseCamelotFilter::CleanUpAfterImport (  BOOL  Successful  )  [protected, virtual]

Happens at the end of the import to allow the filters to clean up after themselves. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> & Mark Neves Date: 29/5/96 Parameters: Successful  - TRUE if the import went OK, FALSE if it failed [INPUTS] Definition at line 2328 of file camfiltr.cpp. { PORTNOTETRACE("other","BaseCamelotFilter::CleanUpAfterImport - ignoring RalphCriticalSection"); #ifndef EXCLUDE_FROM_XARALX RalphCriticalSection rcs; #endif EndImportDocComponents(Successful); DeinitRecordHandlers(); Camelot.UpdateSelection(); if (Successful && TheDocument != NULL) { if (pImportLayer != NULL) { Node* pChild = pImportLayer->FindFirstChild(); if (pChild == NULL) { DeleteNode(pImportLayer); pImportLayer = NULL; } } Spread* pSpread = TheDocument->GetSelectedSpread(); ERROR3IF(pSpread == NULL,"We ought to have a selected spread at this point"); if (pSpread != NULL) { pSpread->ValidateBoundingRect(); pSpread->InvalidateBoundingRect(TRUE); // Make sure we have an active layer, and let everyone know that layer information has changed #ifndef WEBSTER // In Camelot mode, we must now check to see what document we are importing into // If it has frame layers in then we must convert all new layers into frames // If it has no frame layers in, then we must convert all frames into layers EnsureLayerIntegrity(pSpread); //LayerSGallery::EnsureActiveLayerIntegrity(pSpread); #else // In Webster ensure that multiple layers are disallowed unless they are // frame layers. At the same time ensure that there is an active layer. EnsureFrameLayerIntegrity(pSpread); #endif MergeSameNamedLayers(); BROADCAST_TO_ALL(SpreadMsg(pSpread, SpreadMsg::LAYERCHANGES)); // make sure the spread's pasteboard is extended to include all imported objects Node* pNode = pSpread; pNode->PostImport(); } if (TheDocument->IsNotAClipboard()) TheDocument->ResetInsertionPosition(); // Warn user if font substitution has occurred. // TheDocument->CheckFontSubstitution(); TheDocument->CheckReferences(); #if !defined(EXCLUDE_FROM_RALPH) // Make sure all qaulity sliders in the selected doc view get updated PORTNOTE("other","Removed QualitySliderDescriptor usage") #ifndef EXCLUDE_FROM_XARALX QualitySliderDescriptor::Update(); #endif #endif } CleanUpTreeBuilding(); ResetImportExportVars(); // Any warnings to report? // We will do these as two separate warnings as:- // - they should both be rare in themselves // - they are talking about two completely different items // - they are difficult to add together without taking up a very large warning box // - they are difficult to add together in a compact and internationalisable way // Check the unknown but not essential tags found warning first if (Successful && !IgnoredDataString.IsEmpty()) { #if !defined(EXCLUDE_FROM_RALPH) Error::SetError(0,IgnoredDataString,0); InformWarning(); #else // "Non-essential data has been found that is not recognised." String_256 Err(_R(IDE_IMPORT_RALPH_NEWTAGS)); Error::SetError(0,Err,0); InformWarning(); #endif } // Now check the warning about problem data string if (Successful && !WarningsString.IsEmpty()) { #if !defined(EXCLUDE_FROM_RALPH) String_256 Warning = WarningsString; // Add the text on the end which mentions about using defaults instead String_256 Temp(_R(IDS_NATIVE_REPLACEDEFAULTS)); Warning += Temp; Error::SetError(0,Warning,0); InformWarning(); #else // "Problems have been found with some data. The problems have been fixed with default values." String_256 Err(_R(IDE_IMPORT_RALPH_WARNING)); Error::SetError(0,Err,0); InformWarning(); #endif } // Make sure the lists are NULL if (pAtomicTagList != NULL) { pAtomicTagList->DeleteAll(); delete pAtomicTagList; pAtomicTagList = NULL; } if (pEssentialTagList != NULL) { pEssentialTagList->DeleteAll(); delete pEssentialTagList; pEssentialTagList = NULL; } if (pTagDescriptionList != NULL) { pTagDescriptionList->DeleteAll(); delete pTagDescriptionList; pTagDescriptionList= NULL; } // Clean up the current attribute pointer and array. DeleteCurrentAttrs (); }

void BaseCamelotFilter::CleanUpTreeBuilding (   )  [protected, virtual]

This deinits the tree building system. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/5/96 Parameters: -  [INPUTS] Returns: - It must be called sometime after the last node is added to the tree. See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6476 of file camfiltr.cpp. { // Reset the level vars if (pInsertLevelStack != NULL) { delete pInsertLevelStack; pInsertLevelStack = NULL; } if (TheDocument != NULL) TheDocument->GetSafeRenderPointer().SetPointerInValid(); }

BOOL BaseCamelotFilter::CorrectFileHeader (  CCLexFile *  pFile  )  [protected, virtual]

Corrects the file header so that it contains the correct information now that we have correctly reached the end of the file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Parameters: pFile  - the file to put the exported data into [INPUTS] Returns: TRUE if worked, FALSE if failed. See also: DoExport; Reimplemented in FlareTemplateFilter. Definition at line 4109 of file camfiltr.cpp. { #ifdef DO_EXPORT // Seek back to the first thing that needs changing // The Start of file header record if (FileHeaderRecord == 0) { ERROR3("The pos of the file header is 0. What went wrong?"); return TRUE; } pFile->seek(FileHeaderRecord+8+3); // seek to the file size field (skip 8 byte header & file type field) ERROR3IF(FileSize == 0,"Erm, the file must be more than 0 bytes in size"); // Write out the uncompressed length of file if (pFile->write(&FileSize, 4).fail()) return FALSE; TRACEUSER( "Neville", _T("Uncompressed file size is %d\n"), FileSize ); return TRUE; #else return FALSE; #endif }

CXaraFile * BaseCamelotFilter::CreateCXaraFile (   )  [protected, virtual]

This is a central place where the CXaraFile object is created. It is a virtual func to allow derived classes to create different flavours of CXaraFile. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 4/6/96 Parameters: -  [INPUTS] Returns: ptr to a CXaraFile object that can be used for import or export NULL if there's an error Reimplemented in FlareTemplateFilter, CamelotNULLNativeFilter, and CamelotNULLWebFilter. Definition at line 1907 of file camfiltr.cpp. { CXaraFile* pCXaraFile = new CXaraFile; if (pCXaraFile != NULL) pCXaraFile->SetFilter(this); return pCXaraFile; }

virtual BaseCamelotFilter* BaseCamelotFilter::CreateNULLFilter (  Document *  pDocument  )  [protected, pure virtual]

Implemented in CamelotNativeFilter, and CamelotWebFilter.

BOOL BaseCamelotFilter::CreateRecordHandlers (   )  [static, protected]

Definition at line 1723 of file camfiltr.cpp. { if (!RecordHandlersCreated) { RecordHandlerList.DeleteAll(); // General handlers NEW_RECORD_HANDLER(GeneralRecordHandler); // The general record handler NEW_RECORD_HANDLER(CompressionRecordHandler); // The compression record handler NEW_RECORD_HANDLER(DocumentRecordHandler); // Document record handler NEW_RECORD_HANDLER(ViewRecordHandler); // View records handler // Reuseable data item handlers NEW_RECORD_HANDLER(ColourRecordHandler); // Define colour record handler NEW_RECORD_HANDLER(BitmapRecordHandler); // Define bitmap record handler // Document related items NEW_RECORD_HANDLER(DocInfoRecordHandler); // Document info record handler NEW_RECORD_HANDLER(UnitsRecordHandler); // Units record handler // Attribute handlers NEW_RECORD_HANDLER(LineAttrRecordHandler); // Line attribute record handler NEW_RECORD_HANDLER(FillAttrRecordHandler); // Fill attribute record handler NEW_RECORD_HANDLER(GeneralAttrRecordHandler); // Misc attribute record handler // Object handlers NEW_RECORD_HANDLER(PathRecordHandler); // Path record handler NEW_RECORD_HANDLER(PathFlagsRecordHandler); // Path flags record handler NEW_RECORD_HANDLER(GroupRecordHandler); // Group record handler NEW_RECORD_HANDLER(BlendRecordHandler); // Blend-related record handler NEW_RECORD_HANDLER(MouldRecordHandler); // Mould-related record handler NEW_RECORD_HANDLER(RegularShapeRecordHandler); NEW_RECORD_HANDLER(EllipseRecordHandler); NEW_RECORD_HANDLER(RectangleRecordHandler); NEW_RECORD_HANDLER(PolygonRecordHandler); NEW_RECORD_HANDLER(TextObjRecordHandler); NEW_RECORD_HANDLER(TextAttrRecordHandler); NEW_RECORD_HANDLER(FontDefRecordHandler); PORTNOTE("other","Commented ImagesettingAttrRecordHandler") #ifndef EXCLUDE_FROM_XARALX NEW_RECORD_HANDLER(ImagesettingAttrRecordHandler); #endif NEW_RECORD_HANDLER(PrintingRecordHandler); // Remove from webster builds at present as half complete Neville 6/8/97 // Taken out by vector stroking code Neville 2/10/97 #ifdef VECTOR_STROKING NEW_RECORD_HANDLER(StrokeAttrRecordHandler); NEW_RECORD_HANDLER(ShadowRecordHandler); // Shadow-related record handler NEW_RECORD_HANDLER(BevelRecordHandler); #endif NEW_RECORD_HANDLER(ContourRecordHandler); NEW_RECORD_HANDLER(TemplateAttrRecordHandler); PORTNOTE("other","Commented WizOpStyleRecordHandler") #ifndef EXCLUDE_FROM_XARALX NEW_RECORD_HANDLER(WizOpStyleRecordHandler); #endif NEW_RECORD_HANDLER(WizOpStyleRefRecordHandler); NEW_RECORD_HANDLER(ExportHintRecordHandler); NEW_RECORD_HANDLER(BrushAttrRecordHandler); NEW_RECORD_HANDLER(ClipViewRecordHandler); // ClipView-related record handler NEW_RECORD_HANDLER(FeatherRecordHandler); // bitmap properties record handler NEW_RECORD_HANDLER(BitmapPropertiesRecordHandler); // Define bmp props record handler NEW_RECORD_HANDLER(BitmapSmoothingRecordHandler); // Bitmap smoothing document flag NEW_RECORD_HANDLER(LiveEffectRecordHandler); RecordHandlersCreated = TRUE; } return RecordHandlersCreated; }

BOOL BaseCamelotFilter::DecInsertLevel (   )  [virtual]

Tells the tree building system that the next nodes should be added to the previous level of the tree. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/5/96 Parameters: -  [INPUTS] Returns: TRUE if ok, FALSE otherwise This is called when a TAG_UP record is encountered This also calls the node last inserted on the new current level, to inform it that its sub-tree is complete. This gives complex nodes (such as moulds) as chance to do any initialisation after importing. (See Node::ReadPostChildrenWeb()) See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6556 of file camfiltr.cpp. { ERROR2IF(pInsertLevelStack == NULL,FALSE,"pInsertLevelStack == NULL"); // Remove the last level item, as we've moved up a level InsertLevelStackItem* pItem = pInsertLevelStack->Pop(); ERROR3IF(pItem == NULL,"no tail item"); if (pItem != NULL) { // We've just gone up a level, which inplies that the last inserted node on the last // level has a complete child subtree, so inform it of the fact if (!pItem->InformLastInsertedNodeChildrenComplete()) return FALSE; UpdateLastSafeToRenderNode(pItem->GetLastInsertedNode()); // If there were some nodes inserted on the last level (i.e. the insert count > 0), we // need to reset the insert context node. // In this case the new context node is the parent of the current context node if (pItem->GetNumNodesInserted() > 0) { Node* pContextNode = GetInsertContextNode(); if (pContextNode == NULL) return FALSE; SetInsertContextNode(pContextNode->FindParent()); } delete pItem; } // Insert the next node as a sibling to the current context node InsertNextNodeAsSibling(); BOOL ok = TRUE; // Find the info item containing data on the current level InsertLevelStackItem* pCurrentLevelItem = pInsertLevelStack->Get(); if (pCurrentLevelItem != NULL) { // We've just gone up a level, which inplies that the last inserted node on the new current // level has a complete child subtree, so inform it of the fact if (!pCurrentLevelItem->InformLastInsertedNodeChildrenComplete()) return FALSE; UpdateLastSafeToRenderNode(pCurrentLevelItem->GetLastInsertedNode()); // Inform the handler that we have finished a subtree CXaraFileRecordHandler* pHandler = pCurrentLevelItem->GetLastHandler(); if (pHandler != NULL) pHandler->EndSubtree(pCurrentLevelItem->GetLastHandledTag()); } return ok; }

void BaseCamelotFilter::Deinit (   )  [virtual]

Deinits the filter when the program shuts down. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 5/6/96 Reimplemented from Filter. Definition at line 754 of file camfiltr.cpp. { DestroyRecordHandlers(); }

BOOL BaseCamelotFilter::DeinitRecordHandlers (   )  [protected]

Calls all the record handlers via their EndImport() function. It also registers the list of handlers with the attached CXaraFile object. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/5/96 Parameters: -  [INPUTS] Returns: TRUE if ok; FALSE if not. Definition at line 1873 of file camfiltr.cpp. { ERROR2IF(pCXaraFile == NULL, FALSE,"Can't initialise record handlers without a CXaraFile object"); // Register the list handlers with thw CXaraFile objects BOOL ok = pCXaraFile->RegisterRecordHandlers(&RecordHandlerList); // Initialise all the handlers CamelotRecordHandler* pCamelotRecordHandler = (CamelotRecordHandler*)RecordHandlerList.GetHead(); while (ok && pCamelotRecordHandler != NULL) { ok = pCamelotRecordHandler->EndImport(); pCamelotRecordHandler = (CamelotRecordHandler*)RecordHandlerList.GetNext(pCamelotRecordHandler); } return ok; }

BOOL BaseCamelotFilter::DeleteNode (  Node *  pNode  )  [private]

deletes the given node by removing it from the tree Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 5/8/96 Parameters: pNode  = ptr to node to remove from the tree [INPUTS] Returns: TRUE if ok, FALSE otherwise This will delete the node undoably when it has to. At the mo, deletion is only performed undoably when all the following conditions are met: 1) We are importing, and not openning the file 2) pNewNode is a layer 3) we have a ptr to an undoable op See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 6323 of file camfiltr.cpp. { BOOL ok = TRUE; BOOL DeleteWithUndo = (IsImporting() && pNode->IsLayer() && (ImportInfo.pOp != NULL)); if (DeleteWithUndo) ok = ImportInfo.pOp->DoHideNode(pNode,TRUE); else { pNode->CascadeDelete(); delete pNode; } return ok; }

void BaseCamelotFilter::DestroyRecordHandlers (   )  [static, protected]

Destroys all the record handlers associated with the camelot v2 file format filters. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 30/5/96 Parameters: -  [INPUTS] Returns: - Definition at line 1816 of file camfiltr.cpp. { RecordHandlerList.DeleteAll(); RecordHandlersCreated = FALSE; }

BOOL BaseCamelotFilter::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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> & Markn Date: 29/5/96 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 Filter. Reimplemented in PluginNativeFilter. Definition at line 4935 of file camfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(pOp == NULL, FALSE,"BaseCamelotFilter::DoExport no export operation"); ERROR2IF(pFile == NULL, FALSE,"BaseCamelotFilter::DoExport no file to export to"); ERROR2IF(pPath == NULL, FALSE,"BaseCamelotFilter::DoExport no export pathname"); ERROR2IF(pDoc == NULL, FALSE,"BaseCamelotFilter::DoExport no document to export"); // Set up document pointer TheDocument = pDoc; // Get pointer to the spread to export. pTheSpread = GetFirstSpread(pDoc); ERROR2IF(pTheSpread == NULL, FALSE,"BaseCamelotFilter::DoExport no spread to export"); // We must now check if there is a selection present so that we can set up whether the // user gets the choice of exporting the selection, drawing or spread if there is a // selection present OR just a choice between the spread or drawing if no selection is // present. // If have a caret selected in a text story then the selection will be almost zero so trap // this case as well. SelectionType Selection = DRAWING; if (ShowOptions) { Application * pApp = GetApplication(); ERROR2IF(pApp == NULL, FALSE,"BaseCamelotFilter::DoExport no application!"); SelRange* pRange = pApp->FindSelection(); ERROR2IF(pRange == NULL, FALSE,"BaseCamelotFilter::DoExport no selection range!"); DocRect ClipRect = pRange->GetBoundingRect(); if (ClipRect.IsEmpty()) Selection = DRAWING; // no selection present, so choose drawing by default else Selection = SELECTION; // selection present, so choose this by default if (Selection == DRAWING) { // Work out the size of the rectangle encompassing the drawing (visible layers only) ClipRect = BaseBitmapFilter::GetSizeOfDrawing(pTheSpread); // Check that that cliprect is ok, if not then set the spread as the export type if (ClipRect.IsEmpty()) Selection = SPREAD; } } // See if the Camelot filters need some exporting options or not // First, create the preferences class we use to get the data to and from the dialog box pPrefs = new WebPrefsDlgParam; if (pPrefs == NULL) return FALSE; // Set the viewport selection here. if (ShowOptions) { pPrefs->SetExportSel ( Selection ); pPrefs->SetViewportSel ( Selection ); // Invoke the dialogue box. if (!GetExportOptions(pPrefs)) { // User has cancelled the operation so set our error which will be suppressed // and return FALSE Error::SetError(_R(IDN_USER_CANCELLED),0); // Clean up the old preferences. delete pPrefs; pPrefs = NULL; return FALSE; } } else { // Do we want the dialogue box for export options? If not, ensure that the export and // viewport selections don't screw things up. // Graeme (25/1/00) - Changed SelType to ExportSel and ViewportSel. pPrefs->SetExportSel ( DRAWING ); pPrefs->SetViewportSel ( DRAWING ); } // Used to open the file up before starting DoExport. But this meant a cancel on the export // options dialog had filled the file, if it was already present. So now up up here if // not open already. In the PreviewBitmap case the file will already be open. if (!pFile->isOpen()) { if (pFile->IsKindOf(CC_RUNTIME_CLASS(CCDiskFile))) { if (!OpenExportFile((CCDiskFile*) pFile, pPath)) { if (pPrefs) { delete pPrefs; pPrefs = NULL; } return FALSE; } } else { TRACEUSER( "JustinF", _T("Tried to open non-CCDiskFile in BaseCamelotFilter::DoExport\n") ); return FALSE; } } // Get ready for the binary header by setting all our variables to their initial states FileStart = 0; FileEnd = 0; FileHeaderRecord = 0; FileSize = 0; BOOL ok = TRUE; EscapePressed = FALSE; try { // This needs to be fixed sensibly as it uses the value that is // currently in the TotalProgressBarCount variable // UINT32 ExportSize = CalcExportSize(TheDocument); // This resets any export vars, opens the file and writes the header out if (ok) ok = PrepareToExport(pFile); // After we have exported the header, we must export the preview bitmap, if required. // Make sure we use the function to get the CCFile pointer or the template version wont // get written out properly... if (ok) ok = ExportPreviewBitmap(GetCCFile(), pOp, pPath, pDoc); // Start up the progress bar - happends after the preview bmp (in case it starts up a progress bar) if (ok) StartProgressBar(&ProgressBarMessage); // From this point on, everything in the file is related to this document if (ok) ok = BeginDocumentExport(); // WEBSTER - markn 11/2/97 // Write out a tag description record if necessary WriteTagDescriptionRecord(); // Write out some simple document-scope values WriteNudgeSizeRecord(); WriteBitmapSmoothingRecord(); WriteDuplicationOffsetRecord(); /* // Find all the document components that are required // Must do this just before we start the doc components export as otherwise things which fail // will cause clean up to occur and once FindDocComponents is called, it assumes that start // StartExportDocComponents has been called. if (ok ok = FindDocComponents(); */ // Start doc components (before compression is started) if (ok) ok = StartExportDocComponents(TRUE); // Just before we write the main document, we will start compression up, if required if (ok) ok = StartCompression(); // Start doc components (after compression started) if (ok) ok = StartExportDocComponents(FALSE); // Write out all remaining automic tags (note brush defintion and stroke definition have already // been written within the above call). I am not going to move these into here .... if (ok) ok = WriteRemainingAtomicTagDefinitions (); // for bevels, contours, shadows, clipviews, etc. // Save out the document tree if (ok) ok = WriteDocument(pOp); // Save out the current attributes... if (ok) ok = WriteCurrentAttributes(); // Tell doc components we have finished if (ok) ok = EndExportDocComponents(TRUE); // Just before we write the EOF record and close down the file // we will stop compression if (ok) ok = StopCompression(); // Everything in the document has been saved if (ok) ok = EndDocumentExport(); if (ok) { // Write out the EOF record as the last record in the file WriteZeroSizedRecord(TAG_ENDOFFILE); // All done - deallocate dynamic objects and return success. CleanUpAfterExport(TRUE); // Detach document TheDocument = NULL; // Find out where the file ended FileEnd = pFile->tell(); // Correct the binary header, now we know where everything is if (!CorrectFileHeader(pFile)) { ERROR1(FALSE, _R(IDT_EXPORT_INTERNAL_ERR)); } } } catch (...) { TRACE( _T("BaseCamelotFilter::DoExport An error has occurred during export!\n") ); // Flag an error has occurred so that things get cleaned up correctly ok = FALSE; } // Clean up if we get an error if (!ok) { CleanUpAfterExport(FALSE); // If the user has pressed escape then set the proper error if (EscapePressed) Error::SetError(_R(IDW_CANCELEXPORT),0); return FALSE; } //Graham 22/5/97: Export an HTML tag to the clipboard if necessary if (ShouldExportHTMLTag()) ExportHTMLTag(pPath); return ok; #else return FALSE; #endif }

BOOL BaseCamelotFilter::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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 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 Filter. Reimplemented in PluginNativeFilter. Definition at line 3338 of file camfiltr.cpp. { ERROR2IF(FALSE, pOp == NULL,"BaseCamelotFilter::DoImport null operation!"); ERROR2IF(FALSE, pFile == NULL,"BaseCamelotFilter::DoImport null file!"); ERROR2IF(FALSE, pDestDoc == NULL,"BaseCamelotFilter::DoImport null document!"); // Set up document pointer TheDocument = pDestDoc; // Remember operation and position so we can use them to add nodes in other functions. ImportInfo.pOp = pOp; ImportInfo.pPos = pPos; if (!PrepareToImport(pFile)) { // Didn't work (no memory) CleanUpAfterImport(FALSE); return FALSE; } // Get the right spread... Spread *pSpread = NULL; if (pPos == NULL) { // Find the spread on the first page of this document... pSpread = GetFirstSpread(pDestDoc); } else { // Use the spread provided pSpread = pPos->pSpread; } // Set our class variable to point at this spread pTheSpread = pSpread; if (!pSpread) { // Didn't work, no spread // TODO: Add in Error message! Error::SetError(_R(IDT_CANT_FIND_FILTER)); CleanUpAfterImport(FALSE); return FALSE; } // Remember it //ImportInfo.pSpread = pSpread; // Get the spread's bounding rectangle and convert it to spread coords. DocRect SpreadRect = pSpread->GetPasteboardRect(); pSpread->DocCoordToSpreadCoord(&SpreadRect); if (pPos == NULL) { // For now, position objects on 1st page of spread 1 Page *pPage = pSpread->FindFirstPageInSpread(); ERROR2IF(pPage == NULL,FALSE,"BaseCamelotFilter::DoImport Spread has no pages"); // Use bottom left of page as origin DocRect PageRect = pPage->GetPageRect(); SetCoordOrigin(PageRect.lo); } else { // Use position provided SetCoordOrigin(pPos->Position); } // Try to open the file // The file is already open when it is passed in // Find out the size of the file, in bytes. size_t filesize = pFile->Size(); if (filesize <= 0) { Error::SetError(BadFileMsgID); return FALSE; } // Set the progress indicator, this next bit might take a while. // String_64 ImportMessage(ImportMsgID); // String_64 ImportMessage = GetImportProgressString(pFile, GetImportMsgID()); // BeginSlowJob(filesize, TRUE, &ImportMessage); // ContinueSlowJob(); // Start up the record parser BOOL Ok = TRUE; // Must set the exception throwing flag to True and force reporting of errors to False. // This means that the caller must report an error if the function returns False. // Any calls to CCFile::GotError will now throw a file exception and should fall into // the catch handler at the end of the function. // Replaces the goto's that handled this before. BOOL OldThrowingState = pFile->SetThrowExceptions( TRUE ); BOOL OldReportingState = pFile->SetReportErrors( FALSE ); // Record parser starts here try { // Load that file Ok = ReadFile(); } catch( ... ) { Ok = FALSE; } // Must set the exception throwing and reporting flags back to their entry states pFile->SetThrowExceptions( OldThrowingState ); pFile->SetReportErrors( OldReportingState ); // If the load failed for any reason, delete the subtree we have created; otherwise // graft it into the tree (currently bodged to be on the first layer of the second page. if (!Ok) { // Tidy up after ourselves. CleanUpAfterImport(FALSE); // Detach document. TheDocument = NULL; // If the user has pressed escape then set the proper error if (EscapePressed) Error::SetError(_R(IDT_IMPORT_USERABORT),0); pOp->FailAndExecute(); // All work has been completed. //EndSlowJob(); #if !defined(EXCLUDE_FROM_RALPH) // Ensure all the bars are updated to reflect the new document DialogBarOp::UpdateStateOfAllBars(); #endif return FALSE; } // Try to attach any outstanding nodes //BOOL Success = AttachAllNodes(); // Tidy up after ourselves CleanUpAfterImport(TRUE); // Flag this as a new format document // But only flag it if we are opening the document rather than importing into an exisiting one if (TheDocument && !TheDocument->IsImporting()) { TheDocument->SetLoadedAsVersion1File(FALSE); // allow the font manager to fix the current font if (!TheDocument->IsAClipboard()) GetApplication()->GetFontManager()->OnDocumentLoaded(TheDocument); } #if !defined(EXCLUDE_FROM_RALPH) BOOL UpdateBars = TheDocument ? !TheDocument->IsAClipboard() : TRUE; #endif // Detach document. TheDocument = NULL; // End job and inform caller of the success or failure of the venture. //EndSlowJob(); #if !defined(EXCLUDE_FROM_RALPH) // Ensure all the bars are updated to reflect the new document, // but only if it isn't a clipboard document PORTNOTE("other","Removed DialogBarOp usage") if(UpdateBars) DialogBarOp::UpdateStateOfAllBars(); #endif return TRUE; }

BOOL BaseCamelotFilter::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: BaseCamelotFilter::BeginDocumentExport() Scope: Protected Reimplemented in CamelotNativeFilter, CamelotWebFilter, and PluginNativeFilter. Definition at line 4911 of file camfiltr.cpp. { return TRUE; }

BOOL BaseCamelotFilter::EndExportDocComponents (  BOOL  Success  )  [protected, virtual]

Tells all the doc components attached to the document that we have finished exporting the document. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 21/5/95 Parameters: Success  - True if everything went swimmingly, False if just a clean up is required. [INPUTS] Returns: TRUE if worked, FALSE if failed. See also: PrepareToExport, StartExportDocComponents Definition at line 3903 of file camfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(TheDocument == NULL,FALSE,"NULL document ptr"); BOOL ok = TRUE; // Inform all the document components that we have finished exporting, so they must // save any pending information now. DocComponent *pComponent = TheDocument->EnumerateDocComponents(NULL); // Cannot use the EscapePressed flag as we MUST call everything on exit to clean up! while (ok && pComponent != NULL) { // Inform this document component that we have finished a Native/Web export. ok = pComponent->EndExport(this, Success); // Look for next doc component pComponent = TheDocument->EnumerateDocComponents(pComponent); } // Now, go through all DocComponents a second time, telling them to clean up // their exporting data structures. if (!ok) Success = FALSE; pComponent = TheDocument->EnumerateDocComponents(NULL); // Cannot use the EscapePressed flag as we MUST call everything on exit to clean up! while (pComponent != NULL) { // Inform this document component that we have finished a Native/Web export. pComponent->CleanUpAfterExport(Success); // Look for next doc component pComponent = TheDocument->EnumerateDocComponents(pComponent); } // Set the colour and bitmap components back to null // This also signals the end of the doc components export pColComponent = NULL; pBmpComponent = NULL; pUnitsComponent = NULL; pInfoComponent = NULL; pViewComponent = NULL; pPrintComponent = NULL; pFontComponent = NULL; // If the user has pressed escape during export - progress update returns this to us if (EscapePressed) return FALSE; return ok; #else return FALSE; #endif }

BOOL BaseCamelotFilter::EndImportDocComponents (  BOOL  success  )  [protected, virtual]

Tells all the doc components attached to the document that we have finished Importing the document. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/5/95 Parameters: success  = bool denoting import success [INPUTS] Returns: TRUE if worked, FALSE if failed. See also: PrepareToImport, StartImportDocComponents Definition at line 3214 of file camfiltr.cpp. { ERROR2IF(TheDocument == NULL,FALSE,"NULL document ptr"); BOOL ok = TRUE; // Inform all the document components that we have finished Importing DocComponent *pComponent = TheDocument->EnumerateDocComponents(NULL); // Cannot use the EscapeFlag in here as we MUST clean up on failure! while (ok && pComponent != NULL) { // Inform this document component that we have finished a Native/Web Import. ok = pComponent->EndImport(this,success); // Look for next doc component pComponent = TheDocument->EnumerateDocComponents(pComponent); } pColComponent = NULL; pBmpComponent = NULL; pUnitsComponent = NULL; pInfoComponent = NULL; pViewComponent = NULL; pPrintComponent = NULL; pFontComponent = NULL; // If the user has pressed escape during export - progress update returns this to us if (EscapePressed) return FALSE; return ok; }

virtual void BaseCamelotFilter::EndOfFile (   )  [inline, virtual]

Definition at line 309 of file camfiltr.h. { EndOfFileFlag = TRUE; }

void BaseCamelotFilter::EndProgressBar (   )  [protected, virtual]

If a progress bar already exists, it's deleted. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 30/7/96 Parameters: -  [INPUTS] Returns: - Definition at line 2079 of file camfiltr.cpp. { // Check to see if we need to delete the old one if (pProgress != NULL) { TRACE( _T("Stopping progress bar\n")); delete pProgress; pProgress = NULL; } }

BOOL BaseCamelotFilter::EndRecord (   )

Definition at line 5593 of file camfiltr.cpp. { if (pCXaraFile != NULL) return pCXaraFile->EndRecord(); return FALSE; }

BOOL BaseCamelotFilter::EndStreamedRecord (   )

Definition at line 5601 of file camfiltr.cpp. { if (pCXaraFile != NULL) { // Ask the CXaraFile class to end that record for us // Get the function to tell us how big it thinks the record is // This is the size of the data i.e. does not include the header UINT32 RecordSize = 0L; BOOL ok = pCXaraFile->EndStreamedRecord(&RecordSize); // Update the progress bar count with this amount plus 8 for the header //IncProgressBarCount(RecordSize + 8); //TRACEUSER( "Neville", _T("EndStreamedRecord update progress by %d\n"),RecordSize + 8); return ok; } return FALSE; }

BOOL BaseCamelotFilter::EnsureFrameLayerIntegrity (  Spread *  pSpread  )  [protected, virtual]

Happens at the end of the import to allow the layers to be cleaned up. Mainly used by Webster so that we can ensure that frame layers are the order of the day. Do now as the layers are stable and have all their flags present. We cannot decide when we get the layer record as we would need to wait until we have the layer details record. Then this would not be the complete information until we have seen or not seen as the case may be the frame properties record. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 24/6/97 Parameters: pSpread  - the spread to check the layers on. [INPUTS] Definition at line 2859 of file camfiltr.cpp. { // In Webster, check that we have only frame layers or if not combine all non-frame // layers onto one frame layer. // In Camelot do not do this // In both ensure that we have an active layer //#ifdef WEBSTER // Check if we are in a hidden document. This may be the print marks document. // In this case we should do nothing. // Unfortunately the hidden flag is not set in the print marks case which is the one // we are trying to stop. Instead, print marks have been disabled in Webster builds. if (TheDocument != NULL && !TheDocument->IsAHiddenDoc()) { // Ensure that all other non-guide and non-background layers are frame layers UINT32 NonFrameLayersFound = 0; Layer* pCurrentLayer = NULL; Layer * pActiveLayer = NULL; // Search from the first imported layer, so that we only ever combine newly imported // layers together. Only do when importing. // Also, find the first active layer in the spread which should be our original active // layer. if (m_pFirstImportedLayer == NULL && !IsImporting()) pCurrentLayer = pSpread->FindFirstLayer(); else { // Account for minimal web files which do not have a layer and so import onto the // layer that is constructed for that purpose i.e. pImportLayer Layer * pActualFirstImportedLayer = m_pFirstImportedLayer; if (m_pFirstImportedLayer == NULL && pImportLayer != NULL) pActualFirstImportedLayer = pImportLayer; ERROR3IF(pActualFirstImportedLayer == NULL,"BaseCamelotFilter::EnsureFrameLayerIntegrity No first imported layer!"); pCurrentLayer = pActualFirstImportedLayer; // Check that the other layers in the document before this are all frame layers // At present, just mark them as frames as there should always be just one possible // non-frame layer present. (From the default doc which is not in the new format) Layer* pLayer = pSpread->FindFirstLayer(); BOOL Finished = FALSE; while (pLayer != NULL && !Finished) { // Only search up to the first imported layer if (pLayer == pActualFirstImportedLayer) { Finished = TRUE; } else if (pLayer->IsPseudoFrame() && !pLayer->IsFrame()) { pLayer->SetFrame(TRUE); NonFrameLayersFound++; } // Note the original active layer, if found if (!Finished && pLayer == m_pActiveLayerBeforeImport) // pLayer->IsPseudoFrame() && pLayer->IsActive()) { pActiveLayer = pLayer; } pLayer = pLayer->FindNextLayer(); } if (NonFrameLayersFound > 0) { TRACEUSER( "Neville", _T("++++++++++BaseCamelotFilter::EnsureFrameLayerIntegrity fixed %d original non-frame layers\n"),NonFrameLayersFound); } } NonFrameLayersFound = 0; Layer* pNonFrameLayer = NULL; const String_32 CustomMarkName(TEXT("_%CUSTOMMA")); // REM 10 long only const String_32 PrintMarkName(TEXT("%PRINTMARK")); // REM 10 long only while (pCurrentLayer != NULL) { // Check if we are one of the uniquely named layers in the print marks document String_256 LayerName = pCurrentLayer->GetLayerID(); String_32 StartOfName; LayerName.Left(&StartOfName, 10); // The layer has to pass a lot of tests to be counted! // Added a visible test so that hidden layers are not included // If it was a frame layer then it could be invisible but as we don't allow frame layers // then this ok. if (pCurrentLayer->IsPseudoFrame() && !pCurrentLayer->IsFrame() && pCurrentLayer->IsVisible() && StartOfName != CustomMarkName && StartOfName != PrintMarkName) { // Note that we have found a non-frame layer. if (pNonFrameLayer == NULL) pNonFrameLayer = pCurrentLayer; NonFrameLayersFound++; } pCurrentLayer = pCurrentLayer->FindNextLayer(); } /* if (NonFrameLayersFound == 1 && pNonFrameLayer != NULL) { TRACEUSER( "Neville", _T("++++++++++BaseCamelotFilter::EnsureFrameLayerIntegrity found %d non-frame layers\n"),NonFrameLayersFound); // Just mark the non-frame layer found in the above search as a frame layer. // We need do nothing else but fall through and fix up the active layer pNonFrameLayer->SetFrame(TRUE); } else */ if (NonFrameLayersFound >= 1 && pNonFrameLayer != NULL) { TRACEUSER("Neville", _T("++++++++++BaseCamelotFilter::EnsureFrameLayerIntegrity found %d non-frame layers\n"),NonFrameLayersFound); // Right, we need to move all the nodes from the all non-frame layers and move them // to one of the non-frame layers and make this one a frame layer. The user should // therefore notice no difference in appearance of the document as they would have // been seeing one frame representing all the non-frame layers in the frame gallery. // If we are importing then use the active layer as the destination for all non-frame layers. BOOL UsingExistingLayer = FALSE; if (IsImporting() && ImportNonFramesOntoActivelayer) { // If we found an active layer then use this for importing all the non-frames onto // if the user has the preference set // if (pActiveLayer) This is not always perfect e.g. first import of a web file // so use the version we save in PrepareToImport and have checked is still present above // i.e. m_pActiveLayerBeforeImport if (pActiveLayer) { pNonFrameLayer = pActiveLayer; UsingExistingLayer = TRUE; } } if (!UsingExistingLayer) { // First, mark the non-frame layer found in the above search as a frame layer as this // is the one that we are going to use as out destination. Then all other non-frame // searches will not find it. Also, mark it as edited. pNonFrameLayer->SetFrame(TRUE); pNonFrameLayer->SetEdited(TRUE); // We will also set the new frames to overlay so that the user sees the old plus the new pNonFrameLayer->SetOverlay(TRUE); } // Start a progress bar Progress CombiningProgress(_R(IDS_COMBINING_LAYERS)); CombiningProgress.Update(); BOOL ok = TRUE; BOOL UpdateSelection = FALSE; BOOL MoveWithUndo = (IsImporting() && (ImportInfo.pOp != NULL)); Layer* pLayer = pSpread->FindFirstLayer(); while (pLayer != NULL) { if (pLayer->IsPseudoFrame() && !pLayer->IsFrame() && ok) { Node * pNode = NULL; // Move all the top level nodes to the new layer // We MUST include hidden nodes as these will be in undo records // Added a visible test so that hidden layers are not included but are just deleted // If it was a frame layer then it could be invisible but as we don't allow frame layers // then this ok. if (pLayer->IsVisible()) pNode = pLayer->FindFirstChild(); while (pNode && ok) { // Note the node to move Node* pNodeToMove = pNode; // and the next node in the tree pNode = pNode->FindNext(); // Note if we have moved at least one selected node UpdateSelection |= pNodeToMove->IsSelected(); // Find the insertion point, which will be after the last child but // BEFORE the insertion node, if present. Node * pInsertPoint = pNonFrameLayer->FindLastChild(TRUE); // If we have an undoable op then move the node with undo if (MoveWithUndo) { // Importing, so use the undoable op to do the work for us if (pInsertPoint) ok = ok && ImportInfo.pOp->DoMoveNode(pNodeToMove, pInsertPoint, NEXT); else ok = ok && ImportInfo.pOp->DoMoveNode(pNodeToMove, pNonFrameLayer, LASTCHILD); } else { // Loading, so do it blatently if (pInsertPoint) pNodeToMove->MoveNode(pInsertPoint, NEXT); else pNodeToMove->MoveNode(pNonFrameLayer, LASTCHILD); } // Update the progress display to show we have done something CombiningProgress.Update(); } // Finally, go and hide that layer Layer * pLayerToHide = pLayer; // First, invalidate the bounding rect pLayerToHide->InvalidateBoundingRect(); // note the next layer pLayer = pLayer->FindNextLayer(); // and hide the layer itself. // This will do it undoably if importing, otherwise blatently DeleteNode(pLayerToHide); /* // Have to do this ourselves as we are not undoable pLayerToHide->CascadeDelete(); delete pLayerToHide; */ pLayerToHide = NULL; } else pLayer = pLayer->FindNextLayer(); // Update the progress display to show we have done something CombiningProgress.Update(); } // Make sure that our new frame layer is up to date pNonFrameLayer->InvalidateBoundingRect(); //pSpread->ValidateBoundingRect(); //pSpread->InvalidateBoundingRect(TRUE); // If we have changed a selected node then update the selection if (UpdateSelection) { // Update the selection range Camelot.UpdateSelection(); } // Update the progress display to show we have done something CombiningProgress.Update(); // Finally, select the new frame layer as active and fix the other layers // and their visibility accordingly // Use an undoable op, if available // UndoableOperation * pUndoOp = NULL; /* if (IsImporting() && (ImportInfo.pOp != NULL)) pUndoOp = ImportInfo.pOp; */ PORTNOTE("other","Removed FrameSGallery usage") #ifndef EXCLUDE_FROM_XARALX FrameSGallery::MakeActiveLayer(pNonFrameLayer, pUndoOp); #endif // We do this afterwards in the caller /* // We need to update the display as one or more layer items have changed status // So tell ourselves about the change. (We are static and so cannot do it directly!) BROADCAST_TO_ALL(SpreadMsg(pSpread, SpreadMsg::SpreadReason::LAYERCHANGES)); */ // We don't want to repeat the code below so return now as everything // should be set up ok return TRUE; } } //#endif // WEBSTER // In Webster, always pick the top layer to be the active layer. // Used to do this in EnsureActiveLayerIntegrity but now that we have frames/layers // in Webster we cannot be this blatent. So do what we want here. // Only pick the last layer to be active if there is no frame layer in the doc. If there // is a frame layer present then use the active layer saved in the document. // Use an undoable op, if available // UndoableOperation * pUndoOp = NULL; /* if (IsImporting() && (ImportInfo.pOp != NULL)) pUndoOp = ImportInfo.pOp; */ // Find out if there is a frame layer or not Layer * pFrameLayer = pSpread->FindLastFrameLayer(); if (pFrameLayer != NULL) { // Frame layer present so just ensure that the active layer is selected // and there is only one of them. // If we have just imported something then there will be an active layer in this but it // will be after the active layer that was present BEFORE the import. Therefore, the original // active layer will be retained and so the user wont see anything. // Search from the last frame layer backwards until we find an active layer and then choose // this as the new active layer Layer * pActiveFrameLayer = NULL; while (pFrameLayer != NULL && pActiveFrameLayer == NULL) { if (pFrameLayer->IsActive()) pActiveFrameLayer = pFrameLayer; pFrameLayer = pFrameLayer->FindPrevFrameLayer(); } // Try and switch to this new one PORTNOTE("other","Removed FrameSGallery usage") #ifndef EXCLUDE_FROM_XARALX if (pActiveFrameLayer != NULL) FrameSGallery::MakeActiveLayer(pActiveFrameLayer, pUndoOp); else LayerSGallery::EnsureActiveLayerIntegrity(pSpread); #endif } else { // No frame layers so make the active layer the last layer in the spread // This should never be called now as the non-frame layer fixing code should // have been invoked, leave it in for safeties sake. PORTNOTE("other","Removed LayerSGallery usage") // LayerSGallery::MakeTopLayerActive(pSpread); } return TRUE; }

BOOL BaseCamelotFilter::EnsureLayerIntegrity (  Spread *  pSpread  )  [protected, virtual]

Happens at the end of the import to allow the layers to be cleaned up. Mainly used by Camelot so that we can see whether we are using a framed document or a layered document. We must check that:- If the document has frame layers in then we must convert all new layers into frames If the document has no frame layers in, then we must convert all frames into layers. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/97 Parameters: pSpread  - the spread to check the layers on. [INPUTS] Do now as the layers are stable and have all their flags present. We cannot decide when we get the layer record as we would need to wait until we have the layer details record. Then this would not be the complete information until we have seen or not seen as the case may be the frame properties record. Definition at line 2684 of file camfiltr.cpp. { // Search existing layers, if frame layer in there then must convert all new layers into // frames. Could use existing code below // If frame layer not there then just make sure that all new layers are not frames if (IsImporting()) { // Check if we are in a hidden document. This may be the print marks document. // In this case we should do nothing. // Unfortunately the hidden flag is not set in the print marks case which is the one // we are trying to stop. Instead, print marks have been disabled in Webster builds. if (TheDocument != NULL && !TheDocument->IsAHiddenDoc()) { // Ensure that all other non-guide and non-background layers are frame layers UINT32 OriginalNonFrameLayersFound = 0; UINT32 OriginalFrameLayersFound = 0; Layer* pCurrentLayer = NULL; Layer * pActiveLayer = NULL; // Search from the first imported layer, so that we only ever combine newly imported // layers together. Only do when importing. // Also, find the first active layer in the spread which should be our original active // layer. if (m_pFirstImportedLayer == NULL && !IsImporting()) pCurrentLayer = pSpread->FindFirstLayer(); else { // Account for minimal web files which do not have a layer and so import onto the // layer that is constructed for that purpose i.e. pImportLayer Layer * pActualFirstImportedLayer = m_pFirstImportedLayer; if (m_pFirstImportedLayer == NULL && pImportLayer != NULL) pActualFirstImportedLayer = pImportLayer; ERROR3IF(pActualFirstImportedLayer == NULL,"BaseCamelotFilter::EnsureLayerIntegrity No first imported layer!"); pCurrentLayer = pActualFirstImportedLayer; // Check that the other layers in the document before this are all frame layers // At present, just mark them as frames as there should always be just one possible // non-frame layer present. (From the default doc which is not in the new format) Layer* pLayer = pSpread->FindFirstLayer(); BOOL Finished = FALSE; while (pLayer != NULL && !Finished) { // Only search up to the first imported layer if (pLayer == pActualFirstImportedLayer) { Finished = TRUE; } else if (pLayer->IsPseudoFrame()) { if (pLayer->IsFrame()) { OriginalFrameLayersFound++; } else { OriginalNonFrameLayersFound++; } } // Note the original active layer, if found if (!Finished && pLayer == m_pActiveLayerBeforeImport) // pLayer->IsPseudoFrame() && pLayer->IsActive()) { pActiveLayer = pLayer; } pLayer = pLayer->FindNextLayer(); } if (OriginalNonFrameLayersFound > 0 || OriginalFrameLayersFound > 0) { TRACEUSER( "Neville", _T("++++++++++BaseCamelotFilter::EnsureLayerIntegrity %d original frames and %d layers\n"), OriginalFrameLayersFound,OriginalNonFrameLayersFound); } } // Search through all the new layers to see potential frame ones are frames and which // are layers. UINT32 NonFrameLayersFound = 0; UINT32 FrameLayersFound = 0; Layer* pNonFrameLayer = NULL; const String_32 CustomMarkName(TEXT("_%CUSTOMMA")); // REM 10 long only const String_32 PrintMarkName(TEXT("%PRINTMARK")); // REM 10 long only while (pCurrentLayer != NULL) { // Check if we are one of the uniquely named layers in the print marks document String_256 LayerName = pCurrentLayer->GetLayerID(); String_32 StartOfName; LayerName.Left(&StartOfName, 10); // The layer has to pass a lot of tests to be counted! if (pCurrentLayer->IsPseudoFrame() && StartOfName != CustomMarkName && StartOfName != PrintMarkName) { if (pCurrentLayer->IsFrame()) { FrameLayersFound++; } else { // Note that we have found a non-frame layer. if (pNonFrameLayer == NULL) pNonFrameLayer = pCurrentLayer; NonFrameLayersFound++; } } pCurrentLayer = pCurrentLayer->FindNextLayer(); } if (NonFrameLayersFound > 0 || FrameLayersFound > 0) { TRACEUSER("Neville", _T("++++++++++BaseCamelotFilter::EnsureLayerIntegrity %d new frames and %d layers\n"),FrameLayersFound,NonFrameLayersFound); } // Decision time, now that we have decided what layers/frames we had before the import // and what layers/frames have been loaded if (OriginalFrameLayersFound > 0) { // We had frames so ensure that we do not have layers in the new document // Use the Webster code to strip all extraneous layers into one new frame BaseCamelotFilter::EnsureFrameLayerIntegrity(pSpread); // This will ensure that there is an active frame layer so we needn't } else { // We had layers so ensure that there are no frames in the new document Layer* pLayer = pSpread->FindFirstLayer(); BOOL Finished = FALSE; while (pLayer != NULL && !Finished) { // Ensure ALL layers are not frames pLayer->SetFrame(FALSE); // Get next one pLayer = pLayer->FindNextLayer(); } PORTNOTE("other","Removed LayerSGallery usage") // Not importing so just ensure that there is one active layer in the document. #ifndef EXCLUDE_FROM_XARALX LayerSGallery::EnsureActiveLayerIntegrity(pSpread); #endif } } } else { PORTNOTE("other","Removed LayerSGallery usage") // Not importing so just ensure that there is one active layer in the document. #ifndef EXCLUDE_FROM_XARALX LayerSGallery::EnsureActiveLayerIntegrity(pSpread); #endif } return TRUE; }

void BaseCamelotFilter::ExportHTMLTag (  PathName *  ppthToUse  )  [virtual]

Exports an HTML tag to the clipboard that can be used in a page of HTML to embed the file that is being exported. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/5/97 Parameters: -  [INPUTS] Returns: - Definition at line 7617 of file camfiltr.cpp. { PORTNOTETRACE("other","BaseCamelotFilter::ExportHTMLTag - do nothing"); #ifndef EXCLUDE_FROM_XARALX //Check our parameter if (ppthToUse==NULL) { ERROR2RAW("BaseCamelotFilter::ExportHTMLTag - NULL parameter"); return; } //First get the name of the file we are exporting to String_256 strFileName=ppthToUse->GetFileName(TRUE); //Now we need to get the width and height of the document we are exporting, //scaled by 96 DPI //So first find out what are we are exporting SelectionType stExportArea=GetSelType(); //And get the DocRect enclosing that area, using this useful static function DocRect rectExportArea=ImagemapFilterOptions::GetSizeOfExportArea(stExportArea); //Scale it to 96 DPI WinRect wrectExportArea = OSRenderRegion::BitmapDocRectToWin(Matrix(), rectExportArea, 96); //Now, put all these values into our formatting string String_256 strTag; strTag.MakeMsg( _R(IDS_WEBFILTER_HTMLTAG), &strFileName, wrectExportArea.GetWidth(), wrectExportArea.GetHeight() ); //And put that string on the clipboard InternalClipboard::CopyText(strTag); #endif }

BOOL BaseCamelotFilter::ExportPreviewBitmap (  CCLexFile *  pFile, Operation *  pOp, PathName *  pPath, Document *  pDoc )  [protected, virtual]

Exports a preview bitmap into the file in the correct format. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Parameters: pFile  - the file to put the exported data into [INPUTS] pOp - the operation that started the export off pPath - the pathname of the file being exported pDoc - the document to export Returns: TRUE if worked, FALSE if failed. See also: DoExport; Definition at line 3979 of file camfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(pOp == NULL, FALSE,"BaseCamelotFilter::ExportPreviewBitmap no export operation"); ERROR2IF(pFile == NULL, FALSE,"BaseCamelotFilter::ExportPreviewBitmap no file to export to"); ERROR2IF(pPath == NULL, FALSE,"BaseCamelotFilter::ExportPreviewBitmap no PathName to export to"); ERROR2IF(pDoc == NULL, FALSE,"BaseCamelotFilter::ExportPreviewBitmap no document to export"); // Do we want a Preview Bitmap while we are here? // We should always want it in native files // In Web files we will only want them if the user requests them BOOL WantPreviewBmp = GetPreviewBitmapExport(); //TRUE; //if (IsWebFilter() && !PreviewBitmapExport) // WantPreviewBmp = FALSE; if (WantPreviewBmp) { // Go and find the correct Preview Bitmap Exporter UINT32 SearchFilter = FILTERID_PREVIEW_GIF; UINT32 Tag = TAG_PREVIEWBITMAP_GIF; // Use the preference to work out which filter we require switch (PreviewBitmapFilterType) { case 0: SearchFilter = FILTERID_PREVIEW_BMP; Tag = TAG_PREVIEWBITMAP_BMP; break; case 1: SearchFilter = FILTERID_PREVIEW_GIF; Tag = TAG_PREVIEWBITMAP_GIF; break; case 2: SearchFilter = FILTERID_PREVIEW_JPEG; Tag = TAG_PREVIEWBITMAP_JPEG; // Force the Accusoft filters to use a 75% compression by default //WEBSTER-Martin-02/01/97 //AccusoftFilters::SetExportCompressionQuality(75); break; case 3: SearchFilter = FILTERID_PREVIEW_PNG; Tag = TAG_PREVIEWBITMAP_PNG; break; case 4: SearchFilter = FILTERID_PREVIEW_TIFF; Tag = TAG_PREVIEWBITMAP_TIFFLZW; break; } Filter* pFilter = NULL; pFilter = Filter::GetFirst(); while ((pFilter != NULL) && (pFilter->FilterID != SearchFilter)) { // Try the next filter pFilter = Filter::GetNext(pFilter); } // Make sure that we found the preview bitmap filter if ((pFilter != NULL) && (pFilter->IS_KIND_OF(BaseBitmapFilter))) { BitmapFillAttribute::m_doBitmapSmoothing = FALSE; // we don't want bitmaps to be smoothed for previews BitmapTranspFillAttribute::m_doBitmapSmoothing = FALSE; // we don't want bitmaps to be smoothed for previews // Get the system to start us a streamed preview bitmap record ready // to take the bitmap data INT32 RecordNumber = StartStreamedRecord(Tag, CXF_UNKNOWN_SIZE); // If we had a problem starting the record up then exit now if (RecordNumber <= 0) { BitmapFillAttribute::m_doBitmapSmoothing = TRUE; // turn bitmap smoothing back on for normal rendering/printing BitmapTranspFillAttribute::m_doBitmapSmoothing = TRUE; // turn bitmap smoothing back on for normal rendering/printing return TRUE; } // As we are the Native (or Web) file Exporter, then we want to force // the Preview to a fixed size //WEBSTER-Martin-10/01/97 INT32 OldPreviewSize = PreviewFilter::PreviewBitmapSize; // Set the Preview to be just over an inch accross PreviewFilter::PreviewBitmapSize = 96000; // Get as Bitmap Filter and set it up BaseBitmapFilter* pBitmapFilter = (BaseBitmapFilter*) pFilter; pBitmapFilter->SetPreviewBitmap(TRUE); // Export the Preview to the file BOOL ok = pFilter->DoExport(pOp, pFile, pPath, TheDocument); // If the Preview bitmap failed to export then we still need to clean up // Set it back pBitmapFilter->SetPreviewBitmap(FALSE); // Set the Preview back to its default setting //WEBSTER-Martin-10/01/97 PreviewFilter::PreviewBitmapSize = OldPreviewSize; // Ask for the record to be ended and hence items like the size in the record header // to be cleaned up and hence made correct if (ok) ok = EndStreamedRecord(); BitmapFillAttribute::m_doBitmapSmoothing = TRUE; // turn bitmap smoothing back on for normal rendering/printing BitmapTranspFillAttribute::m_doBitmapSmoothing = TRUE; // turn bitmap smoothing back on for normal rendering/printing return ok; } BitmapFillAttribute::m_doBitmapSmoothing = TRUE; // turn bitmap smoothing back on for normal rendering/printing BitmapTranspFillAttribute::m_doBitmapSmoothing = TRUE; // turn bitmap smoothing back on for normal rendering/printing } return TRUE; #else return FALSE; #endif }

BOOL BaseCamelotFilter::FindDocComponents (   )  [protected, virtual]

Finds ptrs to all the doc components the filter is interested in. If it can't find all of them, FALSE will be returned. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 30/7/96 Parameters: -  [INPUTS] Returns: TRUE if worked, FALSE if failed. Notes: This is import as well as export See also: PrepareToExport, EndExportDocComponents Definition at line 3791 of file camfiltr.cpp. { // Inform all the document components that we are about to export DocComponent *pComponent = TheDocument->EnumerateDocComponents(NULL); while (pComponent != NULL) { if (pComponent->IS_KIND_OF(ColourListComponent)) pColComponent = (ColourListComponent*)pComponent; else if (pComponent->IS_KIND_OF(BitmapListComponent)) pBmpComponent = (BitmapListComponent*)pComponent; else if (pComponent->IS_KIND_OF(UnitListComponent)) pUnitsComponent = (UnitListComponent*)pComponent; else if (pComponent->IS_KIND_OF(DocInfoComponent)) pInfoComponent = (DocInfoComponent*)pComponent; else if (pComponent->IS_KIND_OF(ViewComponent)) pViewComponent = (ViewComponent*)pComponent; #if !defined(EXCLUDE_FROM_RALPH) else if (pComponent->IS_KIND_OF(PrintComponent)) pPrintComponent = (PrintComponent*)pComponent; #endif else if (pComponent->IS_KIND_OF(FontComponent)) pFontComponent = (FontComponent*)pComponent; // Look for next doc component pComponent = TheDocument->EnumerateDocComponents(pComponent); } if ( pColComponent == NULL || pBmpComponent == NULL || pUnitsComponent == NULL || pInfoComponent == NULL || pViewComponent == NULL || pPrintComponent == NULL || pFontComponent == NULL) { ERROR3("Unable to find ptrs to all the objects required for import/export"); return FALSE; } return TRUE; }

NodeGroup * BaseCamelotFilter::FindGroupForThisNode (  Node *  pNode  )  [virtual]

Finds the group associated with the node. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 29/1/97 Parameters: pNode  = ptr to a node [INPUTS] Returns: ptr to a group that's associated with the node NULL is returned if the group could not be found WEBSTER - markn 29/1/97 Part of the general form of the system used to convert text to outlines in v1.5 See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Reimplemented in CamelotNULLNativeFilter, and CamelotNULLWebFilter. Definition at line 7581 of file camfiltr.cpp. { ERROR3IF(pNode == NULL,"Null pNode entry param"); if (pNode != NULL) { if (pNodeGroupRefList != NULL) { CXaraFileNodeGroupRefListItem* pItem = pNodeGroupRefList->GetHead(); while (pItem != NULL) { if (pItem->GetNode() == pNode) return pItem->GetNodeGroup(); pItem = pNodeGroupRefList->GetNext(pItem); } } } return NULL; }

NodePath * BaseCamelotFilter::FindPathRecordRefPath (  UINT32  RecordNumber  )  [virtual]

Finds the path for the given record number. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/8/96 Parameters: RecordNumber  = the record number of the record that holds this path [INPUTS] Returns: pNodePath = ptr to a node path object NULL is returned if path could not be found See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 7214 of file camfiltr.cpp. { ERROR3IF(RecordNumber == 0,"Zero entry record number"); if (RecordNumber != 0) { if (pPathRecordRefList != NULL) { CXaraFilePathRecordRefListItem* pItem = pPathRecordRefList->GetHead(); while (pItem != NULL) { if (pItem->GetRecordNumber() == RecordNumber) return pItem->GetNodePath(); pItem = pPathRecordRefList->GetNext(pItem); } } } return NULL; }

UINT32 BaseCamelotFilter::FindPathRecordRefRecordNumber (  NodePath *  pNodePath  )  [virtual]

Finds the record number for the given path. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/8/96 Parameters: pNodePath  = ptr to a node path object [INPUTS] Returns: RecordNumber = the record number of the record that holds this path 0 is returned if path could not be found See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 7175 of file camfiltr.cpp. { ERROR3IF(pNodePath == NULL,"Null entry param"); if (pNodePath != NULL) { if (pPathRecordRefList != NULL) { CXaraFilePathRecordRefListItem* pItem = pPathRecordRefList->GetHead(); while (pItem != NULL) { if (pItem->GetNodePath() == pNodePath) return pItem->GetRecordNumber(); pItem = pPathRecordRefList->GetNext(pItem); } } } return 0; }

BOOL BaseCamelotFilter::FindSimilarPath (  NodePath *  pNodePath, UINT32 *  pOtherPathRecNum, Matrix *  pTransform )  [virtual]

Finds a similar path to the one provided that has previously been output to the file. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 3/9/96 Parameters: pNodePath  = ptr to path to match [INPUTS] pOtherPathRecNum= ptr to place the record number of a similar path, if one's found pTransform = ptr to place transformation matrix Returns: TRUE It scans the list of previously outputted paths See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 7256 of file camfiltr.cpp. { ERROR2IF(pNodePath == NULL,FALSE,"NULL src path ptr"); ERROR2IF(pOtherPathRecNum == NULL,FALSE,"NULL other rec num ptr"); ERROR2IF(pTransform == NULL,FALSE,"NULL matrix ptr"); BOOL Found = FALSE; INT32 PathCount = GetMaxPathLookUp(); if (pPathRecordRefList != NULL) { CXaraFilePathRecordRefListItem* pItem = pPathRecordRefList->GetTail(); while (pItem != NULL && !Found && PathCount != 0) { PathCount--; NodePath* pOtherNodePath = pItem->GetNodePath(); if (pOtherNodePath != NULL) { // Is the given path the similar to the other path? // First, do a fast check - if the num coords is different, then forget it. if (pNodePath->InkPath.GetNumCoords() == pOtherNodePath->InkPath.GetNumCoords()) { // We need the coord origin DocCoord Origin = GetCoordOrigin(); // Translate the two paths by the coord origin. // This turns the path coords into the form in which they appear in the file // // Remember, all absolute coords of objects (such as path coords) get translated before // being output to the file, so that the coord's origin is at the page origin, rather // than the spread origin. This allows us to import the same file into a different doc // and still position objects that are the same relative distance from the new page origin // // The following translation turns the path's coord values into the exact values that // appear in the file. This is important if IsIsometric() creates a transform for us // to use. The transform has to be valid for the path that ends up in the file, and not // the one in the document, because that is the path that's going to be read during import. { Matrix TranslateMat(-Origin.x,-Origin.y); Trans2DMatrix Trans(TranslateMat); pNodePath->Transform(Trans); pOtherNodePath->Transform(Trans); } // Now, can the path be described using the other path and a transform? Found = pOtherNodePath->InkPath.IsIsometric(pNodePath->InkPath,pTransform,GetSimilarPathTolerance(pNodePath)); if (Found) { // If so, make a note of the record number which contains the source path data *pOtherPathRecNum = pItem->GetRecordNumber(); } // Translate the paths back to the original position { Matrix TranslateMat(Origin.x,Origin.y); Trans2DMatrix Trans(TranslateMat); pNodePath->Transform(Trans); pOtherNodePath->Transform(Trans); } } } pItem = pPathRecordRefList->GetPrev(pItem); } } return Found; }

INT32 BaseCamelotFilter::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: Virtual so that can be overriden in native filter to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/6/96 Parameters: -  [INPUTS] Returns: The current state of the bitmap compression. Reimplemented in FlareTemplateFilter, CamelotNativeFilter, and PluginNativeFilter. Definition at line 903 of file camfiltr.cpp. { return BaseCamelotFilter::BitmapCompression; }

BitmapListComponent* BaseCamelotFilter::GetBitmapDocComponent (   )  [inline]

Definition at line 292 of file camfiltr.h. { return pBmpComponent; }

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

Reimplemented in PluginNativeFilter. Definition at line 815 of file camfiltr.h. { return(BWL_NONE); }

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

Reimplemented in CamelotNativeFilter, and PluginNativeFilter. Definition at line 339 of file camfiltr.h. { return pPrefs; }

CCLexFile * BaseCamelotFilter::GetCCFile (   )  [virtual]

Function to give public access to the underlying CCFile that is being used to save out the data. Note: only people who have a genuine reason need to access this - e.g. bitmap savers. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/6/96 Parameters: -  [INPUTS] Returns: The CCFile that is being used to export the data. Errors: - See also: BitmapListComponent::SaveBitmapDefinition Definition at line 2001 of file camfiltr.cpp. { ERROR2IF(pCXaraFile == NULL,FALSE,"BaseCamelotFilter::GetCCFile pCXaraFile is NULL"); return pCXaraFile->GetCCFile(); }

UINT32 BaseCamelotFilter::GetChapterInsertedCount (   )  [inline]

Definition at line 624 of file camfiltr.h. { return ChapterCount; }

ColourListComponent* BaseCamelotFilter::GetColourDocComponent (   )  [inline]

Definition at line 291 of file camfiltr.h. { return pColComponent; }

BOOL BaseCamelotFilter::GetConvertBlendsToOutlines (   )  [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 blends to outlines, False means do not. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/1/97 Parameters: -  [INPUTS] Returns: The current state of the convert blends to outlines. Added for WEBSTER Note: Virtual so that can be overriden in native filter to save in the proper native state Reimplemented in FlareTemplateFilter. Definition at line 1038 of file camfiltr.cpp. { #ifdef _BATCHING return FALSE; #else return BaseCamelotFilter::ConvertBlendsToOutlines; #endif }

BOOL BaseCamelotFilter::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: Virtual so that can be overriden in native filter to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/6/96 Parameters: -  [INPUTS] Returns: The current state of the convert text to outlines. Reimplemented in FlareTemplateFilter, CamelotNativeFilter, and PluginNativeFilter. Definition at line 990 of file camfiltr.cpp. { #ifdef _BATCHING return FALSE; #else return BaseCamelotFilter::ConvertTextToOutlines; #endif }

DocCoord BaseCamelotFilter::GetCoordOrigin (   )

The Get function. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 24/6/96 Parameters: -  [INPUTS] Returns: The orgin applied to all spread coords See also: Spread::WritePreChildrenWeb(BaseCamelotFilter* pFilter), SetCoordOrigin() Scope: - Definition at line 5559 of file camfiltr.cpp. { return CoordOrigin; }

UINT32 BaseCamelotFilter::GetCurrentRecordSize (   )  [virtual]

Function to get the current size of the record that has been read in by the CXaraFile and RecordHandlers and are currently processing. This can be used by streamed record handlers, such as bitmaps, which need to know the size of the recordso that they can update the progress bar size by a proportion of this amount on loading. (Not require on saving as the streamed record handlers can supply what value they like to the progress system and hence update with whatever value they require. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/8/96 Parameters: -  [INPUTS] Returns: The size of the current record. Definition at line 2026 of file camfiltr.cpp. { ERROR2IF(pCXaraFile == NULL,FALSE,"BaseCamelotFilter::GetCurrentRecordSize pCXaraFile is NULL"); return pCXaraFile->GetCurrentRecordSize(); }

OpDescriptor * BaseCamelotFilter::GetDialogueOp (  void   )  [protected, virtual]

Obtains a pointer to the OpDescriptor to be used to access the relevant export dialogue. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 25/10/00 Parameters: -  [INPUTS] Returns: The OpDescriptor pointing to the dialogue used by the export proceedure. Reimplemented in CamelotWebFilter. Definition at line 3676 of file camfiltr.cpp. { // Just return the found OpDescriptor. return OpDescriptor::FindOpDescriptor( CC_RUNTIME_CLASS( NativePrefsDlg ) ); }

DocInfoComponent* BaseCamelotFilter::GetDocInfoComponent (   )  [inline]

Definition at line 294 of file camfiltr.h. { return pInfoComponent; }

virtual Document* BaseCamelotFilter::GetDocument (   )  [inline, virtual]

Reimplemented from Filter. Definition at line 302 of file camfiltr.h. { return TheDocument; }

UINT32 BaseCamelotFilter::GetDocumentInsertedCount (   )  [inline]

Definition at line 623 of file camfiltr.h. { return DocumentCount; }

String_256 BaseCamelotFilter::GetDontConvertTheseFontsToOutlinesString (   )  [virtual]

Access func to that fint list dude. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/96 Parameters: -  [INPUTS] Returns: The string of fonts that shouldn't be converted to shapes Definition at line 1284 of file camfiltr.cpp. { return DontConvertTheseFontsToOutlines; }

virtual char* BaseCamelotFilter::GetExportFileType (   )  [pure virtual]

Implemented in CamelotNativeFilter, CamelotWebFilter, and PluginNativeFilter.

Node * BaseCamelotFilter::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 in PluginNativeFilter. Definition at line 4221 of file camfiltr.cpp. { // JCF: changed to begin writing with the first node following the last default attribute, // and to simply write out every node at the second level of the tree, not only Chapters, // so the traversal will include the NodeSetSentinel and its children. Node* pNode = TheDocument->GetFirstNode(); if (pNode != 0 && pNode->FindNext() != 0) { pNode = pNode->FindNext()->FindLastChild(CC_RUNTIME_CLASS(NodeAttribute)); if (pNode != 0) pNode = pNode->FindNext(); } return(pNode); }

BOOL BaseCamelotFilter::GetExportOptions (  WebPrefsDlgParam *  pPrefs  )  [protected, virtual]

Allows the user to be prompted to get information for export. This overriden version returns True so that nothing happens. Scope: Protected. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Parameters: pPrefs  - the WebPrefsDlgParam class which holds all of the preferences that [INPUTS] can be set. pPrefs  - new versions [OUTPUTS] Returns: TRUE if OK, FALSE if user pressed Cancel. Reimplemented in PluginNativeFilter. Definition at line 3597 of file camfiltr.cpp. { // WEBSTER - markn 28/1/97 // Not needed in Webster #ifdef WEBSTER return TRUE; #else #ifdef DO_EXPORT ERROR2IF(pPrefs == NULL, FALSE, "CamelotWebFilter::GetExportOptions null pPrefs"); // Use the preference option in the baseclass camelot filter pPrefs->SetCompression(GetNativeCompression()); // Use the preference option in the baseclass camelot filter; pPrefs->SetBmpCompression ( GetBitmapCompression () ); pPrefs->SetExportPreviewBitmap ( GetPreviewBitmapExport () ); pPrefs->SetConvertTextToOutlines ( GetConvertTextToOutlines () ); pPrefs->SetConvertBlendsToOutlines ( GetConvertBlendsToOutlines () ); pPrefs->SetRemoveInvisibleLayers ( GetRemoveInvisibleLayers () ); pPrefs->SetRemoveUnusedColours ( GetRemoveUnusedColours () ); pPrefs->SetMinimalWebFormat ( BaseCamelotFilter::MinimalWebFormat ); pPrefs->SetHTMLToClipboard ( ShouldExportHTMLTag () ); pPrefs->SetWebOk ( FALSE ); // Find an associated OpDescriptor. OpDescriptor *pOp = GetDialogueOp (); // Call the op. if ( pOp != NULL ) { pOp->Invoke ( static_cast <OpParam*> ( pPrefs ) ); } // For now, always use the compression option, regardless of ok/cancel used // Means you can change the native option by using the web options dialog box // without having to save the file // Use the preference option in the baseclass camelot filter if ( pPrefs->GetWebOk () ) { // Set up some returned variables as the user has oked them SetBitmapCompression ( pPrefs->GetBmpCompression () ); SetPreviewBitmapExport ( pPrefs->GetExportPreviewBitmap () ); SetConvertTextToOutlines ( pPrefs->GetConvertTextToOutlines () ); SetRemoveInvisibleLayers ( pPrefs->GetRemoveInvisibleLayers () ); SetRemoveUnusedColours ( pPrefs->GetRemoveUnusedColours () ); SetHTMLToClipboard ( pPrefs->GetHTMLToClipboard () ); BaseCamelotFilter::MinimalWebFormat = pPrefs->GetMinimalWebFormat (); return TRUE; } // It didn't work. else { return FALSE; } #else return FALSE; #endif // DO_EXPORT #endif // WEBSTER }

BOOL BaseCamelotFilter::GetFileCompressionState (   )  [protected, virtual]

Get the current file compression state. True if compressing. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Returns: The current state of the file compression. Definition at line 878 of file camfiltr.cpp. { return CompressionOn; }

FilePos BaseCamelotFilter::GetFilePos (   )

Definition at line 5619 of file camfiltr.cpp. { if (pCXaraFile != NULL) return pCXaraFile->GetFilePos(); return 0; }

virtual Layer* BaseCamelotFilter::GetFirstImportedLayer (   )  [inline, virtual]

Definition at line 688 of file camfiltr.h. { return m_pFirstImportedLayer; }

FontComponent* BaseCamelotFilter::GetFontComponent (   )  [inline]

Definition at line 297 of file camfiltr.h. { return pFontComponent; }

SelOperation* BaseCamelotFilter::GetImportSelOp (   )  const [inline]

Definition at line 533 of file camfiltr.h. { return ImportInfo.pOp; }

InsertTreeContext * BaseCamelotFilter::GetInsertContext (  void   )  [virtual]

If you wish to use SetInsertcontextNode to alter where the filter imports to, then chances are you'll want to save & restore the insertion state so that subsequent importing can continue where it left off. If this is the case, bracket your subtree import with code like this: InsertTreeContext *pContext = pFilter->GetInsertContext(); ... import your subtree or whatever ... pFilter->RestoreInsertContext(pContext);. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 5/3/97 Returns: A pointer to a record from which the current insertion context can be restored at a later date. See also: BaseCamelotFilter::RestoreInsertContext Definition at line 6101 of file camfiltr.cpp. { InsertTreeContext *pContext = new InsertTreeContext; if (pContext != NULL) { pContext->pContextNode = GetInsertContextNode(); pContext->InsertAsChild = InsertNextAsChild; } return(pContext); }

Node * BaseCamelotFilter::GetInsertContextNode (   )  [virtual]

Returns the node to add the next node to. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 31/5/96 Parameters: -  [INPUTS] Returns: ptr to the context node If no context node is found, then a context node is found (and if necessary created) by this function See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Definition at line 5867 of file camfiltr.cpp. { if (pInsertContextNode == NULL) { ERROR2IF(TheDocument == NULL,FALSE,"TheDocument is NULL!"); Chapter* pChapter = Node::FindFirstChapter(TheDocument); if (pChapter != NULL) { Spread* pSpread = pChapter->FindFirstSpread(); if (pSpread != NULL) { Layer* pLayer = pSpread->FindFirstLayer(); if (pLayer == NULL) { pLayer = new Layer; if (pLayer != NULL) { if (!AttachNode(pLayer,pSpread,LASTCHILD)) return NULL; String_256 Name1(_R(IDS_K_EPSFILTER_IMPORTED)); String_256 Name2(_R(IDS_LAYER_DESCRS)); Name1 += Name2; pLayer->SetLayerID(Name1); pLayer->EnsureUniqueLayerID(); } } pInsertContextNode = pLayer; InsertNextNodeAsChild(); } } } return pInsertContextNode; }

virtual InsertMode BaseCamelotFilter::GetInsertMode (   )  [inline, virtual]

Definition at line 640 of file camfiltr.h. {return m_InsertMode;}

Chapter* BaseCamelotFilter::GetLastChapterInserted (   )  [inline]

Definition at line 610 of file camfiltr.h. { return pLastChapter; }

NodeAttribute* BaseCamelotFilter::GetLastCurrentAttrInserted (   )  [inline]

Definition at line 614 of file camfiltr.h. { return pLastCurrentAttr; }

Document* BaseCamelotFilter::GetLastDocumentInserted (   )  [inline]

Definition at line 609 of file camfiltr.h. { return pLastDocument; }

Layer* BaseCamelotFilter::GetLastLayerInserted (   )  [inline]

Definition at line 612 of file camfiltr.h. { return pLastLayer; }

NodePath* BaseCamelotFilter::GetLastNodePathInserted (   )  [inline]

Definition at line 613 of file camfiltr.h. { return pLastNodePath; }

Spread* BaseCamelotFilter::GetLastSpreadInserted (   )  [inline]

Definition at line 611 of file camfiltr.h. { return pLastSpread; }

UINT32 BaseCamelotFilter::GetLayerInsertedCount (   )  [inline]

Definition at line 626 of file camfiltr.h. { return LayerCount; }

INT32 BaseCamelotFilter::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: -1 always -1 means no limit See also: BaseCamelotFilter::PrepareToImport; BaseCamelotFilter::DoImport Scope: Protected Reimplemented in CamelotNativeFilter, CamelotWebFilter, and PluginNativeFilter. Definition at line 7345 of file camfiltr.cpp. { return -1; }

BOOL BaseCamelotFilter::GetMinimalWebFormat (   )  [virtual]

Public access function. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/1/97 Parameters: -  [INPUTS] Returns: The current state of the min web format flag WEBSTER - 28/1/97 Note: Reimplemented in FlareTemplateFilter. Definition at line 1208 of file camfiltr.cpp. { return BaseCamelotFilter::MinimalWebFormat; }

BOOL BaseCamelotFilter::GetNativeCheckSimilarPaths (   )  [virtual]

Public access to the current Native check similar paths flag setting. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/9/96 Parameters: -  [INPUTS] Returns: The current state of the Native check similar paths flag. Definition at line 1301 of file camfiltr.cpp. { return BaseCamelotFilter::NativeCheckSimilarPaths; }

BOOL BaseCamelotFilter::GetNativeCompression (   )  [static]

Set the prefernece as to whether we are to compress the native files or not. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/5/96 Parameters: New  state for native file compression, TRUE if want on, FALSE if want off. [INPUTS] Returns: The old state of the compression. Definition at line 795 of file camfiltr.cpp. { return CompressNative; }

UINT32 BaseCamelotFilter::GetNumBytesWritten (   )

Definition at line 5627 of file camfiltr.cpp. { if (pCXaraFile != NULL) return pCXaraFile->GetNumBytesWritten(); return 0; }

virtual UINT32 BaseCamelotFilter::GetPreCompression (   )  [inline, virtual]

Definition at line 756 of file camfiltr.h. { return PreCompFlags; }

BOOL BaseCamelotFilter::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: Virtual so that can be overriden in native filter to save in the proper native state. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/6/96 Parameters: -  [INPUTS] Returns: The current state of the export preview bitmap. Reimplemented in FlareTemplateFilter, CamelotNativeFilter, and PluginNativeFilter. Definition at line 945 of file camfiltr.cpp. { #ifdef _BATCHING return FALSE;