1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_installation_XInstallationCheck_idl__
28#define __com_sun_star_installation_XInstallationCheck_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module installation {
38
39//=============================================================================
40
41// DocMerge from xml: interface com::sun::star::installation::XInstallationCheck
42/** a flag called "suppressed", changes the action of check and checkWithDialog
43	@see com::sun::star::uno::XInterface
44	@deprecated
45 */
46published interface XInstallationCheck: com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49
50	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::check
51	/** checks if something of the installation is missing.
52
53		<p>If missing parts are detected, check should try to automatically repair/
54		reinstall these parts. Only if this is not possible, return <FALSE/>.
55
56		</p>@see resetSuppressed
57	 */
58	boolean check( [in] boolean bForce );
59
60	//-------------------------------------------------------------------------
61
62	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::checkWithDialog
63	/** same as check, but additionally shows a dialog if result is <FALSE/>.
64
65		<p>The dialog shows which parts of the installation are missing and
66		can't be repaired/reinstalled automatically. It also contains some
67		hints for the user to reinstall the missing parts on his own.
68		</p>@see check
69				@see resetSuppressed
70	 */
71	boolean checkWithDialog( [in] boolean bForce );
72
73	//-------------------------------------------------------------------------
74
75	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::executeDialog
76	/** shows a dialog if something of the installation is missing.
77
78		<p>The dialog shows which part(s) is (are) missing, and has a checkbox
79		that represents the state of the flag suppressed. This dialog is
80		the only way to set the flag suppressed to <TRUE/>. This method is
81		not affected by the value of the flag suppressed.
82		</p>@see resetSuppressed
83	 */
84	boolean executeDialog();
85
86	//-------------------------------------------------------------------------
87
88	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::getSuppressed
89	/** gets the status of flag suppressed
90
91		<p>The flag suppressed is stored in the OfficeRegistry. If suppressed is
92		<FALSE/>, the methods check and checkWithDialog ignore the parameter
93		bForce.
94		If suppressed is <TRUE/>, check and checkWithDialog only
95		perform an action if their parameter bForce is <TRUE/>; otherwise,
96		they return TRUE.
97		</p>
98	 */
99	boolean getSuppressed();
100
101	//-------------------------------------------------------------------------
102
103	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::setSuppressed
104	/** set status of flag "suppressed".
105	 */
106	void setSuppressed( [in] boolean bSuppress );
107
108};
109
110//=============================================================================
111
112}; }; }; };
113
114#endif
115