Updated documentation about intercepting keyboard events. Resolves #699

pull/711/head
Oliver 2 years ago
parent 8e58f395ad
commit 96063d6082

@ -182,12 +182,8 @@ func (b *Box) InputHandler() func(event *tcell.EventKey, setFocus func(p Primiti
//
// Providing a nil handler will remove a previously existing handler.
//
// Note that this function will not have an effect on primitives composed of
// other primitives, such as Form, Flex, or Grid. Key events are only captured
// by the primitives that have focus (e.g. InputField) and only one primitive
// can have focus at a time. Composing primitives such as Form pass the focus on
// to their contained primitives and thus never receive any key events
// themselves. Therefore, they cannot intercept key events.
// This function can also be used on container primitives (like Flex, Grid, or
// Form) as keyboard events will be handed down until they are handled.
func (b *Box) SetInputCapture(capture func(event *tcell.EventKey) *tcell.EventKey) *Box {
b.inputCapture = capture
return b

Loading…
Cancel
Save