glok-core/uk.co.nickthecoder.glok.action/Command

Command

class Command(val commands: Commands, val name: String, text: String, keyCombination: KeyCombination? = null, var tooltip: String? = null)

Command defines an instruction from the user to the program, such a saving the current document. It does NOT define HOW that instruction is performed, that is the job of Action.

An Command defines the text, icon and keyCombination (AKA keyboard shortcut). Actions are grouped using the Commands class.

Constructors

Command

constructor(commands: Commands, name: String, text: String, keyCombination: KeyCombination? = null, tooltip: String? = null)

Properties

additionalKeyCombinations

val additionalKeyCombinations: MutableList<KeyCombination>

Additional key combinations which are not displayed in tooltips, nor in menu items.

alternateIconName

var alternateIconName: String?

commands

val commands: Commands

iconName

var iconName: String

keyCombination

var keyCombination: KeyCombination?

keyCombinationProperty

val keyCombinationProperty: OptionalKeyCombinationProperty

name

val name: String

text

var text: String

textProperty

val textProperty: StringProperty

The text that will appear in buttons / menu items

tinted

var tinted: Boolean

For monochrome icons, which must be tinted with the fontColor.

tooltip

var tooltip: String?

Functions

add

fun add(vararg keyCombinations: KeyCombination)

matches

fun matches(event: KeyEvent): Boolean

toString

open override fun toString(): String