offapi/com/sun/star/awt/XPopupMenu.idl

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