1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef _INSTALLATION_OINSTCHK_IDL
24#define _INSTALLATION_OINSTCHK_IDL
25
26
27#include <uno/intrface.idl>
28#include <stardiv/uno/beans/propset.idl>
29#include <stardiv/uno/lang/ulexcp.idl>
30
31module stardiv
32{
33
34    module installation
35    {
36
37/** a flag called "surpressed" changes the action of check and checkWithDialog
38 @author      Berndt Reinhold
39 @see         stardiv::uno::XInterface
40 */
41
42        [ uik(BF6D5A72-B53B-11d2-A17B00A0-243D2A0B), ident("OInstChk", 1.0) ]
43        interface XOInstChk: stardiv::uno::XInterface
44        {
45            /** Checks if "StarMath" and "StarBats" fonts are installed.
46             <P>
47             @param bForce: If TRUE check the fonts even if surpressed.
48             Otherwise check the fonts only if not surpressed.
49             @see resetSurpressed
50             @returns TRUE if the fonts are available. Also TRUE if surpressed
51             is TRUE and bForce is FALSE. Otherwise return FALSE.
52             </P>
53             */
54            boolean check([in] boolean bForce);
55
56            /** Same as check but additional shows a dialog if result is FALSE.
57             <P>
58             @param bForce: same as in check
59             @see check
60             @see resetSurpressed
61             </P>
62             */
63            boolean checkWithDialog([in] boolean bForce);
64
65            /** Shows a dialog if the font "StarBats" or "StarMath" is missing.
66             <P>
67             The dialog shows which font(s) is/are missing and have a checkbox,
68             that represents the state of the flag surpressed. This dialog is
69             the only way to set the flag surpressed to TRUE. This method is
70             not affected by the value of the flag surpressed.
71             @see resetSurpressed
72             </P>
73             */
74            boolean executeDialog();
75
76            /** Set flag surpressed to FALSE
77             <P>
78             The flag surpressed is stored in the registry. If surpressed is
79             FALSE the methods check and checkWithDialog ignores the parameter
80             bForce. if surpressed is TRUE check and checkWithDialog only
81             perform any action if their parameter bForce is TRUE. otherwise
82             they simply return TRUE.
83             </P>
84             */
85            void resetSurpressed();
86        };
87
88/*-------------- services -------------------------------------------
89 This service is the implementation of the interface XOInstChk.
90 @version 1.0
91 @author Berndt Reinhold
92 */
93
94        service OInstChkService
95        {
96            interface XOInstChk;
97        };
98
99//-------------------------------------------------------------------
100
101    }; // installation
102}; // stardiv
103
104#endif
105