Add Items to Model Editor Menus - MATLAB & Simulink (original) (raw)

You can add commands and submenus to context menus for the Simulink® Editor and Stateflow® Editor. Menu bar customization will be removed in a future release. To customize the Simulink Toolstrip, use custom tabs. For more information on custom tabs, see Create Custom Simulink Toolstrip Tabs. To convert an existing toolbar menu into a toolstrip tab, use slConvertCustomMenus.

To add an item to a menu:

1. For each item, create a function, called a schema function, that defines the item (see Define Menu Items).
2. Register the menu customizations with the Simulink customization manager at startup, e.g., in ansl_customization.m file on the MATLAB® path (see Register Menu Customizations).
3. Create callback functions that implement the commands triggered by the items that you add to the menus.

Code for Adding Menu Items

The following sl_customization.m file adds four items to the bottom of the context menu that appears when you right-click the Simulink Editor canvas.

function sl_customization(cm)

%% Register custom menu function. cm.addCustomMenuFcn('Simulink:ContextMenu', @getMyMenuItems); end

%% Define the custom menu function. function schemaFcns = getMyMenuItems(callbackInfo) schemaFcns = {@getItem1, ... @getItem2, ... {@getItem3,3}, ... %% Pass 3 as user data to getItem3. @getItem4}; end

%% Define the schema function for first menu item. function schema = getItem1(callbackInfo) schema = sl_action_schema; schema.label = 'Item One'; schema.userdata = 'item one'; schema.callback = @myCallback1; end

function myCallback1(callbackInfo) disp(['Callback for item ' callbackInfo.userdata ' was called']); end

function schema = getItem2(callbackInfo) % Make a submenu label 'Item Two' with
% the menu item above three times.
schema = sl_container_schema; schema.label = 'Item Two';
schema.childrenFcns = {@getItem1, @getItem1, @getItem1}; end

function schema = getItem3(callbackInfo) % Create a menu item whose label is % 'Item Three: 3', with the 3 being passed % from getMyItems above.

schema = sl_action_schema; schema.label = ['Item Three: ' num2str(callbackInfo.userdata)]; end

function myToggleCallback(callbackInfo) if strcmp(get_param(gcs, 'ScreenColor'), 'red') == 0 set_param(gcs, 'ScreenColor', 'red'); else set_param(gcs, 'ScreenColor', 'white'); end end

%% Define the schema function for a toggle menu item. function schema = getItem4(callbackInfo) schema = sl_toggle_schema; schema.label = 'Red Screen'; if strcmp(get_param(gcs, 'ScreenColor'), 'red') == 1 schema.checked = 'checked'; else schema.checked = 'unchecked'; end schema.callback = @myToggleCallback; end

Define Menu Items

You define a menu item by creating a function that returns an object, called a_schema_ object, that specifies the information needed to create the menu item. The menu item that you define may trigger a custom action or display a custom submenu. See the following sections for more information.

• Defining Menu Items That Trigger Custom Commands
• Defining Custom Submenus

Defining Menu Items That Trigger Custom Commands

To define an item that triggers a custom command, your schema function must accept a callback info object (see Callback Info Object) and create and return an action schema object (see Action Schema Object) that specifies the item label and a function, called a callback, to be invoked when the user selects the item. For example, the following schema function defines a menu item that displays a message when selected by the user.

function schema = getItem1(callbackInfo)

%% Create an instance of an action schema. schema = sl_action_schema;

%% Specify the menu item label. schema.label = 'My Item 1'; schema.userdata = 'item1';

%% Specify the menu item callback function. schema.callback = @myCallback1;

end

function myCallback1(callbackInfo) disp(['Callback for item ' callbackInfo.userdata ' was called']); end

Action Schema Object. This object specifies information about menu items that trigger commands that you define, including the label that appears on the menu item and the function to be invoked when the user selects the menu item. Use the functionsl_action_schema to create instances of this object in your schema functions. Its properties include:

Toggle Schema Object. This object specifies information about a menu item that toggles some object on or off. Use the function sl_toggle_schema to create instances of this object in your schema functions. Its properties include:

Defining Custom Submenus

To define a submenu, create a schema function that accepts a callback info object and returns a container schema object (see Container Schema Object) that specifies the schemas that define the items on the submenu. For example, the following schema function defines a submenu that contains three instances of the menu item defined in the example in Defining Menu Items That Trigger Custom Commands.

function schema = getItem2( callbackInfo ) schema = sl_container_schema; schema.label = 'Item Two'; schema.childrenFcns = {@getItem1, @getItem1, @getItem1}; end

Container Schema Object. A container schema object specifies a submenu label and its contents. Use the function sl_container_schema to create instances of this object in your schema functions. Properties of the object include:

Register Menu Customizations

You must register custom items to be included on a Simulink menu with the customization manager. Use thesl_customization.m file for a Simulink installation (see Register Customizations with Simulink) to perform this task. In particular, for each menu that you want to customize, your systemsl_customization function must invoke the customization manageraddCustomMenuFcn method. Each invocation should pass the tag of the menu (see Menu Tags) to be customized and a custom menu function that specifies the items to be added to the menu (see Creating the Custom Menu Function). For example, the following sl_customization function adds custom items to the Simulink Tools menu.

function sl_customization(cm) %% Register custom menu function. cm.addCustomMenuFcn('Simulink:ToolsMenu', @getMyItems);

Creating the Custom Menu Function

The custom menu function returns a cell array of schema functions that define custom items that you want to appear on the model editor menus (see Define Menu Items ). The custom menu function returns a cell array similar to that returned by the generateFcn function.

Your custom menu function should accept a callback info object (see Callback Info Object) and return a cell array that lists the schema functions. Each element of the cell array can be either a handle to a schema function or a two-element cell array whose first element is a handle to a schema function and whose second element is user-defined data to be passed to the schema function. For example, the following custom menu function returns a cell array that lists three schema functions.

function schemas = getMyItems(callbackInfo) schemas = {@getItem1, ... @getItem2, ... {@getItem3,3} }; % Pass 3 as userdata to getItem3. end

Callback Info Object

Instances of these objects are passed to menu customization functions. Methods and properties of these objects include:

Debugging Custom Menu Callbacks

On systems using the Microsoft® Windows® operating system, selecting a custom menu item whose callback contains a breakpoint can cause the mouse to become unresponsive or the menu to remain open and on top of other windows. To fix these problems, use the MATLAB code debugger keyboard commands to continue execution of the callback.

Menu Tags

A menu tag identifies a Simulink Editor menu, a Stateflow Editor menu, or a context menu. You need to know the tag for a menu to add custom items to it (see Register Menu Customizations).

Simulink and Stateflow Editor Menu Customization

Use the same general procedures to customize Stateflow Editor menus as you use for Simulink Editor. The addition of custom menu functions to the ends of top-level menus depends on the active editor:

• Menus bound to Simulink:FileMenu only appear when the Simulink Editor is active.
• Menus bound to Stateflow:FileMenu only appear when the Stateflow Editor is active.
• To have a menu to appear in both of the editors, calladdCustomMenuFcn twice, once for each tag. Check that the code works in both editors.

See Also

Topics

• Disable Simulink Toolstrip and Context Menu Actions
• Disable and Hide Dialog Box Controls
• Customize Library Browser Appearance
• Register Customizations with Simulink