offapi/com/sun/star/form/XApproveActionBroadcaster.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_form_XApproveActionBroadcaster_idl__
  28 #define __com_sun_star_form_XApproveActionBroadcaster_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_form_XApproveActionListener_idl__
  35 #include <com/sun/star/form/XApproveActionListener.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module form {
  42
  43 //=============================================================================
  44
  45 /** allows to probably veto actions to be performed on components.
  46
  47     <p> Usually, a component which supports the
  48     <type>XApproveActionBroadcaster</type> interface implements
  49     <type scope="com::sun::star::awt">XActionListener</type> as well.</p>
  50  */
  51 published interface XApproveActionBroadcaster: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** adds the specified listener to receive the <member>XApproveActionListener::approveAction</member>
  56         event.
  57
  58         @param aListener
  59              the listener to be added
  60      */
  61     [oneway] void addApproveActionListener( [in] com::sun::star::form::XApproveActionListener aListener );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** removes the specified listener
  66
  67         @param aListener
  68              the listener to be removed
  69      */
  70     [oneway] void removeApproveActionListener( [in] com::sun::star::form::XApproveActionListener aListener );
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 /*=============================================================================
  79
  80 =============================================================================*/
  81 #endif