udkapi/com/sun/star/bridge/oleautomation/NamedArgument.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_bridge_oleautomation_NamedArgument_idl__
  20 #define __com_sun_star_bridge_oleautomation_NamedArgument_idl__
  21
  22
  23 module com {  module sun {  module star {  module bridge {  module oleautomation {
  24
  25 /** represents a named argument in a call to a method of an Automation object.
  26     <p>
  27     The Automation bridge accepts values of NamedArgument when a
  28     call to an Automation object is made. The call is done through the
  29     com::sun::star::script::XInvocation::invoke()
  30     method, which takes all arguments in a sequence of anys. Usually the order
  31     of the arguments must correspond to the order of arguments in the Automation
  32     method. By using instances of NamedArgument the arguments in the
  33     sequence can be unordered. The Automation object being called must support
  34     named arguments, otherwise the call fails.
  35     </p>
  36
  37     @since OOo 1.1.2
  38  */
  39 struct NamedArgument
  40 {
  41     /** The name of the argument, for which
  42         NamedArgument::Value is intended.
  43      */
  44     string Name;
  45
  46     /** The value of the argument whoose name is the one as contained in the
  47         member #Name.
  48      */
  49     any Value;
  50 };
  51
  52 }; }; }; }; };
  53
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */