WizOpStyles Class Reference

Provide a component that allows us to save out the information for this document using the serialisation facilities of the DocComponent base class. More...

#include <styles.h>

Inheritance diagram for WizOpStyles:

List of all members.

Public Member Functions
	WizOpStyles ()
virtual BOOL	StartImport (BaseCamelotFilter *pFilter)
	Inform the colour list document component that a Native or Web import is about to start.
virtual BOOL	EndImport (BaseCamelotFilter *pFilter, BOOL Success)
	Inform the component that a Native or Web import has just finished. Calls EndCopyComponent(q.v).
WizOpStyle *	FindStyleFromRecordReference (XFileRef RecordRef) const
	In between StartImport & EndImport this function is called by WizOpStyleRefRecordHandler::HandleRecord so it knows which WizOpStyle to use for its StyleRefAttribute.
BOOL	SetRecordHandler (WizOpStyleRecordHandler &RecordHandler)
WizOpStyleRecordHandler &	GetRecordHandler () const
virtual BOOL	StartExport (BaseCamelotFilter *pFilter)
	Inform the colour list document component that a WEb or Native export is about to start.
virtual BOOL	EndExport (BaseCamelotFilter *pFilter, BOOL Success)
	Inform the colour list document component that a Web or Native export has just finished.
virtual XFileRef	GetRecordRefForStyle (const WizOpStyle &Style)
	Writes out a WizOpStyle record.
Private Attributes
WizOpStyleRecordHandler *	m_pImporter

---

Detailed Description

Provide a component that allows us to save out the information for this document using the serialisation facilities of the DocComponent base class.

Author:

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

Date:

15/07/96

See also:

DocComponent

Definition at line 307 of file styles.h.

---

Constructor & Destructor Documentation

WizOpStyles::WizOpStyles (   )  [inline]

Definition at line 312 of file styles.h. {}

---

Member Function Documentation

BOOL WizOpStyles::EndExport (  BaseCamelotFilter *  pFilter, BOOL  Success )  [virtual]

Inform the colour list document component that a Web or Native export has just finished. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 11/07/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to import a file. [INPUTS] Success - True if everything went swimmingly, False if just a clean up is required. Returns: TRUE if the component was able to end the importing; FALSE if not (e.g. out of memory) See also: DocComponent Reimplemented from DocComponent. Definition at line 1246 of file styles.cpp. { #ifdef DO_EXPORT ENSURE_NOT_NULL(pFilter); ENSURE_NOT_NULL(m_pCurrentExporter); delete m_pCurrentExporter; m_pCurrentExporter = NULL; return TRUE; #endif return TRUE; }

BOOL WizOpStyles::EndImport (  BaseCamelotFilter *  pFilter, BOOL  Success )  [virtual]

Inform the component that a Native or Web import has just finished. Calls EndCopyComponent(q.v). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 11/07/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to import a file. [INPUTS] Success - TRUE => The import was successful; FALSE => The import failed - abandon any changes. Returns: TRUE if the component was able to end the importing; FALSE if not (e.g. out of memory) Reimplemented from DocComponent. Definition at line 1126 of file styles.cpp. { ENSURE_NOT_NULL(pFilter); BOOL Ok = EndComponentCopy(); m_pImporter = NULL; return Ok; }

WizOpStyle * WizOpStyles::FindStyleFromRecordReference (  XFileRef  RecordRef  )  const

In between StartImport & EndImport this function is called by WizOpStyleRefRecordHandler::HandleRecord so it knows which WizOpStyle to use for its StyleRefAttribute. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 11/07/97 Definition at line 1103 of file styles.cpp. { return GetRecordHandler().FindStyleFromRecordReference(RecordRef); }

WizOpStyleRecordHandler & WizOpStyles::GetRecordHandler (   )  const

Definition at line 1150 of file styles.cpp. { // This static dummy object is used for returning in the ERROR2 case // The original used to return a ptr to a local variable, which is a tad dangerous. // This solution is not ideal, because there's a permanent instance of an object // that will probably never be used. static WizOpStyleRecordHandler Dummy; ERROR2IF(m_pImporter == NULL, Dummy, "NULL Member"); return *m_pImporter; }

XFileRef WizOpStyles::GetRecordRefForStyle (  const WizOpStyle &  Style  )  [virtual]

Writes out a WizOpStyle record. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 11/07/97 Parameters: Style  - The document colour to save [INPUTS] Returns: A record reference to be used for the style. This will be zero if a problem has occurred. Notes: In the process of getting a record reference for the style the style itself may be written to the record stream. As this does save information, it MUST* be called before the caller has called StartRecord() as otherwise the records will become intertwined! Definition at line 1215 of file styles.cpp. { #ifdef DO_EXPORT // We should only be here after a StartExport ENSURE_NOT_NULL(m_pCurrentExporter); INT32 RecordNumber = m_pCurrentExporter->WriteStyle(Style); return RecordNumber; #endif return 0L; }

BOOL WizOpStyles::SetRecordHandler (  WizOpStyleRecordHandler &  RecordHandler  )

Definition at line 1138 of file styles.cpp. { #ifdef _DEBUG /*Styles& ThisShouldWork =*/ GetStylesToAdd(); // there should be some styles that we can add to #endif m_pImporter = &RecordHandler; return TRUE; }

BOOL WizOpStyles::StartExport (  BaseCamelotFilter *  pFilter  )  [virtual]

Inform the colour list document component that a WEb or Native export is about to start. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 11/07/97 Returns: TRUE if the component was able to prepare for exporting; FALSE if not (e.g. out of memory) Parameters: pFilter  - the BaseCamelotFilter filter that is being used to export a file. [INPUTS] See also: DocComponent Reimplemented from DocComponent. Definition at line 1178 of file styles.cpp. { #ifdef DO_EXPORT ENSURE_NOT_NULL(pFilter); // We don't support multi-threading ERROR2IF(m_pCurrentExporter != NULL, FALSE, "Current exporter already exists"); // Create an exporter for the styles m_pCurrentExporter = new StylesExporter(*this, *pFilter); if (m_pCurrentExporter == NULL) return FALSE; #endif return TRUE; }

BOOL WizOpStyles::StartImport (  BaseCamelotFilter *  pFilter  )  [virtual]

Inform the colour list document component that a Native or Web import is about to start. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 11/07/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to import a file. [INPUTS] Returns: TRUE if the component was able to prepare for importing; FALSE if not (e.g. out of memory) See also: DocComponent Reimplemented from DocComponent. Definition at line 1080 of file styles.cpp. { ENSURE_NOT_NULL(pFilter); BOOL Ok = StartComponentCopy(); return Ok; }

---

Member Data Documentation

WizOpStyleRecordHandler* WizOpStyles::m_pImporter [private]

Definition at line 331 of file styles.h.

---

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

• Kernel/styles.h (r1785/r1688)
• Kernel/styles.cpp (r1785/r1688)

---