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