![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The IDeviceHandler interface provides a collection of all engine's Input and Output device methods.
All methods can be called without consideration of the availability of the device, all methods simply return zero, false or empty strings if the corresponding device is not available.
Initialize the object.
Boolean Init()
Deinitialize the object.
Boolean DeInit()
Notification of changed configuration. The notification is executed in the engine thread context if any configuration item has changed.
ConfigChanged(Murl.IAppConfiguration appConfig)
appConfig | The application configuration object. |
Check if the Input::IAccelerometerDevice is available.
Boolean IsAccelerationAvailable()
Forward to Input::Input::IAccelerometerDevice::GetAccelerationX() if control is available, otherwise 0 is returned.
Number GetAccelerationX()
Forward to Input::IAccelerometerDevice::GetAccelerationY() if control is available, otherwise 0 is returned.
Number GetAccelerationY()
Forward to Input::IAccelerometerDevice::GetAccelerationZ() if control is available, otherwise 0 is returned.
Number GetAccelerationZ()
Forward to Input::IAccelerometerDevice::GetAcceleration() if control is available, otherwise a zero vector is returned.
Murl.Math.Vector GetAcceleration()
Check if the Input::IGyroscopeDevice is available.
Boolean IsGyroscopeAvailable()
Forward to Input::IGyroscopeDevice::GetAngularVelocityX() if control is available, otherwise 0 is returned.
Number GetAngularVelocityX()
Forward to Input::IGyroscopeDevice::GetAngularVelocityY() if control is available, otherwise 0 is returned.
Number GetAngularVelocityY()
Forward to Input::IGyroscopeDevice::GetAngularVelocityZ() if control is available, otherwise 0 is returned.
Number GetAngularVelocityZ()
Forward to Input::IGyroscopeDevice::GetAngularVelocity() if control is available, otherwise a zero vector is returned.
Murl.Math.Vector GetAngularVelocity()
Check if the Input::IHeadingDevice is available.
Boolean IsHeadingAvailable()
Forward to Input::IHeadingDevice::GetMagneticFieldX() if control is available, otherwise 0 is returned.
Number GetMagneticFieldX()
Forward to Input::IHeadingDevice::GetMagneticFieldY() if control is available, otherwise 0 is returned.
Number GetMagneticFieldY()
Forward to Input::IHeadingDevice::GetMagneticFieldZ() if control is available, otherwise 0 is returned.
Number GetMagneticFieldZ()
Forward to Input::IHeadingDevice::GetMagneticField() if control is available, otherwise a zero vector is returned.
Murl.Math.Vector GetMagneticField()
Forward to Input::IHeadingDevice::GetMagneticAngle() if control is available, otherwise 0 is returned.
Number GetMagneticAngle()
Forward to Input::IHeadingDevice::GetTrueAngle() if control is available, otherwise 0 is returned.
Number GetTrueAngle()
Check if the Input::ILocationDevice is available.
Boolean IsLocationAvailable()
Forward to Input::ILocationDevice::GetLatitude() if control is available, otherwise 0 is returned.
Number GetLatitude()
Forward to Input::ILocationDevice::GetLongitude() if control is available, otherwise 0 is returned.
Number GetLongitude()
Forward to Input::ILocationDevice::GetAltitude() if control is available, otherwise 0 is returned.
Number GetAltitude()
Forward to Input::ILocationDevice::GetGeoLocation() if control is available, otherwise a zero location is returned.
Murl.Util.GeoLocation GetGeoLocation()
Forward to Input::ILocationDevice::GetVelocity() if control is available, otherwise -1 is returned.
Number GetVelocity()
Forward to Input::ILocationDevice::GetHorizontalAccuracy() if control is available, otherwise -1 is returned.
Number GetHorizontalAccuracy()
Forward to Input::ILocationDevice::GetVerticalAccuracy() if control is available, otherwise -1 is returned.
Number GetVerticalAccuracy()
Forward to Input::ILocationDevice::GetAuthorization() if control is available, otherwise IEnums::AUTHORIZATION_NOT_DETERMINED is returned.
Murl.IEnums.AuthorizationStatus GetAuthorization()
Get the number of Input::IGameControllerDevice devices. If an additional controller is connected the number of devices will increase.
Integer GetNumberOfGameControllerDevices()
Check if a game controller device is connected. If a controller is disconnected, the connected state changes to false and no more events are generated.
If another controller is connected, the controller device will be reconfigured and the connected state changes to true.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean IsGameControllerConnected(Integer deviceIndex)
deviceIndex | The zero-based index of the game controller device. |
Get the game controller player index. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Integer GetGameControllerPlayerIndex(Integer deviceIndex)
deviceIndex | The zero-based index of the game controller device. |
Get the game controller device information. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Murl.IGameControllerMapping.DeviceInfo GetGameControllerDeviceInfo(Murl.IGameControllerMapping.DeviceInfo deviceInfo, Integer deviceIndex)
deviceInfo | The device information return value. |
deviceIndex | The zero-based index of the game controller device. |
Check if a specified game controller button is available. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean IsGameControllerButtonAvailable(Murl.IEnums.GameControllerButton button, Integer deviceIndex)
button | The game controller button identifier. |
deviceIndex | The zero-based index of the game controller device. |
Check if a specified game controller button is pressed. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean IsGameControllerButtonPressed(Murl.IEnums.GameControllerButton button, Integer deviceIndex)
button | The game controller button identifier. |
deviceIndex | The zero-based index of the game controller device. |
Check if a specified game controller button was pressed in the most recent tick. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean WasGameControllerButtonPressed(Murl.IEnums.GameControllerButton button, Integer deviceIndex)
button | The game controller button identifier. |
deviceIndex | The zero-based index of the game controller device. |
Check if a specified game controller button was released in the most recent tick. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean WasGameControllerButtonReleased(Murl.IEnums.GameControllerButton button, Integer deviceIndex)
button | The game controller button identifier. |
deviceIndex | The zero-based index of the game controller device. |
Check if a specified game controller control is available. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean IsGameControllerControlAvailable(Murl.IEnums.GameControllerControl control, Integer deviceIndex)
control | The game controller control identifier. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller analog shoulder button value. The return value is in range [0.0 not pressed .. 1.0 full pressed].
Supported controls are IEnums::GAME_CONTROLLER_CONTROL_SHOULDER_L1, IEnums::GAME_CONTROLLER_CONTROL_SHOULDER_R1, IEnums::GAME_CONTROLLER_CONTROL_SHOULDER_L2 or IEnums::GAME_CONTROLLER_CONTROL_SHOULDER_R2.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Number GetGameControllerShoulder(Number value, Murl.IEnums.GameControllerControl control, Integer deviceIndex)
value | The button return value. |
control | The game controller control identifier. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller analog stick axis values. The return values are in range [-1.0 bottom/left .. 1.0 top/right].
Supported controls are IEnums::GAME_CONTROLLER_CONTROL_LEFT_STICK or IEnums::GAME_CONTROLLER_CONTROL_RIGHT_STICK.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Number, Number GetGameControllerStick(Number xAxis, Number yAxis, Murl.IEnums.GameControllerControl control, Integer deviceIndex)
xAxis | The x-axis return value. |
yAxis | The y-axis return value. |
control | The game controller control identifier. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller gravity axes values. Note that the total acceleration of the controller is equal to gravity plus acceleration.
The values are available if IsControlAvailable(IEnums::GAME_CONTROLLER_CONTROL_ACCELERATION).
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Murl.Math.Vector GetGameControllerGravity(Murl.Math.Vector gravity, Integer deviceIndex)
gravity | The gravity axes return value in meter per seconds^2. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller acceleration axes values. Note that the total acceleration of the controller is equal to gravity plus acceleration.
The values are available if IsControlAvailable(IEnums::GAME_CONTROLLER_CONTROL_ACCELERATION).
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Murl.Math.Vector GetGameControllerAcceleration(Murl.Math.Vector acceleration, Integer deviceIndex)
acceleration | The acceleration axes return value in meter per seconds^2. |
deviceIndex | The zero-based index of the game controller device. |
Set the game controller touchpad orientation enabled state. The default value for this state is false, which means that the values of the touchpad are always determined based on the controller’s portrait orientation. If the state is set to true, then the touchpad values are calculated based on its current orientation, either landscape or portrait.
Supported control is IEnums::GAME_CONTROLLER_CONTROL_TOUCH_ORIENTATION.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean SetGameControllerTouchOrientationEnabled(Boolean isEnabled, Integer deviceIndex)
isEnabled | The touchpad orientation enabled state. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller touchpad orientation enabled state. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Boolean GetGameControllerTouchOrientationEnabled(Boolean isEnabled, Integer deviceIndex)
isEnabled | The touchpad orientation enabled state return value. |
deviceIndex | The zero-based index of the game controller device. |
Set the game controller touchpad absolute enabled state. The default value for this state is false, which means that the location where the user first touches the touchpad is assumed to be the neutral (0/0) value for the touchpad. All subsequent values are calculated relative to this position until the user lifts the finger. The next time the user’s finger touches the touchpad, a new origin is chosen. If this state is set to true, then all values are calculated relative to the physical center of the touchpad.
Supported control is IEnums::GAME_CONTROLLER_CONTROL_TOUCH_ABS_REL.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean SetGameControllerTouchAbsoluteEnabled(Boolean isEnabled, Integer deviceIndex)
isEnabled | The touchpad absolute enabled state. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller touchpad absolute enabled state. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean, Boolean GetGameControllerTouchAbsoluteEnabled(Boolean isEnabled, Integer deviceIndex)
isEnabled | The touchpad absolute enabled state return value. |
deviceIndex | The zero-based index of the game controller device. |
Set a game controller vibration with a specified intensity. Supported controls are IEnums::GAME_CONTROLLER_CONTROL_VIBRATE_LOW or IEnums::GAME_CONTROLLER_CONTROL_VIBRATE_HIGH.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Boolean SetGameControllerVibration(Number intensity, Murl.IEnums.GameControllerControl control, Integer deviceIndex)
intensity | The intensity of the vibration in range [0.0 none .. 1.0 full]. |
control | The game controller control identifier. |
deviceIndex | The zero-based index of the game controller device. |
Get the game controller mapping interface. Gamecontroller mapping is supported for USB HID game controller devices only, e.g. XBox controller or iOS controllers do not support mapping and return null.
A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].
Murl.SharedPointer.IGameControllerMapping GetGameControllerMapping(Integer deviceIndex)
deviceIndex | The zero-based index of the game controller device. |
Check if the Input::IKeyboardDevice is available.
Boolean IsKeyboardAvailable()
Forward to Input::IKeyboardDevice::GetNumberOfKeys() if control is available, otherwise 0 is returned.
Integer GetNumberOfKeys()
Forward to Input::IKeyboardDevice::GetKey() if control is available, otherwise an empty string is returned.
Forward to Input::IKeyboardDevice::GetKeys() if control is available, otherwise an empty string array is returned.
Murl.Array.String GetKeys()
Get the key code of a key pressed in the most recent tick. A valid key buffer index is [0 .. GetNumberOfKeys() - 1].
Murl.IEnums.KeyCode GetKeyCode(Integer index)
index | The zero-based index of the key buffer. |
Edit a UTF8 string using all keys pressed in the most recent tick. This method supports the IEnums::KEYCODE_BACKSPACE key to remove UTF8 characters from the end of the string.
Integer, String EditString(String editString, Integer maxLength, Boolean hideKeyboard, Murl.Graph.ITextGeometry textGeometry, String nonPrintableReplacement)
editString | The string to edit. |
maxLength | Maximum number of UTF8 characters to put into the string or zero for unlimited number of characters. |
hideKeyboard | If true hide the on screen keyboard if the IEnums::KEYCODE_RETURN key was pressed. |
textGeometry | A textgeometry node to add printable characters only. |
nonPrintableReplacement | If a text geometry node is given, any non-printable characters are replaced by this string if it is not empty. |
Check if the Input::IMotionDevice is available.
Boolean IsMotionAvailable()
Forward to Input::IMotionDevice::IsShaken() if control is available, otherwise false is returned.
Boolean IsShaken()
Forward to Input::IMotionDevice::WasShaken() if control is available, otherwise false is returned.
Boolean WasShaken()
Check if the Input::IMouseDevice is available.
Boolean IsMouseAvailable()
Forward to Input::IMouseDevice::WasMoved() if control is available, otherwise false is returned.
Boolean WasMouseMoved()
Get the mouse position on the display surface. The return values are in range [-1.0 bottom/left .. 1.0 top/right].
Boolean, Number, Number GetMousePosition(Number x, Number y)
x | The x-position return value. |
y | The y-position return value. |
Check if the mouse position is in range of the display surface. If the mouse cursor is moved out of the display surface (e.g. the window), the mouse positions are clipped to range [-1.0, 1.0]. This method can be used to detect this case.
Boolean IsMousePositionInRange()
Forward to Input::IMouseDevice::IsPositionXInRange() if control is available, otherwise false is returned.
Boolean IsMousePositionXInRange()
Forward to Input::IMouseDevice::IsPositionYInRange() if control is available, otherwise false is returned.
Boolean IsMousePositionYInRange()
Check if a specified mouse button is pressed.
Boolean IsMouseButtonPressed(Murl.IEnums.MouseButton button)
button | The mouse button identifier. |
Check if a specified mouse button was pressed in the most recent tick.
Boolean WasMouseButtonPressed(Murl.IEnums.MouseButton button)
button | The mouse button identifier. |
Check if a specified mouse button was released in the most recent tick.
Boolean WasMouseButtonReleased(Murl.IEnums.MouseButton button)
button | The mouse button identifier. |
Check if the Input::IOrientationDevice is available.
Boolean IsOrientationAvailable()
Forward to Input::IOrientationDevice::GetOrientation() if control is available, otherwise IEnums::SENSOR_ORIENTATION_UNKNOWN is returned.
Murl.IEnums.SensorOrientation GetOrientation()
Check if the Input::IRawButtonDevice is available.
Boolean IsRawButtonAvailable()
Forward to Input::IRawButtonDevice::IsButtonPressed() if control is available, otherwise false is returned.
Boolean IsRawButtonPressed(Murl.RawButtonCode code)
Forward to Input::IRawButtonDevice::WasButtonPressed() if control is available, otherwise false is returned.
Boolean WasRawButtonPressed(Murl.RawButtonCode code)
Forward to Input::IRawButtonDevice::WasButtonReleased() if control is available, otherwise false is returned.
Boolean WasRawButtonReleased(Murl.RawButtonCode code)
Check if the Input::IRawKeyboardDevice is available.
Boolean IsRawKeyboardAvailable()
Forward to Input::IRawKeyboardDevice::IsKeyPressed() if control is available, otherwise false is returned.
Boolean IsRawKeyPressed(Murl.RawKeyCode code)
Forward to Input::IRawKeyboardDevice::WasKeyPressed() if control is available, otherwise false is returned.
Boolean WasRawKeyPressed(Murl.RawKeyCode code)
Forward to Input::IRawKeyboardDevice::WasKeyReleased() if control is available, otherwise false is returned.
Boolean WasRawKeyReleased(Murl.RawKeyCode code)
Check if the Input::IRawMouseDevice is available.
Boolean IsRawMouseAvailable()
Get the mouse axis delta values in the most recent tick.
Boolean, Number, Number GetRawMouseDelta(Number x, Number y)
x | The x-axis return value. |
y | The y-axis return value. |
Get the mouse wheel axis delta values in the most recent tick.
Boolean, Number, Number GetRawWheelDelta(Number x, Number y)
x | The x-axis return value. |
y | The y-axis return value. |
Get the number of Input::ITouchScreenDevice devices. Multi touch devices represents each single touch by a separate device.
Integer GetNumberOfTouchDevices()
Check if the touch is pressed. A valid device index is [0 .. GetNumberOfTouchDevices() - 1].
Boolean IsTouchPressed(Integer deviceIndex)
deviceIndex | The zero-based index of the touch device. |
Check if the touch was cancelled in the most recent tick. A touch controller typically cancel multi touch inputs if too much simultaneous touches are present. A valid device index is [0 .. GetNumberOfTouchDevices() - 1].
Boolean WasTouchCancelled(Integer deviceIndex)
deviceIndex | The zero-based index of the touch device. |
Check if the touch was pressed in the most recent tick. A valid device index is [0 .. GetNumberOfTouchDevices() - 1].
Boolean WasTouchPressed(Integer deviceIndex)
deviceIndex | The zero-based index of the touch device. |
Check if the touch was released in the most recent tick. A valid device index is [0 .. GetNumberOfTouchDevices() - 1].
Boolean WasTouchReleased(Integer deviceIndex)
deviceIndex | The zero-based index of the touch device. |
Check if the touch was moved in the most recent tick. A valid device index is [0 .. GetNumberOfTouchDevices() - 1].
Boolean WasTouchMoved(Integer deviceIndex)
deviceIndex | The zero-based index of the touch device. |
Get the touch position on the display surface. The return values are in range [-1.0 bottom/left .. 1.0 top/right]. A valid device index is [0 .. GetNumberOfTouchDevices() - 1].
Boolean, Number, Number GetTouchPosition(Number x, Number y, Integer deviceIndex)
x | The x-position return value. |
y | The y-position return value. |
deviceIndex | The zero-based index of the touch device. |
Check if the keyboard control is available.
Boolean IsKeyboardControlAvailable()
Get the keyboard control interface. Use this interface to use on-screen keyboard with text fields.
Murl.IKeyboardControl GetKeyboardControl()
Forward to IKeyboardControl::SetKeyboardType() if control is available.
SetKeyboardType(Murl.IKeyboardControl.KeyboardType keyboardType)
Forward to IKeyboardControl::SetReturnKeyType() if control is available.
SetReturnKeyType(Murl.IKeyboardControl.ReturnKeyType returnKeyType)
Forward to IKeyboardControl::Show() if control is available.
ShowKeyboard()
Forward to IKeyboardControl::Hide() if control is available.
HideKeyboard()
Toggle the show/hide state of the on-screen keyboard.
Boolean ToggleKeyboard()
Forward to IKeyboardControl::IsShowing() if control is available, otherwise false is returned.
Boolean IsKeyboardShowing()
Forward to IKeyboardControl::WasClosed() if control is available, otherwise false is returned.
Boolean WasKeyboardClosed()
Forward to IKeyboardControl::HasTextfield() if control is available, otherwise false is returned.
Boolean HasKeyboardTextfield()
Forward to IKeyboardControl::SetTitle() if control is available.
SetKeyboardTitle(String title)
title | The title string. |
Forward to IKeyboardControl::SetDescription() if control is available.
SetKeyboardDescription(String description)
description | The description string. |
Forward to IKeyboardControl::SetText() if control is available.
SetKeyboardText(String text)
text | The editing string. |
Forward to IKeyboardControl::GetText() if control is available, otherwise an empty string is returned.
String GetKeyboardText()
Check if the rumble control is available.
Boolean IsRumbleControlAvailable()
Forward to IRumbleControl::Rumble() if control is available.
Rumble(Number duration)
Check if the app-store control is available.
Boolean IsAppStoreControlAvailable()
Get the app-store control interface.
Murl.IAppStoreControl GetAppStoreControl()
Forward to IAppStoreControl::GetStatus() if control is available, otherwise IAppStoreControl::STATUS_IDLE is returned.
Murl.IAppStoreControl.Status GetAppStoreStatus()
Forward to IAppStoreControl::RegisterProduct() if control is available, otherwise false is returned.
Boolean RegisterProduct(String productId, Murl.IAppStoreProduct.ProductType productType)
Forward to IAppStoreControl::ConnectToStore() if control is available, otherwise false is returned.
Boolean ConnectToStore()
Forward to IAppStoreControl::DisconnectToStore() if control is available, otherwise false is returned.
Boolean DisconnectFromStore()
Forward to IAppStoreControl::RestoreTransactions() if control is available, otherwise false is returned.
Boolean RestoreTransactions()
Forward to IAppStoreControl::GetNumberOfAvailableProducts() if control is available, otherwise 0 is returned.
Integer GetNumberOfAvailableProducts()
Forward to IAppStoreControl::GetAvailableProduct() if control is available, otherwise null is returned.
Murl.IAppStoreProduct GetAvailableProduct(Integer index)
Forward to IAppStoreControl::GetAvailableProduct() if control is available, otherwise null is returned.
Murl.IAppStoreProduct GetAvailableProduct(String productId)
Forward to IAppStoreControl::CanPurchaseProducts() if control is available, otherwise false is returned.
Boolean CanPurchaseProducts()
Forward to IAppStoreControl::PurchaseProduct() if control is available, otherwise false is returned.
Boolean PurchaseProduct(Murl.IAppStoreProduct product)
Forward to IAppStoreControl::ConsumeProduct() if control is available, otherwise false is returned.
Boolean ConsumeProduct(Murl.IAppStoreProduct product)
Forward to IAppStoreControl::ConfirmConsumedProduct() if control is available, otherwise false is returned.
Boolean ConfirmConsumedProduct(Murl.IAppStoreProduct product)
Forward to IAppStoreControl::GetLastError() if control is available, otherwise an empty string is returned.
String GetAppStoreLastError()
Forward to IAppStoreControl::ClearLastError() if control is available, otherwise false is returned.
Boolean ClearAppStoreLastError()
Check if the cloud control is available. The cloud control must be enabled during IApp::Configure() by setting IEngineConfiguration::SetCloudControlEnable().
Boolean IsCloudControlAvailable()
Get the cloud control interface. The cloud control must be enabled during IApp::Configure() by setting IEngineConfiguration::SetCloudControlEnable().
Murl.ICloudControl GetCloudControl()
Check if the game-center control is available.
Boolean IsGameCenterControlAvailable()
Get the game center control interface.
Murl.IGameCenterControl GetGameCenterControl()
Check if the system-dialog control is available.
Boolean IsSystemDialogControlAvailable()
Forward to ISystemDialogControl::CreateSystemDialog() if control is available, otherwise null is returned.
Murl.ISystemDialog CreateSystemDialog(String title, String message)
Create a system-dialog object with 1 button.
Murl.ISystemDialog CreateSystemDialog(String title, String message, String button0Label)
title | The title string for the system-dialog object. |
message | The message string for the system-dialog object. |
button0Label | The button label string for the system-dialog object. |
Create a system-dialog object with 2 buttons. Button appearance is right to left or bottom up.
Murl.ISystemDialog CreateSystemDialog(String title, String message, String button0Label, String button1Label)
title | The title string for the system-dialog object. |
message | The message string for the system-dialog object. |
button0Label | The 1st button label string for the system-dialog object. |
button1Label | The 2nd button label string for the system-dialog object. |
Create a system-dialog object with 3 buttons. Button appearance is right to left or bottom up.
Murl.ISystemDialog CreateSystemDialog(String title, String message, String button0Label, String button1Label, String button2Label)
title | The title string for the system-dialog object. |
message | The message string for the system-dialog object. |
button0Label | The 1st button label string for the system-dialog object. |
button1Label | The 2nd button label string for the system-dialog object. |
button2Label | The 3rd button label string for the system-dialog object. |
Create a system-dialog object with a variable number of buttons. Button appearance is right to left or bottom up.
Murl.ISystemDialog CreateSystemDialog(String title, String message, Murl.Array.String buttonLabels)
title | The title string for the system-dialog object. |
message | The message string for the system-dialog object. |
buttonLabels | The button label strings for the system-dialog object. |
Forward to ISystemDialogControl::DestroySystemDialog() if control is available.
Murl.ISystemDialog DestroySystemDialog(Murl.ISystemDialog dialog)
Check if the web control is available.
Boolean IsWebControlAvailable()
Forward to IWebControl::OpenUrlInSystemBrowser() if control is available, otherwise false is returned.
Boolean OpenUrlInSystemBrowser(String url)
Forward to IWebControl::CreateUrlRequest() if control is available, otherwise null is returned.
Murl.IUrlRequest CreateUrlRequest()
Forward to IWebControl::DestroyUrlRequest() if control is available.
Murl.IUrlRequest DestroyUrlRequest(Murl.IUrlRequest urlRequest)
Forward to IWebControl::CreateEMail() if control is available, otherwise null is returned.
Murl.IEMail CreateEMail(String subject, String message)
Forward to IWebControl::CreateEMail() if control is available, otherwise null is returned.
Murl.IEMail CreateEMail(String subject, String message, String recipientAddress)
Forward to IWebControl::DestroyEMail() if control is available.
Murl.IEMail DestroyEMail(Murl.IEMail eMail)
Check if the screen-shot control is available.
Boolean IsScreenshotControlAvailable()
Forward to IScreenshotControl::CreateScreenshot() if control is available, otherwise false is returned.
Boolean CreateScreenshot()
Forward to IScreenshotControl::DestroyScreenshot() if control is available, otherwise false is returned.
Boolean DestroyScreenshot()
Forward to IScreenshotControl::IsBusy() if control is available, otherwise false is returned.
Boolean IsScreenshotBusy()
Forward to IScreenshotControl::IsReady() if control is available, otherwise false is returned.
Boolean IsScreenshotReady()
Forward to IScreenshotControl::GetScreenshotImage() if control is available, otherwise null is returned.
Murl.Resource.IImage GetScreenshotImage()
Check if the preferences control is available.
Boolean IsPreferencesControlAvailable()
Get the preferences control interface.
Murl.IPreferencesControl GetPreferencesControl()
Forward to IPreferencesControl::Exists() if control is available, otherwise false is returned.
Boolean PreferenceExists(String key)
Forward to IPreferencesControl::GetValue(const String& key) if control is available, otherwise an empty string is returned.
String GetPreferenceValue(String key)
Forward to IPreferencesControl::GetValue(const String& key, String& value) if control is available, otherwise false is returned.
Boolean, String GetPreferenceValue(String key, String value)
Forward to IPreferencesControl::SetValue() if control is available, otherwise false is returned.
Boolean SetPreferenceValue(String key, String value)
Forward to IPreferencesControl::GetData() if control is available, otherwise false is returned.
Boolean, Murl.Data GetPreferenceData(String key, Murl.Data value)
Forward to IPreferencesControl::SetData() if control is available, otherwise false is returned.
Boolean SetPreferenceData(String key, Murl.Data value)
Forward to IPreferencesControl::Remove() if control is available, otherwise false is returned.
Boolean PreferenceRemove(String key)
Check if the telephony control is available.
Boolean IsTelephonyControlAvailable()
Forward to ITelephonyControl::GetCarrierName() if control is available, otherwise an empty string is returned.
String GetTelephonyCarrierName()
Forward to ITelephonyControl::GetCountryCode() if control is available, otherwise an empty string is returned.
String GetTelephonyCountryCode()
Forward to ITelephonyControl::GetNetworkCode() if control is available, otherwise an empty string is returned.
String GetTelephonyNetworkCode()
Forward to IAppControl::TerminateApp() if control is available, otherwise false is returned.
Boolean TerminateApp()
Forward to IAppControl::IsTerminateApp() if control is available, otherwise false is returned.
Boolean IsTerminateApp()
Forward to IAppControl::SetLoadingProgress() if control is available, otherwise false is returned.
Boolean SetLoadingProgress(Number progress)
Forward to IAppControl::GetLoadingProgress() if control is available, otherwise 0.0 is returned.
Number GetLoadingProgress()
Check if the music player control is available.
Boolean IsMusicPlayerControlAvailable()
Get the music player control interface.
Murl.IMusicPlayerControl GetMusicPlayerControl()
Get the virtual-mouse device object.
Murl.IVirtualMouse GetVirtualMouse()
Get the input devicehandler object.
Murl.Input.IDeviceHandler GetInputDeviceHandler()
Get the output devicehandler object.
Murl.Output.IDeviceHandler GetOutputDeviceHandler()