ImgDlog_SelectEffect¶
Display a dialog where the user can select an image effect and
associated parameters.
ImgDlog_SelectEffect(effectNamePtr; effectParamsPtr{; docRef{; frameIdx{; dialogOptions}}}) ➔ success
| effectNamePtr | Pointer | Pointer to the effect name. |
| effectParamsPtr | Pointer | Pointer to the effect parameters. |
| docRef | Text | The image document to use as preview. |
| frameIdx | Longint | The index of the image frame to use as preview. |
| dialogOptions | Object | Options. |
| success | Longint | Completion status: 1 on success, 0 otherwise. |
Display a dialog where the user can select an image effect and associated parameters.
Parameters effectNamePtr and effectParamsPtr are pointers to text and object
respectively. On entry, they specify the effect name and parameters to be initially
selected in the dialog. If the user accepts the dialog, they receive the selected
name effect and parameters.
Parameters docRef and frameIdx are optional and can be used to specify
the image to be displayed in the preview area of the dialog.
The dialogOptions object parameter is also optional and can be used to customize
titles titles of the window and OK button:
| Property name | Default | Description |
|---|---|---|
| “WindowTitle” | “Select effect” | The window title. |
| “OKButtonTitle” | “OK” | The OK button title. |
The method returns 1 if the user accepts the dialog, 0 otherwise.
