Files
AdditionalLibs/B4A/Dialogs2.xml

1626 lines
64 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
<doclet-version-NOT-library-version>1.07</doclet-version-NOT-library-version>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog</name>
<shortname>InputDialog</shortname>
<comment>This modal dialog allows the collection of user entered data in the form of text.
The default is free text but the input can be restricted to numeric characters only
or to signed numbers including a decimal point.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal input dialog. The Dialog_Result event will be raised.
Example: &lt;code&gt;
Dim id As InputDialog
Dim sf As Object = id.ShowAsync("", "Enter your name", "Ok", "", "Cancel", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Log(id.Input)
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>Message</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal text input dialog with the specified message and title.
Message - The dialog message.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>message</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Input</name>
<returntype>java.lang.String</returntype>
<parameter>
<name>value</name>
<type>java.lang.String</type>
</parameter>
<comment>Sets the initial text when the dialog is shown and returns the text entered by the user.</comment>
</property>
<property>
<name>HintColor</name>
<returntype>int</returntype>
<parameter>
<name>hintcolor</name>
<type>int</type>
</parameter>
<comment>Gets or sets the hint text color.</comment>
</property>
<property>
<name>InputType</name>
<returntype>int</returntype>
<parameter>
<name>inputtype</name>
<type>int</type>
</parameter>
<comment>Sets or returns the input type accepted by the input box.Possible values are:
ThisDialogName.INPUT_TYPE_INTERGER for unsigned integer numbers.
ThisDialogName.INPUT_TYPE_SIGNED_INTEGER for signed integer numbers.
ThisDialogName.INPUT_TYPE_SIGNED_DECIMAL for signed decimal numbers.
ThisDialogName.INPUT_TYPE_TEXT for free text.
ThisDialogName.INPUT_TYPE_PHONE for telephone numbers.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>Hint</name>
<returntype>java.lang.String</returntype>
<parameter>
<name>hint</name>
<type>java.lang.String</type>
</parameter>
<comment>Gets or sets the text that will appear when the dialog is empty.</comment>
</property>
<property>
<name>PasswordMode</name>
<returntype>boolean</returntype>
<parameter>
<name>value</name>
<type>boolean</type>
</parameter>
<comment>Sets or returns whether this dialog hides the actual characters entered by the user.</comment>
</property>
<field>
<name>INPUT_TYPE_SIGNED_INTEGER</name>
<comment></comment>
<returntype>int</returntype>
</field>
<field>
<name>INPUT_TYPE_NONE</name>
<comment></comment>
<returntype>int</returntype>
</field>
<field>
<name>INPUT_TYPE_TEXT</name>
<comment></comment>
<returntype>int</returntype>
</field>
<field>
<name>INPUT_TYPE_INTEGER</name>
<comment></comment>
<returntype>int</returntype>
</field>
<field>
<name>INPUT_TYPE_PHONE</name>
<comment></comment>
<returntype>int</returntype>
</field>
<field>
<name>INPUT_TYPE_SIGNED_DECIMAL</name>
<comment></comment>
<returntype>int</returntype>
</field>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.DateDialog</name>
<shortname>DateDialog</shortname>
<comment>This modal dialog allows the collection of user entered data in the form of a date.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>SetDate</name>
<comment>Sets the date values of the dialog when is intially shown.</comment>
<returntype>void</returntype>
<parameter>
<name>dayofmonth</name>
<type>int</type>
</parameter>
<parameter>
<name>month</name>
<type>int</type>
</parameter>
<parameter>
<name>year</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal date dialog. The Dialog_Result event will be raised.
Example: &lt;code&gt;
Dim dd As DateDialog
dd.DateTicks = DateTime.Now
Dim sf As Object = dd.ShowAsync("", "Select day", "Yes", "", "Cancel", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Log(DateTime.Date(dd.DateTicks))
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>Message</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal date input dialog with the specified message and title.
Message - The dialog message.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>Message</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Month</name>
<returntype>int</returntype>
<parameter>
<name>month</name>
<type>int</type>
</parameter>
<comment>Sets the month value of the dialog when is intially shown.
Returns the month value of the dialog when it is closed.</comment>
</property>
<property>
<name>Year</name>
<returntype>int</returntype>
<parameter>
<name>year</name>
<type>int</type>
</parameter>
<comment>Sets the year value of the dialog when is intially shown.
Returns the year value of the dialog when it is closed.</comment>
</property>
<property>
<name>DateTicks</name>
<returntype>long</returntype>
<parameter>
<name>ticks</name>
<type>long</type>
</parameter>
<comment>Sets the date value of the dialog when is intially shown.
Returns the date value in ticks of the dialog when it is closed.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>DayOfMonth</name>
<returntype>int</returntype>
<parameter>
<name>day</name>
<type>int</type>
</parameter>
<comment>Sets the day of month value of the dialog when is intially shown.
Returns the day of month value of the dialog when it is closed.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.TimeDialog</name>
<shortname>TimeDialog</shortname>
<comment>This modal dialog allows the collection of user entered data in the form of a time.
The time may be entered in 12 or 24 hour format as determined by the programmer.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>SetTime</name>
<comment>Sets the time values of the dialog when is intially shown.</comment>
<returntype>void</returntype>
<parameter>
<name>hour</name>
<type>int</type>
</parameter>
<parameter>
<name>minutes</name>
<type>int</type>
</parameter>
<parameter>
<name>hours24</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal time dialog. The Dialog_Result event will be raised.
Note that this dialog does not show properly in landscape orientation.
Example: &lt;code&gt;
Dim td As TimeDialog
td.TimeTicks = DateTime.Now
Dim sf As Object = td.ShowAsync("", "Select time", "Yes", "", "Cancel", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Log(DateTime.Time(td.TimeTicks))
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>Message</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal time input dialog with the specified message and title.
Message - The dialog message.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>Message</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Minute</name>
<returntype>int</returntype>
<parameter>
<name>minute</name>
<type>int</type>
</parameter>
<comment>Sets the minute value of the dialog when is intially shown.
Returns the minute value of the dialog when it is closed.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>Hour</name>
<returntype>int</returntype>
<parameter>
<name>hour</name>
<type>int</type>
</parameter>
<comment>Sets the hour value of the dialog when is intially shown.
Returns the hour value of the dialog when it is closed.</comment>
</property>
<property>
<name>TimeTicks</name>
<returntype>long</returntype>
<parameter>
<name>ticks</name>
<type>long</type>
</parameter>
<comment>Sets the time value of the dialog when is intially shown.
Returns the time value in ticks of the dialog when it is closed.</comment>
</property>
<property>
<name>Is24Hours</name>
<returntype>boolean</returntype>
<parameter>
<name>is24hours</name>
<type>boolean</type>
</parameter>
<comment>Sets or returns whether the dialog shows the time in 24 hour format.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.ColorDialog</name>
<shortname>ColorDialog</shortname>
<comment>This modal dialog allows the user to define a colour by its Red, Green and Blue components.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>ARGB</name>
<comment>Returns an integer value representing the color built from the three components and with the specified alpha value.
Alpha - A value between 0 to 255 where 0 is fully transparent and 255 is fully opaque.</comment>
<returntype>int</returntype>
<parameter>
<name>alpha</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal color dialog. The Dialog_Result event will be raised.
Example:&lt;code&gt;
Dim cd As ColorDialog
Dim sf As Object = cd.ShowAsync("Choose Color", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Activity.Color = cd.RGB
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal color dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Red</name>
<returntype>int</returntype>
<parameter>
<name>red</name>
<type>int</type>
</parameter>
<comment>Sets the value of the red component of the dialog when is intially shown.
Returns the value of the red component of the dialog when it was closed.</comment>
</property>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Blue</name>
<returntype>int</returntype>
<parameter>
<name>blue</name>
<type>int</type>
</parameter>
<comment>Sets the value of the blue component of the dialog when is intially shown.
Returns the value of the blue component of the dialog when it was closed.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>RGB</name>
<returntype>int</returntype>
<parameter>
<name>color</name>
<type>int</type>
</parameter>
<comment>Sets the value of the red, green and blue components of the dialog when is intially shown.
Returns the color of the red, green and blue components of the dialog when it was closed.
Alpha of the provided color is ignored on set and implicitly set to 255 (opaque) on get.</comment>
</property>
<property>
<name>Green</name>
<returntype>int</returntype>
<parameter>
<name>green</name>
<type>int</type>
</parameter>
<comment>Sets the value of the green component of the dialog when is intially shown.
Returns the value of the green component of the dialog when it was closed.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.ColorDialogHSV</name>
<shortname>ColorDialogHSV</shortname>
<comment>This modal dialog allows the user to define a colour by its Hue, Saturation and Value components.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>ARGB</name>
<comment>Returns an integer value representing the color built from the three components and with the specified alpha value.
Alpha - A value between 0 to 255 where 0 is fully transparent and 255 is fully opaque.</comment>
<returntype>int</returntype>
<parameter>
<name>alpha</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal color dialog. The Dialog_Result event will be raised.
Example: &lt;code&gt;
Dim hsv As ColorDialogHSV
Dim sf As Object = hsv.ShowAsync("Choose Color", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Activity.Color = hsv.RGB
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal color dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>Saturation</name>
<returntype>float</returntype>
<parameter>
<name>saturation</name>
<type>float</type>
</parameter>
<comment>Sets the value of the saturation component of the dialog when is intially shown.
Returns the value of the saturation component of the dialog when it was closed.
The range of valid numbers for saturation is 0.0 to 1.0.</comment>
</property>
<property>
<name>Value</name>
<returntype>float</returntype>
<parameter>
<name>value</name>
<type>float</type>
</parameter>
<comment>Sets the value of the value component of the dialog when is intially shown.
Returns the value of the value component of the dialog when it was closed.
The range of valid numbers for value is 0.0 to 1.0.</comment>
</property>
<property>
<name>Hue</name>
<returntype>float</returntype>
<parameter>
<name>hue</name>
<type>float</type>
</parameter>
<comment>Sets the value of the hue component of the dialog when is intially shown.
Returns the value of the hue component of the dialog when it was closed.
The range of valid numbers for hue is 0.0 to 360.0.</comment>
</property>
<property>
<name>RGB</name>
<returntype>int</returntype>
<parameter>
<name>color</name>
<type>int</type>
</parameter>
<comment>Sets the value of the red, green and blue components of the dialog when is intially shown.
Returns the color of the red, green and blue components of the dialog when it was closed.
Alpha of the provided color is ignored on set and implicitly set to 255 (opaque) on get.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.ColorPickerDialog</name>
<shortname>ColorPickerDialog</shortname>
<comment>This modal dialog allows the user to select a colour from a palette of colours.
The color may be from a standard palette in the dialog or a custom programmed palette.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>ARGB</name>
<comment>Returns an integer value representing the color built from the chosen color and with the specified alpha value.
Alpha - A value between 0 to 255 where 0 is fully transparent and 255 is fully opaque.</comment>
<returntype>int</returntype>
<parameter>
<name>alpha</name>
<type>int</type>
</parameter>
</method>
<method>
<name>GetPaletteAt</name>
<comment>Gets the value of the color at the specified index in the current palette.</comment>
<returntype>int</returntype>
<parameter>
<name>index</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal color dialog. The Dialog_Result event will be raised.
Example: &lt;code&gt;
Dim cp As ColorPickerDialog
Dim sf As Object = cp.ShowAsync("Choose Color", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Activity.Color = cp.RGB
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal color picker dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<method>
<name>ResetPalette</name>
<comment>Reset the palette of colors to the standard palette of the dialog.</comment>
<returntype>void</returntype>
</method>
<method>
<name>SetPaletteAt</name>
<comment>Sets the value of the color at the specified index in the current palette.
This allows replacing just one or two colors without defining an entire palette.</comment>
<returntype>void</returntype>
<parameter>
<name>index</name>
<type>int</type>
</parameter>
<parameter>
<name>color</name>
<type>int</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Palette</name>
<returntype>int[]</returntype>
<parameter>
<name>palette</name>
<type>int[]</type>
</parameter>
<comment>Copies the colours in the array provided to the palette of colors in the dialog.
The provided array should contain 15 colors.
Returns an integer array that is a copy of the present palette.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>RGB</name>
<returntype>int</returntype>
<parameter>
<name>color</name>
<type>int</type>
</parameter>
<comment>Sets the value of the chosen color of the dialog when is intially shown.
Returns the value of the chosen color of the dialog when it was closed.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.NumberDialog</name>
<shortname>NumberDialog</shortname>
<comment>This configurable modal dialog allows the user to enter a number.
The dialog is configurable to show any number of digits between a minimum of one and a maximum of eight.
The display of a decimal point is optional and the character displayed as the decimal indicator is configurable.
Note that the number accepted and returned by the dialog is an integer value and so may need scaling appropriately.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal number dialog. The Dialog_Result event will be raised.
Example: &lt;code&gt;
Dim nd As NumberDialog
nd.Digits = 4
Dim sf As Object = nd.ShowAsync("Select number", "Yes", "", "Cancel", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Log(nd.Number)
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal number picker dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Number</name>
<returntype>int</returntype>
<parameter>
<name>number</name>
<type>int</type>
</parameter>
<comment>Sets the number initially displayed in the dialog when it is shown.
If the number is negative and ShowSign is False then the absolute value is displayed
Gets the number entered by the user after the dialog is closed.
If ShowSign is True the sign of the number corresponds to the sign entered by the user.</comment>
</property>
<property>
<name>Decimal</name>
<returntype>int</returntype>
<parameter>
<name>digits</name>
<type>int</type>
</parameter>
<comment>Gets or sets the position of a displayed decimal point in the dialog.
Zero displays no decimals, one indicates a single decimal, and so on.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>Digits</name>
<returntype>int</returntype>
<parameter>
<name>digits</name>
<type>int</type>
</parameter>
<comment>Gets or sets the number of digits displayed in the dialog when it is open.
One is the minimum, nine is the maximum. The default is five.
If ShowSign is True then the leftmost digit will display a "+" or "-".</comment>
</property>
<property>
<name>DecimalChar</name>
<returntype>char</returntype>
<parameter>
<name>decimalchar</name>
<type>char</type>
</parameter>
<comment>Gets or sets the displayed decimal character in the dialog.
The default is ".".</comment>
</property>
<property>
<name>ShowSign</name>
<returntype>boolean</returntype>
<parameter>
<name>show</name>
<type>boolean</type>
</parameter>
<comment>Gets or sets whether the displayed number includes a sign character.
The default is False, no absolute value of the input number is displayed.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.FileDialog</name>
<shortname>FileDialog</shortname>
<comment>This modal dialog allows the user to choose a folder and choose or enter a filename.</comment>
<owner>activity</owner>
<event>Result (Result As Int)</event>
<method>
<name>ShowAsync</name>
<comment>Shows an async file dialog. Dialog_Result event will be raised.
Example:&lt;code&gt;
Dim fd As FileDialog
fd.FilePath = File.DirRootExternal
Dim sf As Object = fd.ShowAsync("Select file", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
Log("File path: " &amp; fd.FilePath)
Log("File name: " &amp; fd.ChosenName)
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>Title</name>
<type>java.lang.CharSequence</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal file dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>Title</name>
<type>java.lang.CharSequence</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>FilePath</name>
<returntype>java.lang.String</returntype>
<parameter>
<name>path</name>
<type>java.lang.String</type>
</parameter>
<comment>Sets the file path of the dialog when it is intially shown.
Returns the file path of the dialog when it is closed.
Note that setting the file path also sets ChosenName to an empty string.</comment>
</property>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>ShowOnlyFolders</name>
<returntype>boolean</returntype>
<parameter>
<name>onlyfolders</name>
<type>boolean</type>
</parameter>
<comment>Gets or sets whether to show only folders and not files in the dialog.</comment>
</property>
<property>
<name>ScrollingBackgroundColor</name>
<returntype>int</returntype>
<parameter>
<name>scrollcolor</name>
<type>int</type>
</parameter>
<comment>Gets or sets the background color that will be used while scrolling the list.
This is an optimization done to make the scrolling smoother.
Set to Colors.Transparent if the background behind the list is not solid color.
The default whatever is the default for the particular device</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
<property>
<name>FileFilter</name>
<returntype>java.lang.String</returntype>
<parameter>
<name>filetype</name>
<type>java.lang.String</type>
</parameter>
<comment>Gets or sets the filter values of the dialog.
The filter can be a single value ".txt"
The filter can also be a comma separated list of values ".jpg,.png".
Note that spaces in filter values are significant and are not ignored.
If a filename contains the text of a filter value the file will be displayed.
A value of an empty string, the default, will show all files.</comment>
</property>
<property>
<name>ChosenName</name>
<returntype>java.lang.String</returntype>
<parameter>
<name>filename</name>
<type>java.lang.String</type>
</parameter>
<comment>Sets the filename initially shown to the user.
Returns the filename entered or chosen by the user.</comment>
</property>
<property>
<name>FastScroll</name>
<returntype>boolean</returntype>
<parameter>
<name>fastscroll</name>
<type>boolean</type>
</parameter>
<comment>Gets or sets whether the fast scroll thumb is displayed by the dialog.</comment>
</property>
<field>
<name>TextSize</name>
<comment>Get or set the size of the displayed text as "scaled pixel" units.
This size is adjusted based on the current density and user font size preference.
The default value is 0, which selects the default size.</comment>
<returntype>float</returntype>
</field>
<field>
<name>TextColor</name>
<comment>Get or set the colour of the displayed text</comment>
<returntype>int</returntype>
</field>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.CustomDialog</name>
<shortname>CustomDialog</shortname>
<comment>This dialog displays a custom set of controls laid out on a Basic4android Panel.
The Panel is displayed at an absolute position and size within the dialog.
It is recommended to use CustomLayoutDialog instead.</comment>
<owner>activity</owner>
<method>
<name>AddView</name>
<comment>Adds the custom layout view, most probably a Panel, to the custom dialog.
Although named AddView to match Basic4androd syntax only one view can be added.
Adding a view replaces any existing view previously added to the dialog.</comment>
<returntype>void</returntype>
<parameter>
<name>view</name>
<type>android.view.View</type>
</parameter>
<parameter>
<name>left</name>
<type>int</type>
</parameter>
<parameter>
<name>top</name>
<type>int</type>
</parameter>
<parameter>
<name>width</name>
<type>int</type>
</parameter>
<parameter>
<name>height</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal custom dialog. The Dialog_Result event will be raised.
Example:&lt;code&gt;
Dim cd As CustomDialog
...
Dim sf As Object = cd.ShowAsync("Choose Color", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
...
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal custom dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.CustomLayoutDialog</name>
<shortname>CustomLayoutDialog</shortname>
<comment>A customisable non-modal dialog. Note that it is supported by Android 4+ (API 14+).
After ShowAsynce is called the dialog provides a Panel into which a layout may be loaded.
Alternatively views may be placed programmatically on this Panel.</comment>
<owner>activity</owner>
<event>Ready (DialogPanel As Panel)</event>
<event>Result (Result As Int)</event>
<method>
<name>GetButton</name>
<comment>Returns one of the dialogs buttons. Returns an uninitialised object if there is no such button.
ButtonType - One of the DialogResponse values.</comment>
<returntype>anywheresoftware.b4a.objects.ButtonWrapper</returntype>
<parameter>
<name>ButtonType</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Prepares the dialog. The Ready event will be raised.
Example:&lt;code&gt;
Dim cd As CustomLayoutDialog
Dim sf As Object = cd.ShowAsync("Title", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Ready (DialogPanel As Panel)
DialogPanel.LoadLayout("DialogLayout")
Wait For (sf) Dialog_Result (Result As Int)
If Result = DialogResponse.POSITIVE Then
Log("Yes!")
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>SetSize</name>
<comment>Sets the dialog size. If not called then the default size will be used.
Must be set immediately after the ShowAsync call (before the Ready event).
The actual size of the panel will be smaller, especially the height dimension.</comment>
<returntype>void</returntype>
<parameter>
<name>Width</name>
<type Pixel="true">int</type>
</parameter>
<parameter>
<name>Height</name>
<type Pixel="true">int</type>
</parameter>
</method>
<method>
<name>CloseDialog</name>
<comment>Closes the dialog and raises the Dialog_Result event.
Example: &lt;code&gt;
DetailsDialog.CloseDialog(DialogResponse.POSITIVE)&lt;/code&gt;</comment>
<returntype>void</returntype>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>Result</name>
<type>int</type>
</parameter>
</method>
</class>
<class>
<name>anywheresoftware.b4a.agraham.dialogs2.InputDialog.CustomDialog2</name>
<shortname>CustomDialog2</shortname>
<comment>This dialog displays a custom set of controls laid out on a Basic4android Panel.
The Panel will be automatically centred in the displayed dialog.
It is recommended to use CustomLayoutDialog instead.</comment>
<owner>activity</owner>
<method>
<name>AddView</name>
<comment>Adds the custom layout view, most probably a Panel, to the custom dialog.
Although named AddView to match Basic4androd syntax only one view can be added.
Adding a view replaces any existing view previously added to the dialog.</comment>
<returntype>void</returntype>
<parameter>
<name>view</name>
<type>android.view.View</type>
</parameter>
<parameter>
<name>width</name>
<type>int</type>
</parameter>
<parameter>
<name>height</name>
<type>int</type>
</parameter>
</method>
<method>
<name>ShowAsync</name>
<comment>Shows a non-modal custom dialog. The Dialog_Result event will be raised.
Example:&lt;code&gt;
Dim cd As CustomDialog2
...
Dim sf As Object = cd.ShowAsync("Choose Color", "Yes", "Cancel", "No", Null, False)
Wait For (sf) Dialog_Result(Result As Int)
If Result = DialogResponse.POSITIVE Then
...
End If&lt;/code&gt;</comment>
<returntype>java.lang.Object</returntype>
<parameter>
<name>title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
<parameter>
<name>Cancelable</name>
<type>boolean</type>
</parameter>
</method>
<method>
<name>Show</name>
<comment>Shows a modal custom dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.</comment>
<returntype>int</returntype>
<parameter>
<name>Title</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Positive</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Cancel</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>Negative</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<name>ba</name>
<type>anywheresoftware.b4a.BA</type>
</parameter>
<parameter>
<name>icon</name>
<type>android.graphics.Bitmap</type>
</parameter>
</method>
<property>
<name>Response</name>
<returntype>int</returntype>
<comment>Returns the response code that the dialog returned when it last closed.</comment>
</property>
<property>
<name>Version</name>
<returntype>double</returntype>
<comment>Returns the version of the library.</comment>
</property>
</class>
<version>1.2</version>
<comment>This library contains several modal, that is blocking, dialogs by which the user
can enter data. Presently they are an InputDialog for text, a TimeDialog for times,
a DateDialog for dates, a ColorDialog, ColoDialogHSV and a ColorPickerDialog for colors, a
NumberDialog for numbers, a FileDialog for folders and files and three CustomDialogs.
These dialogs are available in modal, that is blocking, and non-modal form except for
CustomLayoutDialog. Use Show for modal and ShowAsync for non-modal operation.
There is also a non-modal only CustomLayoutDialog available.
Android does not provide modal dialogs but a special mechanism to permit this exists
in Basic4android. The Android Activity lifetime system makes this support complicated
because Activities can be created and destroyed at will by the OS. To avoid stack
runaway on the GUI thread when an Activity is destroyed the stack must be unwound to
the lowest level. The Basic4android modal mechanism does this by closing any modal
dialog being shown and exiting the Sub that called the dialog, and any Sub that called
that Sub and so on, in order to return the main thread to the message loop. This means
that the application does not necessarily receive a return value from the dialog and has
its expected flow of execution interrupted. This will probably most often happen if the
device is rotated while a modal dialog is displayed so the Activity is destroyed and rebuilt
with a new layout.
Because this may happen unexpectedly applications, depending upon their logical structure,
may need code in the Pause and Resume Subs to deal with the fact that modal dialog closure
may not always be detected. Setting a process global when a modal dialog is shown and
clearing it when it returns with some checking code in the Resume Sub is one way of dealing
with this possibility.
The above discussion also applies the modal versions of Basic4android modal dialogs InputList,
InputMultiList, InputMap, Msgbox and Msgbox2. Non-modal version of all of these are available.</comment>
<author>Andrew Graham</author>
</root>