lib/com.github.mnemotechnician.mkui.windows/Window

Window

abstract class Window

A class that represents a floating on-screen window that the user can drag and interact with.

In most cases an instance of this class has to be passed to WindowManager before anything can be done with it.

Constructors

Window

fun Window()

Functions

addAction

open fun addAction(action: Action)

Applies an action to the root table.

destroy

fun destroy()

Destroys this window, removing it from the scene and triggering onDestroy.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

onCreate

abstract fun onCreate()

Called when the window is being created.

onDestroy

open fun onDestroy()

Called when the window is being destroyed. Usually this means that the user has closed the window.

onDrag

open fun onDrag()

Called when the window is being dragged by the user.

onFullScreen

open fun onFullScreen(fullscreen: Boolean)

Called whenever the user switches between full screen and normal mode

onToggle

open fun onToggle(collapsed: Boolean)

Called whenever this window is being toggled by the user

onUpdate

open fun onUpdate()

This function is called on every tick after creating the table.

shrink

open fun shrink()

Shrinks the root table of this window, reducing it's size to the minimum preferred size.

toString

open override fun toString(): String

Properties

closeable

abstract val closeable: Boolean

Whether this window can be closed by the user. Should be overriden.

fullScreen

var fullScreen: Boolean = false

Whether the window is in the full screen mode. Modifying this property triggers onFullScreen.

isCollapsed

var isCollapsed: Boolean = false

Whether this window is collapsed. Modifying this property triggers onToggle.

isDragged

var isDragged: Boolean = false

Whether the window is being dragged by the user right now

name

abstract val name: String

Name of this window, displayed in the top bar. Should be overriden.

supportsFullScreen

open val supportsFullScreen: Boolean

Whether this window supports full screen mode. Can be overriden. Currently broken, should not be used.

table

lateinit var table: Table

The table this window is assigned to. Initialized when the window is created.