Document Class Reference

To represent a platform independent document object. More...

#include <document.h>

Inheritance diagram for Document:

List of all members.

Public Member Functions
	Document (BOOL IsAHiddenDocument=FALSE)
	Constructor. Initialises the link to the OIL document.
virtual	~Document ()
	Destructor. Deletes the whole document tree of this object, and all memory is returned to the heaps whence it came. The busy cursor is displayed while this is happening.
virtual BOOL	Init (CCamDoc *pOilDoc)
	Sets up the document tree. At the moment it fills it with test data (paths etc) but in future only the initial tree nodes will be set up. When the document has been completely initialised, it becomes the selected and current document: DocChangingMsg message broadcasts will occur (in the order BORN, CURRENT, SELECTED).
virtual BOOL	ReInit ()
	Calls InitFailed to delete the Tree and various others and follows this with an Init to put the Document back into a virgin state Not used just yet...
virtual BOOL	IsNotAClipboard () const
virtual BOOL	IsAClipboard () const
INT32	GetNumLayers ()
	Counts the layers in this document.
BOOL	IsStable () const
void	SetStable (BOOL fStable)
RalphDocument *	GetRalphDoc ()
BOOL	IsARalphDoc (void)
void	SetRalphDoc (BOOL b)
BOOL	ConnectRalphDocument (RalphDocument *pDoc)
void	SetRalphViewMode (ViewMode Vmode)
ViewMode	GetRalphViewMode ()
BOOL	RalphDontShowPaper ()
SafeRenderPointer &	GetSafeRenderPointer ()
	Returns a reference to the document's 'Safe render pointer'.
String_256	GetTitle () const
	Returns the Title of the document. The title is the text that appears in the documents windows (when it is not maximised). For example 'Untitled #1' or 'Untitled #1 (Modified)' or even 'Blobby.art (Modified)'.
String_256	GetDocName (BOOL IncludeFileType=TRUE) const
	Returns the name of the document. The name will be the first part of the title which is the text that appears in the document windows (when it is not maximised). For example 'Untitled #1' or 'Untitled #1 (Modified)' or even 'Blobby.art (Modified)'.
String_256	GetPathName (UINT32 MaxSize=0) const
	Returns the pathname of the document.
String_256	GetLocation (UINT32 MaxSize=0) const
	Returns the location of the document, which is the pathname with no filename.
const String_256 &	GetProducer () const
const String_256 &	GetComment () const
	Getting the time the document was created.
void	SetComment (String_256 *NewComment)
	Setting the document's comment string.
const time_t &	GetCreationTime () const
void	SetCreationTime (time_t)
	Allows setting of the document's creation time.
const time_t &	GetLastSaveTime () const
	Getting the time the document was last saved.
void	SetLastSaveTime (time_t)
	Allows setting of the document's last saved time.
void	SetLastSaveTime ()
	Call on saving a document. Sets the document's last saved time.
void	MakeJustCreated ()
	Resets member variables of the document so it abbears as if the document has just been created (eg CreationTime is set to the current time).
void	SetModified (BOOL fState)
	Sets (or clears) the "document is modified" flag.
BOOL	IsModified () const
	Tests the "Modified" flag.
BOOL	IsReadOnly () const
	Tests the "Read Only" flag.
BOOL	IsACopy () const
	Tests the "Copy" flag.
BOOL	IsLoadedAsVersion1File () const
	Returns the current state of the IsLoadedAsVersion1File flag. Flag to say that the document was loaded as a version 1 file and so the user needs to be given the option of saving it in this form when the document is saved.
BOOL	SetLoadedAsVersion1File (BOOL NewState)
	Sets a new current state of the IsLoadedAsVersion1File flag. Flag to say that the document was loaded as a version 1 file and so the user needs to be given the option of saving it in this form when the document is saved.
Spread *	FindFirstSpread ()
	Finds the first spread in this document.
void	SetCurrent ()
BOOL	IsAnimated ()
	Finds whether this document is an animation.
void	GetExtents (DocCoord *Lo, DocCoord *Hi, DocRect *Extent, View *pView)
	Find the extents of the document. These are in DocCoords - Lo is the bottom-left corner of the last chapter, and Hi is the top-right corner of the first chapter.
void	UpdateExtents (const DocCoord &Lo, const DocCoord &Hi)
	Change the document extents. This will only be done by objects of class NodeDocument. All related DocViews are informed of the change.
UnitType	GetDocFontUnits ()
	return Font Units for this document default to COMP_POINTS if no unit list available
void	DeleteContents ()
	None. Nothing. Does not do anything. And don't even think about making it do anything!
void	InsertNewNode (Node *NewNode, Spread *pDestSpread)
	Inserts the Node into the Document at the position specified. The node is added to the active layer on this spread.
void	HandleNodeDeletion (Node *pNode)
	Calls DocView::ForceRedraw(WorkRect&) for each DocView attached to this Document.
CCamDoc *	GetOilDoc () const
	Find the Oil document associated with the Document.
DocView *	GetFirstDocView () const
DocView *	GetNextDocView (const DocView *pView) const
DocView *	GetTopmostView () const
	Finds out which of this Document's DocViews is 'selected'.
DocView *	GetNewDocView ()
	Returns a new DocView for the client. If any unconnected views already exist for this document, the first is returned. Otherwise a new DocView is created and returned. If a new DocView is obtained, it becomes the 'current' DocView before it is returned to the caller.
DocView *	GetSpareDocView ()
	Looks for a DocView with no attached OilView, so we can recycle it.
void	OnDocViewDying (DocView *pdv)
void	ShowViewScrollers (BOOL fIsVisible)
void	ShowViewRulers (BOOL fIsVisible)
BOOL	CreateDragTargets (DragInformation *DragInfo)
	Calls all (OILY) views to create their drag targets.
void	ForceRedraw (FRDocViewFunc=NULL)
	Calls DocView::ForceRedraw() for each DocView attached to this Document. i.e. This forces a *complete* redraw for the whole document in all views attached to it.
void	ForceRedraw (WorkRect &forceRect)
	Calls DocView::ForceRedraw(WorkRect&) for each DocView attached to this Document.
void	ForceRedraw (Spread *pSpread, DocRect SpreadRect, BOOL Accumulate=FALSE, Node *pInvalidNode=NULL, BOOL bAutoRelease=TRUE)
	Calls DocView::ForceRedraw(Spread*, DocRect) for each DocView attached to this Document.
void	FlushRedraw ()
	Calls DocView::FlushRedraw() for each DocView attached to this Document.
UINT32	GetCreatorSerialNo ()
UINT32	GetLastSerialNo ()
void	SetLastEditorSerialNo (UINT32 sn)
BOOL	IsMultilayer ()
	Interogate the multilayer status of this document.
BOOL	IsAllVisible ()
	Interogate the "all visible" status of this document.
void	SetMultilayer (BOOL state)
	Lets you set the state of the multilayer document flag.
void	SetAllVisible (BOOL state)
	Lets you set the state of the "all visible" document flag.
AttributeManager &	GetAttributeMgr () const
	For finding the documents operation history.
NodeSetSentinel *	GetSetSentinel () const
NodeAttribute *	GetDefaultAttr (CCRuntimeClass *RequiredAttr)
	Finds the default attribute node for a document, given the attribute class to look for. For instance, to find out the default line width for a document: MonoOn.
MILLIPOINT	GetBleedOffset () const
	For getting the Document's bleed area size.
BOOL	SetBleedOffset (MILLIPOINT)
	For setting a new value for the Document's bleed area size.
OperationHistory &	GetOpHistory ()
	For finding the documents operation history.
BOOL	EmptyOperationHistory ()
	This function deletes the operation history, destroying everything in it. It then creates a new empty Operation History and sets it up ready for use. This function was really created to allow the New and Open Document options to get rid of the undo that is created by the file importing.
BitmapList *	GetBitmapList ()
	Gets the bitmap list from this documents doc component.
DocUnitList *	GetDocUnitList ()
UINT32	GetDocNudge ()
BOOL	SetDocNudge (UINT32 newVal)
	Sets the documents nudge size.
BOOL	GetBitmapSmoothing ()
void	SetBitmapSmoothing (BOOL newVal)
DocCoord	GetDuplicationOffset ()
void	SetDuplicationOffset (DocCoord newOffset)
virtual BOOL	EPSStartImport (EPSFilter *)
	Inform the document that an EPS import is about to start.
virtual void	EPSEndImport (EPSFilter *, BOOL)
	Inform the document that an EPS import has just finished.
virtual BOOL	EPSStartExport (EPSFilter *)
	Inform the document that an EPS export is about to start.
virtual void	EPSEndExport (EPSFilter *)
	Inform the document that an EPS export has just finished.
virtual BOOL	WriteEPSResources (EPSFilter *)
	Write out the EPS resources for this document, using the EPS filter object supplied. (The base class does nothing except return TRUE).
virtual BOOL	WriteEPSProlog (EPSFilter *)
	Write out the EPS prolog for this document, using the EPS filter object supplied. (The base class does nothing except return TRUE).
