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