summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-04-27 07:55:33 +0200
committerGitHub <noreply@github.com>2022-04-27 07:55:33 +0200
commit8121db871ad038444bd77ef2918cfc5b731e45f3 (patch)
tree0b50593cd1074ae958514abd6feb43d5307503ba /doc/classes/OS.xml
parent14caf9ee73e10ac857021538be356dbc84993411 (diff)
parentb80e52f04899d28ea191ce3eaad9fdb76bc11b52 (diff)
Merge pull request #60542 from KoBeWi/garbage
Expose `move_to_trash()`
Diffstat (limited to 'doc/classes/OS.xml')
-rw-r--r--doc/classes/OS.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index b2e325d226..f45bee4db4 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -455,6 +455,14 @@
[b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows.
</description>
</method>
+ <method name="move_to_trash" qualifiers="const">
+ <return type="int" enum="Error" />
+ <argument index="0" name="path" type="String" />
+ <description>
+ Moves the file or directory to the system's recycle bin. See also [method Directory.remove].
+ [b]Note:[/b] If the user has disabled the recycle bin on their system, the file will be permanently deleted instead.
+ </description>
+ </method>
<method name="open_midi_inputs">
<return type="void" />
<description>