All Frameworks Class Hierarchy This Framework Previous Indexes
VPMDesktopObjects Interface ENOVIUEDesktopCommand
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIUEDesktopCommand
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIUEDesktopCommand
Gives access to attributes of objects in filling panels.
Role : When the user creates or updates an object on the screen, the list
of attributes with their values are displayed. This interface gives access to
this list in order to customize the list and compute some default values. With it,
the user can hide some attributes, compute automatically the value of some depending
on the value of others, make an attribute mandatory, perform some tasks on the
current object...
Method Index
- o
get_Attributes(VPMIListOfAttributes*&,int&)
- Retrieves the whole list of attributes currently manipulated.
- o
get_Environment(CATUnicodeString&)
- Retrieves the environment in which the current object has been created.
- o
get_Parameter(CATString&,CATString&,VPMIQAttribute*&)
- Retrieves the whole attribute structure given the type of the object owning the
attribute and the name of the attribute.
- o
get_Source(CATIVpmFactoryObject*&)
- Retrieves the current object owning the attributes.
- o
set_Message(CATUnicodeString&)
- Sets a message to be displayed on the screen in case of warning or error.
- o
set_Parameter(CATString&,CATString&,VPMIQAttribute&)
- Sets the definition of an attribute after the user-exit has processed it, then
these changes will be later reflected on the screen.
Methods
o get_Attributes
-
Retrieves the whole list of attributes currently manipulated.
- Parameters:
-
- oParameters
- The list of attributes.
- oNbAttrChanged
- This parameter is used only for the Check part of the user-exit. It gives the number of attributes which value have changed, and those attributes are put at the beginning of
the previous list.
o get_Environment
-
Retrieves the environment in which the current object has been created.
- Parameters:
-
- oEnv
- Environment of the object.
- Returns:
- Always S_OK.
o get_Parameter
-
Retrieves the whole attribute structure given the type of the object owning the
attribute and the name of the attribute.
- Parameters:
-
- iObjectName
- Name of the object.
- iParameterName
- Name of the attribute.
- oParameter
- Complete structure of the attribute, for later use.
- Returns:
- S_OK in case of success, S_FALSE if the attribute asked for was not found,
E_FAIL in case of error.
o get_Source
-
Retrieves the current object owning the attributes.
- Parameters:
-
- oObject
- The current object.
- Returns:
- S_OK in case of success, another code in case of error (E_FAIL, E_NOINTERFACE).
o set_Message
-
Sets a message to be displayed on the screen in case of warning or error.
- Parameters:
-
- iMessage
- The message to display.
- Returns:
- Always S_OK.
o set_Parameter
-
Sets the definition of an attribute after the user-exit has processed it, then
these changes will be later reflected on the screen.
If the attribute is not found in the initial list, it is added.
- Parameters:
-
- iObjectName
- Name of the object.
- iParameterName
- Name of the attribute.
- iParameter
- Complete changed structure of the attribute.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIUEDesktopCommand.h
If needed, your Imakefile.mk should include the module: VDO0Commands