2021-01-19 09:20:52 +00:00
|
|
|
---
|
|
|
|
module: [kind=event] term_resize
|
|
|
|
---
|
|
|
|
|
2023-03-15 21:52:13 +00:00
|
|
|
<!--
|
|
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
|
|
|
|
SPDX-License-Identifier: LicenseRef-CCPL
|
|
|
|
-->
|
|
|
|
|
2021-12-31 18:12:26 +00:00
|
|
|
The @{term_resize} event is fired when the main terminal is resized. For instance:
|
|
|
|
- When a the tab bar is shown or hidden in @{multishell}.
|
|
|
|
- When the terminal is redirected to a monitor via the "monitor" program and the monitor is resized.
|
|
|
|
|
|
|
|
When this event fires, some parts of the terminal may have been moved or deleted. Simple terminal programs (those
|
|
|
|
not using @{term.setCursorPos}) can ignore this event, but more complex GUI programs should redraw the entire screen.
|
2021-01-19 09:20:52 +00:00
|
|
|
|
2023-01-17 21:17:47 +00:00
|
|
|
## Return values
|
|
|
|
1. @{string}: The event name.
|
|
|
|
|
2021-01-19 09:20:52 +00:00
|
|
|
## Example
|
2023-01-16 22:53:58 +00:00
|
|
|
Print a message each time the terminal is resized.
|
|
|
|
|
2021-01-19 09:20:52 +00:00
|
|
|
```lua
|
|
|
|
while true do
|
|
|
|
os.pullEvent("term_resize")
|
|
|
|
local w, h = term.getSize()
|
|
|
|
print("The term was resized to (" .. w .. ", " .. h .. ")")
|
|
|
|
end
|
|
|
|
```
|