1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef _EXTENSIONS_FONTEST_IDL
28#define _EXTENSIONS_FONTEST_IDL
29
30
31#include <uno/intrface.idl>
32#include <stardiv/uno/beans/propset.idl>
33#include <stardiv/uno/lang/ulexcp.idl>
34
35module stardiv
36{
37
38    module extensions
39    {
40
41        module fontest
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            [ uik(BF6D5A72-B53B-11d2-A17B00A0-243D2A0B), ident("FonTest", 1.0) ]
49            interface XFonTest: stardiv::uno::XInterface
50            {
51                /** Checks if "StarMath" and "StarBats" fonts are installed.
52                 <P>
53                 @param bForce: If TRUE check the fonts even if surpressed.
54                 Otherwise check the fonts only if not surpressed.
55                 @see resetSurpressed
56                 @returns TRUE if the fonts are available. Also TRUE if surpressed
57                 is TRUE and bForce is FALSE. Otherwise return FALSE.
58                 </P>
59                 */
60                boolean check([in] boolean bForce);
61
62                /** Same as check but additional shows a dialog if result is FALSE.
63                 <P>
64                 @param bForce: same as in check
65                 @see check
66                 @see resetSurpressed
67                 </P>
68                 */
69                boolean checkWithDialog([in] boolean bForce);
70
71                /** Shows a dialog if the font "StarBats" or "StarMath" is missing.
72                 <P>
73                 The dialog shows which font(s) is/are missing and have a checkbox,
74                 that represents the state of the flag surpressed. This dialog is
75                 the only way to set the flag surpressed to TRUE. This method is
76                 not affected by the value of the flag surpressed.
77                 @see resetSurpressed
78                 </P>
79                 */
80                boolean executeDialog();
81
82                /** Set flag surpressed to FALSE
83                 <P>
84                 The flag surpressed is stored in the registry. If surpressed is
85                 FALSE the methods check and checkWithDialog ignores the parameter
86                 bForce. if surpressed is TRUE check and checkWithDialog only
87                 perform any action if their parameter bForce is TRUE. otherwise
88                 they simply return TRUE.
89                 </P>
90                 */
91                void resetSurpressed();
92            };
93
94/*-------------- services -------------------------------------------
95 This service is the implementation of the interface XFonTest.
96 @version 1.0
97 @author Berndt Reinhold
98 */
99
100          service FonTestService
101          {
102              interface XFonTest;
103          };
104
105//-------------------------------------------------------------------
106
107        }; // fontest
108    }; // extensions
109}; // stardiv
110
111#endif
112