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