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