offapi/com/sun/star/util/ModeChangeEvent.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_ModeChangeEvent_idl__
  21 #define __com_sun_star_util_ModeChangeEvent_idl__
  22
  23 #include <com/sun/star/lang/EventObject.idl>
  24
  25
  26 module com {  module sun {  module star {  module util {
  27
  28
  29 /** allows to veto changes in an object's internal mode.
  30
  31     @see XModeChangeBroadcaster
  32     @see XModeChangeListener
  33
  34     @since OOo 1.1.2
  35 */
  36 published struct ModeChangeEvent : com::sun::star::lang::EventObject
  37 {
  38     /** denotes the new internal mode of a component
  39
  40         <p>The semantics of the mode string is to be defined by the component
  41         broadcasting this event.</p>
  42     */
  43     string NewMode;
  44 };
  45
  46
  47 }; }; }; };
  48
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */