Inheritance diagram for XMLMrkSuiteTextCSB:

Public Member Functions
	XMLMrkSuiteTextCSB (IPMUnknown *boss)

virtual	~XMLMrkSuiteTextCSB (void)

virtual bool16	CanMakeTable () const

virtual ErrorCode	MakeTable (bool16 hasHeaderRow)

virtual bool16	CanMakeKeywordSet () const

virtual ErrorCode	MakeKeywordSet ()

virtual bool16	CanMakeItemizedList () const

virtual ErrorCode	MakeItemizedList ()

virtual bool16	CanMakeSectionComposite () const

virtual ErrorCode	MakeSectionComposite ()

virtual bool16	CanMakeMediaObject () const

virtual ErrorCode	MakeMediaObject ()

Public Member Functions inherited from CPMUnknown< IXMLMrkSuite >
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
int32	getMaxNumberCols (const K2Vector< ColumnEnds > &rows)

RangeData	getRowRange (const ColumnEnds &colEnds)

UIDRef	getTag (const WideString &pstr) const

bool16	isTagPresent (const WideString &pstr) const

void	parseText (const UIDRef &textUIDRef, K2Vector< ColumnEnds > &rows, const TextIndex &startOfTableText, const TextIndex &endOfTableText)

ErrorCode	tagTextRange (const UIDRef &textModelRef, const TextIndex &startIndex, const TextIndex &endIndex, const WideString &pstrTag, bool16 addAttribute, const WideString &attrName, const WideString &attrValue)

bool16	isNonEmptyRange () const

bool16	isEmptyRow (const ColumnEnds &colEnds)

Protected Member Functions inherited from CPMUnknown< IXMLMrkSuite >
	CPMUnknown (IPMUnknown *boss)

Additional Inherited Members
Public Types inherited from IXMLMrkSuite
enum	{ kDefaultIID = IID_IXMLMrkSUITE }

Protected Attributes inherited from CPMUnknown< IXMLMrkSuite >
HelperInterface	fHelperInterface

Detailed Description

Class XMLMrkSuiteTextCSB. This is the implementation of IXMLMrkSuite on the text selection boss class.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * XMLMrkSuiteTextCSB::XMLMrkSuiteTextCSB ( IPMUnknown * boss )

Constructor.

Parameters

boss	boss object on which this interface is aggregated.

XMLMrkSuiteTextCSB::~XMLMrkSuiteTextCSB ( void )

virtual

Destructor.

Member Function Documentation

bool16 XMLMrkSuiteTextCSB::CanMakeItemizedList ( ) const

virtual

See IXMLMrkSuite::CanMakeItemizedList

Parameters

none

Returns: bool16

Implements IXMLMrkSuite.

bool16 XMLMrkSuiteTextCSB::CanMakeKeywordSet ( ) const

virtual

See IXMLMrkSuite::CanMakeKeywordSet

Parameters

none

Returns: bool16

Implements IXMLMrkSuite.

bool16 XMLMrkSuiteTextCSB::CanMakeMediaObject ( ) const

virtual

See IXMLMrkSuite::CanMakeMediaObject

Parameters

none

Returns: bool16

Implements IXMLMrkSuite.

bool16 XMLMrkSuiteTextCSB::CanMakeSectionComposite ( ) const

virtual

See IXMLMrkSuite::CanMakeSectionComposite

Parameters

none

Returns: bool16

Implements IXMLMrkSuite.

bool16 XMLMrkSuiteTextCSB::CanMakeTable ( ) const

virtual

See IXMLMrkSuite::CanMakeTable

Parameters

none

Returns: bool16

Implements IXMLMrkSuite.

int32 XMLMrkSuiteTextCSB::getMaxNumberCols ( const K2Vector< ColumnEnds > & rows )

protected

Determine many columns are present given the ColumnEnds.

Parameters

