offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.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: XConfigurationControllerRequestQueue.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_XConfigurationControllerRequestQueue_idl__
  32 #define __com_sun_star_drawing_framework_XConfigurationControllerRequestQueue_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module drawing { module framework {
  39
  40 interface XConfigurationChangeRequest;
  41
  42 /** The request queue of the configuration controller handles requests for
  43     changes to the current configuration.
  44
  45     <p>This interface allows callers to add requests to the back of the
  46     queue and to determine wheter the queue is empty.  Using this interace
  47     should normally not be necessary for anyone else than the
  48     <type>XConfigurationController</type>.  It may be removed in the future.</p>
  49 */
  50 interface XConfigurationControllerRequestQueue
  51 {
  52     /** Return whether there are pending requests for configuration changes.
  53         @return
  54             Returns <TRUE/> when there is at least one request object in the
  55             queue that has not yet been processed.  It returns <FALSE/> when
  56             the queue is empty.
  57     */
  58     boolean hasPendingRequests ();
  59
  60     /** Add a request for a configuration change to the request queue.
  61         <p>This method should not be called from outside the drawing
  62         famework.  Other sub conrollers of the drawing framework are typical
  63         callers.  They can add change requests that can not be made with the
  64         <member>requestResourceActivation()</member> and
  65         <member>requestResourceDeactivation()</member> methods.</p>
  66         @param xRequest
  67             The configuration change represented by this request object must only
  68             be commited to the configuration when the
  69             <member
  70             scope="com::sun::star::drawing::framework::XConfigurationChangeRequest"
  71             >execute()</member>
  72             method of the xRequest object is called.
  73     */
  74     void postChangeRequest (
  75         [in] XConfigurationChangeRequest xRequest);
  76 };
  77
  78 }; }; }; }; }; // ::com::sun::star::drawing::framework
  79
  80 #endif