offapi/com/sun/star/awt/XMenuExtended2.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: XMenuExtended2.idl,v $
  10  * $Revision: 1.0 $
  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_XMenuExtended2_idl__
  31 #define __com_sun_star_awt_XMenuExtended2_idl__
  32
  33 #ifndef __com_sun_star_awt_XMenu_idl__
  34 #include <com/sun/star/awt/XMenu.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XMenuExtended_idl__
  38 #include <com/sun/star/awt/XMenuExtended.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_MenuItemType_idl__
  42 #include <com/sun/star/awt/MenuItemType.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  46 #include <com/sun/star/container/NoSuchElementException.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com {  module sun {  module star {  module awt {
  52
  53 /** specifies extended menu functions.
  54  */
  55
  56 interface XMenuExtended2
  57 {
  58     /** specifies some extended menu functions, like setting a command URL and a help command for a menu item.<br>
  59         These functions are available for both menu bar and popup menu.
  60     */
  61     interface com::sun::star::awt::XMenuExtended;
  62
  63     /** specifies basic menu functions.
  64     */
  65     interface com::sun::star::awt::XMenu;
  66
  67
  68     //=========================================================================
  69
  70     /** checks whether an <type>XMenu</type> is an <type>XPopupMenu</type>.
  71
  72         @return
  73                 <TRUE/> if the menu is a <type>PopupMenu</type>, <FALSE/> if it is a <type>MenuBar</type>.
  74     */
  75     boolean isPopupMenu();
  76
  77     //.........................................................................
  78
  79     /** removes all items from the menu.
  80     */
  81     void clear();
  82
  83     //.........................................................................
  84
  85     /** retrieves the type of the menu item.
  86
  87         @param nItemPos
  88             specifies the position of the menu item for which the item type is queried.
  89
  90         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
  91             if there is no menu item in the position specified in <var>nItemPos</var>.
  92
  93         @see MenuItemType
  94     */
  95     ::com::sun::star::awt::MenuItemType getItemType( [in] short nItemPos )
  96         raises ( ::com::sun::star::container::NoSuchElementException );
  97
  98     //.........................................................................
  99
 100     /** specifies whether disabled menu entries should be hidden, or not.
 101
 102         @param bHide
 103             if <TRUE/>, disabled menu entries are hidden.
 104
 105         @see
 106             <member scope="com::sun::star::awt">XMenu::enableItem()</member>
 107     */
 108     void hideDisabledEntries( [in] boolean bHide );
 109
 110
 111 };
 112
 113 }; }; }; };
 114
 115 #endif