offapi/com/sun/star/util/XModeChangeBroadcaster.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: XModeChangeBroadcaster.idl,v $
  10  * $Revision: 1.9 $
  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
  31 #ifndef __com_sun_star_util_XModeChangeBroadcaster_idl__
  32 #define __com_sun_star_util_XModeChangeBroadcaster_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_NoSupportException_idl__
  39 #include <com/sun/star/lang/NoSupportException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_util_XModeChangeListener_idl__
  43 #include <com/sun/star/util/XModeChangeListener.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_util_XModeChangeApproveListener_idl__
  47 #include <com/sun/star/util/XModeChangeApproveListener.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module util {
  53
  54 //=============================================================================
  55
  56 /** broadcasts changes in an object's internal mode.
  57
  58     @see XModeSelector
  59     @see XModeChangeListener
  60     @see XModeChangeApproveListener
  61
  62     @since OOo 1.1.2
  63 */
  64 published interface XModeChangeBroadcaster : com::sun::star::uno::XInterface
  65 {
  66     /** adds the given listener to the list of components to be notified when the mode
  67         changes.
  68     */
  69     void addModeChangeListener( [in] XModeChangeListener _rxListener );
  70
  71     /** removes the given listener from the list of components to be notified when the mode
  72         changes.
  73     */
  74     void removeModeChangeListener( [in] XModeChangeListener _rxListener );
  75
  76     /** adds the given listener to the list of components to be notified when the mode
  77         is about to change.
  78
  79         @throws com::sun::star::lang::NoSupportException
  80             if the component does not allow vetoing mode changes
  81     */
  82     void addModeChangeApproveListener( [in] XModeChangeApproveListener _rxListener )
  83         raises( com::sun::star::lang::NoSupportException );
  84
  85     /** remove the given listener from the list of components to be notified when the mode
  86         is about to change.
  87
  88         @throws com::sun::star::lang::NoSupportException
  89             if the component does not allow vetoing mode changes
  90     */
  91     void removeModeChangeApproveListener( [in] XModeChangeApproveListener _rxListener )
  92         raises( com::sun::star::lang::NoSupportException );
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; };
  98
  99 #endif
 100