diff options
Diffstat (limited to 'offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl')
-rw-r--r-- | offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl new file mode 100644 index 000000000000..ebd171cb4f23 --- /dev/null +++ b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl @@ -0,0 +1,77 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_drawing_framework_XConfigurationControllerRequestQueue_idl__ +#define __com_sun_star_drawing_framework_XConfigurationControllerRequestQueue_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +module com { module sun { module star { module drawing { module framework { + +interface XConfigurationChangeRequest; + +/** The request queue of the configuration controller handles requests for + changes to the current configuration. + + <p>This interface allows callers to add requests to the back of the + queue and to determine wheter the queue is empty. Using this interace + should normally not be necessary for anyone else than the + <type>XConfigurationController</type>. It may be removed in the future.</p> +*/ +interface XConfigurationControllerRequestQueue +{ + /** Return whether there are pending requests for configuration changes. + @return + Returns <TRUE/> when there is at least one request object in the + queue that has not yet been processed. It returns <FALSE/> when + the queue is empty. + */ + boolean hasPendingRequests (); + + /** Add a request for a configuration change to the request queue. + <p>This method should not be called from outside the drawing + famework. Other sub conrollers of the drawing framework are typical + callers. They can add change requests that can not be made with the + <member>requestResourceActivation()</member> and + <member>requestResourceDeactivation()</member> methods.</p> + @param xRequest + The configuration change represented by this request object must only + be commited to the configuration when the + <member + scope="com::sun::star::drawing::framework::XConfigurationChangeRequest" + >execute()</member> + method of the xRequest object is called. + */ + void postChangeRequest ( + [in] XConfigurationChangeRequest xRequest); +}; + +}; }; }; }; }; // ::com::sun::star::drawing::framework + +#endif |