LibreOffice LibreOffice 25.8 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
20module com { module sun { module star { module awt {
21
22published interface XPopupMenu;
23published interface XMenuListener;
24
27published interface XMenu: com::sun::star::uno::XInterface
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: */
com::sun::star::awt::XMenuListener
makes it possible to receive menu events on a window.
Definition: XMenuListener.idl:25
com::sun::star::awt::XMenu
specifies a simple menu.
Definition: XMenu.idl:28
com::sun::star::awt::XMenu::setPopupMenu
void setPopupMenu([in] short nItemId, [in] XPopupMenu aPopupMenu)
sets the popup menu for a specified menu item.
com::sun::star::awt::XMenu::getPopupMenu
XPopupMenu getPopupMenu([in] short nItemId)
returns the popup menu from the menu item.
com::sun::star::awt::XMenu::removeMenuListener
void removeMenuListener([in] XMenuListener xListener)
removes the specified menu listener so that it no longer receives events from this menu.
com::sun::star::awt::XMenu::getItemCount
short getItemCount()
returns the number of items in the menu.
com::sun::star::awt::XMenu::getItemText
string getItemText([in] short nItemId)
returns the string for the given item id.
com::sun::star::awt::XMenu::addMenuListener
void addMenuListener([in] XMenuListener xListener)
adds the specified menu listener to receive events from this menu.
com::sun::star::awt::XMenu::getItemType
::com::sun::star::awt::MenuItemType getItemType([in] short nItemPos)
retrieves the type of the menu item.
com::sun::star::awt::XMenu::setHelpText
void setHelpText([in] short nItemId, [in] string sHelpText)
sets the help text for the menu item.
com::sun::star::awt::XMenu::isPopupMenu
boolean isPopupMenu()
checks whether an XMenu is an XPopupMenu.
com::sun::star::awt::XMenu::hideDisabledEntries
void hideDisabledEntries([in] boolean bHide)
specifies whether disabled menu entries should be hidden, or not.
com::sun::star::awt::XMenu::getHelpCommand
string getHelpCommand([in] short nItemId)
retrieves the help command string for the menu item.
com::sun::star::awt::XMenu::setHelpCommand
void setHelpCommand([in] short nItemId, [in] string aCommand)
sets the help command string for the menu item.
com::sun::star::awt::XMenu::getItemId
short getItemId([in] short nItemPos)
returns the ID of the item at the specified position.
com::sun::star::awt::XMenu::isItemEnabled
boolean isItemEnabled([in] short nItemId)
returns the state of the menu item.
com::sun::star::awt::XMenu::enableAutoMnemonics
void enableAutoMnemonics([in] boolean bEnable)
specifies whether mnemonics are automatically assigned to menu items, or not.
com::sun::star::awt::XMenu::getTipHelpText
string getTipHelpText([in] short nItemId)
retrieves the tip help text for the menu item.
com::sun::star::awt::XMenu::enableItem
void enableItem([in] short nItemId, [in] boolean bEnable)
enables or disables the menu item.
com::sun::star::awt::XMenu::getCommand
string getCommand([in] short nItemId)
retrieves the command string for the menu item.
com::sun::star::awt::XMenu::setCommand
void setCommand([in] short nItemId, [in] string aCommand)
sets the command string for the menu item.
com::sun::star::awt::XMenu::getItemPos
short getItemPos([in] short nItemId)
returns the position of the item with the specified ID.
com::sun::star::awt::XMenu::clear
void clear()
removes all items from the menu.
com::sun::star::awt::XMenu::setItemText
void setItemText([in] short nItemId, [in] string aText)
sets the text for the menu item.
com::sun::star::awt::XMenu::removeItem
void removeItem([in] short nItemPos, [in] short nCount)
removes one or more items from the menu.
com::sun::star::awt::XMenu::insertItem
void insertItem([in] short nItemId, [in] string aText, [in] short nItemStyle, [in] short nItemPos)
inserts an item into the menu.
com::sun::star::awt::XMenu::setTipHelpText
void setTipHelpText([in] short nItemId, [in] string sTipHelpText)
sets the tip help text for the menu item.
com::sun::star::awt::XMenu::getHelpText
string getHelpText([in] short nItemId)
retrieves the help text for the menu item.
com::sun::star::awt::XPopupMenu
controls a pop-up menu.
Definition: XPopupMenu.idl:27
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::awt::MenuItemType
MenuItemType
specifies the type of a menu item, as returned by com::sun::star::awt::XMenu::getItemType().
Definition: MenuItemType.idl:26
com
Definition: Ambiguous.idl:20