virtual BOOL	WriteEPSSetup (EPSFilter *)
	Write out the EPS setup for this document, using the EPS filter object supplied. (The base class does nothing except return TRUE).
virtual BOOL	WriteEPSFonts (EPSFilter *)
	Write out the EPS fonts for this document, using the EPS filter object supplied. (The base class does nothing except return TRUE).
virtual BOOL	WriteEPSComments (EPSFilter *)
	Write out any comments that need to be in the initial batch of EPS comments (i.e. before the %EndComments line), using the specified EPS Filter object. (The base class does nothing except return TRUE).
virtual BOOL	WriteEPSTrailer (EPSFilter *)
	Write out the EPS trailer for this document, using the EPS filter object supplied. (The base class does nothing except return TRUE).
virtual ProcessEPSResult	ProcessEPSComment (EPSFilter *, const TCHAR *)
	Process an EPS comment found in the file, if it 'belongs' to the document. If it does not, then the document should return EPSCommentUnknown, and the comment will be passed on to the document components. If the function returns EPSCommentOK, and the next line in the file starts with "%%+", i.e. an EPS/PostScript continuation comment, then this will be passed to this document immediately, without trying any of the document components first. This allows items such a colour lists to be imported easily, as they are usually specified on multiple lines in the file, using "%%+" comments. (The base class does nothing - it returns EPSCommentUnknown).
virtual void	EndOfEPSComment (EPSFilter *)
	Informs the document that the comment it has been decoding has now finished, and it should take whatever action required to act on the comment. This call is made even for single-line comments, because by the nature of DSC comments, it is not known until the next comment starts or a non-comment line is encountered that the comment is over and is not multi-line.
virtual INT32	GetSizeOfExport (Filter *)
	Find out how many nodes will be exported when this document is exported. The node can use the filter to find out how it will be exported. NB. This is virtual - the default implementation just returns 1 - only override if this is not accurate.
BOOL	IsImporting ()
	Helps work out if the document is in the process of opening an existing file or if it is importing data into itself. Called during the reading of the Document Info section of the .art files. All the DocInfo section is ignored if the file is actually being imported.
void	SetIsImporting (BOOL NewIsImporting)
	Sets the IsImporting flag for the document.
BOOL	IsTemplateLoading ()
	Helps work out if the document being opened or imported is a default or template document. At present, used in Webster to check if we need to use layers or not. Template documents are allowed to have layers. Non-template docs are not.
void	SetTemplateLoading (BOOL NewTemplateLoading)
	Sets the TemplateLoading flag for the document.
BOOL	AIExportExtras (EPSExportDC *pDC)
	Export an Illustrator compatible trailer.
InsertionNode *	GetInsertionPosition ()
	This function should be called to find the position in the document where a new object should be inserted. The object should always be inserted as a previous child of the InsertionNode which is returned.
void	ResetInsertionPosition ()
	Forces the insertion node to move to the end of the layer that it is currently on. This is used by the filters so they can insert an arbitrary number of nodes into the tree without worryng about the insertion position being updated every time and then it can just update it at the end using this function.
void	InsertionNodeDying ()
Static Public Member Functions
static BOOL	ReadPrefs ()
	Reads preferences for the Document class from the program's .INI file.
static Document *	GetCurrent ()
	Find the current Document object.
static void	SetNoCurrent ()
	Set the current document pointer to be NULL, i.e., there is no current document object. Changed 22/7/94 by MarkN **** Does NOT broadcasts a message to all that this is happening any more.
static Document *	GetSelected ()
	Find the selected Document object.
static void	SetSelectedViewAndSpread (Document *TheDocument=NULL, DocView *TheView=NULL, Spread *TheSpread=NULL)
	To set the Selected Document, DocView, and Spread.
static void	SetNoSelectedViewAndSpread (void)
	To set the Selected Document, DocView, and Spread. This sets all three of these entities to NULL - no selected entity.
static Spread *	GetSelectedSpread ()
	THIS METHOD IS DEFUNCT! DO NOT CALL IT! Use Document::SetSelectedViewAndSpread() instead (This call is currently indirected to that one, and gives TRACE warnings)THIS METHOD IS DEFUNCT! DO NOT CALL IT! Use Document::SetNoSelectedViewAndSpread() instead (This call is currently indirected to that one, and gives TRACE warnings)THIS METHOD IS DEFUNCT! DO NOT CALL IT! Use Document::SetSelectedViewAndSpread() instead (This call is currently indirected to that one, and gives TRACE warnings)Returns the selected spread.
static BOOL	SpreadBelongsToDoc (Document *pDoc, Spread *pSpread)
	Tests to see if the spread belongs to the document.
static void	IncCurrentNodeCount ()
	Adds one to the NodesInTree counter of the Current Document object, if it exists. Called by the constructors of class Node.
static void	DecCurrentNodeCount ()
	Decrements the node counter in the current Document, if there is one. Called by the destructor of class Node.
static BOOL	GetRestoreViewOnImport ()
static void	ShouldRestoreViewOnImport (BOOL fNewState)
	Sets/clears a flag that if TRUE will ask this document to restore the view saved within the doc, if FALSE it won't bother. Normally we want the view saved in the doc to be restore, but if we are restoring the entire workspace then this is dealt with elsewhere.
Protected Member Functions
BOOL	InitFailed ()
	Called by Document::Init when it fails; encapsulates all necessary tidying up, and then returns FALSE so that it can be called as part of the final return statement. Replaces some completely unnecessary goto code.
BOOL	InitTree (NodeDocument *RootNode)
	Called by Document::Init to initialise the document tree structure.
BOOL	ExportPageInfo (EPSExportDC *pDC)
	Exports a Document Info continuation comment that describes the page layout. It takes the following form :- %+p VersionNum if VersionNum is zero then the following will be on the rest of the line Width Height Margin Bleed DPS(1 for yes, 0 for no) ShowDropShadow(1 for yes, 0 for no).
BOOL	ExportDocumentComment (EPSExportDC *pDC)
	Will export as many Document Info continuation comments as are needed to save out the whole comment. Each continuation comment takes the form as follows :- %+c CommentHere Each line will not have more that about 100 chars of comment on it (they will all be simple joined together when importing). If there is a new line char in the comment the continuation comment will end at that point, but the last char of the continuation comment will be ^.
BOOL	ExportViewInfo (EPSExportDC *pDC)
	Exports the View Settings continuation comment (part of the Document Info comment). It has the following form %+v VersionNum(1) XScrollOffset YScrollOffset ScaleFactor Active DrawingScale RealScale. ScaleFactor is represented 1000 times the actual scale factor. eg when the document is viewed at 100% the scale factor is 1.0. This is export as 1000. 200% would be 2000 etc. Active is a flag to say if the Document Scale Factor is active or not. It is followed by the Drawing and Real scales in the document.
BOOL	ExportStateInfo (EPSExportDC *pDC)
	Part of the Document Info comment. This is document state information It takes the following form :- %+s VersionNum Version 0 comment lines follows this with ShowGrid SnapToGrid SnapToMagObjects SnapToObjects ForeBackMode (and zero as a dummy value, see comments in the function). Each of the values is a flag and will hold either 0 for FALSE or 1 for TRUE.
BOOL	ExportQualityInfo (EPSExportDC *pDC)
	Part of the Document Info comment. It takes the following form :- %+q VersionNum(0) ViewQuality. ViewQuality is the numerical value of the view Quality.
BOOL	ExportGridInfo (EPSExportDC *pDC)
BOOL	ExportFlagInfo (EPSExportDC *pDC)
BOOL	ExportUnitInfo (EPSExportDC *pDC)
	Saves out all the user defined units. These are saved in version 0 comments lines, 1 unit per line. The default units being used for page and fonts are exported in:-.
BOOL	ExportDateInfo (EPSExportDC *pDC)
	exports a continuation comment that holds the Last Saved Date and the Creation Date. It takes the follwoing form :- %+d Version(0) CreationDate LastSavedDate
BOOL	ExportTextSetup (EPSFilter *pFilter)
BOOL	ExportTextTrailer (EPSFilter *pFilter)
BOOL	ExportRulerState (EPSExportDC *pFilter)
	Exports the View Settings continuation comment (part of the Document Info comment). It has the following form %+r VersionNum(0) ScrollersVisible RulersVisible.
BOOL	ExportUndoInfo (EPSExportDC *pDC)
	Exports a Document Info continuation comment that describes the document's OperationHistory size. It takes the following form :- %+h VersionNum if VersionNum is zero then the following will be on the rest of the line Size(bytes).
BOOL	ExportDefaultUnitsInfo (EPSExportDC *pDC)
	Saves out the user default units for displaying things like page units and font units to the user. These are saved in version 0 comments lines followed by a string for the page units and a string for the font units. Must come after the user units section as the default might be one of these user units. The usert unit definitions are exported in:-.
BOOL	ExportOriginInfo (EPSExportDC *pDC)
	Export grid/user origin Note: Should be exported after grid and page info as when importing, these both reset the origin to the origin of the page.
BOOL	AIExportResources (EPSExportDC *pDC, BOOL)
	Export an Illustrator standard needed resources.
