offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.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: ConfigurationChangeEvent.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
  32 #define __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
  33
  34 #ifndef __com_sun_star_lang_EventObject_idl__
  35 #include <com/sun/star/lang/EventObject.idl>
  36 #endif
  37
  38 module com { module sun { module star { module uno { interface XInterface; }; }; }; };
  39
  40 module com { module sun { module star { module drawing { module framework {
  41
  42 interface XConfiguration;
  43 interface XConfigurationController;
  44 interface XResourceId;
  45
  46 /** Objects of this class are used for notifying changes of the
  47     configuration.
  48
  49     <p>They are broadcasted by the configuration controller
  50     which maintains the configuration.  The set of types of configuration
  51     changes is not fixed and is not maintained or documented in one
  52     place.</p>
  53
  54     <p>The set of used members and the exact meaning of their values is not the
  55     same for all types.  Therefore, the descriptions of the members are just
  56     general guidelines.   See <type>XConfigurationController</type> for a
  57     list of event types used by the basic drawing framework.</p>
  58 */
  59 struct ConfigurationChangeEvent
  60      : ::com::sun::star::lang::EventObject
  61 {
  62     /** The type of configuration change is a free-form string.  This is the
  63         only member that is always set.  The values of the other members
  64         depend on the configuration change type and may or may not be set.
  65     */
  66     string Type;
  67
  68     /** The current configuration, depending on the event type, either
  69         before or after the change.  May be an empty reference.
  70     */
  71     XConfiguration Configuration;
  72
  73     /** The resource id that is part of the configuration change.
  74     */
  75     XResourceId ResourceId;
  76
  77     /** The resource object that corresponds to the ResourceId.  May
  78         be an empty reference.
  79     */
  80     com::sun::star::uno::XInterface ResourceObject;
  81
  82     /** Each listener is called with exactly the <member>UserData</member>
  83         that was given when the listener was registered.
  84     */
  85     any UserData;
  86 };
  87
  88 }; }; }; }; }; // ::com::sun::star::drawing::framework
  89
  90 #endif