tmozIInputPlugin Interface Reference

Input plugin. More...

List of all members.

Public Member Functions
long	process (in tmozIDomain domain, in AString contextName, in tmozIViewObject inputFile, in tmozIInputPluginResult result, in tmozIException tmozException)
	Process one file.
Public Attributes
const long	IPR_ERROR = 0
	Error in plugin.
const long	IPR_OK = 1
	File is ok.
const long	IPR_FORBIDDEN = 2
	File is forbidden.
const long	IPR_CANCEL = 3
	Operation was canceled.
const long	IPR_TRANSFORMED = 4
	File was transformed.
readonly attribute AString	name
	User visible name of plugin.
readonly attribute AString	description
	Descirption of the plugin main function.
readonly attribute AString	configDialogUrl
	URL of dialog for plugin configuration.

---

Detailed Description

Input plugin.

Input plugins are used by Input plugin manager (tmozIInputPluginManager) to check if file can be add or if need some transformation.

---

Member Function Documentation

long process	(	in tmozIDomain	domain,
		in AString	contextName,
		in tmozIViewObject	inputFile,
		in tmozIInputPluginResult	result,
		in tmozIException	tmozException
	)

Process one file.

Function process one item in the plugin.

Parameters:

	domain	Domain where to import files
	contextName	Context
	inputFile	Input object
	result	Object to receive results
	tmozException	Exception object

Returns:

Return one of predefined constants.

• IPR_ERROR error in plugin
• IPR_OK item confirmed
• IPR_FORBIDDEN item is forbidden - cannot be add
• IPR_CANCEL adding was canceled
• IPR_TRANSFORMED item was transformed.

---

Member Data Documentation

readonly attribute AString configDialogUrl

URL of dialog for plugin configuration.

Plugin can return empty URL if there is no configuration.

const long IPR_CANCEL = 3

Operation was canceled.

User pressed cancel button.

const long IPR_FORBIDDEN = 2

File is forbidden.

Forbidden items should not be add

const long IPR_OK = 1

File is ok.

File is ok and can be add.