gh-pages / com.nextfaze.devfun.overlay / OverlayWindow

OverlayWindow

interface OverlayWindow (source)

Overlay windows are used by DevFun to display the loggers DeveloperLogger and DevMenu cog.

See Also

OverlayPermissions

Properties

Name	Summary
configurationOptions	`abstract val configurationOptions:` `List<UiField<*>>` Configuration options for this overlay.
enabled	`abstract var enabled:` `Boolean` If the overlay is enabled. Setting to false will hide it (but not remove it from the window).
hideWhenDialogsPresent	`abstract var hideWhenDialogsPresent:` `Boolean` If disabled this overlay will be visible when dialogs are visible (i.e. when DevMenu opens if `true` (default) this overlay will be hidden).
inset	`abstract var inset:` `Rect` Insets the overlay window. For a docked window, a pos
isVisible	`abstract val isVisible:` `Boolean` Flag indicating if the overlay is currently visible.
name	`abstract val name:` `String` User-friendly name.
onAttachListener	`abstract var onAttachListener:` `AttachListener?` Callback when overlay is added/removed to the window.
onClickListener	`abstract var onClickListener:` `ClickListener?` Callback when user taps the overlay.
onLongClickListener	`abstract var onLongClickListener:` `ClickListener?` Callback when user long-presses the overlay (defaults to showing overlay config dialog).
onVisibilityListener	`abstract var onVisibilityListener:` `VisibilityListener?` Callback when overlay visibility changes.
prefsName	`abstract val prefsName:` `String` Preferences file name to store non-default state - must be unique.
reason	`abstract val reason:` `OverlayReason` Rendered only if the user has not granted overlay permissions.
snapToEdge	`abstract var snapToEdge:` `Boolean` If enabled the overlay will snap to the closest edge of the window. If disabled it can be moved anywhere and will only snap if it leaves the windows’s display bounds.
view	`abstract val view:` `View` The overlay’s view.
visibilityScope	`abstract var visibilityScope:` `VisibilityScope` Determines when the overlay can be visible.

Functions

Name	Summary
addToWindow	`abstract fun addToWindow():` `Unit` Add this overlay to the window.
dispose	`abstract fun dispose():` `Unit` Clean up listeners and callbacks of this window.
removeFromWindow	`abstract fun removeFromWindow():` `Unit` Remove this overlay from the window.
resetPositionAndState	`abstract fun resetPositionAndState():` `Unit` Reset the position and state to its initial default values and clear its preferences.