offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.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: XConfigurationChangeRequest.idl,v $
  10  * $Revision: 1.4 $
  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_XConfigurationChangeRequest_idl__
  32 #define __com_sun_star_drawing_framework_XConfigurationChangeRequest_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
  38 #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl>
  39 #endif
  40
  41 module com { module sun { module star { module drawing { module framework {
  42
  43 interface XConfiguration;
  44
  45 /** A single explicit request for a configuration change.
  46
  47     <p>The requested change is committed to a configuration only when the
  48     <member>execute()</member> method is called.  Configuration change
  49     requests are executed asynchronously.  This is done to avoid reentrance
  50     problems with objects that are registered as
  51     <type>XConfigurationChangeListener</type> and at the same time make
  52     configuration change requests.  When the requests were executed
  53     synchronously then the listeners would be notified of the changes while
  54     their request call has not yet returned.</p>
  55
  56     <p>This interface is typically used internally by the
  57     <type>XConfigurationController</type></p> @see XConfigurationController
  58 */
  59 interface XConfigurationChangeRequest
  60 {
  61     /** Commit the configuration change request represented by the called
  62         object to the given configuration.
  63         @param xConfiguration
  64             This is the configuration to commit the requested change to.
  65     */
  66     void execute ([in] XConfiguration xConfiguration);
  67 };
  68
  69 }; }; }; }; }; // ::com::sun::star::drawing::framework
  70
  71 #endif