1    /*
     2     * Copyright (c) 2012, Texas Instruments Incorporated
     3     * All rights reserved.
     4     *
     5     * Redistribution and use in source and binary forms, with or without
     6     * modification, are permitted provided that the following conditions
     7     * are met:
     8     *
     9     * *  Redistributions of source code must retain the above copyright
    10     *    notice, this list of conditions and the following disclaimer.
    11     *
    12     * *  Redistributions in binary form must reproduce the above copyright
    13     *    notice, this list of conditions and the following disclaimer in the
    14     *    documentation and/or other materials provided with the distribution.
    15     *
    16     * *  Neither the name of Texas Instruments Incorporated nor the names of
    17     *    its contributors may be used to endorse or promote products derived
    18     *    from this software without specific prior written permission.
    19     *
    20     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    22     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    23     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    24     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    25     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    26     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    27     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    28     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    29     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
    30     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    31     * */
    32    
    33    /*
    34     *  ======== IUIAMetaProvider.xdc ========
    35     */
    36    
    37    package ti.uia.events;
    38    
    39    /*!
    40     *  ======== IUIAMetaProvider ========
    41     *  Interface to identify UIA MetaData providers to the UIAMetaData xml
    42     *     generation script
    43     *
    44     *  Inheriting from this interface is sufficient to identify to
    45     *  ti.uia.runtime.UIAMetaData.xs that the module is able to provide metadata
    46     *  for inclusion in the .uia.xml file
    47     */
    48    interface IUIAMetaProvider {
    49    
    50        /*! @_nodoc
    51         * ======== hasMetaData =========
    52         * set to true to indicate that the module has metadata to contribute to the
    53         *    uia.xml file.
    54         */
    55        metaonly config Bool hasMetaData = false;
    56    
    57        /*! @_nodoc
    58         *  ======== writeUIAMetaData ========
    59         *  Writes any UIA metadata required to support the module
    60         *
    61         *  NOTE: This should only be called by ti.uia.runtime.UIAMetaData.xs in
    62         *  order to ensure that the UIA xml file has been properly opened and is
    63         *  ready for writing.
    64         *  @param(inst) instance of the module to generate data for, null for
    65         *     module-level info
    66         *  @param(instNum) the instance number used in .h files
    67         *  @param(indent) the number of spaces to preceed the xml tag with
    68         */
    69        metaonly function writeUIAMetaData(inst, instNum, indent);
    70    
    71    }