/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPopupMenuController.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 01:25:08 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_frame_XPopupMenuController_idl__
#define __com_sun_star_frame_XPopupMenuController_idl__

#ifndef __com_sun_star_awt_XPopupMenu_idl__
#include <com/sun/star/awt/XPopupMenu.idl>
#endif

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

module com { module sun { module star { module frame {

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

/** provides data to a popup menu controller implementation to
    fill and update a popup menu dynamically.
    
    <p>
    A popup menu controller gets a <type scope="com::sun::star::awt">XPopupMenu</type> 
    from its parent menu implementation. The controller has to fill this popup 
    menu with a set of menu items and/or sub menus. The parent menu implementation 
    briefs the controller whenever the popup menu gets activated by a user.
    </p>
    
    @since OOo 2.0.0
*/
interface XPopupMenuController : com::sun::star::uno::XInterface
{
    /** provides a <type scope="com::sun::star::awt">XPopupMenu</type> to a
        popup menu controller implementation. The controller must fill this
        popup menu with its functions.

        @param PopupMenu
            An empty popup menu that must be filled by the popup menu controller.
    */
    void setPopupMenu( [in] com::sun::star::awt::XPopupMenu PopupMenu );

    /** briefs the popup menu controller to update the contents of the provided
        popup menu to reflect the current state. 
        
        <p>A controller should <b>never</b> update the popup menu structure on its 
        own to prevent performance problems. A better way would be that a controller 
        registers itself as status listener to for a command URL and immediately 
        deregister after that. Therefor status updates will not be send regularly 
        for a non visible popup menu.
        </p>
    */
    void updatePopupMenu();
};

}; }; }; };

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

#endif
