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

   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
  22 #include <com/sun/star/awt/XMenu.idl>
  23
  24 #include <com/sun/star/awt/Rectangle.idl>
  25
  26
  27  module com {  module sun {  module star {  module awt {
  28
  29  published interface XWindowPeer;
  30
  31
  32 /** controls a pop-up menu.
  33  */
  34 published interface XPopupMenu: XMenu
  35 {
  36
  37     /** inserts a separator at the specified position.
  38      */
  39     void insertSeparator( [in] short nPos );
  40
  41
  42     /** sets the menu default item.
  43      */
  44     void setDefaultItem( [in] short nItemId );
  45
  46
  47     /** returns the menu default item.
  48      */
  49     short getDefaultItem();
  50
  51
  52     /** sets the state of the item to be checked or unchecked.
  53      */
  54     void checkItem( [in] short nItemId,
  55              [in] boolean bCheck );
  56
  57
  58     /** returns whether the item is checked or unchecked.
  59      */
  60     boolean isItemChecked( [in] short nItemId );
  61
  62
  63     /** executes the pop-up menu and returns the selected item
  64         or <code>0</code>, if canceled.
  65      */
  66     short execute( [in] XWindowPeer Parent,
  67              [in] Rectangle Area,
  68              [in] short Direction );
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */