LibreOffice
LibreOffice 24.2 SDK API Reference
XMenu.idl
Go to the documentation of this file.
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 
28 {
34  void addMenuListener( [in] XMenuListener xListener );
35 
42  void removeMenuListener( [in] XMenuListener xListener );
43 
61  void insertItem( [in] short nItemId,
62  [in] string aText,
63  [in] short nItemStyle,
64  [in] short nItemPos );
65 
74  void removeItem( [in] short nItemPos,
75  [in] short nCount );
76 
79  void clear();
80 
86  short getItemCount();
87 
96  short getItemId( [in] short nItemPos );
97 
106  short getItemPos( [in] short nItemId );
107 
116  ::com::sun::star::awt::MenuItemType getItemType( [in] short nItemPos );
117 
127  void enableItem( [in] short nItemId,
128  [in] boolean bEnable );
129 
138  boolean isItemEnabled( [in] short nItemId );
139 
145  void hideDisabledEntries( [in] boolean bHide );
146 
152  void enableAutoMnemonics( [in] boolean bEnable );
153 
162  void setItemText( [in] short nItemId,
163  [in] string aText );
164 
173  string getItemText( [in] short nItemId );
174 
183  void setCommand( [in] short nItemId,
184  [in] string aCommand );
185 
194  string getCommand( [in] short nItemId );
195 
204  void setHelpCommand( [in] short nItemId,
205  [in] string aCommand );
206 
215  string getHelpCommand( [in] short nItemId );
216 
225  void setHelpText( [in] short nItemId,
226  [in] string sHelpText );
227 
236  string getHelpText( [in] short nItemId );
237 
246  void setTipHelpText( [in] short nItemId,
247  [in] string sTipHelpText );
248 
257  string getTipHelpText( [in] short nItemId );
258 
265  boolean isPopupMenu();
266 
275  void setPopupMenu( [in] short nItemId,
276  [in] XPopupMenu aPopupMenu );
277 
286  XPopupMenu getPopupMenu( [in] short nItemId );
287 
288 };
289 
290 }; }; }; };
291 
292 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
specifies a simple menu.
Definition: XMenu.idl:27
MenuItemType
specifies the type of a menu item, as returned by com::sun::star::awt::XMenu::getItemType().
Definition: MenuItemType.idl:25
Definition: Ambiguous.idl:20
controls a pop-up menu.
Definition: XPopupMenu.idl:26
makes it possible to receive menu events on a window.
Definition: XMenuListener.idl:24
base interface of all UNO interfaces
Definition: XInterface.idl:45