Add clipboard_has/get_image methods to DisplayServer

[deakcor]

Following proposal #2949, added

clipboard_get_image() to get image from the clipboard

clipboard_has_image() to check if the clipboard has an image. It's faster than clipboard_get_image() so It may be useful to make a check (to disable a "paste" button for example)

Override of clipboard_has(), may be faster for a huge text.

They are only implemented on Windows and MacOS. Should be added on x11 (couldn't get a working result).

Here a code to try quickly (just add a texturerect in child) :

if DisplayServer.clipboard_has():
	print("clipboard txt : ",DisplayServer.clipboard_get())
if DisplayServer.clipboard_has_image():
	print("clipboard img : ",DisplayServer.clipboard_get_image().get_data())
	$TextureRect.texture=ImageTexture.create_from_image(DisplayServer.clipboard_get_image())

Also should be nice to rename clipboard_has() to clipboard_has_text() and clipboard_get() to clipboard_get_text(). Or make Variant as result of clipboard_get() and clipboard_has() should add an optional param to indicate what type it should check.

Production edit: Closes godotengine/godot-proposals#2949.

[akien-mga]

I think that's pretty useful to support. We'll indeed need a X11 implementation too (could be in a follow-up PR if someone else wants to work on it), and assess other platforms (Android, iOS, Web).

Also should be nice to rename clipboard_has() to clipboard_has_text() and clipboard_get() to clipboard_get_text().

I agree, this should be done if this PR is accepted. That would also solve the awkwardness of clipboard_has() and clipboard_get() Yoda-speak, because then it would be more obvious that all those methods are clipboard_<method>.

There should also be support for clipboard_set_image() IMO, and clipboard_set() should be clipboard_set_text().
clipboard_set_image() could be quite convenient to let users grab a screenshot for easy sharing on social media / Discord, etc.

[deakcor]

I began to replace "clipboard" methods with "text" at the end. And I saw clipboard_set_primary and clipboard_get_primary methods, it duplicates a bit all the methods only for x11 system. I don't know if it exists for the images the primary ? But if yes it can become a bit messy.

Shouldn't be easier to add this in clipboard_set_text method ? Like clipboard_set_text(text,primary=false). So that way you can do also clipboard_has_text(primary=false) without new methods.

[m4gr3d]

I think that's pretty useful to support. We'll indeed need a X11 implementation too (could be in a follow-up PR if someone else wants to work on it), and assess other platforms (Android, iOS, Web).

Android provides the ability to copy/paste complex data structure, so this can be added as well as a follow-up PR once the initial one has landed.

[fritol]

wen in the in the main?

[Calinou]

wen in the in the main?

4.0 is in feature freeze, so this will have to wait for a future 4.x release to be merged. Also, this pull request needs to be rebased against the latest master branch first.

[Steveplays28]

Is there anything I could help with to get this merged?
Would be a really nice feature for making apps.

[Calinou]

Is there anything I could help with to get this merged? Would be a really nice feature for making apps.

4.1 is currently in feature freeze, but you can test this PR locally and make sure it works as expected. We also recommend creating a publicly accessible testing project (cc @deakcor if they still have a copy of the project). That said, this PR needs to be rebased against the latest master branch before it can be merged in a future 4.x release.

I began to replace "clipboard" methods with "text" at the end. And I saw clipboard_set_primary and clipboard_get_primary methods, it duplicates a bit all the methods only for x11 system. I don't know if it exists for the images the primary ? But if yes it can become a bit messy.

Note that this particular part of the PR needs to be reverted, as we can't break compatibility anymore now that 4.0 is released.

[deakcor]

Is there anything I could help with to get this merged? Would be a really nice feature for making apps.

4.1 is currently in feature freeze, but you can test this PR locally and make sure it works as expected. We also recommend creating a publicly accessible testing project (cc @deakcor if they still have a copy of the project). That said, this PR needs to be rebased against the latest master branch before it can be merged in a future 4.x release.

I began to replace "clipboard" methods with "text" at the end. And I saw clipboard_set_primary and clipboard_get_primary methods, it duplicates a bit all the methods only for x11 system. I don't know if it exists for the images the primary ? But if yes it can become a bit messy.

Note that this particular part of the PR needs to be reverted, as we can't break compatibility anymore now that 4.0 is released.

So I rebased and reverted the part with "_text" behind clipboard methods. If you validate the changes, let me know and I'll squash the commits into one

[akien-mga]

Looks good to me overall. The classref needs to be updated, see the diff in https://github.com/godotengine/godot/actions/runs/5513089283/jobs/10050780703?pr=63826

CC @bruvzg to review Windows and macOS implementations.

[deakcor]

Strange, the checks succeeded before I squashed the commits but normally there isn't any issue. Let me know if I need to change anything.

[bruvzg]

Strange, the checks succeeded before I squashed the commits but normally there isn't any issue. Let me know if I need to change anything.

It's not related to PR and caused by #78749, I have restarted failed job.

[YuriSizov]

Thanks! This is great! Now we just need a volunteer to implement this for Linux :)