xref: /aoo41x/main/offapi/com/sun/star/installation/XInstallationCheck.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_installation_XInstallationCheck_idl__
#define __com_sun_star_installation_XInstallationCheck_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


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

module com {  module sun {  module star {  module installation {

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

// DocMerge from xml: interface com::sun::star::installation::XInstallationCheck
/** a flag called "suppressed", changes the action of check and checkWithDialog
	@see com::sun::star::uno::XInterface
	@deprecated
 */
published interface XInstallationCheck: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::check
	/** checks if something of the installation is missing.

		<p>If missing parts are detected, check should try to automatically repair/
		reinstall these parts. Only if this is not possible, return <FALSE/>.

		</p>@see resetSuppressed
	 */
	boolean check( [in] boolean bForce );

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::checkWithDialog
	/** same as check, but additionally shows a dialog if result is <FALSE/>.

		<p>The dialog shows which parts of the installation are missing and
		can't be repaired/reinstalled automatically. It also contains some
		hints for the user to reinstall the missing parts on his own.
		</p>@see check
				@see resetSuppressed
	 */
	boolean checkWithDialog( [in] boolean bForce );

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::executeDialog
	/** shows a dialog if something of the installation is missing.

		<p>The dialog shows which part(s) is (are) missing, and has a checkbox
		that represents the state of the flag suppressed. This dialog is
		the only way to set the flag suppressed to <TRUE/>. This method is
		not affected by the value of the flag suppressed.
		</p>@see resetSuppressed
	 */
	boolean executeDialog();

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::getSuppressed
	/** gets the status of flag suppressed

		<p>The flag suppressed is stored in the OfficeRegistry. If suppressed is
		<FALSE/>, the methods check and checkWithDialog ignore the parameter
		bForce.
		If suppressed is <TRUE/>, check and checkWithDialog only
		perform an action if their parameter bForce is <TRUE/>; otherwise,
		they return TRUE.
		</p>
	 */
	boolean getSuppressed();

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::installation::XInstallationCheck::setSuppressed
	/** set status of flag "suppressed".
	 */
	void setSuppressed( [in] boolean bSuppress );

};

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

}; }; }; };

#endif