diff --git a/offapi/com/sun/star/embed/XActionsApproval.idl b/offapi/com/sun/star/embed/XActionsApproval.idl new file mode 100644 index 000000000000..13a7fe5d4355 --- /dev/null +++ b/offapi/com/sun/star/embed/XActionsApproval.idl @@ -0,0 +1,78 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XActionsApproval.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2006-02-09 13:44:47 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 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 + * + ************************************************************************/ +#ifndef __com_sun_star_embed_XActionsApproval_idl__ +#define __com_sun_star_embed_XActionsApproval_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +//============================================================================ + + module com { module sun { module star { module embed { + +//============================================================================ +/** allows to request an approval for an action. + +

+ An implementation of this interface is usually provided to another object + to allow this object to request an approval for actions. The list of + possible actions must be documented in documentation of the object. +

+ */ +interface XActionsApproval: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------ + /** requests an approval for the specified action. + + @param nAction + a value specifying the action that should be approved. Could take + values from Actions constants set. The explicit set + of the actions should be documented by the object that is going + to use this interface for approval as for example + InstanceLocker does. + + @return + returns in case the specified action is approved. + */ + boolean approveAction( [in] long nAction ); +}; + +//============================================================================ + +}; }; }; }; + +#endif +