extensions/stardiv/oinstchk/oinstchk.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: oinstchk.idl,v $
  10  * $Revision: 1.3 $
  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 _INSTALLATION_OINSTCHK_IDL
  31 #define _INSTALLATION_OINSTCHK_IDL
  32
  33
  34 #include <uno/intrface.idl>
  35 #include <stardiv/uno/beans/propset.idl>
  36 #include <stardiv/uno/lang/ulexcp.idl>
  37
  38 module stardiv
  39 {
  40
  41     module installation
  42     {
  43
  44 /** a flag called "surpressed" changes the action of check and checkWithDialog
  45  @author      Berndt Reinhold
  46  @see         stardiv::uno::XInterface
  47  */
  48
  49         [ uik(BF6D5A72-B53B-11d2-A17B00A0-243D2A0B), ident("OInstChk", 1.0) ]
  50         interface XOInstChk: stardiv::uno::XInterface
  51         {
  52             /** Checks if "StarMath" and "StarBats" fonts are installed.
  53              <P>
  54              @param bForce: If TRUE check the fonts even if surpressed.
  55              Otherwise check the fonts only if not surpressed.
  56              @see resetSurpressed
  57              @returns TRUE if the fonts are available. Also TRUE if surpressed
  58              is TRUE and bForce is FALSE. Otherwise return FALSE.
  59              </P>
  60              */
  61             boolean check([in] boolean bForce);
  62
  63             /** Same as check but additional shows a dialog if result is FALSE.
  64              <P>
  65              @param bForce: same as in check
  66              @see check
  67              @see resetSurpressed
  68              </P>
  69              */
  70             boolean checkWithDialog([in] boolean bForce);
  71
  72             /** Shows a dialog if the font "StarBats" or "StarMath" is missing.
  73              <P>
  74              The dialog shows which font(s) is/are missing and have a checkbox,
  75              that represents the state of the flag surpressed. This dialog is
  76              the only way to set the flag surpressed to TRUE. This method is
  77              not affected by the value of the flag surpressed.
  78              @see resetSurpressed
  79              </P>
  80              */
  81             boolean executeDialog();
  82
  83             /** Set flag surpressed to FALSE
  84              <P>
  85              The flag surpressed is stored in the registry. If surpressed is
  86              FALSE the methods check and checkWithDialog ignores the parameter
  87              bForce. if surpressed is TRUE check and checkWithDialog only
  88              perform any action if their parameter bForce is TRUE. otherwise
  89              they simply return TRUE.
  90              </P>
  91              */
  92             void resetSurpressed();
  93         };
  94
  95 /*-------------- services -------------------------------------------
  96  This service is the implementation of the interface XOInstChk.
  97  @version 1.0
  98  @author Berndt Reinhold
  99  */
 100
 101         service OInstChkService
 102         {
 103             interface XOInstChk;
 104         };
 105
 106 //-------------------------------------------------------------------
 107
 108     }; // installation
 109 }; // stardiv
 110
 111 #endif