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 #ifndef __com_sun_star_script_provider_ScriptURIHelper_idl__
  21 #define __com_sun_star_script_provider_ScriptURIHelper_idl__
  22
  23 #include <com/sun/star/script/provider/XScriptURIHelper.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27 module com { module sun { module star { module script { module provider {
  28
  29 /**
  30     This service is used to help transform Scripting Framework storage
  31     locations to Scripting Framework script URIs and vice versa.
  32 */
  33 service ScriptURIHelper : XScriptURIHelper {
  34
  35     /**
  36         create a new ScriptURIHelper
  37
  38         @param language
  39             The name of the scripting language for which this ScriptURIHelper
  40             is being created. It should be the same as the language name
  41             used for the service that inherits from the LanguageScriptProvider
  42             service
  43
  44         @param location
  45             This location which was passed to the LanguageScriptProvider
  46             by the Scripting Framework on its creation
  47
  48         @throws
  49             ::com::sun::star::lang::IllegalArgumentException
  50     */
  51     create( [in] string language, [in] string location )
  52         raises ( ::com::sun::star::lang::IllegalArgumentException );
  53 };
  54
  55 }; }; }; }; }; // ::com::sun::star::script::provider
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */