Difference between revisions of "CueListView:DispatchAction"

Latest revision as of 06:15, 19 December 2016

DispatchAction( action, optionalParameter )

action is a string.

optionalParameter is a string (only some actions require the optionalParameter).

This function sends a user interface action to the Cue List view. These actions would normally by triggered by clicking on the user interface, i.e. clicking on a toolbar button, or selecting a cue row in the Cue List table.

Example.

CueListView:DispatchAction("Select All")

This would send an action that would be the same as selecting the Select All menu item from the Edit menu.

Action Strings

Select All

Will select all the displayed cue rows in the cue table in the Cue List view.

Deselect All

Will deselect all the displayed cue rows in the cue table in the Cue List view.

Select First Cue Row

Will select the first cue row in the cue table in the Cue List view. It is the same as if you had clicked on the first cue row in the cue table. Note that table will not scroll to show the selection.

Select Last Cue Row

Will select the last cue row in the cue table in the Cue List view. It is the same as if you had clicked on the last cue row in the cue table. Note that table will not scroll to show the selection.

Select Next Cue Row

Will select the next cue row in the cue table in the Cue List view. If no cue row was previously selected, it will select the first cue row. Note that table will not scroll to show the selection.

Select Previous Cue Row

Will select the previous cue row in the cue table in the Cue List view. If no cue row was previously selected, it will not do anything. Note that table will not scroll to show the selection.

Select Cue

optionalParameter (string) = Cue Number. i.e.45.

Will select the cue specified in the parameter in the cue table.

Goto Cue

optionalParameter (string) = Cue Number.

Will select the specified cue and trigger the cue timer to take a cue photograph. This is the mechanism used when triggering cues from MSC or OSC. The Follow Console and Auto Photograph buttons in the toolbar must be enabled, as well as the Auto flag for the cue checked. This can be handy for testing the taking of cue photos when troubleshooting.

CueListView:DispatchAction("Goto Cue", "5")

Take Cue Photo

This action would be the same as clicking on the camera (Take Photo) button. It will behave in the same way, in that it will add the photo to the currently selected cue row. It will fail in the same way as if you clicked on the button if there are insufficient available photos (the maximum is 4 for a cue). :There is no optional parameter.

Remove Displayed Cue Photo

This action will delete the currently displayed cue photo for the selected cue row. There will not be any confirmation dialog (unlike if you had clicked on the '-' button by the photo). It is possible to undo the deletion of a cue photo.

Display Cue Photo

optionalParameter (string) = Photo Number (1-4).

This action will display the specified photo for the currently selected cue row. If the photo number is greater than the number of photos, it will display the last photo.

Display Next Cue Photo

This action will display the next cue photo for the selected cue row if one exists.

Display Previous Cue Photo

This action will display the previous cue photo for the selected cue row if one exists.

Display First Cue Photo

This action will display the first cue photo for the selected cue row if one exists.

Display Last Cue Photo

This action will display the last cue photo for the selected cue row if one exists.

Set Cue Selection Auto Photo To True

Will set the Auto photo checkbox to on for the currently selected cue rows in the cue list.

Set Cue Selection Auto Photo To False

Will set the Auto photo checkbox to off for the currently selected cue rows in the cue list.

Example

Selecting all the cue rows and to set the Auto photo checkbox to on. Ensure that the cue table has the focus (i.e. you have clicked somewhere in the table first).

CueListView:DispatchAction("Select All")

CueListView:DispatchAction("Set Cue Selection Auto Photo To True")

CueListView:DispatchAction("Deselect All")