HIOUtilityHTML Class Reference

#include <HIOUtilityHTML.h>

Inheritance diagram for HIOUtilityHTML:

List of all members.

Public Member Functions
HFileOutputResult	FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult	FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult	FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
const char *	GetOutputName ()
HOutputHandlerStyle	GetOutputStyle ()
const char *	GetOutputTypesString ()
	HIOUtilityHTML ()
void	RegisterOutputHandlerTypes ()

---

Detailed Description

The HIOUtilityHTML is used for exporting a HTML page which contains a control which references a HSF file of the same name. The handler creates both the HTML page and the HSF.

Note, the HTML page can only be viewed with Microsoft Internet Explorer.

---

Constructor & Destructor Documentation

HIOUtilityHTML::HIOUtilityHTML

(

)

[inline]

Constructs an HIOUtilityHTML object.

References HOutputOpFileOutputByKey, and HOutputHandler::SetOutputOps().

---

Member Function Documentation

HFileOutputResult HIOUtilityHTML::FileOutputByKey	(	const char *	filename,
		HC_KEY	key,
		HOutputHandlerOptions *	options
	)			[inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:

	filename	The name of the file to output.
	key	The HOOPS segment key to output model data from.
	options	The options class containing any needed extra information for the operation.

Returns:

The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityHTML::FileOutputByKey	(	const unsigned short *	filename,
		HC_KEY	key,
		HOutputHandlerOptions *	options
	)			[inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:

	filename	The wide character name of the file to output.
	key	The HOOPS segment key to get output model data from.
	options	The options class containing any needed extra information for the operation.

Returns:

The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityHTML::FileOutputByKey	(	const __wchar_t *	filename,
		HC_KEY	key,
		HOutputHandlerOptions *	options
	)			[virtual]

This method creates an HTML page designed to work with a separatly created but identically named .hsf file. The HTML file embeds a HOOPS ActiveX control which loads the HSF into the HTML page.

Parameters:

	FileName	A character pointer denoting the name of the file to be written should usually include ".html".
	key	This parameter is current not used.
	options	Pass options with specified width and height to determine the page dimensions.

Returns:

The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

const char* HIOUtilityHTML::GetOutputName

(

)

[inline, virtual]

Returns:

A character pointer denoting the name of the handler.

Implements HOutputHandler.

HOutputHandlerStyle HIOUtilityHTML::GetOutputStyle

(

)

[inline, virtual]

Returns:

The type of output style which is HOutputHandlerStyleHTML.

Implements HOutputHandler.

References HOutputHandlerStyleHTML.

const char* HIOUtilityHTML::GetOutputTypesString

(

)

[inline, virtual]

Returns:

The string of the type of output this handler creates which are "html" and "htm".

Implements HOutputHandler.

void HIOUtilityHTML::RegisterOutputHandlerTypes

(

)

[inline, virtual]

This method registers the "html" and "htm" extensions to this handler as an output handler.

Implements HOutputHandler.

References HIORegisterOutputType.

---

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

• HIOUtilityHTML.h