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