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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_embed_XActionsApproval_idl__
  20 #define __com_sun_star_embed_XActionsApproval_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25  module com {  module sun {  module star {  module embed {
  26
  27 /** allows to request an approval for an action.
  28
  29     <p>
  30     An implementation of this interface is usually provided to another object
  31     to allow this object to request an approval for actions. The list of
  32     possible actions must be documented in documentation of the object.
  33     </p>
  34  */
  35 published interface XActionsApproval: com::sun::star::uno::XInterface
  36 {
  37     /** requests an approval for the specified action.
  38
  39         @param nAction
  40             a value specifying the action that should be approved. Could take
  41             values from Actions constants set. The explicit set
  42             of the actions should be documented by the object that is going
  43             to use this interface for approval as for example
  44             InstanceLocker does.
  45
  46         @return
  47             returns `TRUE` in case the specified action is approved.
  48      */
  49     boolean approveAction( [in] long nAction );
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */