xref: /aoo42x/main/offapi/com/sun/star/awt/XPopupMenu.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_XPopupMenu_idl__
28#define __com_sun_star_awt_XPopupMenu_idl__
29
30#ifndef __com_sun_star_awt_XMenu_idl__
31#include <com/sun/star/awt/XMenu.idl>
32#endif
33
34#ifndef __com_sun_star_awt_Rectangle_idl__
35#include <com/sun/star/awt/Rectangle.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module awt {
41
42 published interface XWindowPeer;
43
44//=============================================================================
45
46/** controls a popup menu.
47 */
48published interface XPopupMenu: XMenu
49{
50	//-------------------------------------------------------------------------
51
52	/** inserts a separator at the specified position.
53	 */
54	[oneway] void insertSeparator( [in] short nPos );
55
56	//-------------------------------------------------------------------------
57
58	/** sets the menu default item.
59	 */
60	[oneway] void setDefaultItem( [in] short nItemId );
61
62	//-------------------------------------------------------------------------
63
64	/** returns the menu default item.
65	 */
66	short getDefaultItem();
67
68	//-------------------------------------------------------------------------
69
70	/** sets the state of the item to be checked or unchecked.
71	 */
72	[oneway] void checkItem( [in] short nItemId,
73			 [in] boolean bCheck );
74
75	//-------------------------------------------------------------------------
76
77	/** returns whether the item is checked or unchecked.
78	 */
79	boolean isItemChecked( [in] short nItemId );
80
81	//-------------------------------------------------------------------------
82
83	/** executes the popup menu and returns the selected item
84		or <code>0</code>, if cancelled.
85	 */
86	short execute( [in] XWindowPeer Parent,
87			 [in] Rectangle Area,
88			 [in] short Direction );
89
90};
91
92//=============================================================================
93
94}; }; }; };
95
96#endif
97