udkapi/com/sun/star/reflection/XPublished.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
  20 #ifndef __com_sun_star_reflection_XPublished_idl__
  21 #define __com_sun_star_reflection_XPublished_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com {  module sun {  module star {  module reflection {
  26
  27 /**
  28    Reflects the &ldquo;published&rdquo; status of a UNOIDL entity.
  29
  30    <p>This interface is intended to be supported by objects that also support
  31    com::sun::star::reflection::XTypeDescription.
  32    (This interface could have been made an optional sub-interface of
  33    com::sun::star::reflection::XTypeDescription, but is
  34    instead kept independent for reasons of backwards compatibility.)</p>
  35
  36    <p>For the various kinds of UNOIDL entities that are represented by objects
  37    supporting com::sun::star::reflection::XTypeDescription
  38    and its subtypes, this optional interface should be supported as follows:</p>
  39    <ul>
  40        <li>Enum types
  41        (com::sun::star::reflection::XEnumTypeDescription),
  42        plain struct types
  43        (com::sun::star::reflection::XStructTypeDescription),
  44        polymorphic struct type templates
  45        (com::sun::star::reflection::XStructTypeDescription),
  46        exception types (com::sun::star::reflection::XCompoundTypeDescription),
  47        interface types (com::sun::star::reflection::XInterfaceTypeDescription2),
  48        typedefs (com::sun::star::reflection::XIndirectTypeDescription),
  49        individual constants
  50        (com::sun::star::reflection::XConstantTypeDescription),
  51        constant groups (com::sun::star::reflection::XConstantsTypeDescription),
  52        single-interface&ndash;based services
  53        (com::sun::star::reflection::XServiceTypeDescription2),
  54        accumulation-based services
  55        (com::sun::star::reflection::XServiceTypeDescription2),
  56        interface-based singletons
  57        (com::sun::star::reflection::XSingletonTypeDescription2),
  58        and service-based singletons
  59        (com::sun::star::reflection::XSingletonTypeDescription2)
  60        support the notion of being published.  Therefore, for an object that
  61        represents any such entity,
  62        com::sun::star::reflection::XPublished should be
  63        supported.</li>
  64
  65        <li>Sequence types
  66        (com::sun::star::reflection::XIndirectTypeDescription),
  67        type parameters of polymorphic struct type templates
  68        (com::sun::star::reflection::XTypeDescription),
  69        instantiated polymorphic struct types
  70        (com::sun::star::reflection::XStructTypeDescription),
  71        attributes of interface types
  72        (com::sun::star::reflection::XInterfaceAttributeTypeDescription2),
  73        methods of interface types
  74        (com::sun::star::reflection::XInterfaceMethodTypeDescription),
  75        properties of accumulation-based services
  76        (com::sun::star::reflection::XPropertyTypeDescription),
  77        deprecated
  78        com::sun::star::reflection::XArrayTypeDescriptions,
  79        and deprecated
  80        com::sun::star::reflection::XUnionTypeDescriptions do
  81        not support the notion of being published.
  82        Therefore, for an object that represents any such entity,
  83        com::sun::star::reflection::XPublished should not be
  84        supported.</li>
  85    </ul>
  86
  87    @since OOo 2.0
  88 */
  89 interface XPublished {
  90     /**
  91        Returns the &ldquo;published&rdquo; status of a UNOIDL entity.
  92
  93        @return `TRUE` if the UNOIDL entity represented by this object is
  94        published
  95      */
  96     boolean isPublished();
  97 };
  98
  99 }; }; }; };
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */