| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_embed_InstanceLocker_idl__ |
| #define __com_sun_star_embed_InstanceLocker_idl__ |
| |
| #ifndef __com_sun_star_lang_XComponent_idl__ |
| #include <com/sun/star/lang/XComponent.idl> |
| #endif |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| #ifndef __com_sun_star_embed_XActionsApproval_idl__ |
| #include <com/sun/star/embed/XActionsApproval.idl> |
| #endif |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| #ifndef __com_sun_star_frame_DoubleInitializationException_idl__ |
| #include <com/sun/star/frame/DoubleInitializationException.idl> |
| #endif |
| |
| //============================================================================= |
| module com { module sun { module star { module embed { |
| |
| //----------------------------------------------------------------------------- |
| /** The main task of this service is to prevent closing, terminating and/or |
| etc. of controlled object. |
| |
| <p> |
| After creation the service adds a listener of requested type |
| ( close, terminate and/or etc. ) to the controlled object and let |
| the listener throw related veto exception until the service is disposed. |
| </p> |
| */ |
| published service InstanceLocker : com::sun::star::lang::XComponent |
| { |
| /** is used to initialize the object on it's creation. |
| |
| @param xInstance |
| the controlled object. Must implement the related to the |
| requested actions broadcaster interface. |
| |
| @param nActions |
| specifies the actions that should be done ( prevent closing, |
| prevent termination and/or etc. ). It must not be empty and can |
| currently contain following values or their combination: |
| <type>Actions</type>::PREVENT_CLOSE and |
| <type>Actions</type>::PREVENT_TERMINATION. |
| */ |
| InstanceLockerCtor1( [in] com::sun::star::uno::XInterface xInstance, |
| [in] long nActions ) |
| raises( ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::frame::DoubleInitializationException, |
| ::com::sun::star::uno::Exception ); |
| |
| /** is used to initialize the object on it's creation. |
| |
| @param xInstance |
| the controlled object. Must implement the related to the |
| requested actions broadcaster interface. |
| |
| @param nActions |
| specifies the actions that should be done ( prevent closing, |
| prevent termination and/or etc. ). It must not be empty and can |
| currently contain following values or their combination: |
| <type>Actions</type>::PREVENT_CLOSE and |
| <type>Actions</type>::PREVENT_TERMINATION. |
| |
| @param xApprove |
| The object implementing <type>XActionsApproval</type> interface. |
| If this parameter is an empty reference the object will proceed |
| with the specified in the first parameter action until it is |
| disposed ( just like in the case of the first constructor ). |
| If the instance is provided, it will be asked for approval each |
| time before proceeding with the action ( the action is |
| specified using <type>string</type> and can take following |
| values in this case: "PreventClose", "PreventTermination" ). |
| */ |
| InstanceLockerCtor2( [in] com::sun::star::uno::XInterface xInstance, |
| [in] long aActions, |
| [in] XActionsApproval xApprove ) |
| raises( ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::frame::DoubleInitializationException, |
| ::com::sun::star::uno::Exception ); |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |
| |