udkapi/com/sun/star/script/ScriptEventDescriptor.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
  22  module com {  module sun {  module star {  module script {
  23
  24 /** describes an effect, especially a script to be executed,
  25     for a certain event given by the listener type and the name of the
  26     event method.
  27  */
  28 published struct ScriptEventDescriptor
  29 {
  30     /** listener type as string, same as listener-XIdlClass.getName().
  31      */
  32     string ListenerType;
  33
  34     /** event method as string.
  35      */
  36     string EventMethod;
  37
  38     /** data to be used if the addListener method needs an additional
  39         parameter.
  40         <p>If the type of this parameter is different from string,
  41         it will be converted, when added.</p>
  42      */
  43     string AddListenerParam;
  44
  45     /** type of the script language as string; for example, "Basic" or "StarScript".
  46      */
  47     string ScriptType;
  48
  49     /** script code as string (the code has to correspond with the language
  50         defined by ScriptType).
  51      */
  52     string ScriptCode;
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */