offapi/com/sun/star/awt/XMenuExtended.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMenuExtended.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XMenuExtended_idl__
  31 #define __com_sun_star_awt_XMenuExtended_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module awt {
  40
  41 /** specifies extended menu functions.
  42  */
  43
  44 interface XMenuExtended: com::sun::star::uno::XInterface
  45 {
  46     /** sets the command string for the menu item.
  47
  48         @param nItemId
  49             specifies the menu item ID for which the command should be set.
  50
  51         @param aCommand
  52             specifies the command for the menu item.
  53     */
  54     void setCommand( [in] short nItemId, [in] string aCommand );
  55
  56     /** retrieves the command string for the menu item.
  57
  58         @param nItemId
  59             specifies the menu item ID for which the command URL should be set.
  60     */
  61     string getCommand( [in] short nItemId );
  62
  63     /** sets the help command string for the menu item.
  64
  65         @param nItemId
  66             specifies the menu item ID for which the help command URL be set.
  67
  68         @param aCommand
  69             specifies the help command for the menu item.
  70     */
  71     void setHelpCommand( [in] short nItemId, [in] string aHelp );
  72
  73     /** retrieves the help command string for the menu item.
  74
  75         @param nItemId
  76             specifies the menu item ID for which the help command should be set.
  77     */
  78     string getHelpCommand( [in] short nItemId );
  79 };
  80
  81 }; }; }; };
  82
  83 #endif