1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_reflection_XPublished_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_reflection_XPublished_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include "com/sun/star/uno/XInterface.idl" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module reflection { 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski/** 32*b1cdbd2cSJim Jagielski Reflects the “published” status of a UNOIDL entity. 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski <p>This interface is intended to be supported by objects that also support 35*b1cdbd2cSJim Jagielski <type scope="com::sun::star::reflection">XTypeDescription</type>. 36*b1cdbd2cSJim Jagielski (This interface could have been made an optional sub-interface of 37*b1cdbd2cSJim Jagielski <type scope="com::sun::star::reflection">XTypeDescription</type>, but is 38*b1cdbd2cSJim Jagielski instead kept independent for reasons of backwards compatibility.)</p> 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski <p>For the various kinds of UNOIDL entities that are represented by objects 41*b1cdbd2cSJim Jagielski supporting <type scope="com::sun::star::reflection">XTypeDescription</type> 42*b1cdbd2cSJim Jagielski and its subtypes, this optional interface should be supported as follows:</p> 43*b1cdbd2cSJim Jagielski <ul> 44*b1cdbd2cSJim Jagielski <li>Enum types 45*b1cdbd2cSJim Jagielski (<type scope="com::sun::star::reflection">XEnumTypeDescription</type>), 46*b1cdbd2cSJim Jagielski plain struct types 47*b1cdbd2cSJim Jagielski (<type scope="com::sun::star::reflection">XStructTypeDescription</type>), 48*b1cdbd2cSJim Jagielski polymorphic struct type templates 49*b1cdbd2cSJim Jagielski (<type scope="com::sun::star::reflection">XStructTypeDescription</type>), 50*b1cdbd2cSJim Jagielski exception types (<type 51*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XCompoundTypeDescription</type>), 52*b1cdbd2cSJim Jagielski interface types (<type 53*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XInterfaceTypeDescription2</type>), 54*b1cdbd2cSJim Jagielski typedefs (<type 55*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XIndirectTypeDescription</type>), 56*b1cdbd2cSJim Jagielski individual constants (<type 57*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XConstantTypeDescription</type>), 58*b1cdbd2cSJim Jagielski constant groups (<type 59*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XConstantsTypeDescription</type>), 60*b1cdbd2cSJim Jagielski single-interface–based services (<type 61*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XServiceTypeDescription2</type>), 62*b1cdbd2cSJim Jagielski accumulation-based services (<type 63*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XServiceTypeDescription2</type>), 64*b1cdbd2cSJim Jagielski interface-based singletons (<type 65*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XSingletonTypeDescription2</type>), 66*b1cdbd2cSJim Jagielski and service-based singletons (<type 67*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XSingletonTypeDescription2</type>) 68*b1cdbd2cSJim Jagielski support the notion of being published. Therefore, for an object that 69*b1cdbd2cSJim Jagielski represents any such entity, 70*b1cdbd2cSJim Jagielski <type scope="com::sun::star::reflection">XPublished</type> should be 71*b1cdbd2cSJim Jagielski supported.</li> 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski <li>Sequence types (<type 74*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XIndirectTypeDescription</type>), 75*b1cdbd2cSJim Jagielski type parameters of polymorphic struct type templates 76*b1cdbd2cSJim Jagielski (<type scope="com::sun::star::reflection">XTypeDescription</type>), 77*b1cdbd2cSJim Jagielski instantiated polymorphic struct types 78*b1cdbd2cSJim Jagielski (<type scope="com::sun::star::reflection">XStructTypeDescription</type>), 79*b1cdbd2cSJim Jagielski attributes of interface types (<type scope="com::sun::star::reflection"> 80*b1cdbd2cSJim Jagielski XInterfaceAttributeTypeDescription2</type>), methods of interface types 81*b1cdbd2cSJim Jagielski (<type scope="com::sun::star::reflection"> 82*b1cdbd2cSJim Jagielski XInterfaceMethodTypeDescription</type>), properties of 83*b1cdbd2cSJim Jagielski accumulation-based services (<type 84*b1cdbd2cSJim Jagielski scope="com::sun::star::reflection">XPropertyTypeDescription</type>), 85*b1cdbd2cSJim Jagielski deprecated 86*b1cdbd2cSJim Jagielski <type scope="com::sun::star::reflection">XArrayTypeDescription</type>s, 87*b1cdbd2cSJim Jagielski and deprecated 88*b1cdbd2cSJim Jagielski <type scope="com::sun::star::reflection">XUnionTypeDescription</type>s do 89*b1cdbd2cSJim Jagielski not support the notion of being published. Therefore, for an object that 90*b1cdbd2cSJim Jagielski represents any such entity, 91*b1cdbd2cSJim Jagielski <type scope="com::sun::star::reflection">XPublished</type> should not be 92*b1cdbd2cSJim Jagielski supported.</li> 93*b1cdbd2cSJim Jagielski </ul> 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 96*b1cdbd2cSJim Jagielski*/ 97*b1cdbd2cSJim Jagielskiinterface XPublished { 98*b1cdbd2cSJim Jagielski /** 99*b1cdbd2cSJim Jagielski Returns the “published” status of a UNOIDL entity. 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @return <TRUE/> if the UNOIDL entity represented by this object is 102*b1cdbd2cSJim Jagielski published 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski boolean isPublished(); 105*b1cdbd2cSJim Jagielski}; 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski}; }; }; }; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski#endif 110