xref: /AOO41X/main/offapi/com/sun/star/awt/XPopupMenu.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XPopupMenu_idl__
#define __com_sun_star_awt_XPopupMenu_idl__

#ifndef __com_sun_star_awt_XMenu_idl__
#include <com/sun/star/awt/XMenu.idl>
#endif

#ifndef __com_sun_star_awt_Rectangle_idl__
#include <com/sun/star/awt/Rectangle.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module awt {

 published interface XWindowPeer;

//=============================================================================

/** controls a popup menu.
 */
published interface XPopupMenu: XMenu
{
    //-------------------------------------------------------------------------

    /** inserts a separator at the specified position.
     */
    [oneway] void insertSeparator( [in] short nPos );

    //-------------------------------------------------------------------------

    /** sets the menu default item.
     */
    [oneway] void setDefaultItem( [in] short nItemId );

    //-------------------------------------------------------------------------

    /** returns the menu default item.
     */
    short getDefaultItem();

    //-------------------------------------------------------------------------

    /** sets the state of the item to be checked or unchecked.
     */
    [oneway] void checkItem( [in] short nItemId,
             [in] boolean bCheck );

    //-------------------------------------------------------------------------

    /** returns whether the item is checked or unchecked.
     */
    boolean isItemChecked( [in] short nItemId );

    //-------------------------------------------------------------------------

    /** executes the popup menu and returns the selected item
        or <code>0</code>, if cancelled.
     */
    short execute( [in] XWindowPeer Parent,
             [in] Rectangle Area,
             [in] short Direction );

};

//=============================================================================

}; }; }; };

#endif