rows	represents the rows (in terms of the sets of TextPair's for each column)

Returns: int32 giving the maximum number of columns across the rows

RangeData XMLMrkSuiteTextCSB::getRowRange ( const ColumnEnds & colEnds )

protected

Determine the text span associated with a given row, represented by its ColumnEnds. Determine the text-span for a given row in the table being created.

Parameters

colEnds represents the row in terms of the text spans of each column

Returns: RangeData

UIDRef XMLMrkSuiteTextCSB::getTag ( const WideString & pstr ) const

protected

Get a persistent ref to the tag given its name, from which we can get an IXMLTagData

Parameters

pstr

Returns: UIDRef persistent reference to the tag

bool16 XMLMrkSuiteTextCSB::isEmptyRow ( const ColumnEnds & colEnds )

protected

Determine if the given row contains any text we could select and markup.

Parameters

colEnds [IN]

Returns: bool16 kTrue if empty, kFalse otherwise

bool16 XMLMrkSuiteTextCSB::isNonEmptyRange ( ) const

protected

Does the selection cover any text?

Returns: kTrue if the selection covers some text, kFalse otherwise

bool16 XMLMrkSuiteTextCSB::isTagPresent ( const WideString & pstr ) const

protected

Determine if a particular tag is present within the active document.

Parameters

pstr

Returns: kTrue if the tag is present in active document, kFalse otherwise

ErrorCode XMLMrkSuiteTextCSB::MakeItemizedList ( )

virtual

See IXMLMrkSuite::MakeItemizedList

Parameters

none

Returns: ErrorCode

Implements IXMLMrkSuite.

ErrorCode XMLMrkSuiteTextCSB::MakeKeywordSet ( )

virtual

See IXMLMrkSuite::MakeKeywordSet

Parameters

none

Returns: ErrorCode

Implements IXMLMrkSuite.

ErrorCode XMLMrkSuiteTextCSB::MakeMediaObject ( )

virtual

See IXMLMrkSuite::MakeMediaObject

Parameters

none

Returns: ErrorCode

Implements IXMLMrkSuite.

ErrorCode XMLMrkSuiteTextCSB::MakeSectionComposite ( )

virtual

See IXMLMrkSuite::MakeSectionComposite

Parameters

none

Returns: ErrorCode

Implements IXMLMrkSuite.

ErrorCode XMLMrkSuiteTextCSB::MakeTable ( bool16 hasHeaderRow )

virtual

IXMLMrkSuite::MakeTable

Parameters

hasHeaderRow

Returns: ErrorCode

Implements IXMLMrkSuite.

void XMLMrkSuiteTextCSB::parseText	(	const UIDRef &	textUIDRef,
		K2Vector< ColumnEnds > &	rows,
		const TextIndex &	startOfTableText,
		const TextIndex &	endOfTableText
	)

protected

Parse the text selection and find the text spans for each column in each row. Delimiters are 'tab' for columns, and CR for rows. For creating an XML-based table, we care about both columns and rows. For the other types of entities (e.g. keywordset), the columns are ignored, and we use only the row information.

Parameters

textUIDRef	text model of interest
rows	[OUT] holds the result of parsing the text
startOfTableText	starting index to begin the parse
endOfTableText	end index for the parse

ErrorCode XMLMrkSuiteTextCSB::tagTextRange	(	const UIDRef &	textModelRef,
		const TextIndex &	startIndex,
		const TextIndex &	endIndex,
		const WideString &	pstrTag,
		bool16	addAttribute,
		const WideString &	attrName,
		const WideString &	attrValue
	)

protected

Create element marking-up specified range, with option to add (single) attribute to the element created. Delegates to IXMLElementCommands::CreateElement to do the complex part.

Parameters

textModelRef	text model of interest
startIndex	specifies where to start tagging from
endIndex	specifies where to end tagging
pstrTag	name for the tag
addAttribute	whether to add an attribute
attrName	name of the attribute, if addAttribute is kFalse, this is ignored
attrValue	attribute value, if addAttribute is kFalse, this is ignored

Returns: kSucess if the operation succeeded, kFailure otherwise

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation