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