77a3182c9ead8d9296c589d4ed419d2642ff9146
[scilab.git] / scilab / modules / gui / src / java / org / scilab / modules / gui / menubar / SimpleMenuBar.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2007 - INRIA - Marouane BEN JELLOUL
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10  *
11  */
12
13 package org.scilab.modules.gui.menubar;
14
15 import org.scilab.modules.gui.menu.Menu;
16
17 /**
18  * Interface for SimpleMenuBar the associated object to Scilab GUIs MenuBar
19  * @author Marouane BEN JELLOUL
20  */
21 public interface SimpleMenuBar {
22
23     /**
24      * Add a Menu to a MenuBar
25      * @param newMenu the Menu to add to the MenuBar
26      */
27     void add(Menu newMenu);
28
29     /**
30      * Set the element id for this menubar
31      * @param id the id of the corresponding menubar object
32      */
33     void setElementId(int id);
34
35     /**
36      * Get the element id for this menubar
37      * @return id the id of the corresponding menubar object
38      */
39     int getElementId();
40
41     /**
42      * Enable/Disable a menu giving its name
43      * @param menuName the name of the menu
44      * @param status true to enable the menu
45      */
46     void setMenuEnabled(String menuName, boolean status);
47
48     /**
49      * Disable a MenuItem of a Scilab root window giving its parent name and position
50      * @param parentMenuName the name of the parent menu
51      * @param menuItemPosition the name of the parent menu
52      * @param status true to set the menu enabled
53      */
54     void setSubMenuEnabled(String parentMenuName, int menuItemPosition, boolean status);
55
56     /**
57      * Remove a menu giving its name
58      * @param menuName the name of the menu
59      */
60     void removeMenu(String menuName);
61     
62     /**
63      * Set the visibility of the Toolbar
64      * @param newVisibleState true to set the toolbar visible
65      */
66     void setVisible(boolean newVisibleState);
67 }