Jasima/godot-xterm
1
0
Fork 0
mirror of https://github.com/lihop/godot-xterm.git synced 2025-05-03 20:14:22 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deprecate the cols and rows properties of Terminal

Browse source 
As cols and rows are read only (i.e. automatically determined by rect
and font size) there is no need for the properties to be exposed.
Instead, users can get the calculated cols and rows using the get_cols()
and get_rows() methods.
This commit is contained in:
Leroy Hopson 2022-08-15 10:35:01 +12:00
parent f49410838c
commit 6cd5facb98
No known key found for this signature in database
GPG key ID: D2747312A6DB51AA
8 changed files with 93 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/CHANGELOG.md
View file

@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased](https://github.com/lihop/godot-xterm/compare/v2.1.1...HEAD)
### Changed
- Deprecated the `cols` and `rows` properties of Terminal.
These properties will be removed in a future version.
Please use `get_cols()` and `get_rows()` instead.
### Removed
- Dropped support for Godot version 3.3.x.

67
docs/api/terminal.md
View file

@ -47,19 +47,21 @@ For example if the string `"\u001b[38;2;0;255;0;mA"` was written to the terminal
|--------------|--------------------------------------|---------|
| [bool] | [bell_muted](#prop-bell_muted) | `false` |
| [float] | [bell_cooldown](#prop-bell_cooldown) | `0.1` |
| [int] | [cols](#prop-cols) | `2` |
| [int] | [rows](#prop-rows) | `2` |
| [int] | [cols](#prop-cols) *(deprecated)* | `2` |
| [int] | [rows](#prop-rows) *(deprecated)* | `2` |
| [UpdateMode] | [update_mode](#prop-update_mode) | `AUTO` |
## Methods
| Returns | Signature |
|----------|-----------------------------------------------------------------|
| void | [clear](#mthd-clear) **()** |
| [String] | [copy_all](#mthd-copy_all) **()** |
| [String] | [copy_selection](#mthd-copy_selection) **()** |
| void | [write](#mthd-write) **(** [String]\|[PoolByteArray] data **)** |
| Returns | Signature |
|----------|-------------------------------------------------------------------|
| void | [clear](#mthd-clear) **()** |
| [String] | [copy_all](#mthd-copy_all) **()** |
| [String] | [copy_selection](#mthd-copy_selection) **()** |
| [int] | [get_cols](#mthd-get_cols) **()** |
| [int] | [get_rows](#mthd-get_rows) **()** |
| void | [write](#mthd-write) **(** [String] \| [PoolByteArray] data **)** |
## Signals
@ -105,19 +107,6 @@ For example if the string `"\u001b[38;2;0;255;0;mA"` was written to the terminal
## Property Descriptions
- <a name="prop-rows" /> [int] **rows**
| | |
|-----------|------------|
| *Default* | `2` |
| *Setter* | None |
| *Getter* | None |
The number of rows in the terminal's rect.
When using a monospace font, this is typically the number of characters that can fit from the top to the bottom.
It will automatically update as the Control's rect_size changes, and therefore shouldn't be used to set the size of the terminal directly.
---
- <a name="prop-cols" /> [int] **cols**
@ -125,11 +114,23 @@ For example if the string `"\u001b[38;2;0;255;0;mA"` was written to the terminal
|-----------|------------|
| *Default* | `2` |
| *Setter* | None |
| *Getter* | None |
| *Getter* | get_cols() |
*Deprecated*. This property is deprecated and will be removed in a future version.
Please use [get_cols](#mthd-get_cols) instead.
---
- <a name="prop-rows" /> [int] **rows** ***Deprecated***
| | |
|-----------|------------|
| *Default* | `2` |
| *Setter* | None |
| *Getter* | get_rows() |
The number of columns in the terminal's rect.
When using a monospace font, this is typically the number of characters that can fit from one side to another.
It will automatically update as the Control's rect_size changes, and therefore shouldn't be used to set the size of the terminal directly.
*Deprecated*. This property is deprecated and will be removed in a future version.
Please use the [get_rows](#mthd-get_rows) instead.
---
@ -195,6 +196,22 @@ For example if the string `"\u001b[38;2;0;255;0;mA"` was written to the terminal
---
- <a name="mthd-get_cols" /> [int] **get_cols** **()**
Returns the width of the terminal in characters.
When using a monospace font, this is the number of visible characters that can fit from one side of the terminal to the other in a single row.
It will automatically update according to the terminal's rect_size and theme's font size.
---
- <a name="mthd-get_rows" /> [int] **get_rows** **()**
Returns the height of the terminal in characters.
When using a monospace font, this is the number of visible characters that can fit from the top of the terminal to the bottom in a single column.
It will automatically update according to the terminal's rect_size and theme's font size.
---
- <a name="mthd-write" /> void **write** **(** [String] \| [PoolByteArray] data **)**
Writes data to the terminal emulator. Accepts either a [String] or [PoolByteArray].