offapi/com/sun/star/document/MacroExecMode.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: MacroExecMode.idl,v $
  10  * $Revision: 1.10 $
  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
  31 #ifndef __com_sun_star_document_MacroExecMode_idl__
  32 #define __com_sun_star_document_MacroExecMode_idl__
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module document {
  37
  38 //=============================================================================
  39 /** Specify whether a macro can be executed.
  40
  41     @since OOo 1.1.2
  42 */
  43 published constants MacroExecMode
  44 {
  45     //-------------------------------------------------------------------------
  46     /** A macro should not be executed at all.
  47     */
  48
  49     const short NEVER_EXECUTE = 0;
  50
  51     //-------------------------------------------------------------------------
  52     /** Execute macros from secure list quietly.
  53
  54         <p>
  55         If a macro is not in the list a conformation for it executing will
  56         appear.
  57         </p>
  58     */
  59
  60     const short FROM_LIST = 1;
  61
  62     //-------------------------------------------------------------------------
  63     /** Execute any macro, macros signed with trusted sertificates and macros
  64         from secure list are executed quietly.
  65
  66         <p>
  67             If the macro is neither in secure list nor signed a conformation
  68             will be requested.
  69         </p>
  70     */
  71
  72     const short ALWAYS_EXECUTE = 2;
  73
  74     //-------------------------------------------------------------------------
  75     /** Use configuration to retrieve macro settings. In case a user
  76         confirmation is required a dialog is output.
  77     */
  78
  79     const short USE_CONFIG = 3;
  80
  81
  82     //-------------------------------------------------------------------------
  83     /** A macro should be executed always no conformation should be provided.
  84     */
  85
  86     const short ALWAYS_EXECUTE_NO_WARN = 4;
  87
  88     //-------------------------------------------------------------------------
  89     /** Use configuration to retrieve macro settings. Treat cases when user
  90         confirmation required as rejected.
  91     */
  92
  93     const short USE_CONFIG_REJECT_CONFIRMATION = 5;
  94
  95     //-------------------------------------------------------------------------
  96     /** Use configuration to retrieve macro settings. Treat cases when user
  97         confirmation required as approved.
  98     */
  99
 100     const short USE_CONFIG_APPROVE_CONFIRMATION = 6;
 101
 102     //-------------------------------------------------------------------------
 103     /** Execute only macros from secure list. Macros that are not from the list
 104         are not executed.
 105     */
 106     const short FROM_LIST_NO_WARN = 7;
 107
 108     //-------------------------------------------------------------------------
 109     /** Execute only macros from secure list or macros that are signed by
 110         trusted certificates.
 111
 112         <p> If the macro is neither in secure list nor signed it will not be
 113             executed.
 114         </p>
 115
 116         <p> If the macro is signed with unknown certificate a warning will
 117             appear. The macro either will not be executed or if the warning
 118             allows conformation, it will be executed after user agrees.
 119         </p>
 120     */
 121     const short FROM_LIST_AND_SIGNED_WARN = 8;
 122
 123     //-------------------------------------------------------------------------
 124     /** Execute only macros from secure list or macros that are signed by
 125         trusted certificates. No warning/conformation should be shown.
 126     */
 127     const short FROM_LIST_AND_SIGNED_NO_WARN = 9;
 128
 129 };
 130
 131 //=============================================================================
 132
 133 }; }; }; };
 134
 135 #endif