PluginItem Class
Reference
This reference page is linked to from the following overview topics: Specifying a Help File for a Plug-in.
#include <xsi_pluginitem.h>
The PluginItem class contains the information on each item of a plug-in.
A plug-in item is basically an XSI customizable component such as:
Public Member Functions |
|
| PluginItem () | |
| ~PluginItem () | |
| PluginItem (const CRef &in_ref) | |
| PluginItem (const PluginItem &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| PluginItem & | operator= (const PluginItem &in_obj) |
| PluginItem & | operator= (const CRef &in_ref) |
| CStatus | PutHelp (const CString &in_strHelp) |
| CStatus | PutCategories (const CString &in_strCat) |
| PluginItem | ( | ) |
Default constructor.
| ~PluginItem | ( | ) |
Default destructor.
| PluginItem | ( | const CRef & | in_ref | ) |
Constructor.
| in_ref | constant reference object. |
| PluginItem | ( | const PluginItem & | in_obj | ) |
Copy constructor.
| in_obj | constant class object. |
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from SIObject.
| siClassID GetClassID | ( | ) | const [virtual] |
| PluginItem& operator= | ( | const PluginItem & | in_obj | ) |
Creates an object from another object. The new object is set to empty if the input object is not compatible.
| in_obj | constant class object. |
| PluginItem& operator= | ( | const CRef & | in_ref | ) |
Creates an object from a reference object. The new object is set to empty if the input reference object is not compatible.
| in_ref | constant class object. |
Reimplemented from SIObject.
Sets the help path for this plug-in item
| in_strHelp | The help path |
Sets the categories for this plug-in item
| in_strCat | A comma-separated string representing the categories of this plug-in item. |