diff options
author | Andreas Schlüns <as@openoffice.org> | 2002-04-05 05:54:27 +0000 |
---|---|---|
committer | Andreas Schlüns <as@openoffice.org> | 2002-04-05 05:54:27 +0000 |
commit | 8523c4b91789e8187472b2705509d4c4d20f8904 (patch) | |
tree | 84ec48a49108dda11128887f985be2e748dc7a3f /offapi/com/sun/star/util/XCloseBroadcaster.idl | |
parent | c30f380bb725498f42a83420c6f0b18595485294 (diff) |
#97426# first revision of interfaces for close mechanism
Diffstat (limited to 'offapi/com/sun/star/util/XCloseBroadcaster.idl')
-rw-r--r-- | offapi/com/sun/star/util/XCloseBroadcaster.idl | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XCloseBroadcaster.idl b/offapi/com/sun/star/util/XCloseBroadcaster.idl new file mode 100644 index 000000000000..0bfe6384cab4 --- /dev/null +++ b/offapi/com/sun/star/util/XCloseBroadcaster.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * $RCSfile: XCloseBroadcaster.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: as $ $Date: 2002-04-05 06:54:27 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_util_XCloseBroadcaster_idl__ +#define __com_sun_star_util_XCloseBroadcaster_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_XCloseListener_idl__ +#include <com/sun/star/util/XCloseListener.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module util { + +//============================================================================= +/** broadcasts each tried closing of an object to all interest listener + + <p> + The called object for closing must post the closing events immediately + and before any internal cancel operations will be started. + If a listener disagree with that it should throw a <type>CloseVetoException</type> + and called function <type>XClosable::close()</type> must be breaked immediately. + It's not allowed to catch it inside the close() request. + If no listener nor internal processes hinder the object on closing + all listener get's a notification about real closing. + </p> + + @see + */ +interface XCloseBroadcaster: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** adds the specified listener to receive or have a veto for "close" events + + @param Listener + the listener wich is interest on closing events + */ + [oneway] void addCloseListener( [in] XCloseListener Listener ); + + //------------------------------------------------------------------------- + /** removes the specified listener + + @param Listener + the listener wich isn't interest on closing events anylonger + */ + [oneway] void removeCloseListener( [in] XCloseListener Listener ); +}; + +//============================================================================= + +}; }; }; }; + +#endif |