offapi/com/sun/star/installation/XInstallationCheck.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: XInstallationCheck.idl,v $
  10  * $Revision: 1.13 $
  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 #ifndef __com_sun_star_installation_XInstallationCheck_idl__
  31 #define __com_sun_star_installation_XInstallationCheck_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module installation {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: interface com::sun::star::installation::XInstallationCheck
  45 /** a flag called "suppressed", changes the action of check and checkWithDialog
  46     @see com::sun::star::uno::XInterface
  47     @deprecated
  48  */
  49 published interface XInstallationCheck: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     // DocMerge from xml: method com::sun::star::installation::XInstallationCheck::check
  54     /** checks if something of the installation is missing.
  55
  56         <p>If missing parts are detected, check should try to automatically repair/
  57         reinstall these parts. Only if this is not possible, return <FALSE/>.
  58
  59         </p>@see resetSuppressed
  60      */
  61     boolean check( [in] boolean bForce );
  62
  63     //-------------------------------------------------------------------------
  64
  65     // DocMerge from xml: method com::sun::star::installation::XInstallationCheck::checkWithDialog
  66     /** same as check, but additionally shows a dialog if result is <FALSE/>.
  67
  68         <p>The dialog shows which parts of the installation are missing and
  69         can't be repaired/reinstalled automatically. It also contains some
  70         hints for the user to reinstall the missing parts on his own.
  71         </p>@see check
  72                 @see resetSuppressed
  73      */
  74     boolean checkWithDialog( [in] boolean bForce );
  75
  76     //-------------------------------------------------------------------------
  77
  78     // DocMerge from xml: method com::sun::star::installation::XInstallationCheck::executeDialog
  79     /** shows a dialog if something of the installation is missing.
  80
  81         <p>The dialog shows which part(s) is (are) missing, and has a checkbox
  82         that represents the state of the flag suppressed. This dialog is
  83         the only way to set the flag suppressed to <TRUE/>. This method is
  84         not affected by the value of the flag suppressed.
  85         </p>@see resetSuppressed
  86      */
  87     boolean executeDialog();
  88
  89     //-------------------------------------------------------------------------
  90
  91     // DocMerge from xml: method com::sun::star::installation::XInstallationCheck::getSuppressed
  92     /** gets the status of flag suppressed
  93
  94         <p>The flag suppressed is stored in the OfficeRegistry. If suppressed is
  95         <FALSE/>, the methods check and checkWithDialog ignore the parameter
  96         bForce.
  97         If suppressed is <TRUE/>, check and checkWithDialog only
  98         perform an action if their parameter bForce is <TRUE/>; otherwise,
  99         they return TRUE.
 100         </p>
 101      */
 102     boolean getSuppressed();
 103
 104     //-------------------------------------------------------------------------
 105
 106     // DocMerge from xml: method com::sun::star::installation::XInstallationCheck::setSuppressed
 107     /** set status of flag "suppressed".
 108      */
 109     void setSuppressed( [in] boolean bSuppress );
 110
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 #endif