1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10*408a4873SAndrew Rist * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*408a4873SAndrew Rist * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19*408a4873SAndrew Rist * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_beans_XIntrospection_idl__ 24cdf0e10cSrcweir#define __com_sun_star_beans_XIntrospection_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_XIntrospectionAccess_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/XIntrospectionAccess.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir module com { module sun { module star { module beans { 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweir// DocMerge from xml: interface com::sun::star::beans::XIntrospection 42cdf0e10cSrcweir/** allows the inspection of an object's properties and methods. 43cdf0e10cSrcweir 44cdf0e10cSrcweir <p><strong>Important note:</strong>An object can only be 45cdf0e10cSrcweir inspected completely if it supports the <type scope= 46cdf0e10cSrcweir "com::sun::star::lang">XTypeProvider</type> interface.</p> 47cdf0e10cSrcweir 48cdf0e10cSrcweir <p>For details see method <member>XIntrospection::inspect</member>. </p> 49cdf0e10cSrcweir 50cdf0e10cSrcweir @see XIntrospectionAccess 51cdf0e10cSrcweir */ 52cdf0e10cSrcweirpublished interface XIntrospection: com::sun::star::uno::XInterface 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir //------------------------------------------------------------------------- 55cdf0e10cSrcweir 56cdf0e10cSrcweir // DocMerge from xml: method com::sun::star::beans::XIntrospection::inspect 57cdf0e10cSrcweir /** inspects the given object. 58cdf0e10cSrcweir 59cdf0e10cSrcweir <p>It identifies all properties supported by the object 60cdf0e10cSrcweir if they are represented in one of the following ways: </p> 61cdf0e10cSrcweir 62cdf0e10cSrcweir <dl> 63cdf0e10cSrcweir <dt>property set </dt> 64cdf0e10cSrcweir <dd>If the object supports an <type>XPropertySet</type> 65cdf0e10cSrcweir interface, all its properties are adopted. 66cdf0e10cSrcweir </dd> 67cdf0e10cSrcweir 68cdf0e10cSrcweir <dt>attributes </dt> 69cdf0e10cSrcweir <dd>All of an object's attributes are considered as properties 70cdf0e10cSrcweir with same name. If an attribute is read-only, the property 71cdf0e10cSrcweir also is read-only. 72cdf0e10cSrcweir </dd> 73cdf0e10cSrcweir 74cdf0e10cSrcweir <dt>get/set methods </dt> 75cdf0e10cSrcweir <dd>Every method <code>RetType getX()</code> defines a 76cdf0e10cSrcweir property where "X" stands for the property name and 77cdf0e10cSrcweir "RetType" for its type. The method must not have any 78cdf0e10cSrcweir parameters, or there is no property access method 79cdf0e10cSrcweir and "X" has no property. If there is also a method 80cdf0e10cSrcweir <code>void setX( [in] RetType )</code>, the property 81cdf0e10cSrcweir "X" also allows write access; otherwise it is read-only. 82cdf0e10cSrcweir </dd> 83cdf0e10cSrcweir 84cdf0e10cSrcweir <dt> <strong>Important note:</strong></dt> 85cdf0e10cSrcweir <dd>If an object implements <type scope="com::sun::star::container">XNameAccess</type>, 86cdf0e10cSrcweir the items that can be accessed are not considered as properties 87cdf0e10cSrcweir of the object and so are not included in the property list offered by 88cdf0e10cSrcweir <member scope="com::sun::star::beans">XIntrospectionAccess::getProperties()</member>. 89cdf0e10cSrcweir <type scope="com::sun::star::container">XNameAccess</type> items have to be 90cdf0e10cSrcweir accessed separately by <member scope="com::sun::star::beans">XIntrospectionAccess::getNameAccess()</member>. 91cdf0e10cSrcweir </dd> 92cdf0e10cSrcweir </dl> 93cdf0e10cSrcweir 94cdf0e10cSrcweir <p>In addition, the inspect method identifies all listener 95cdf0e10cSrcweir access methods in the form <code>add...Listener</code>/ 96cdf0e10cSrcweir <code>remove...Listener</code> (except methods of interface 97cdf0e10cSrcweir <type>XPropertySet</type>) where "..." stands for the listener type. 98cdf0e10cSrcweir </p> 99cdf0e10cSrcweir 100cdf0e10cSrcweir <p>Methods which do not belong to a property nor which represent 101cdf0e10cSrcweir a listener access nor which are methods of <type>XPropertySet</type>, 102cdf0e10cSrcweir <type scope="com::sun::star::container">XNameAccess</type>, 103cdf0e10cSrcweir <type scope="com::sun::star::container">XIndexAccess</type>, or 104cdf0e10cSrcweir <type scope="com::sun::star::container">XEnumerationAccess</type>, are considered to be normal 105cdf0e10cSrcweir methods. </p> 106cdf0e10cSrcweir 107cdf0e10cSrcweir @see XIntrospectionAccess 108cdf0e10cSrcweir */ 109cdf0e10cSrcweir com::sun::star::beans::XIntrospectionAccess inspect( [in] any aObject ); 110cdf0e10cSrcweir 111cdf0e10cSrcweir}; 112cdf0e10cSrcweir 113cdf0e10cSrcweir//============================================================================= 114cdf0e10cSrcweir 115cdf0e10cSrcweir}; }; }; }; 116cdf0e10cSrcweir 117cdf0e10cSrcweir#endif 118