Support of InDesigns® multi state objects (panel Interactive:States).
Support of InDesigns® multi state objects (panel Interactive:States). To create a new states object please use itemlist::create_multistate.
static int count_states(ItemRef mso)
Number of states inside the object.
| Name | Type | Default | Description |
| Return | int | Number of states inside the object? 0 : No states object or error |
|
| mso | ItemRef | - | Valid reference to frame or object. |
static int get_states(ItemRef mso, ItemList resultList)
DEPRECATED! Please use the function interactive::get_frames instead.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode |
static int get_active_state(ItemRef mso)
Index iof th active state of a states object.
| Name | Type | Default | Description |
| Return | int | Active state (0-based) -1 : Error |
|
| mso | ItemRef | - | Valid states object. |
static int set_active_state(ItemRef mso, int objIndex)
Index iof th active state of a states object.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode | |
| mso | ItemRef | - | Valid states object. |
| oldpos | int | - | 0-based index of the new active state -1 : last state |
static int add_state(ItemRef mso, ItemRef frameRef)
DEPRECATED! Please use the function interactive::add_frame instead.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode |
static int move_state(
ItemRef mso,
int oldpos,
int newpos)
Move a state of a states object.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode | |
| mso | ItemRef | - | Valid states object. |
| oldpos | int | - | Old position of state (0-based) -1 : Last state |
| newpos | int | - | New position of state (0-based) -1 : Last state |
static int remove_state(
ItemRef mso,
int objIndex = 0,
ItemList outItems = 0)
DEPRECATED! Please use the function interactive::resolve instead.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode |
static char* get_state_name(
ItemRef mso,
int objIndex,
char* outName)
Get a state name.
| Name | Type | Default | Description |
| Return | String or char* | (Depends on parameter outName) Name, same as parameter outName | |
| mso | ItemRef | - | Valid states object. |
| objIndex | int | - | 0-based index of the state -1 : Laste state |
| outName | String or char* | - | Allocated memory for the result |
static int set_state_name(
ItemRef mso,
int objIndex,
char* newName)
Set a state name.
Alphabetic index HTML hierarchy of classes or Java