Menu Operations

< Previous | Contents | Manuals Home | Boris FX | Next >

These operations let Python "click" various menu operations, as specified by name. The name is given by the bare name, ie "Add Shot", not "Shot/Add Shot". The item name must be, and usually is, unique. It will be searched for recursively if it is within a submenu. The Main versions look in the overall main application menu. The Top versions look in the specified top-level menu, ie "File", "Track", etc. The AndWait versions don't return until the operation completes, ie they wait out any required user interaction on any dialogs that pop up. The AndContinue versions return immediately, so any dialog that appears can be driven by remote control from python.

Before operating on menus, you should call InitMenu() to make sure that dynamically- constructed menu items are built. The underlying routine is called within SynthEyes when the user clicks on a menu directly, so you might not encounter a problem by omitting InitMenu until you try to run your script before the user has done anything.

Note: right-click menus are not currently accessible, except via Actions.

ClickMainMenuAndWait(itemnm) the bare name "Add Shot" ClickMainMenuAndContinue(itemnm) the bare name "Add Shot" ClickTopMenuAndWait(topnm, itemnm) ie "Shot", "Add Shot" ClickTopMenuAndContinue(topnm, itemnm) ie "Shot", "Add Shot"

InitMenu() Updates the main menu based on the apps current status

MainMenu() Returns the main menu's SyMenu object

TopMenu(topnm) Returns the SyMenu object for the top-menu with the given

name.

< Previous | | Manuals Home | Boris FX | Next >