Files
AdditionalLibs/B4A/OverlayWindow.xml

437 lines
15 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
<doclet-version-NOT-library-version>1.05</doclet-version-NOT-library-version>
<class>
<name>b4a.flm.overlaywdw.OverlayWindow</name>
<shortname>OverlayWindow</shortname>
<owner>process</owner>
<event>Touch(Action As Int, X As Float, Y As Float, ScreenX As Float, ScreenY As Float)</event>
<event>Click</event>
<event>LongClick</event>
<permission>android.permission.SYSTEM_ALERT_WINDOW</permission>
<permission>android.permission.SYSTEM_ERROR_WINDOW</permission>
<method>
<name>Initialize2</name>
<comment>Creates an empty overlay window at the specified position. The window is displayed after calling Open.
The window has a panel which can contain child views. Note that these views cannot acquire the focus.
The window can be placed or moved over the status and notification bars. Starting from Android 8 (Oreo), it always appears under critical system windows.
Width: Width of the window.
Height: Height of the window.
EventPrefix: Prefix of the Touch, Click and LongClick events.</comment>
<returntype>void</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
<parameter>
<name>EventPrefix</name>
<type>java.lang.String</type>
</parameter>
</method>
<method>
<name>SetPosition</name>
<comment></comment>
<returntype>void</returntype>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
</method>
<method>
<name>Close</name>
<comment>Closes this window. The bound buttons are removed, if any.</comment>
<returntype>void</returntype>
</method>
<method>
<name>IsInitialized</name>
<comment></comment>
<returntype>boolean</returntype>
</method>
<method>
<name>SetSize</name>
<comment></comment>
<returntype>void</returntype>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
</method>
<method>
<name>Initialize</name>
<comment>Creates an empty overlay window at the specified position. The window is displayed after calling Open.
The window has a panel which can contain child views. Note that these views cannot acquire the focus.
The window cannot be placed or moved over the status and notification bars.
Width: Width of the window.
Height: Height of the window.
EventPrefix: Prefix of the Touch, Click and LongClick events.</comment>
<returntype>void</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
<parameter>
<name>EventPrefix</name>
<type>java.lang.String</type>
</parameter>
</method>
<method>
<name>Open</name>
<comment>Opens this window. The bound buttons are added, if any.</comment>
<returntype>void</returntype>
</method>
<method>
<name>IsOpen</name>
<comment>Returns True if the window was opened by a call to Open.</comment>
<returntype>boolean</returntype>
</method>
<property>
<name>Panel</name>
<returntype>anywheresoftware.b4a.objects.PanelWrapper</returntype>
<comment>Returns the window panel.</comment>
</property>
<property>
<name>KeepScreenOn</name>
<returntype>boolean</returntype>
<parameter>
<name>KeepScreenOn</name>
<type>boolean</type>
</parameter>
<comment>Gets or sets whether the screen is kept turned on and bright as long as the window is visible. Default = False. Should be set only after the window is opened.</comment>
</property>
<property>
<name>Visible</name>
<returntype>boolean</returntype>
<parameter>
<name>Visible</name>
<type>boolean</type>
</parameter>
<comment>Gets or sets the window visibility. The bound buttons, if any, are shown or hidden accordingly.</comment>
</property>
<property>
<name>X</name>
<returntype>int</returntype>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>Y</name>
<returntype>int</returntype>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>Height</name>
<returntype>int</returntype>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>Width</name>
<returntype>int</returntype>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>TouchMode</name>
<returntype>int</returntype>
<parameter>
<name>TouchMode</name>
<type>int</type>
</parameter>
<comment>Gets or sets the touch mode (one of the TOUCH_ constants). Default = TOUCH_INSIDE. Should be set only after the window is opened.</comment>
</property>
<field>
<name>TOUCH_NONE</name>
<comment>The window does not receive touch events.</comment>
<returntype>int</returntype>
</field>
<field>
<name>TOUCH_ALL</name>
<comment>The window receives all touch events.</comment>
<returntype>int</returntype>
</field>
<field>
<name>TOUCH_INSIDE</name>
<comment>The window receives touch events inside the window.</comment>
<returntype>int</returntype>
</field>
</class>
<class>
<name>b4a.flm.overlaywdw.OverlayPermission</name>
<shortname>OverlayPermission</shortname>
<owner>process</owner>
<event>DrawPermission(Allowed As Boolean)</event>
<method>
<name>RequestPermission</name>
<comment>Requests the permission to draw overlays over applications for Android versions &gt;= 23. Returns whether a permission is required or not.</comment>
<returntype>boolean</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>EventPrefix</name>
<type>java.lang.String</type>
</parameter>
</method>
<method>
<name>IsAllowed</name>
<comment>Returns whether this application is allowed to draw overlays over applications.</comment>
<returntype>boolean</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
</method>
</class>
<class>
<name>b4a.flm.overlaywdw.OverlayButton</name>
<shortname>OverlayButton</shortname>
<owner>process</owner>
<event>Click</event>
<event>LongClick</event>
<method>
<name>Add</name>
<comment>Adds this button to the screen.</comment>
<returntype>void</returntype>
</method>
<method>
<name>IsAdded</name>
<comment>Returns True if the button was added by a call to Add (or a call to Open if bound).</comment>
<returntype>boolean</returntype>
</method>
<method>
<name>BindTo</name>
<comment>Associates this button with the given overlay window so the button is automatically added or removed when the window is opened or closed, and automatically shown or hidden according to the window visibility.</comment>
<returntype>void</returntype>
<parameter>
<name>Window</name>
<type>b4a.flm.overlaywdw.OverlayWindow</type>
</parameter>
</method>
<method>
<name>UnbindFrom</name>
<comment>Breaks the association between this button and the given overlay window.</comment>
<returntype>void</returntype>
<parameter>
<name>Window</name>
<type>b4a.flm.overlaywdw.OverlayWindow</type>
</parameter>
</method>
<method>
<name>Initialize2</name>
<comment>Creates a button at the specified position. The button is displayed after calling Add.
The button can be placed or moved over the status and notification bars. Starting from Android 8 (Oreo), it always appears under critical system windows.
Width: Width of the button.
Height: Height of the button.
EventPrefix: Prefix of the Click and LongClick events.</comment>
<returntype>void</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
<parameter>
<name>EventPrefix</name>
<type>java.lang.String</type>
</parameter>
</method>
<method>
<name>SetPosition</name>
<comment></comment>
<returntype>void</returntype>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
</method>
<method>
<name>SetStateImages</name>
<comment>Sets the images for the Up, Down and Disabled states. Pass Null if you do not want to set an image.</comment>
<returntype>void</returntype>
<parameter>
<name>Up</name>
<type>android.graphics.drawable.Drawable</type>
</parameter>
<parameter>
<name>Down</name>
<type>android.graphics.drawable.Drawable</type>
</parameter>
<parameter>
<name>Disabled</name>
<type>android.graphics.drawable.Drawable</type>
</parameter>
</method>
<method>
<name>IsInitialized</name>
<comment></comment>
<returntype>boolean</returntype>
</method>
<method>
<name>Remove</name>
<comment>Removes this button from the screen.</comment>
<returntype>void</returntype>
</method>
<method>
<name>SetSize</name>
<comment></comment>
<returntype>void</returntype>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
</method>
<method>
<name>Initialize</name>
<comment>Creates a button at the specified position. The button is displayed after calling Add.
The button cannot be placed or moved over the status and notification bars.
Width: Width of the button.
Height: Height of the button.
EventPrefix: Prefix of the Click and LongClick events.</comment>
<returntype>void</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
<parameter>
<name>EventPrefix</name>
<type>java.lang.String</type>
</parameter>
</method>
<property>
<name>Button</name>
<returntype>anywheresoftware.b4a.objects.ButtonWrapper</returntype>
<comment>Returns the wrapped button.</comment>
</property>
<property>
<name>X</name>
<returntype>int</returntype>
<parameter>
<name>X</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>Y</name>
<returntype>int</returntype>
<parameter>
<name>Y</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>Height</name>
<returntype>int</returntype>
<parameter>
<name>Height</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
<property>
<name>Width</name>
<returntype>int</returntype>
<parameter>
<name>Width</name>
<type>int</type>
</parameter>
<comment></comment>
</property>
</class>
<version>1.2</version>
<author>F.Leneuf-Magaud/Informatix</author>
</root>