xref: /aoo4110/main/extensions/stardiv/fontest/fontest.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef _EXTENSIONS_FONTEST_IDL
#define _EXTENSIONS_FONTEST_IDL


#include <uno/intrface.idl>
#include <stardiv/uno/beans/propset.idl>
#include <stardiv/uno/lang/ulexcp.idl>

module stardiv
{

    module extensions
    {

        module fontest
        {

/** a flag called "surpressed" changes the action of check and checkWithDialog
 @author      Berndt Reinhold
 @see         stardiv::uno::XInterface
 */
            [ uik(BF6D5A72-B53B-11d2-A17B00A0-243D2A0B), ident("FonTest", 1.0) ]
            interface XFonTest: stardiv::uno::XInterface
            {
                /** Checks if "StarMath" and "StarBats" fonts are installed.
                 <P>
                 @param bForce: If TRUE check the fonts even if surpressed.
                 Otherwise check the fonts only if not surpressed.
                 @see resetSurpressed
                 @returns TRUE if the fonts are available. Also TRUE if surpressed
                 is TRUE and bForce is FALSE. Otherwise return FALSE.
                 </P>
                 */
                boolean check([in] boolean bForce);

                /** Same as check but additional shows a dialog if result is FALSE.
                 <P>
                 @param bForce: same as in check
                 @see check
                 @see resetSurpressed
                 </P>
                 */
                boolean checkWithDialog([in] boolean bForce);

                /** Shows a dialog if the font "StarBats" or "StarMath" is missing.
                 <P>
                 The dialog shows which font(s) is/are missing and have a checkbox,
                 that represents the state of the flag surpressed. This dialog is
                 the only way to set the flag surpressed to TRUE. This method is
                 not affected by the value of the flag surpressed.
                 @see resetSurpressed
                 </P>
                 */
                boolean executeDialog();

                /** Set flag surpressed to FALSE
                 <P>
                 The flag surpressed is stored in the registry. If surpressed is
                 FALSE the methods check and checkWithDialog ignores the parameter
                 bForce. if surpressed is TRUE check and checkWithDialog only
                 perform any action if their parameter bForce is TRUE. otherwise
                 they simply return TRUE.
                 </P>
                 */
                void resetSurpressed();
            };

/*-------------- services -------------------------------------------
 This service is the implementation of the interface XFonTest.
 @version 1.0
 @author Berndt Reinhold
 */

          service FonTestService
          {
              interface XFonTest;
          };

//-------------------------------------------------------------------

        }; // fontest
    }; // extensions
}; // stardiv

#endif