udkapi/com/sun/star/script/XInvocation2.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XInvocation2.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_XInvocation2_idl__
  31 #define __com_sun_star_script_XInvocation2_idl__
  32
  33 #ifndef __com_sun_star_script_XInvocation_idl__
  34 #include <com/sun/star/script/XInvocation.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_script_InvocationInfo_idl__
  38 #include <com/sun/star/script/InvocationInfo.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module script {
  44
  45 //=============================================================================
  46
  47 /**
  48     Extension of XInvocation to provide additional information
  49     about the methods and properties that are accessable via
  50     XInvocation.
  51     </p>
  52  */
  53 published interface XInvocation2: com::sun::star::script::XInvocation
  54 {
  55     /** returns the names of all methods and properties accessable via XInvocation.
  56      */
  57     sequence< string > getMemberNames();
  58
  59     /** returns information items for all methods and properties accessable via XInvocation.
  60
  61         @see com::sun::star::script::Invocation
  62      */
  63     sequence< InvocationInfo > getInfo();
  64
  65     /** returns information item for the method or property defined by aName
  66
  67         @param aName
  68             specifies the name of the method or property
  69
  70         @param bExact
  71             specifies the name of the method or property
  72
  73         @throws IllegalArgumentException
  74             if aName is not the name of a supported method or property
  75
  76         @see com::sun::star::script::Invocation
  77      */
  78     InvocationInfo getInfoForName( [in] string aName, [in] boolean bExact )
  79         raises( com::sun::star::lang::IllegalArgumentException );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif