OpenDiablo2/d2common/d2interface/input_handlers.go

package d2interface

// InputEventHandler is an event handler
type InputEventHandler interface{}

/*
	NOTE: The return values of the handler methods below are used to prevent
	other bound handlers from being called (if the handler returns `true`).
*/

// KeyDownHandler represents a handler for a keyboard key pressed event
type KeyDownHandler interface {
	OnKeyDown(event KeyEvent) (preventPropagation bool)
}

// KeyRepeatHandler represents a handler for a keyboard key held-down event; between a pressed and released.
type KeyRepeatHandler interface {
	OnKeyRepeat(event KeyEvent) (preventPropagation bool)
}

// KeyUpHandler represents a handler for a keyboard key release event
type KeyUpHandler interface {
	OnKeyUp(event KeyEvent) (preventPropagation bool)
}

// KeyCharsHandler represents a handler associated with a keyboard character pressed event
type KeyCharsHandler interface {
	OnKeyChars(event KeyCharsEvent) (preventPropagation bool)
}

// MouseButtonDownHandler represents a handler for a mouse button pressed event
type MouseButtonDownHandler interface {
	OnMouseButtonDown(event MouseEvent) (preventPropagation bool)
}

// MouseButtonRepeatHandler represents a handler for a mouse button held-down event; between a pressed and released.
type MouseButtonRepeatHandler interface {
	OnMouseButtonRepeat(event MouseEvent) (preventPropagation bool)
}

// MouseButtonUpHandler represents a handler for a mouse button release event
type MouseButtonUpHandler interface {
	OnMouseButtonUp(event MouseEvent) (preventPropagation bool)
}

// MouseMoveHandler represents a handler for a mouse button release event
type MouseMoveHandler interface {
	OnMouseMove(event MouseMoveEvent) (preventPropagation bool)
}