UIEvolutin Inc.
UJML Language Reference
ithings.ujmi

The ithings.ujmi sample declares interfaces for the Things sample application.

This is a set of interface declarations describing things, both in general and specifically. See Interfaces. It also provides for thing data provider, which may be locale independent. See thingdata.ujml.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ujml PUBLIC "-//UIEVOLUTION//DTD UJML 2.1//EN" "http://www.uievolution.com/dtd/ujml-2.1.dtd"[]>
<!--
  Copyright (c) 2000-2007 UIEvolution, Inc.
  http://www.uievolution.com
-->
<!--
    ithings.ujmi

    Interface declarations for the 'Things' sample application.
-->
<ujml>
    <interfaces>
        <!--
            IThing

            A 'thing'.
        -->
        <interface name="IThing">
            <functions>
                <!--
                    Gets the name of the thing.
                -->
                <function name="getName" type="string" />
                <!--
                    Gets a description of the thing.
                -->
                <function name="getDescription" type="string" />
                <!--
                    Gets the image URL of the thing.
                -->
                <function name="getImageName" type="string" />
            </functions>
        </interface>
        <!--
            IUnknown

            A 'thing' that is an 'unknown' type.
        -->
        <interface name="IUnknown">
            <functions>
                <!--
                   Initializes the thing.
                -->
                <function name="init" type="void">
                    <parameters>
                        <var name="name" type="string"/>
                        <var name="description" type="string"/>
                        <var name="imgName" type="string"/>
                    </parameters>
                </function>
            </functions>
        </interface>
        <!--
            IAnimal

            A 'thing' that is an 'animal'.
        -->
        <interface name="IAnimal">
            <functions>
                <!--
                   Initializes the thing.
                -->
                <function name="init" type="void">
                    <parameters>
                        <var name="name" type="string"/>
                        <var name="description" type="string"/>
                        <var name="imgName" type="string"/>
                        <var name="sound" type="string"/>
                        <var name="isDomesticated" type="boolean"/>
                    </parameters>
                </function>
                <!--
                    Gets the sound the thing makes.
                -->
                <function name="getSound" type="string" />
                <!--
                    Gets a boolean value indicating if the thing is often
                    domesticated.
                -->
                <function name="getIsDomesticated" type="boolean" />
            </functions>
        </interface>
        <!--
            IVegetable

            A 'thing' that is an 'vegetable' (plant or part of a plant).
        -->
        <interface name="IVegetable">
            <functions>
                <!--
                   Initializes the thing.
                -->
                <function name="init" type="void">
                    <parameters>
                        <var name="name" type="string"/>
                        <var name="description" type="string"/>
                        <var name="imgName" type="string"/>
                        <var name="foundIn" type="string"/>
                        <var name="isEdible" type="boolean"/>
                    </parameters>
                </function>
                <!--
                    Gets the typical location you would find the thing.
                -->
                <function name="getFoundIn" type="string" />
                <!--
                    Gets a boolean value indicating if the thing can a
                    eaten.
                -->
                <function name="getIsEdible" type="boolean" />
            </functions>
        </interface>
        <!--
            IMineral

            Generally a 'thing' that is neither 'animal' or 'vegetable'.
        -->
        <interface name="IMineral">
            <functions>
                <!--
                   Initializes the thing.
                -->
                <function name="init" type="void">
                    <parameters>
                        <var name="name" type="string"/>
                        <var name="description" type="string"/>
                        <var name="imgName" type="string"/>
                        <var name="isMostly" type="string"/>
                        <var name="isManMade" type="boolean"/>
                    </parameters>
                </function>
                <!--
                    Gets the typical composition of the thing.
                -->
                <function name="getIsMostly" type="string" />
                <!--
                    Gets a boolean value indicating if the thing was
                    made by humans.
                -->
                <function name="getIsManMade" type="boolean" />
            </functions>
        </interface>
        <!--
            IEnumerable forward reference.
        -->
        <interface name="IEnumerable"/>
        <!--
            IThingData

            A data provider for things.
        -->
        <interface name="IThingData">
            <functions>
                <!--
                    Gets the heading for 'Animal'.
                -->
                <function name="getAnimalHeading" type="string" />
                <!--
                    Gets the caption for animal string value.
                -->
                <function name="getAnimalStringCaption" type="string" />
                <!--
                    Gets the string value for the animal boolean true.
                -->
                <function name="getAnimalBooleanTrue" type="string" />
                <!--
                    Gets the string value for the animal boolean false.
                -->
                <function name="getAnimalBooleanFalse" type="string" />
                <!--
                    Gets the heading for 'Vegegatable'.
                -->
                <function name="getVegetableHeading" type="string" />
                <!--
                    Gets the caption for vegetable string value.
                -->
                <function name="getVegetableStringCaption" type="string" />
                <!--
                    Gets the string value for the vegetable boolean true.
                -->
                <function name="getVegetableBooleanTrue" type="string" />
                <!--
                    Gets the string value for the vegetable boolean false.
                -->
                <function name="getVegetableBooleanFalse" type="string" />
                <!--
                    Gets the heading for 'Mineral'.
                -->
                <function name="getMineralHeading" type="string" />
                <!--
                    Gets the caption for mineral string value.
                -->
                <function name="getMineralStringCaption" type="string" />
                <!--
                    Gets the string value for the mineral boolean true.
                -->
                <function name="getMineralBooleanTrue" type="string" />
                <!--
                    Gets the string value for the mineral boolean false.
                -->
                <function name="getMineralBooleanFalse" type="string" />
                <!--
                    Gets the heading for 'Unknown'.
                -->
                <function name="getUnknownHeading" type="string" />
                <!--
                    Gets the name for 'Nothing'.
                -->
                <function name="getNothingName" type="string" />
                <!--
                    Gets the description for 'Nothing'.
                -->
                <function name="getNothingDescription" type="string" />
                <!--
                    Gets the image for 'Nothing'.
                -->
                <function name="getNothingImageName" type="string" />
                <!--
                    Gets the text for 'OK'.
                -->
                <function name="getOKText" type="string" />
                <!--
                    Gets the text for 'Next'.
                -->
                <function name="getNextText" type="string" />
                <!--
                    Gets the text for Splash screen.
                -->
                <function name="getSplashText" type="string" />
                <!--
                    Gets the text used to separate a caption from other text.
                -->
                <function name="getCaptionSeparator" type="string" />
                <!--
                    Gets an IEnumerable instance that enumerates a collection
                    of IThing instances.
                -->
                <function name="getThingEnumerator" type="IEnumerable" />
            </functions>
        </interface>
    </interfaces>
</ujml>
Copyright (c) 2000-2007 UIEvolution, Inc. All rights reserved.
What do you think about this topic? Send feedback!