xref: /aoo42x/main/offapi/com/sun/star/document/MacroExecMode.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_document_MacroExecMode_idl__
#define __com_sun_star_document_MacroExecMode_idl__

//=============================================================================

module com { module sun { module star { module document {

//=============================================================================
/** Specify whether a macro can be executed.

    @since OOo 1.1.2
*/
published constants MacroExecMode
{
	//-------------------------------------------------------------------------
	/** A macro should not be executed at all.
	*/

	const short NEVER_EXECUTE = 0;

	//-------------------------------------------------------------------------
	/** Execute macros from secure list quietly.

		<p>
		If a macro is not in the list a conformation for it executing will
		appear.
		</p>
	*/

	const short FROM_LIST = 1;

	//-------------------------------------------------------------------------
	/** Execute any macro, macros signed with trusted sertificates and macros
		from secure list are executed quietly.

		<p>
			If the macro is neither in secure list nor signed a conformation
			will be requested.
		</p>
	*/

	const short ALWAYS_EXECUTE = 2;

	//-------------------------------------------------------------------------
	/** Use configuration to retrieve macro settings. In case a user
		confirmation is required a dialog is output.
	*/

	const short USE_CONFIG = 3;


	//-------------------------------------------------------------------------
	/** A macro should be executed always no conformation should be provided.
	*/

	const short ALWAYS_EXECUTE_NO_WARN = 4;

	//-------------------------------------------------------------------------
	/** Use configuration to retrieve macro settings. Treat cases when user
		confirmation required as rejected.
	*/

	const short USE_CONFIG_REJECT_CONFIRMATION = 5;

	//-------------------------------------------------------------------------
	/** Use configuration to retrieve macro settings. Treat cases when user
		confirmation required as approved.
	*/

	const short USE_CONFIG_APPROVE_CONFIRMATION = 6;

	//-------------------------------------------------------------------------
	/** Execute only macros from secure list. Macros that are not from the list
		are not executed.
	*/
	const short FROM_LIST_NO_WARN = 7;

	//-------------------------------------------------------------------------
	/** Execute only macros from secure list or macros that are signed by
		trusted certificates.

		<p> If the macro is neither in secure list nor signed it will not be
			executed.
		</p>

		<p> If the macro is signed with unknown certificate a warning will
			appear. The macro either will not be executed or if the warning
			allows conformation, it will be executed after user agrees.
		</p>
	*/
	const short FROM_LIST_AND_SIGNED_WARN = 8;

	//-------------------------------------------------------------------------
	/** Execute only macros from secure list or macros that are signed by
		trusted certificates. No warning/conformation should be shown.
	*/
	const short FROM_LIST_AND_SIGNED_NO_WARN = 9;

};

//=============================================================================

}; }; }; };

#endif