#include <CPanelBasedXMLGenerator.h>

Inheritance diagram for CPanelBasedXMLGenerator:

Public Member Functions
	CPanelBasedXMLGenerator (IPMUnknown *boss)

virtual bool16	ShouldPanelBePersisted (IControlView *panel)

virtual void	GeneratePanelBeginTag (IXMLOutStream s, IControlView panel)

virtual void	GeneratePanelContents (IXMLOutStream s, IControlView panel)

virtual void	GeneratePanelEndTag (IXMLOutStream s, IControlView panel)

Public Member Functions inherited from CXMLGenerator
	CXMLGenerator (IPMUnknown *boss)

virtual void	GenerateBeginTag (IXMLOutStream *s)

virtual void	CollectAttributes (IXMLOutStream s, IXMLOutStream::AttributeList attrs)

virtual void	GenerateContent (IXMLOutStream *s, int32 beforeChildIndex=0)

virtual void	GenerateEndTag (IXMLOutStream *s)

Public Member Functions inherited from CPMUnknown< IXMLGenerator >
IPMUnknown *	QueryInterface (PMIID interfaceID) const

void	AddRef () const

void	Release () const

void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)

void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)

	CPMUnknown (const CPMUnknown &)=delete

CPMUnknown &	operator= (const CPMUnknown &)=delete

Protected Member Functions
virtual void	PushPanelAttributes (IXMLOutStream::AttributeList &attrs, IControlView *panel)

virtual void	GenerateControlSet (IXMLOutStream s, IKit panelKit)

void	PushBool (IXMLOutStream::AttributeList &attrs, const PMString &name, bool16 theBool)

void	PushInt (IXMLOutStream::AttributeList &attrs, const PMString &name, int32 theInt)

void	PushString (IXMLOutStream::AttributeList &attrs, const PMString &name, const PMString &value)

Additional Inherited Members
Public Types inherited from IXMLGenerator
enum	{ kDefaultIID = IID_IXMLGENERATOR }

Protected Attributes inherited from CPMUnknown< IXMLGenerator >
HelperInterface	fHelperInterface

Detailed Description

The base class used to generate the xml-based workspace representation of palette based panels. CPanelBasedXMLGenerator contains the default implementation used to write panels into a palette workspace.

Clients who need to override the default behavior provided here should subclass BasePanelXMLGenerator and include the implementation on their panel's boss as an IID_IXMLGENERATOR interface.

See Also: IXMLGenerator, BasePanelXMLGenerator

Member Function Documentation

virtual void CPanelBasedXMLGenerator::GenerateControlSet	(	IXMLOutStream *	s,
		IKit *	panelKit
	)

protectedvirtual

Writes the XML representation of a control set onto a stream

virtual void CPanelBasedXMLGenerator::GeneratePanelBeginTag	(	IXMLOutStream *	s,
		IControlView *	panel
	)

virtual

Writes the XML begin tag for a panel, including panel attributes, onto a stream

virtual void CPanelBasedXMLGenerator::GeneratePanelContents	(	IXMLOutStream *	s,
		IControlView *	panel
	)

virtual

Writes the XML representation of the panel content, onto a stream

virtual void CPanelBasedXMLGenerator::GeneratePanelEndTag	(	IXMLOutStream *	s,
		IControlView *	panel
	)

virtual

Writes the XML end tag for a panel onto a stream

void CPanelBasedXMLGenerator::PushBool	(	IXMLOutStream::AttributeList &	attrs,
		const PMString &	name,
		bool16	theBool
	)

protected

Utility method to add a boolean attribute to an attribute list

void CPanelBasedXMLGenerator::PushInt	(	IXMLOutStream::AttributeList &	attrs,
		const PMString &	name,
		int32	theInt
	)

protected

Utility method to add an integer attribute to an attribute list

virtual void CPanelBasedXMLGenerator::PushPanelAttributes	(	IXMLOutStream::AttributeList &	attrs,
		IControlView *	panel
	)

protectedvirtual

Collect the panel attributes (size, widgetID, detail level, etc. in an attribute list

Reimplemented in BasePanelXMLGenerator.

void CPanelBasedXMLGenerator::PushString	(	IXMLOutStream::AttributeList &	attrs,
		const PMString &	name,
		const PMString &	value
	)

protected

Utility method to add a string attribute to an attribute list

virtual bool16 CPanelBasedXMLGenerator::ShouldPanelBePersisted ( IControlView * panel )

virtual

Should this particular panel be persisted. Returns kTrue by default. Book panels (which are not persisted) provide their own XMLGenerator that returns kFalse.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation