xref: /AOO41X/main/offapi/com/sun/star/awt/XPopupMenu.idl (revision 54628ca40d27d15cc98fe861da7fff7e60c2f7d6)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XPopupMenu_idl__
24#define __com_sun_star_awt_XPopupMenu_idl__
25
26#ifndef __com_sun_star_awt_XMenu_idl__
27#include <com/sun/star/awt/XMenu.idl>
28#endif
29
30#ifndef __com_sun_star_awt_Rectangle_idl__
31#include <com/sun/star/awt/Rectangle.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module awt {
37
38 published interface XWindowPeer;
39
40//=============================================================================
41
42/** controls a popup menu.
43 */
44published interface XPopupMenu: XMenu
45{
46    //-------------------------------------------------------------------------
47
48    /** inserts a separator at the specified position.
49     */
50    [oneway] void insertSeparator( [in] short nPos );
51
52    //-------------------------------------------------------------------------
53
54    /** sets the menu default item.
55     */
56    [oneway] void setDefaultItem( [in] short nItemId );
57
58    //-------------------------------------------------------------------------
59
60    /** returns the menu default item.
61     */
62    short getDefaultItem();
63
64    //-------------------------------------------------------------------------
65
66    /** sets the state of the item to be checked or unchecked.
67     */
68    [oneway] void checkItem( [in] short nItemId,
69             [in] boolean bCheck );
70
71    //-------------------------------------------------------------------------
72
73    /** returns whether the item is checked or unchecked.
74     */
75    boolean isItemChecked( [in] short nItemId );
76
77    //-------------------------------------------------------------------------
78
79    /** executes the popup menu and returns the selected item
80        or <code>0</code>, if cancelled.
81     */
82    short execute( [in] XWindowPeer Parent,
83             [in] Rectangle Area,
84             [in] short Direction );
85
86};
87
88//=============================================================================
89
90}; }; }; };
91
92#endif
93