offapi/com/sun/star/util/XModeChangeBroadcaster.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
  20 #ifndef __com_sun_star_util_XModeChangeBroadcaster_idl__
  21 #define __com_sun_star_util_XModeChangeBroadcaster_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/NoSupportException.idl>
  25 #include <com/sun/star/util/XModeChangeListener.idl>
  26 #include <com/sun/star/util/XModeChangeApproveListener.idl>
  27
  28
  29 module com {  module sun {  module star {  module util {
  30
  31
  32 /** broadcasts changes in an object's internal mode.
  33
  34     @see XModeSelector
  35     @see XModeChangeListener
  36     @see XModeChangeApproveListener
  37
  38     @since OOo 1.1.2
  39 */
  40 published interface XModeChangeBroadcaster : com::sun::star::uno::XInterface
  41 {
  42     /** adds the given listener to the list of components to be notified when the mode
  43         changes.
  44     */
  45     void addModeChangeListener( [in] XModeChangeListener rxListener );
  46
  47     /** removes the given listener from the list of components to be notified when the mode
  48         changes.
  49     */
  50     void removeModeChangeListener( [in] XModeChangeListener rxListener );
  51
  52     /** adds the given listener to the list of components to be notified when the mode
  53         is about to change.
  54
  55         @throws com::sun::star::lang::NoSupportException
  56             if the component does not allow vetoing mode changes
  57     */
  58     void addModeChangeApproveListener( [in] XModeChangeApproveListener rxListener )
  59         raises( com::sun::star::lang::NoSupportException );
  60
  61     /** remove the given listener from the list of components to be notified when the mode
  62         is about to change.
  63
  64         @throws com::sun::star::lang::NoSupportException
  65             if the component does not allow vetoing mode changes
  66     */
  67     void removeModeChangeApproveListener( [in] XModeChangeApproveListener rxListener )
  68         raises( com::sun::star::lang::NoSupportException );
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */