LibreOffice LibreOffice 25.2 SDK API Reference

XPopupMenu.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 XWindowPeer;
23
26published interface XPopupMenu: XMenu
27{
33 void insertSeparator( [in] short nItemPos );
34
40 void setDefaultItem( [in] short nItemId );
41
47 short getDefaultItem();
48
57 void checkItem( [in] short nItemId,
58 [in] boolean bCheck );
59
68 boolean isItemChecked( [in] short nItemId );
69
87 short execute( [in] XWindowPeer Parent,
88 [in] Rectangle Position,
89 [in] short Direction );
90
104 boolean isInExecute();
105
112 void endExecute();
113
128 void setAcceleratorKeyEvent( [in] short nItemId,
129 [in] KeyEvent aKeyEvent );
130
143 KeyEvent getAcceleratorKeyEvent( [in] short nItemId );
144
157 void setItemImage( [in] short nItemId,
158 [in] ::com::sun::star::graphic::XGraphic xGraphic,
159 [in] boolean bScale );
160
169 ::com::sun::star::graphic::XGraphic getItemImage( [in] short nItemId );
170
171};
172
173}; }; }; };
174
175/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XMenu
specifies a simple menu.
Definition: XMenu.idl:28
com::sun::star::awt::XPopupMenu
controls a pop-up menu.
Definition: XPopupMenu.idl:27
com::sun::star::awt::XPopupMenu::endExecute
void endExecute()
ends the execution of the PopupMenu.
com::sun::star::awt::XPopupMenu::setItemImage
void setItemImage([in] short nItemId, [in] ::com::sun::star::graphic::XGraphic xGraphic, [in] boolean bScale)
sets the image for the menu item.
com::sun::star::awt::XPopupMenu::getDefaultItem
short getDefaultItem()
returns the menu default item.
com::sun::star::awt::XPopupMenu::setDefaultItem
void setDefaultItem([in] short nItemId)
sets the menu default item.
com::sun::star::awt::XPopupMenu::checkItem
void checkItem([in] short nItemId, [in] boolean bCheck)
sets the state of the item to be checked or unchecked.
com::sun::star::awt::XPopupMenu::execute
short execute([in] XWindowPeer Parent, [in] Rectangle Position, [in] short Direction)
executes the popup menu and returns the selected item or 0, if cancelled.
com::sun::star::awt::XPopupMenu::setAcceleratorKeyEvent
void setAcceleratorKeyEvent([in] short nItemId, [in] KeyEvent aKeyEvent)
sets the KeyEvent for the menu item.
com::sun::star::awt::XPopupMenu::getItemImage
::com::sun::star::graphic::XGraphic getItemImage([in] short nItemId)
retrieves the image for the menu item.
com::sun::star::awt::XPopupMenu::getAcceleratorKeyEvent
KeyEvent getAcceleratorKeyEvent([in] short nItemId)
retrieves the KeyEvent for the menu item.
com::sun::star::awt::XPopupMenu::isItemChecked
boolean isItemChecked([in] short nItemId)
returns whether the item is checked or unchecked.
com::sun::star::awt::XPopupMenu::insertSeparator
void insertSeparator([in] short nItemPos)
inserts a separator at the specified position.
com::sun::star::awt::XPopupMenu::isInExecute
boolean isInExecute()
queries if the PopupMenu is being.
com::sun::star::awt::XWindowPeer
gives access to the actual window implementation on the device.
Definition: XWindowPeer.idl:30
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:38
com
Definition: Ambiguous.idl:20
com::sun::star::awt::KeyEvent
specifies a key event.
Definition: KeyEvent.idl:30
com::sun::star::awt::Rectangle
specifies a rectangular area by position and size.
Definition: Rectangle.idl:28