/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at
http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
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:
Actions::PREVENT_CLOSE and
Actions::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:
Actions::PREVENT_CLOSE and
Actions::PREVENT_TERMINATION.
@param xApprove
The object implementing XActionsApproval 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 string and can take following
values in this case: "PreventClose", "PreventTermination" ).
*/
InstanceLockerCtor2( [in] com::sun::star::uno::XInterface xInstance,
[in] long nActions,
[in] XActionsApproval xApprove )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::frame::DoubleInitializationException,
::com::sun::star::uno::Exception );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
