offapi/com/sun/star/embed/XActionsApproval.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: XActionsApproval.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_XActionsApproval_idl__
  31 #define __com_sun_star_embed_XActionsApproval_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //============================================================================
  38
  39  module com {  module sun {  module star {  module embed {
  40
  41 //============================================================================
  42 /** allows to request an approval for an action.
  43
  44     <p>
  45     An implementation of this interface is usually provided to another object
  46     to allow this object to request an approval for actions. The list of
  47     possible actions must be documented in documentation of the object.
  48     </p>
  49  */
  50 interface XActionsApproval: com::sun::star::uno::XInterface
  51 {
  52     //------------------------------------------------------------------------
  53     /** requests an approval for the specified action.
  54
  55         @param nAction
  56             a value specifying the action that should be approved. Could take
  57             values from <type>Actions</type> constants set. The explicit set
  58             of the actions should be documented by the object that is going
  59             to use this interface for approval as for example
  60             <type>InstanceLocker</type> does.
  61
  62         @return
  63             returns <TRUE/> in case the specified action is approved.
  64      */
  65     boolean approveAction( [in] long nAction );
  66 };
  67
  68 //============================================================================
  69
  70 }; }; }; };
  71
  72 #endif
  73