BOOL	AIExportProlog (EPSExportDC *pDC)
	Export an Illustrator standard prolog.
BOOL	AIExportCharEncoding (EPSExportDC *pDC)
	Export an Illustrator compatible character encoding vector but only in EPS format.
BOOL	AIExportFontEncoding (EPSExportDC *pDC)
	Export an Illustrator compatible font encodings but only in EPS format.
BOOL	AIExportFontEncoding (EPSExportDC *pDC, String_64 &FontName, INT32 Style)
	Export an Illustrator compatible font encoding but only in EPS format.
BOOL	AIExportTrailer (EPSExportDC *pDC)
	Export an Illustrator compatible trailer.
ProcessEPSResult	ImportPageInfo (TCHAR *Comment)
	Tries to import the page info. This function only returns FALSE if there was an actual error in the file that needs reporting.
ProcessEPSResult	ImportDocumentComment (TCHAR *Comment)
ProcessEPSResult	ImportViewInfo (TCHAR *Comment)
ProcessEPSResult	ImportRulerState (TCHAR *Comment)
ProcessEPSResult	ImportStateInfo (TCHAR *Comment)
	Imports state information. Version 0 holds view state information such as:- grid showing and snap to grid magnetic snap to objects foregound background redraw modes.
ProcessEPSResult	ImportQualityInfo (TCHAR *Comment)
ProcessEPSResult	ImportGridInfo (TCHAR *Comment)
	Imports the global grid that covers the whole spread.
ProcessEPSResult	ImportFlagInfo (TCHAR *Comment)
ProcessEPSResult	ImportUnitInfo (TCHAR *Comment)
	Imports a continuation comment with details about a user defined unit on it There is 1 unit per comment. This comment always creates a new user unit in version prior to Studio 1.00b, code updated to not do this 4/9/95.
ProcessEPSResult	ImportDateInfo (TCHAR *Comment)
	Reads in the Last saved Date and Creation Date from the file.
ProcessEPSResult	ImportUndoInfo (TCHAR *Comment)
	Reads in the Last saved operation history size from the file.
ProcessEPSResult	ImportDefaultUnitsInfo (TCHAR *Comment)
	Imports a continuation comment with details about the default units which are going to be used for showing page and font measurements. Cannot use units as on older version will always create a new user unit for each ++u found..
ProcessEPSResult	ImportOriginInfo (TCHAR *Comment)
	Imports the spread grid/user origin Note: The origin should already have been set up to the page origin when importing the grid (ie already has a sensible default if the origin import fails) Also since the origin does not affect the look of the doc, if possible don't abort importing if an error is encountered so the doc can be recovered.
Protected Attributes
BOOL	IsARalph
ViewMode	Viewmode
RalphDocument *	pRalphDocument
SafeRenderPointer	TheSafeRenderPointer
CCamDoc *	OilDoc
List	DocViews
OperationHistory *	OpHistory
BOOL	DocIsImporting
BOOL	DocTemplateLoading
Static Protected Attributes
static BOOL	fRestoreViewOnImport = TRUE
Private Member Functions
BOOL	InitDefaultAttributeNodes ()
	This function adds the document's default attributes as nodes at the start of the tree (i.e. as first children of the NodeDocument).
	CC_DECLARE_DYNAMIC (Document)
Private Attributes
BOOL	m_fStable
time_t	CreationTime
time_t	LastSaveTime
String_256	Producer
String_256	Comment
struct {
BOOL   SaveWithUndo: 1
BOOL   LayerMultilayer: 1
BOOL   LayerAllVisible: 1
}	DocFlags
BOOL	LoadedAsVersion1File
Spread *	pSelSpread
UINT32	CreatorSerialNo
UINT32	LastSerialNo
AttributeManager *	AttributeMgr
NodeSetSentinel *	m_pSetSentinel
MILLIPOINT	PasteBoardOffsetWidth
MILLIPOINT	PasteBoardOffsetHeight
MILLIPOINT	BleedOffset
DocUnitList *	pDocUnitList
UINT32	m_docNudge
BOOL	m_bSmoothBitmaps
DocCoord	m_DuplicationOffset
InsertionNode *	InsertPos
Static Private Attributes
static Spread *	pGlobalSelSpread = NULL
static Document *	Current = NULL
static Document *	Selected = NULL

---

Detailed Description

To represent a platform independent document object.

Author:

Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> (messed about by Tim) (sorted out by JustinF)

Date:

13/4/1993

Definition at line 219 of file document.h.

---

Constructor & Destructor Documentation

Document::Document (  BOOL  bIsAHiddenDoc = FALSE  )

Constructor. Initialises the link to the OIL document. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 19/5/93 Parameters: IsAHiddenDoc  - FALSE for a normal document (see below) [INPUTS] TRUE for a hidden document (including clipboards, etc) Notes: You MUST call Document::Init after Creation of the document, to fill in the defaults and build the document tree root. HIDDEN DOCUMENTS A hidden document is one which is not shown to the user in any UI. Hidden docs are used mainly for clipboard (and OLE) data transfer operations. Note that if you pass in (pCCamDoc = NULL) then the document is forced to be hidden. SeeAlso IsAHiddenDoc() and IsNotAHiddenDoc() in document.h The InternalClipboard is now based upon Document. It creates a Hidden Document. Generally nobody should care about this, but some bits of code might have to be careful of the differences. Use IsAClipboard() to check if the doc is really a clipboard. Note also that Clipboard documents do not broadcast DocChangingMsgs. Returns: Errors: None. See also: Document::Init; InternalClipboard; BaseDocument Definition at line 230 of file document.cpp. : BaseDocument(bIsAHiddenDoc), OilDoc(0) { // NB. Make sure all the Document stuff is set up before calling routines which // might interrogate the Document object. // Set the default state of the flags. DocFlags.LayerMultilayer = FALSE; DocFlags.LayerAllVisible = FALSE; DocFlags.SaveWithUndo = TRUE; // Set the times CreationTime = ::time(NULL); LastSaveTime = 0; // Set up default bleed offset BleedOffset = DefBleedSize; // Set up our array of default colour contexts by copying the 'global' array ColourContext::GetGlobalDefaults( &DefaultColourContexts ); // Add this document to the list of all documents in Camelot #ifdef RALPH Camelot.Documents.AddHead(this); #else if (IsNotAHiddenDoc()) { Camelot.Documents.AddHead(this); } #endif // Set this document to be the current one this->SetCurrent(); NodesInTree = 0; // Initialise pointers to sensible values (they are set up in the Init() function) OpHistory = 0; AttributeMgr = 0; m_pSetSentinel = 0; pDocUnitList = 0; pSelSpread = 0; IsARalph = FALSE; pRalphDocument =NULL; Viewmode = DOCUMENT_VIEW; // Always keep this flag TRUE except when Loading New Files in DocIsImporting = TRUE; // Always keep this False unless loading a template document DocTemplateLoading = FALSE; // Make sure that the loaded as old version file is set to a known state LoadedAsVersion1File = FALSE; m_docNudge = DEFAULT_NUDGE_SIZE; SetBitmapSmoothing(TRUE); m_DuplicationOffset = DocCoord(OpDuplicate::DuplicatePlacementX, OpDuplicate::DuplicatePlacementY); // Document is not yet "born and stable". m_fStable = FALSE; }

Document::~Document (   )  [virtual]

Destructor. Deletes the whole document tree of this object, and all memory is returned to the heaps whence it came. The busy cursor is displayed while this is happening. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 19/5/93 Definition at line 640 of file document.cpp. { // Set the busy cursor . . . BeginSlowJob(-1, FALSE); #ifndef RALPH // Broadcast to everyone that this document is a dead duck. if (IsNotAHiddenDoc()) #endif { // Document no longer stable. SetStable(FALSE); BROADCAST_TO_ALL(DocChangingMsg(this, DocChangingMsg::ABOUTTODIE)); } #ifdef _DEBUG // DocViews should be closed before Documents, so all render regions for this document // should have been deleted - make sure they have. Camelot.DeleteRenderRegions(this); #endif #ifndef RALPH // Remove Document from list of all documents if (IsNotAHiddenDoc()) #endif { Camelot.Documents.RemoveItem(this); // Is this the last document in the program? BOOL ThisIsTheLastDoc = (Camelot.Documents.GetHead() == NULL); if (ThisIsTheLastDoc) { // There are no more documents, so ensure that the system is in the correct state. // If the system is working correctly, then the following should be true: // If Current != NULL, Current must be this document // If Selected != NULL, Selected must be this document // We will ensure this is the case in debug builds ENSURE((Current == NULL) || (Current == this),"Current document is garbage"); ENSURE((Selected == NULL) || (Selected == this),"Selected document is garbage"); // Reset Current and Selected document and DocView SetNoCurrent(); SetNoSelectedViewAndSpread(); DocView::SetNoCurrent(); // DocView::SetNoSelected(); -- now done in SetNoSelectedViewAndSpread(), above } else { // Make sure that Current and Selected do not refer to the dying document if (this == Current) SetNoCurrent(); if (this == Selected) SetNoSelectedViewAndSpread(); // This special test added to fix a problem whereby current doc was being set to null // above and hence causing unit display problems (ERROR2s) in the selector tool when // opening a bitmap had been aborted. 18/9/96 Neville if (Selected != NULL && Current == NULL) Current = Selected; } } // Delete all DocViews attached to document DocViews.DeleteAll(); #ifndef RALPH // Broadcast to everyone that this document is a dead duck. if (IsNotAHiddenDoc()) { BROADCAST_TO_ALL(DocChangingMsg(this, DocChangingMsg::KILLED)); } #endif // Destroy the operation history. This must get destroyed before the tree is destroyed if (OpHistory != NULL) delete (OpHistory); // Destroy the attribute manager if (AttributeMgr != NULL) delete (AttributeMgr); // Destroy the list of units in this document if (pDocUnitList != NULL) delete (pDocUnitList); // All done... EndSlowJob(); // Note that the tree is deleted in the base class destructor }

---

Member Function Documentation

BOOL Document::AIExportCharEncoding (  EPSExportDC *  pDC  )  [protected]

Export an Illustrator compatible character encoding vector but only in EPS format. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: pDC  - the dc to export to [INPUTS] Returns: TRUE Definition at line 4669 of file document.cpp. { // Temporarily output an inline encoding. This should really be read from a file. pDC->OutputToken(_T("[")); pDC->OutputNewLine(); pDC->OutputToken(_T("39/quotesingle 96/grave 128/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis")); pDC->OutputNewLine(); pDC->OutputToken(_T("/Udieresis/aacute/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute")); pDC->OutputNewLine(); pDC->OutputToken(_T("/egrave/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde")); pDC->OutputNewLine(); pDC->OutputToken(_T("/oacute/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex")); pDC->OutputNewLine(); pDC->OutputToken(_T("/udieresis/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls")); pDC->OutputNewLine(); pDC->OutputToken(_T("/registered/copyright/trademark/acute/dieresis/.notdef/AE/Oslash")); pDC->OutputNewLine(); pDC->OutputToken(_T("/.notdef/plusminus/.notdef/.notdef/yen/mu/.notdef/.notdef")); pDC->OutputNewLine(); pDC->OutputToken(_T("/.notdef/.notdef/.notdef/ordfeminine/ordmasculine/.notdef/ae/oslash")); pDC->OutputNewLine(); pDC->OutputToken(_T("/questiondown/exclamdown/logicalnot/.notdef/florin/.notdef/.notdef")); pDC->OutputNewLine(); pDC->OutputToken(_T("/guillemotleft/guillemotright/ellipsis/.notdef/Agrave/Atilde/Otilde/OE/oe")); pDC->OutputNewLine(); pDC->OutputToken(_T("/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide")); pDC->OutputNewLine(); pDC->OutputToken(_T("/.notdef/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright")); pDC->OutputNewLine(); pDC->OutputToken(_T("/fi/fl/daggerdbl/periodcentered/quotesinglbase/quotedblbase/perthousand")); pDC->OutputNewLine(); pDC->OutputToken(_T("/Acircumflex/Ecircumflex/Aacute/Edieresis/Egrave/Iacute/Icircumflex")); pDC->OutputNewLine(); pDC->OutputToken(_T("/Idieresis/Igrave/Oacute/Ocircumflex/.notdef/Ograve/Uacute/Ucircumflex")); pDC->OutputNewLine(); pDC->OutputToken(_T("/Ugrave/dotlessi/circumflex/tilde/macron/breve/dotaccent/ring/cedilla")); pDC->OutputNewLine(); pDC->OutputToken(_T("/hungarumlaut/ogonek/caron")); pDC->OutputNewLine(); pDC->OutputToken(_T("TE")); pDC->OutputNewLine(); return TRUE; }

BOOL Document::AIExportExtras (  EPSExportDC *  pDC  )

Export an Illustrator compatible trailer. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: pDC  - the dc to export to [INPUTS] Returns: TRUE Definition at line 4791 of file document.cpp. { pDC->OutputToken(_T("Adobe_level2_AI5 /initialize get exec")); pDC->OutputNewLine(); pDC->OutputToken(_T("Adobe_packedarray /initialize get exec")); pDC->OutputNewLine(); pDC->OutputToken(_T("Adobe_ColorImage_AI6 /initialize get exec")); pDC->OutputNewLine(); pDC->OutputToken(_T("Adobe_cshow /initialize get exec")); pDC->OutputNewLine(); pDC->OutputToken(_T("Adobe_cmykcolor /initialize get exec")); pDC->OutputNewLine(); pDC->OutputToken(_T("Adobe_customcolor /initialize get exec")); pDC->OutputNewLine(); // ChrisG (31/10/00) Changed typography line to match Illustrator and CorelDraw. // This allows photoshop to import the file correctly. pDC->OutputToken(_T("Adobe_Illustrator_AI5_vars Adobe_Illustrator_AI5")); pDC->OutputToken(_T("Adobe_typography_AI5 /initialize get exec")); pDC->OutputNewLine(); // End of typography output. pDC->OutputToken(_T("Adobe_pattern_AI3 /initialize get exec")); pDC->OutputNewLine(); pDC->OutputToken(_T("Adobe_Illustrator_AI5 /initialize get exec")); pDC->OutputNewLine(); return TRUE; }

BOOL Document::AIExportFontEncoding (  EPSExportDC *  pDC, String_64 &  FontName, INT32  Style )  [protected]

Export an Illustrator compatible font encoding but only in EPS format. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: pDC  - the dc to export to [INPUTS] FontName - a reference to a font name Style - a font style b0 = 1 bold b1 = 1 italic Returns: TRUE Definition at line 4749 of file document.cpp. { String_64 EFont; // Graeme (31-3-00) - Map the encoded name onto the PS font name. FONTMANAGER->EncodeAndMapFontName(FontName, EFont, Style); String_256 Line(_T("%AI3_BeginEncoding: _")); Line+=(TCHAR*)EFont; Line+=_T(" "); Line+=(TCHAR*)EFont; pDC->OutputToken((TCHAR*)Line); pDC->OutputNewLine(); Line=_T("[/_"); Line+=(TCHAR*)EFont; Line+=_T("/"); Line+=(TCHAR*)EFont; Line+=_T(" 0 0 1 TZ"); pDC->OutputToken((TCHAR*)Line); pDC->OutputNewLine(); Line=_T("%AI3_EndEncoding"); pDC->OutputToken((TCHAR*)Line); pDC->OutputNewLine(); return TRUE; }

BOOL Document::AIExportFontEncoding (  EPSExportDC *  pDC  )  [protected]

Export an Illustrator compatible font encodings but only in EPS format. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: pDC  - the dc to export to [INPUTS] Returns: TRUE Definition at line 4708 of file document.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // need to enumerate all fonts for this encodeing String_64 FName; INT32 Style; FontList CurFontList; if (!CurFontList.Build(this)) return FALSE; FontListItem* pItem = CurFontList.GetFirstItem(); while (pItem) { FName = pItem->GetFontName(); Style = pItem->GetFontStyle(); AIExportFontEncoding(pDC,FName,Style); pItem = CurFontList.GetNextItem(pItem); } #endif return TRUE; }

BOOL Document::AIExportProlog (  EPSExportDC *  pDC  )  [protected]

Export an Illustrator standard prolog. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: pDC  - the dc to export to [INPUTS] Returns: TRUE Definition at line 4641 of file document.cpp. { pDC->OutputToken(_T("%%IncludeResource: procset Adobe_level2_AI5 1.2 0")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_packedarray 2.0 0")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_ColorImage_AI6 1.1 0")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_cshow 2.0 8")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_cmykcolor 1.1 0")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_customcolor 1.0 0")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_typography_AI5 1.1 0")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_pattern_AI3 1.0 1")); pDC->OutputNewLine(); pDC->OutputToken(_T("%%IncludeResource: procset Adobe_Illustrator_AI5 1.2 0")); pDC->OutputNewLine(); return TRUE; }

BOOL Document::AIExportResources (  EPSExportDC *  pDC, BOOL  first )  [protected]

Export an Illustrator standard needed resources. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: pDC  - the dc to export to [INPUTS] Returns: TRUE Definition at line 4608 of file document.cpp. { if (!first) pDC->OutputToken(_T("%%+")); // Graeme (28-3-00) - I've updated these to bring them in line with the procset // definitions from Fireworks 3 and CorelDraw 9. These have upgraded the file // to AI version 7.0, and should hopefully offer gradient fill support. pDC->OutputToken ( _T("procset Adobe_level2_AI5 1.2 0 ") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_packedarray 2.0 0") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_ColorImage_AI6 1.1 0") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_cshow 2.0 8") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_cmykcolor 1.1 0") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_customcolor 1.0 0") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_typography_AI5 1.0 1") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_pattern_AI3 1.0 1") ); pDC->OutputNewLine (); pDC->OutputToken ( _T("%%+ procset Adobe_Illustrator_AI5 1.2 0") ); pDC->OutputNewLine (); return TRUE; }

BOOL Document::AIExportTrailer (  EPSExportDC *  pDC  )  [protected]

Export an Illustrator compatible trailer. Author:<