#include <BasePanelSAXHandler.h>

Inheritance diagram for BasePanelSAXHandler:

Public Member Functions
	BasePanelSAXHandler (IPMUnknown *boss)

virtual void	Register (ISAXServices saxServices, IPMUnknown importer)

virtual void	StartElement (const WideString &uri, const WideString &localname, const WideString &qname, ISAXAttributes *attrs)=0

virtual void	EndElement (const WideString &uri, const WideString &localname, const WideString &qname)

virtual bool16	HandlesSubElements () const

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

virtual void	Characters (const WideString &chars)

virtual void	StartDocument (ISAXServices *saxServices)

virtual void	EndDocument ()

virtual void	StartPrefixMapping (const WideString &prefix, const WideString &uri)

virtual void	EndPrefixMapping (const WideString &prefix)

virtual void	IgnorableWhitespace (const WideString &chars)

virtual void	ProcessingInstruction (const WideString &target, const WideString &data)

virtual void	SkippedEntity (const WideString &name)

virtual void	ExtComment (const WideString &comment)

virtual void	ExtXMLDecl (const WideString &version, const WideString &encoding, const WideString &standalone, const WideString &actualEncoding)

virtual void	SetDocumentLocator (ISAXLocator *locator)

virtual ISAXLocator *	GetDocumentLocator () const

Public Member Functions inherited from CPMUnknown< ISAXContentHandler >
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 Attributes
ISAXServices *	fSAXServices

Additional Inherited Members
Public Types inherited from ISAXContentHandler
enum	{ kDefaultIID = IID_ISAXCONTENTHANDLER }

Protected Member Functions inherited from CSAXContentHandler
bool16	HasAttribute (ISAXAttributes *attrs, const PMString &key)

bool16	HasAttribute (ISAXAttributes *attrs, const WideString &key)

PMString	GetAttributeString (ISAXAttributes *attrs, const PMString &key, const PMString &defaultValue="")

WideString	GetAttributeString (ISAXAttributes attrs, const WideString &key, const WideString defaultValue=nil)

bool16	GetAttributeBool (ISAXAttributes *attrs, const PMString &key, bool16 defaultValue=kFalse)

bool16	GetAttributeBool (ISAXAttributes *attrs, const WideString &key, bool16 defaultValue=kFalse)

int32	GetAttributeInt (ISAXAttributes *attrs, const PMString &key, int32 defaultValue=0)

int32	GetAttributeInt (ISAXAttributes *attrs, const WideString &key, int32 defaultValue=0)

Detailed Description

This class is the base class used by palette based panels that need to override their xml-based workspace representation. The default implementation provided here handles generating the begin and end tags (including default panel attributes), as well as a default content generator.

In order to change their XML content representation, clients can override GenerateContent. (there are 8 panels in CS3 that generate extra panel content - you can look inside a workspace file to see examples of this). In order to augment the XML attributes used in the panel's begin tag, clients can override PushPanelAttributes. (this is uncommon - the only use within InDesign is by the library panel to distinguish multiple copies of a panel by adding attributes that contain the name and path to the library being displayed).

See Also: IXMLGenerator, CPanelBasedXMLGenerator

Member Function Documentation

virtual void BasePanelSAXHandler::EndElement	(	const WideString &	uri,
		const WideString &	localname,
		const WideString &	qname
	)

virtual

Override to handle the end tag. Default implementation does nothing, which is sufficient, unless the tag is a container for sub elements.

Reimplemented from CSAXContentHandler.

Reimplemented in DCLSizPanelSAXHandler.

virtual bool16 BasePanelSAXHandler::HandlesSubElements ( ) const

virtual

Override to change handling of sub elements within your content data. Default is to handle sub elements.

Reimplemented from CSAXContentHandler.

Reimplemented in DCLSizPanelSAXHandler.

virtual void BasePanelSAXHandler::Register	(	ISAXServices *	saxServices,
		IPMUnknown *	importer
	)

virtual

Override to register the content tags specific to your panel. Default implementation only caches saxServices into fSAXServices.

Reimplemented from CSAXContentHandler.

Reimplemented in DCLSizPanelSAXHandler.

virtual void BasePanelSAXHandler::StartElement	(	const WideString &	uri,
		const WideString &	localname,
		const WideString &	qname,
		ISAXAttributes *	attrs
	)

pure virtual

Override to handle one of the content tags you registered for.

Reimplemented from CSAXContentHandler.

Implemented in DCLSizPanelSAXHandler.

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation