AdditionalLibs/B4A/LiveWallpaper.xml

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <doclet-version-NOT-library-version>1.02</doclet-version-NOT-library-version>
    <class>
        <name>anywheresoftware.b4a.objects.WallpaperInternalService.LWManager</name>
        <shortname>LWManager</shortname>
        <comment>Manages the wallpaper events and the timer.
A tutorial is available &lt;link&gt;here|http://www.basic4ppc.com/forum/basic4android-getting-started-tutorials/12605-android-live-wallpaper-tutorial.html&lt;/link&gt;.</comment>
        <owner>process</owner>
        <event>SizeChanged (Engine As LWEngine)</event>
        <event>Touch (Engine As LWEngine, Action As Int, X As Float, Y As Float)</event>
        <event>VisibilityChanged (Engine As LWEngine, Visible As Boolean)</event>
        <event>EngineDestroyed (Engine As LWEngine)</event>
        <event>Tick (Engine As LWEngine)</event>
        <event>OffsetChanged (Engine As LWEngine)</event>
        <method>
            <name>Initialize</name>
            <comment>Initializes the object.
EventName - Sets the Subs that will handle the events.
TouchEventsEnabled - Whether the wallpaper should raise the Touch event when the user touches the screen.</comment>
            <returntype>void</returntype>
            <parameter>
                <name>EventName</name>
                <type>java.lang.String</type>
            </parameter>
            <parameter>
                <name>TouchEventsEnabled</name>
                <type>boolean</type>
            </parameter>
            <parameter>
                <name>ba</name>
                <type>anywheresoftware.b4a.BA</type>
            </parameter>
        </method>
        <method>
            <name>StopTicking</name>
            <comment>Stops the internal timer.</comment>
            <returntype>void</returntype>
        </method>
        <method>
            <name>StartTicking</name>
            <comment>Starts the internal timer.
IntervalMs - Interval in milliseconds.</comment>
            <returntype>void</returntype>
            <parameter>
                <name>IntervalMs</name>
                <type>int</type>
            </parameter>
        </method>
    </class>
    <class>
        <name>anywheresoftware.b4a.objects.WallpaperInternalService.LWEngine</name>
        <shortname>LWEngine</shortname>
        <comment>Represents a wallpaper instance.
A tutorial is available &lt;link&gt;here|http://www.basic4ppc.com/forum/basic4android-getting-started-tutorials/12605-android-live-wallpaper-tutorial.html&lt;/link&gt;.</comment>
        <owner>process</owner>
        <method>
            <name>RefreshAll</name>
            <comment>Refreshes the complete screen.</comment>
            <returntype>void</returntype>
        </method>
        <method>
            <name>Refresh</name>
            <comment>Refreshes the given region.</comment>
            <returntype>void</returntype>
            <parameter>
                <name>DirtyRect</name>
                <type>android.graphics.Rect</type>
            </parameter>
        </method>
        <method>
            <name>IsInitialized</name>
            <comment>Tests whether this object is initialized.</comment>
            <returntype>boolean</returntype>
        </method>
        <property>
            <name>CurrentOffsetY</name>
            <returntype>int</returntype>
            <comment>Returns the current vertical offset related to the full wallpaper height.</comment>
        </property>
        <property>
            <name>CurrentOffsetX</name>
            <returntype>int</returntype>
            <comment>Returns the current horizontal offset related to the full wallpaper width.</comment>
        </property>
        <property>
            <name>FullWallpaperWidth</name>
            <returntype>int</returntype>
            <comment>Returns the full wallpaper width. A wallpaper can be made of several screens.</comment>
        </property>
        <property>
            <name>IsVisible</name>
            <returntype>boolean</returntype>
            <comment>Tests whether this wallpaper is visible.</comment>
        </property>
        <property>
            <name>ScreenHeight</name>
            <returntype>int</returntype>
            <comment>Returns the screen height.</comment>
        </property>
        <property>
            <name>Canvas</name>
            <returntype>anywheresoftware.b4a.objects.drawable.CanvasWrapper</returntype>
            <comment>Returns the canvas which is used to draw on the wallpaper.
Changes will not be visible till you call Refresh or RefreshAll.</comment>
        </property>
        <property>
            <name>IsPreview</name>
            <returntype>boolean</returntype>
            <comment>Tests whether this wallpaper is running in "preview mode".</comment>
        </property>
        <property>
            <name>FullWallpaperHeight</name>
            <returntype>int</returntype>
            <comment>Returns the full wallpaper height.</comment>
        </property>
        <property>
            <name>ScreenWidth</name>
            <returntype>int</returntype>
            <comment>Returns the screen width.</comment>
        </property>
        <field>
            <name>Rect</name>
            <comment>A convenient Rect object which you can use. This object is not used internally.</comment>
            <returntype>anywheresoftware.b4a.objects.drawable.CanvasWrapper.RectWrapper</returntype>
        </field>
        <field>
            <name>Tag</name>
            <comment>Gets or sets the Tag value. This is a place holder which can used to store additional data.</comment>
            <returntype>java.lang.Object</returntype>
        </field>
    </class>
    <version>1.01</version>
</root>