Public Member Functions

app_Plugin Class Reference

a plugin that can be registered More...

#include <structs.app.h>

Inheritance diagram for app_Plugin:
GrtObject app_DocumentPlugin

List of all members.

Public Member Functions

grt::DictRef attributes () const
 Getter for attribute attributes (read-only).
grt::StringRef caption () const
 Getter for attribute caption.
virtual void caption (const grt::StringRef &value)
 Setter for attribute caption.
grt::StringRef description () const
 Getter for attribute description.
virtual void description (const grt::StringRef &value)
 Setter for attribute description.
grt::StringListRef documentStructNames () const
 Getter for attribute documentStructNames (read-only).
grt::StringListRef groups () const
 Getter for attribute groups (read-only).
grt::ListRef
< app_PluginInputDefinition
inputValues () const
 Getter for attribute inputValues (read-only).
grt::StringRef moduleFunctionName () const
 Getter for attribute moduleFunctionName.
virtual void moduleFunctionName (const grt::StringRef &value)
 Setter for attribute moduleFunctionName.
grt::StringRef moduleName () const
 Getter for attribute moduleName.
virtual void moduleName (const grt::StringRef &value)
 Setter for attribute moduleName.
grt::StringRef pluginType () const
 Getter for attribute pluginType.
virtual void pluginType (const grt::StringRef &value)
 Setter for attribute pluginType.
grt::IntegerRef rating () const
 Getter for attribute rating.
virtual void rating (const grt::IntegerRef &value)
 Setter for attribute rating.
grt::IntegerRef showProgress () const
 Getter for attribute showProgress.
virtual void showProgress (const grt::IntegerRef &value)
 Setter for attribute showProgress.

Detailed Description

a plugin that can be registered


Member Function Documentation

grt::DictRef attributes (  )  const

Getter for attribute attributes (read-only).

additional application specific attributes

In Python:
value = obj.attributes
virtual void caption ( const grt::StringRef &  value  )  [virtual]

Setter for attribute caption.

the plugin caption

In Python:
obj.caption = value
grt::StringRef caption (  )  const

Getter for attribute caption.

the plugin caption

In Python:
value = obj.caption
grt::StringRef description (  )  const

Getter for attribute description.

the plugin description

In Python:
value = obj.description
virtual void description ( const grt::StringRef &  value  )  [virtual]

Setter for attribute description.

the plugin description

In Python:
obj.description = value
grt::StringListRef documentStructNames (  )  const

Getter for attribute documentStructNames (read-only).

the types of documents that can be handled by this plugin

In Python:
value = obj.documentStructNames
grt::StringListRef groups (  )  const

Getter for attribute groups (read-only).

list of group names the plugin belongs to

In Python:
value = obj.groups
grt::ListRef<app_PluginInputDefinition> inputValues (  )  const

Getter for attribute inputValues (read-only).

In Python:
value = obj.inputValues
grt::StringRef moduleFunctionName (  )  const

Getter for attribute moduleFunctionName.

the module function that implements the editor (for dll plugins, the dll function name)

In Python:
value = obj.moduleFunctionName
virtual void moduleFunctionName ( const grt::StringRef &  value  )  [virtual]

Setter for attribute moduleFunctionName.

the module function that implements the editor (for dll plugins, the dll function name)

In Python:
obj.moduleFunctionName = value
grt::StringRef moduleName (  )  const

Getter for attribute moduleName.

the module that implements the editor (for dll plugins, it will be the dll name)

In Python:
value = obj.moduleName
virtual void moduleName ( const grt::StringRef &  value  )  [virtual]

Setter for attribute moduleName.

the module that implements the editor (for dll plugins, it will be the dll name)

In Python:
obj.moduleName = value
virtual void pluginType ( const grt::StringRef &  value  )  [virtual]

Setter for attribute pluginType.

one of (normal, gui, standalone). Type of plugin.

In Python:
obj.pluginType = value
grt::StringRef pluginType (  )  const

Getter for attribute pluginType.

one of (normal, gui, standalone). Type of plugin.

In Python:
value = obj.pluginType
grt::IntegerRef rating (  )  const

Getter for attribute rating.

the rating of this plugin. The plugin with the highest rating will be choosen, if some kind of matching is used

In Python:
value = obj.rating
virtual void rating ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute rating.

the rating of this plugin. The plugin with the highest rating will be choosen, if some kind of matching is used

In Python:
obj.rating = value
virtual void showProgress ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute showProgress.

set to 1 to show a progress bar during execution, 2 if the progress is indeterminate

In Python:
obj.showProgress = value
grt::IntegerRef showProgress (  )  const

Getter for attribute showProgress.

set to 1 to show a progress bar during execution, 2 if the progress is indeterminate

In Python:
value = obj.showProgress