udkapi/com/sun/star/script/XInvocation.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 /** gives access to an object's methods and properties.
  25     Container access is available through
  26     com::sun::star::container::XIndexContainer,
  27     com::sun::star::container::XNameContainer and
  28     com::sun::star::container::XEnumerationAccess.
  29     </p>
  30  */
  31 published interface XInvocation: com::sun::star::uno::XInterface
  32 {
  33     /** returns the introspection from this object or `NULL`
  34         if the object does not provide this information.
  35      */
  36     com::sun::star::beans::XIntrospectionAccess getIntrospection();
  37
  38     /** provides access to methods exposed by an object.
  39
  40         @param aFunctionName the method to invoke
  41         @param aParams all parameters; pure out params are undefined in sequence,
  42                        the value has to be ignored by the callee
  43         @param aOutParamIndex This sequence contains the indices of all parameters
  44                         that are specified as out or inout.
  45         @param aOutParam This sequence contains the values of all parameters that
  46                         are specified as out or inout and corresponds with the
  47                         indices provided by the aOutParamIndex sequence.
  48
  49                         Example: aOutParamIndex == { 1, 4 } means that
  50                         aOutParam[0] contains the out value of the aParams[1]
  51                         parameter and aOutParam[1] contains the out value of
  52                         the aParams[4] parameter.
  53      */
  54     any invoke( [in] string aFunctionName,
  55              [in] sequence<any> aParams,
  56              [out] sequence<short> aOutParamIndex,
  57              [out] sequence<any> aOutParam )
  58             raises( com::sun::star::lang::IllegalArgumentException,
  59                     com::sun::star::script::CannotConvertException,
  60                     com::sun::star::reflection::InvocationTargetException );
  61
  62     /** sets a value to the property with the specified name.
  63
  64         <p> If the underlying object implements an
  65         com::sun::star::container::XNameContainer,
  66         then this method will insert the value if there is no such
  67         <var>aPropertyName</var>.
  68
  69         </p>
  70      */
  71     void setValue( [in] string aPropertyName,
  72              [in] any aValue )
  73             raises( com::sun::star::beans::UnknownPropertyException,
  74                     com::sun::star::script::CannotConvertException,
  75                     com::sun::star::reflection::InvocationTargetException );
  76
  77     /** returns the value of the property with the specified name.
  78
  79         @param aPropertyName
  80             specifies the name of the property.
  81      */
  82     any getValue( [in] string aPropertyName )
  83             raises( com::sun::star::beans::UnknownPropertyException );
  84
  85     /** returns `TRUE` if the method with the specified name exists, else `FALSE`.
  86
  87         <p>This optimizes the calling sequence
  88         ( XInvocation::hasMethod(),
  89         XInvocation::invoke() )!</p>
  90
  91                 @param aName
  92                     specifies the name of the method.
  93      */
  94     boolean hasMethod( [in] string aName );
  95
  96     /** returns `TRUE` if the property with the specified name exists, else `FALSE`.
  97
  98                 <p>This optimizes the calling sequence
  99                 ( XInvocation::hasProperty(),
 100                 XInvocation::getValue() ) or
 101
 102                 ( XInvocation::hasProperty(),
 103                 XInvocation::setValue() )!
 104
 105                     @param aName
 106                 specifies the name of the property.
 107      */
 108     boolean hasProperty( [in] string aName );
 109
 110 };
 111
 112
 113 }; }; }; };
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */