Your IP : 216.73.216.48


Current Path : /usr/X11R6/share/apps/rocs/engineapi/
Upload File :
Current File : //usr/X11R6/share/apps/rocs/engineapi/Pointer.xml

<?xml version="1.0"?>
<object>
<name>Abstract Pointer</name>
<id>Pointer</id>
<componentType>Pointer</componentType>
<description>
<para>A pointer connects two data elements and can itself hold information by its properties.</para>
</description>
<syntax>
</syntax>
<properties>
<property>
    <name>from</name>
    <description><para>Start of the connection.</para></description>
    <type>Data</type>
</property>
<property>
    <name>to</name>
    <description><para>End of the connection</para></description>
    <type>Data</type>
</property>
<property>
    <name>directed</name>
    <description><para>If true, the connection is directed. Otherwise is connection is undirected.</para></description>
    <type>bool</type>
</property>
<property>
    <name>color</name>
    <description><para>ID of the connection type.</para></description>
    <type>int</type>
</property>
<property>
    <name>width</name>
    <description><para>The width of the connection.</para></description>
    <type>real</type>
</property>
</properties>
<methods>
<method>
    <name>remove()</name>
    <description>
        <para>Remove this connection.</para>
    </description>
    <returnType>void</returnType>
    <parameters>
    </parameters>
</method>
<method>
    <name>add_property(name, value)</name>
    <description>
        <para>Add a new property to the connection.</para>
    </description>
    <returnType>void</returnType>
    <parameters>
        <parameter>
            <name>name</name>
            <type>string</type>
            <info>The name/identifier for the new connection property.</info>
        </parameter>
        <parameter>
            <name>value</name>
            <type>string</type>
            <info>The initial value of the property.</info>
        </parameter>
    </parameters>
</method>
<method>
    <name>remove_property(name)</name>
    <description>
        <para>Remove an existing property from the connection.</para>
    </description>
    <returnType>void</returnType>
    <parameters>
        <parameter>
            <name>name</name>
            <type>string</type>
            <info>The name/identifier of the connection property that shall be removed.</info>
        </parameter>
    </parameters>
</method>
</methods>
</object>