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