offapi/com/sun/star/script/provider/ScriptURIHelper.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module script { module provider {
  22
  23 /**
  24     This service is used to help transform Scripting Framework storage
  25     locations to Scripting Framework script URIs and vice versa.
  26 */
  27 service ScriptURIHelper : XScriptURIHelper {
  28
  29     /**
  30         create a new ScriptURIHelper
  31
  32         @param language
  33             The name of the scripting language for which this ScriptURIHelper
  34             is being created. It should be the same as the language name
  35             used for the service that inherits from the LanguageScriptProvider
  36             service
  37
  38         @param location
  39             This location which was passed to the LanguageScriptProvider
  40             by the Scripting Framework on its creation
  41
  42         @throws
  43             ::com::sun::star::lang::IllegalArgumentException
  44     */
  45     create( [in] string language, [in] string location )
  46         raises ( ::com::sun::star::lang::IllegalArgumentException );
  47 };
  48
  49 }; }; }; }; }; // ::com::sun::star::script::provider
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */