1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_installation_XInstallationCheck_idl__
24#define __com_sun_star_installation_XInstallationCheck_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module installation {
34
35//=============================================================================
36
37// DocMerge from xml: interface com::sun::star::installation::XInstallationCheck
38/** a flag called "suppressed", changes the action of check and checkWithDialog
39	@see com::sun::star::uno::XInterface
40	@deprecated
41 */
42published interface XInstallationCheck: com::sun::star::uno::XInterface
43{
44	//-------------------------------------------------------------------------
45
46	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::check
47	/** checks if something of the installation is missing.
48
49		<p>If missing parts are detected, check should try to automatically repair/
50		reinstall these parts. Only if this is not possible, return <FALSE/>.
51
52		</p>@see resetSuppressed
53	 */
54	boolean check( [in] boolean bForce );
55
56	//-------------------------------------------------------------------------
57
58	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::checkWithDialog
59	/** same as check, but additionally shows a dialog if result is <FALSE/>.
60
61		<p>The dialog shows which parts of the installation are missing and
62		can't be repaired/reinstalled automatically. It also contains some
63		hints for the user to reinstall the missing parts on his own.
64		</p>@see check
65				@see resetSuppressed
66	 */
67	boolean checkWithDialog( [in] boolean bForce );
68
69	//-------------------------------------------------------------------------
70
71	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::executeDialog
72	/** shows a dialog if something of the installation is missing.
73
74		<p>The dialog shows which part(s) is (are) missing, and has a checkbox
75		that represents the state of the flag suppressed. This dialog is
76		the only way to set the flag suppressed to <TRUE/>. This method is
77		not affected by the value of the flag suppressed.
78		</p>@see resetSuppressed
79	 */
80	boolean executeDialog();
81
82	//-------------------------------------------------------------------------
83
84	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::getSuppressed
85	/** gets the status of flag suppressed
86
87		<p>The flag suppressed is stored in the OfficeRegistry. If suppressed is
88		<FALSE/>, the methods check and checkWithDialog ignore the parameter
89		bForce.
90		If suppressed is <TRUE/>, check and checkWithDialog only
91		perform an action if their parameter bForce is <TRUE/>; otherwise,
92		they return TRUE.
93		</p>
94	 */
95	boolean getSuppressed();
96
97	//-------------------------------------------------------------------------
98
99	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::setSuppressed
100	/** set status of flag "suppressed".
101	 */
102	void setSuppressed( [in] boolean bSuppress );
103
104};
105
106//=============================================================================
107
108}; }; }; };
109
110#endif
111