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