LibreOffice
LibreOffice 6.4 SDK API Reference
com
sun
star
awt
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
#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
32
published
interface
XMenu
:
com::sun::star::uno::XInterface
33
{
39
void
addMenuListener
( [in]
XMenuListener
xListener );
40
47
void
removeMenuListener
( [in]
XMenuListener
xListener );
48
66
void
insertItem
( [in]
short
nItemId,
67
[in]
string
aText,
68
[in]
short
nItemStyle,
69
[in]
short
nItemPos );
70
79
void
removeItem
( [in]
short
nItemPos,
80
[in]
short
nCount );
81
84
void
clear
();
85
91
short
getItemCount
();
92
101
short
getItemId
( [in]
short
nItemPos );
102
111
short
getItemPos
( [in]
short
nItemId );
112
121
::com::sun::star::awt::MenuItemType
getItemType
( [in]
short
nItemPos );
122
132
void
enableItem
( [in]
short
nItemId,
133
[in]
boolean
bEnable );
134
143
boolean
isItemEnabled
( [in]
short
nItemId );
144
150
void
hideDisabledEntries
( [in]
boolean
bHide );
151
157
void
enableAutoMnemonics
( [in]
boolean
bEnable );
158
167
void
setItemText
( [in]
short
nItemId,
168
[in]
string
aText );
169
178
string
getItemText
( [in]
short
nItemId );
179
188
void
setCommand
( [in]
short
nItemId,
189
[in]
string
aCommand );
190
199
string
getCommand
( [in]
short
nItemId );
200
209
void
setHelpCommand
( [in]
short
nItemId,
210
[in]
string
aCommand );
211
220
string
getHelpCommand
( [in]
short
nItemId );
221
230
void
setHelpText
( [in]
short
nItemId,
231
[in]
string
sHelpText );
232
241
string
getHelpText
( [in]
short
nItemId );
242
251
void
setTipHelpText
( [in]
short
nItemId,
252
[in]
string
sTipHelpText );
253
262
string
getTipHelpText
( [in]
short
nItemId );
263
270
boolean
isPopupMenu
();
271
280
void
setPopupMenu
( [in]
short
nItemId,
281
[in]
XPopupMenu
aPopupMenu );
282
291
XPopupMenu
getPopupMenu
( [in]
short
nItemId );
292
293
};
294
295
}; }; }; };
296
297
#endif
298
299
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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::setCommand
void setCommand([in] short nItemId, [in] string aCommand)
sets the command string for the menu item.
XInterface.idl
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::getCommand
string getCommand([in] short nItemId)
retrieves the command string for the menu item.
com::sun::star::awt::XMenu::clear
void clear()
removes all items from the menu.
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.
MenuItemType.idl
com::sun::star::awt::XMenu
specifies a simple menu.
Definition:
XMenu.idl:33
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::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:34
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::getTipHelpText
string getTipHelpText([in] short nItemId)
retrieves the tip help text for 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::XMenuListener
makes it possible to receive menu events on a window.
Definition:
XMenuListener.idl:30
com::sun::star::awt::XMenu::getPopupMenu
XPopupMenu getPopupMenu([in] short nItemId)
returns the popup menu from the menu item.
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::removeItem
void removeItem([in] short nItemPos, [in] short nCount)
removes one or more items from the menu.
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::setItemText
void setItemText([in] short nItemId, [in] string aText)
sets the text for the menu item.
com::sun::star::awt::XMenu::getItemText
string getItemText([in] short nItemId)
returns the string for the given item id.
com
Definition:
Ambiguous.idl:22
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: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::getItemCount
short getItemCount()
returns the number of items in the menu.
com::sun::star::awt::XMenu::hideDisabledEntries
void hideDisabledEntries([in] boolean bHide)
specifies whether disabled menu entries should be hidden, or not.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition:
XInterface.idl:48
com::sun::star::awt::XMenu::isItemEnabled
boolean isItemEnabled([in] short nItemId)
returns the state of the menu item.
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::setHelpCommand
void setHelpCommand([in] short nItemId, [in] string aCommand)
sets the help command string for 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::getHelpCommand
string getHelpCommand([in] short nItemId)
retrieves the help command string for the menu item.
Generated by
1.8.18