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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XMenu_idl__
  20 #define __com_sun_star_awt_XMenu_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/awt/MenuItemType.idl>
  24
  25 module com {  module sun {  module star {  module awt {
  26
  27 published interface XPopupMenu;
  28 published interface XMenuListener;
  29
  30 /** specifies a simple menu.
  31  */
  32 published interface XMenu: com::sun::star::uno::XInterface
  33 {
  34     /** adds the specified menu listener to receive events from this menu.
  35
  36         @param xListener
  37             the XMenuListener to be added.
  38      */
  39     void addMenuListener( [in] XMenuListener xListener );
  40
  41     /** removes the specified menu listener so that it no longer
  42         receives events from this menu.
  43
  44         @param xListener
  45             the XMenuListener to be removed.
  46      */
  47     void removeMenuListener( [in] XMenuListener xListener );
  48
  49     /** inserts an item into the menu.
  50         <p>The item is appended if the position is greater than or equal to
  51         getItemCount() or if it is negative.</p>
  52
  53         @param nItemId
  54             specifies the ID of the menu item to be inserted.
  55
  56         @param aText
  57             specifies the label of the menu item.
  58
  59         @param nItemStyle
  60             specifies the style of the menu item, as defined in
  61             MenuItemStyle.
  62
  63         @param nItemPos
  64             specifies the position where the menu item will be inserted.
  65      */
  66     void insertItem( [in] short nItemId,
  67                      [in] string aText,
  68                      [in] short nItemStyle,
  69                      [in] short nItemPos );
  70
  71     /** removes one or more items from the menu.
  72
  73         @param nItemPos
  74             specifies the position of the (first) menu item to be removed.
  75
  76         @param nCount
  77             specifies the number of menu items to remove.
  78      */
  79     void removeItem( [in] short nItemPos,
  80                      [in] short nCount );
  81
  82     /** removes all items from the menu.
  83      */
  84     void clear();
  85
  86     /** returns the number of items in the menu.
  87
  88         @return
  89             the number of items in this XMenu.
  90      */
  91     short getItemCount();
  92
  93     /** returns the ID of the item at the specified position.
  94
  95         @param nItemPos
  96             specifies the position of the menu item for which the item ID is queried.
  97
  98         @return
  99             the ID of the menu item at the given position.
 100      */
 101     short getItemId( [in] short nItemPos );
 102
 103     /** returns the position of the item with the specified ID.
 104
 105         @param nItemId
 106             specifies the ID of the menu item for which the item position is queried.
 107
 108         @return
 109             the position of the menu item with the specified ID.
 110      */
 111     short getItemPos( [in] short nItemId );
 112
 113     /** retrieves the type of the menu item.
 114
 115         @param nItemPos
 116             specifies the position of the menu item for which the item type is queried.
 117
 118         @return
 119             a MenuItemType indicating the item type.
 120     */
 121     ::com::sun::star::awt::MenuItemType getItemType( [in] short nItemPos );
 122
 123     /** enables or disables the menu item.
 124
 125         @param nItemId
 126             specifies the menu item ID.
 127
 128         @param bEnable
 129             specifies whether the menu item should be enabled (`TRUE`) or
 130             disabled (`FALSE`).
 131      */
 132     void enableItem( [in] short nItemId,
 133                      [in] boolean bEnable );
 134
 135     /** returns the state of the menu item.
 136
 137         @param nItemId
 138             specifies the menu item ID.
 139
 140         @return
 141             `TRUE` if the item is enabled, `FALSE` otherwise.
 142      */
 143     boolean isItemEnabled( [in] short nItemId );
 144
 145     /** specifies whether disabled menu entries should be hidden, or not.
 146
 147         @param bHide
 148             if `TRUE`, disabled menu entries are hidden.
 149     */
 150     void hideDisabledEntries( [in] boolean bHide );
 151
 152     /** specifies whether mnemonics are automatically assigned to menu items, or not.
 153
 154         @param bEnable
 155             if `TRUE`, mnemonics are automatically assigned to menu items.
 156     */
 157     void enableAutoMnemonics( [in] boolean bEnable );
 158
 159     /** sets the text for the menu item.
 160
 161         @param nItemId
 162             specifies the ID of the menu item.
 163
 164         @param aText
 165             specifies the label of the menu item.
 166      */
 167     void setItemText( [in] short nItemId,
 168                       [in] string aText );
 169
 170     /** returns the string for the given item id.
 171
 172         @param nItemId
 173             specifies the ID of the menu item.
 174
 175         @return
 176             the label of the menu item.
 177      */
 178     string getItemText( [in] short nItemId );
 179
 180     /** sets the command string for the menu item.
 181
 182         @param nItemId
 183             specifies the menu item ID for which the command should be set.
 184
 185         @param aCommand
 186             specifies the command for the menu item.
 187     */
 188     void setCommand( [in] short nItemId,
 189                      [in] string aCommand );
 190
 191     /** retrieves the command string for the menu item.
 192
 193         @param nItemId
 194             specifies the menu item ID for which the command URL should be set.
 195
 196         @return
 197             the command of the menu item.
 198     */
 199     string getCommand( [in] short nItemId );
 200
 201     /** sets the help command string for the menu item.
 202
 203         @param nItemId
 204             specifies the menu item ID for which the help command URL be set.
 205
 206         @param aCommand
 207             specifies the help command for the menu item.
 208     */
 209     void setHelpCommand( [in] short nItemId,
 210                          [in] string aCommand );
 211
 212     /** retrieves the help command string for the menu item.
 213
 214         @param nItemId
 215             specifies the menu item ID for which the help command should be set.
 216
 217         @return
 218             the help command of the menu item.
 219     */
 220     string getHelpCommand( [in] short nItemId );
 221
 222     /** sets the help text for the menu item.
 223
 224         @param nItemId
 225             specifies the menu item identifier for which the help text should be set.
 226
 227         @param sHelpText
 228             specifies the help text for the menu item.
 229     */
 230     void setHelpText( [in] short nItemId,
 231                       [in] string sHelpText );
 232
 233     /** retrieves the help text for the menu item.
 234
 235         @param nItemId
 236             specifies the menu item identifier for which the help text should be retrieved.
 237
 238         @return
 239             a string with the help text.
 240     */
 241     string getHelpText( [in] short nItemId );
 242
 243     /** sets the tip help text for the menu item.
 244
 245         @param nItemId
 246             specifies the menu item identifier for which the tip help text should be set.
 247
 248         @param sTipHelpText
 249             specifies the tip help text for the menu item.
 250     */
 251     void setTipHelpText( [in] short nItemId,
 252                          [in] string sTipHelpText );
 253
 254     /** retrieves the tip help text for the menu item.
 255
 256         @param nItemId
 257             specifies the menu item identifier for which the tip help text should be retrieved.
 258
 259         @return
 260             a string with the tip help text.
 261     */
 262     string getTipHelpText( [in] short nItemId );
 263
 264     /** checks whether an XMenu is an XPopupMenu.
 265
 266         @return
 267                 `TRUE` if the menu is a PopupMenu,
 268                 `FALSE` if it is a MenuBar.
 269     */
 270     boolean isPopupMenu();
 271
 272     /** sets the popup menu for a specified menu item.
 273
 274         @param nItemId
 275             specifies the menu item ID for which the XPopupMenu should be set.
 276
 277         @param aPopupMenu
 278             specifies a XPopupMenu.
 279      */
 280     void setPopupMenu( [in] short nItemId,
 281                        [in] XPopupMenu aPopupMenu );
 282
 283     /** returns the popup menu from the menu item.
 284
 285         @param nItemId
 286             specifies the menu item ID for which the XPopupMenu should be retrieved.
 287
 288         @return
 289             a XPopupMenu.
 290      */
 291     XPopupMenu getPopupMenu( [in] short nItemId );
 292
 293 };
 294
 295 }; }; }; };
 296
 297 #endif
 298
 299 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */