IXMLMrkSuite Class Reference

#include <IXMLMrkSuite.h>

Inheritance diagram for IXMLMrkSuite:

Public Types
enum	{ kDefaultIID = IID_IXMLMrkSUITE }

Public Member Functions
virtual bool16	CanMakeTable () const =0
virtual ErrorCode	MakeTable (bool16 hasHeaderRow)=0
virtual bool16	CanMakeKeywordSet () const =0
virtual ErrorCode	MakeKeywordSet ()=0
virtual bool16	CanMakeItemizedList () const =0
virtual ErrorCode	MakeItemizedList ()=0
virtual bool16	CanMakeSectionComposite () const =0
virtual ErrorCode	MakeSectionComposite ()=0
virtual bool16	CanMakeMediaObject () const =0
virtual ErrorCode	MakeMediaObject ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

From SDK sample; abstract suite to allow marking up text selection as one of a variety of different XML based sub-trees. For example, the informaltable sub-tree (from DocBook XML)can consist of:

<informaltable>

    <tgroup>

        <tbody>

            <row>

                <entry>

                ...

            </row>

            ....

        </tbody>

    </tgroup>

</informaltable>

To create such a rich sub-tree by hand is relatively difficult and tedious within the user-interface. The use of this plug-in would be when the content is already within InDesign and the objective is to mark up the content automatically and as quickly and accurately as possible, rather than relying on manual cutting and pasting into an empty structured template.

See XMLMrkConstants for more detail on the different elements and for references to the Web based documentation about the XML language that these elements were drawn from.

Member Enumeration Documentation

anonymous enum

kDefaultIID

Member Function Documentation

virtual bool16 IXMLMrkSuite::CanMakeItemizedList ( ) const

pure virtual

Determine if abstract selection supports making an itemizedlist sub-tree with listitem/para dependents.

Returns

bool16 kTrue if the current selection format supports the operation, kFalse otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual bool16 IXMLMrkSuite::CanMakeKeywordSet ( ) const

pure virtual

Determine if abstract selection supports making a keywordset sub-tree with keyword dependents.

Parameters

none

Returns

bool16 kTrue if the current selection format supports the operation, kFalse otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual bool16 IXMLMrkSuite::CanMakeMediaObject ( ) const

pure virtual

Determine if abstract selection supports making a mediaobject sub-tree indicated.

Returns

bool16 kTrue if the current selection format supports the operation, kFalse otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual bool16 IXMLMrkSuite::CanMakeSectionComposite ( ) const

pure virtual

Determine if abstract selection supports making a section sub-tree with title/para dependents.

Returns

bool16 kTrue if the current selection format supports the operation, kFalse otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual bool16 IXMLMrkSuite::CanMakeTable ( ) const

pure virtual

Determine if abstract selection supports making a informaltable sub-tree.

Parameters

none

Returns

kTrue if the abstraction selection supports making an informaltable subtree, kFalse otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual ErrorCode IXMLMrkSuite::MakeItemizedList ( )

pure virtual

If CanMakeItemizedList returned true, then proceed to make the itemizedlist subtree.

Returns

ErrorCode kSuccess if operation completed, kFailure otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual ErrorCode IXMLMrkSuite::MakeKeywordSet ( )

pure virtual

If CanMakeKeywordSet returned true, then proceed to make the keywordset subtree.

Returns

ErrorCode kSuccess if operation completed, kFailure otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual ErrorCode IXMLMrkSuite::MakeMediaObject ( )

pure virtual

If CanMakeMediaObject returned true, then proceed to make the mediaobject subtree.

Returns

ErrorCode kSuccess if operation completed, kFailure otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual ErrorCode IXMLMrkSuite::MakeSectionComposite ( )

pure virtual

If CanMakeSectionComposite returned true, then proceed to make the section subtree.

Returns

ErrorCode kSuccess if operation completed, kFailure otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.

virtual ErrorCode IXMLMrkSuite::MakeTable ( bool16  hasHeaderRow )

pure virtual

If CanMakeTable returned true, then proceed to make the informaltable subtree.

Parameters

hasHeaderRow

kTrue to make an informaltable with a thead row, kFalse otherwise

Returns

ErrorCode kSuccess if operation completed, kFailure otherwise

Implemented in XMLMrkSuiteTextCSB, and XMLMrkSuiteASB.