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