offapi/com/sun/star/embed/Actions.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Actions.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_embed_Actions_idl__
  31 #define __com_sun_star_embed_Actions_idl__
  32
  33 //============================================================================
  34
  35 module com { module sun { module star { module embed {
  36
  37 //============================================================================
  38 /** This constant set contains possible actions that could be approved by
  39 <type>ActionsApproval</type> implementation.
  40 */
  41 constants Actions
  42 {
  43     //------------------------------------------------------------------------
  44     /** "Prevent Close" - throws veto excetion if target object is going to
  45         close.
  46
  47         <p>
  48         Usually a <type scope="com::sun::star::util">XCloseListener</type>
  49         implementation could use this constant to request approval to throw
  50         veto exception.
  51         </p>
  52      */
  53     const long PREVENT_CLOSE = 1;
  54
  55     //------------------------------------------------------------------------
  56     /** "Prevent Termination" - throws veto excetion if target object is going
  57         to terminate.
  58
  59         <p>
  60         Usually a <type scope="com::sun::star::frame">XTerminateListener</type>
  61         implementation could use this constant to request approval to throw
  62         veto exception.
  63         </p>
  64      */
  65     const long PREVENT_TERMINATION = 2;
  66 };
  67
  68 //============================================================================
  69
  70 }; }; }; };
  71
  72 #endif
  73