LibreOffice
LibreOffice 7.4 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 #ifndef __com_sun_star_awt_XPopupMenu_idl__
20 #define __com_sun_star_awt_XPopupMenu_idl__
21 
26 
27 module com { module sun { module star { module awt {
28 
29 published interface XWindowPeer;
30 
33 published interface XPopupMenu: XMenu
34 {
40  void insertSeparator( [in] short nItemPos );
41 
47  void setDefaultItem( [in] short nItemId );
48 
54  short getDefaultItem();
55 
64  void checkItem( [in] short nItemId,
65  [in] boolean bCheck );
66 
75  boolean isItemChecked( [in] short nItemId );
76 
94  short execute( [in] XWindowPeer Parent,
95  [in] Rectangle Position,
96  [in] short Direction );
97 
111  boolean isInExecute();
112 
119  void endExecute();
120 
135  void setAcceleratorKeyEvent( [in] short nItemId,
136  [in] KeyEvent aKeyEvent );
137 
150  KeyEvent getAcceleratorKeyEvent( [in] short nItemId );
151 
164  void setItemImage( [in] short nItemId,
165  [in] ::com::sun::star::graphic::XGraphic xGraphic,
166  [in] boolean bScale );
167 
177 
178 };
179 
180 }; }; }; };
181 
182 #endif
183 
184 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
specifies a simple menu.
Definition: XMenu.idl:33
controls a pop-up menu.
Definition: XPopupMenu.idl:34
void endExecute()
ends the execution of the PopupMenu.
void setItemImage([in] short nItemId, [in] ::com::sun::star::graphic::XGraphic xGraphic, [in] boolean bScale)
sets the image for the menu item.
short getDefaultItem()
returns the menu default item.
void setDefaultItem([in] short nItemId)
sets the menu default item.
void checkItem([in] short nItemId, [in] boolean bCheck)
sets the state of the item to be checked or unchecked.
short execute([in] XWindowPeer Parent, [in] Rectangle Position, [in] short Direction)
executes the popup menu and returns the selected item or 0, if cancelled.
void setAcceleratorKeyEvent([in] short nItemId, [in] KeyEvent aKeyEvent)
sets the KeyEvent for the menu item.
::com::sun::star::graphic::XGraphic getItemImage([in] short nItemId)
retrieves the image for the menu item.
KeyEvent getAcceleratorKeyEvent([in] short nItemId)
retrieves the KeyEvent for the menu item.
boolean isItemChecked([in] short nItemId)
returns whether the item is checked or unchecked.
void insertSeparator([in] short nItemPos)
inserts a separator at the specified position.
boolean isInExecute()
queries if the PopupMenu is being.
gives access to the actual window implementation on the device.
Definition: XWindowPeer.idl:37
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:44
Definition: Ambiguous.idl:22
specifies a key event.
Definition: KeyEvent.idl:34
specifies a rectangular area by position and size.
Definition: Rectangle.idl:30