offapi/com/sun/star/ucb/CommandInfoChangeEvent.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_ucb_CommandInfoChangeEvent_idl__
  28 #define __com_sun_star_ucb_CommandInfoChangeEvent_idl__
  29
  30 #ifndef __com_sun_star_lang_EventObject_idl__
  31 #include <com/sun/star/lang/EventObject.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module ucb {
  38
  39 //=============================================================================
  40 /** This event gets delivered whenever a <type>XCommandInfo</type> is changed.
  41
  42     <p>A <type>CommandInfoChangeEvent</type> object is sent to
  43     <type>XCommandInfoChangeListener</type>s.
  44 */
  45 published struct CommandInfoChangeEvent: com::sun::star::lang::EventObject
  46 {
  47     //-------------------------------------------------------------------------
  48     /** contains the name of the command.
  49     */
  50     string Name;
  51
  52     //-------------------------------------------------------------------------
  53     /** contains the implementation handle for the command.
  54
  55         <p>May be <code>-1</code> if the implementation has no handle.
  56     */
  57     long   Handle;
  58
  59     //-------------------------------------------------------------------------
  60     /** contains the reason for the event.
  61
  62         <p>The value can be one of the <type>CommandInfoChange</type> constants.
  63     */
  64     long   Reason;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif