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

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