Add clipboard image data get/set methods

doc/classes/DisplayServer.xml

@@ -10,38 +10,50 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="clipboard_get" qualifiers="const">
-			<return type="String" />
+		<method name="clipboard_get_image" qualifiers="const">
+			<return type="Image" />
 			<description>
-				Returns the user's clipboard as a string if possible.
+				Returns the user's clipboard as an image if possible.
 			</description>
 		</method>
 		<method name="clipboard_get_primary" qualifiers="const">
 			<return type="String" />
 			<description>
-				Returns the user's [url=https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer]primary[/url] clipboard as a string if possible. This is the clipboard that is set when the user selects text in any application, rather than when pressing [kbd]Ctrl + C[/kbd]. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism.
-				[b]Note:[/b] This method is only implemented on Linux (X11).
+				Returns the user's primary clipboard as a string if possible.
+				[b]Note:[/b] This method is only implemented on Linux.
+			</description>
+		</method>
+		<method name="clipboard_get_text" qualifiers="const">
+			<return type="String" />
+			<description>
+				Returns the user's clipboard as a string if possible.
 			</description>
 		</method>
-		<method name="clipboard_has" qualifiers="const">
+		<method name="clipboard_has_image" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if there is content on the user's clipboard.
+				Returns [code]true[/code] if there is an image content on the user's clipboard.
 			</description>
 		</method>
-		<method name="clipboard_set">
-			<return type="void" />
-			<param index="0" name="clipboard" type="String" />
+		<method name="clipboard_has_text" qualifiers="const">
+			<return type="bool" />
 			<description>
-				Sets the user's clipboard content to the given string.
+				Returns [code]true[/code] if there is a text content on the user's clipboard.
 			</description>
 		</method>
 		<method name="clipboard_set_primary">
 			<return type="void" />
-			<param index="0" name="clipboard_primary" type="String" />
+			<argument index="0" name="clipboard_primary" type="String" />
 			<description>
-				Sets the user's [url=https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer]primary[/url] clipboard content to the given string. This is the clipboard that is set when the user selects text in any application, rather than when pressing [kbd]Ctrl + C[/kbd]. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism.
-				[b]Note:[/b] This method is only implemented on Linux (X11).
+				Sets the user's primary clipboard content to the given string.
+				[b]Note:[/b] This method is only implemented on Linux.
+			</description>
+		</method>
+		<method name="clipboard_set_text">
+			<return type="void" />
+			<argument index="0" name="clipboard" type="String" />
+			<description>
+				Sets the user's clipboard content to the given string.
 			</description>
 		</method>
 		<method name="cursor_get_shape" qualifiers="const">

editor/connections_dialog.cpp

@@ -1113,7 +1113,7 @@ void ConnectionsDock::_handle_signal_menu_option(int p_option) {
 			disconnect_all_dialog->popup_centered();
 		} break;
 		case COPY_NAME: {
-			DisplayServer::get_singleton()->clipboard_set(item->get_metadata(0).operator Dictionary()["name"]);
+			DisplayServer::get_singleton()->clipboard_set_text(item->get_metadata(0).operator Dictionary()["name"]);
 		} break;
 	}
 }

editor/debugger/editor_debugger_tree.cpp

@@ -347,7 +347,7 @@ void EditorDebuggerTree::_item_menu_id_pressed(int p_option) {
 					text = text.substr(slash + 1);
 				}
 			}
-			DisplayServer::get_singleton()->clipboard_set(text);
+			DisplayServer::get_singleton()->clipboard_set_text(text);
 		} break;
 	}
 }

editor/debugger/script_editor_debugger.cpp

@@ -85,7 +85,7 @@ void ScriptEditorDebugger::debug_copy() {
 	if (msg.is_empty()) {
 		return;
 	}
-	DisplayServer::get_singleton()->clipboard_set(msg);
+	DisplayServer::get_singleton()->clipboard_set_text(msg);
 }
 
 void ScriptEditorDebugger::debug_skip_breakpoints() {
@@ -1590,7 +1590,7 @@ void ScriptEditorDebugger::_item_menu_id_pressed(int p_option) {
 				ci = ci->get_next();
 			}
 
-			DisplayServer::get_singleton()->clipboard_set(text);
+			DisplayServer::get_singleton()->clipboard_set_text(text);
 		} break;
 
 		case ACTION_OPEN_SOURCE: {

editor/editor_about.cpp

@@ -65,7 +65,7 @@ void EditorAbout::_license_tree_selected() {
 }
 
 void EditorAbout::_version_button_pressed() {
-	DisplayServer::get_singleton()->clipboard_set(version_btn->get_meta(META_TEXT_TO_COPY));
+	DisplayServer::get_singleton()->clipboard_set_text(version_btn->get_meta(META_TEXT_TO_COPY));
 }
 
 void EditorAbout::_bind_methods() {

editor/editor_inspector.cpp

@@ -957,7 +957,7 @@ void EditorProperty::menu_option(int p_option) {
 			emit_changed(property, InspectorDock::get_inspector_singleton()->get_property_clipboard());
 		} break;
 		case MENU_COPY_PROPERTY_PATH: {
-			DisplayServer::get_singleton()->clipboard_set(property_path);
+			DisplayServer::get_singleton()->clipboard_set_text(property_path);
 		} break;
 		case MENU_PIN_VALUE: {
 			emit_signal(SNAME("property_pinned"), property, !pinned);

editor/editor_log.cpp

@@ -200,7 +200,7 @@ void EditorLog::_copy_request() {
 	}
 
 	if (!text.is_empty()) {
-		DisplayServer::get_singleton()->clipboard_set(text);
+		DisplayServer::get_singleton()->clipboard_set_text(text);
 	}
 }
 

editor/editor_node.cpp

@@ -1202,7 +1202,7 @@ void EditorNode::_titlebar_resized() {
 }
 
 void EditorNode::_version_button_pressed() {
-	DisplayServer::get_singleton()->clipboard_set(version_btn->get_meta(META_TEXT_TO_COPY));
+	DisplayServer::get_singleton()->clipboard_set_text(version_btn->get_meta(META_TEXT_TO_COPY));
 }
 
 void EditorNode::_update_undo_redo_allowed() {
@@ -4465,7 +4465,7 @@ void EditorNode::show_warning(const String &p_text, const String &p_title) {
 }
 
 void EditorNode::_copy_warning(const String &p_str) {
-	DisplayServer::get_singleton()->clipboard_set(warning->get_text());
+	DisplayServer::get_singleton()->clipboard_set_text(warning->get_text());
 }
 
 void EditorNode::_dock_floating_close_request(Control *p_control) {

editor/export/export_template_manager.cpp

@@ -591,7 +591,7 @@ void ExportTemplateManager::_mirror_options_button_cbk(int p_id) {
 				return;
 			}
 
-			DisplayServer::get_singleton()->clipboard_set(mirror_url);
+			DisplayServer::get_singleton()->clipboard_set_text(mirror_url);
 		} break;
 	}
 }

editor/filesystem_dock.cpp

@@ -2098,7 +2098,7 @@ void FileSystemDock::_file_option(int p_option, const Vector<String> &p_selected
 		case FILE_COPY_PATH: {
 			if (!p_selected.is_empty()) {
 				String fpath = p_selected[0];
-				DisplayServer::get_singleton()->clipboard_set(fpath);
+				DisplayServer::get_singleton()->clipboard_set_text(fpath);
 			}
 		} break;
 
@@ -2107,7 +2107,7 @@ void FileSystemDock::_file_option(int p_option, const Vector<String> &p_selected
 				ResourceUID::ID uid = ResourceLoader::get_resource_uid(p_selected[0]);
 				if (uid != ResourceUID::INVALID_ID) {
 					String uid_string = ResourceUID::get_singleton()->id_to_text(uid);
-					DisplayServer::get_singleton()->clipboard_set(uid_string);
+					DisplayServer::get_singleton()->clipboard_set_text(uid_string);
 				}
 			}
 		} break;

editor/groups_editor.cpp

@@ -359,7 +359,7 @@ void GroupDialog::_modify_group_pressed(Object *p_item, int p_column, int p_id,
 			undo_redo->commit_action();
 		} break;
 		case COPY_GROUP: {
-			DisplayServer::get_singleton()->clipboard_set(ti->get_text(p_column));
+			DisplayServer::get_singleton()->clipboard_set_text(ti->get_text(p_column));
 		} break;
 	}
 }
@@ -705,7 +705,7 @@ void GroupsEditor::_modify_group(Object *p_item, int p_column, int p_id, MouseBu
 			undo_redo->commit_action();
 		} break;
 		case COPY_GROUP: {
-			DisplayServer::get_singleton()->clipboard_set(ti->get_text(p_column));
+			DisplayServer::get_singleton()->clipboard_set_text(ti->get_text(p_column));
 		} break;
 	}
 }

editor/gui/editor_file_dialog.cpp

@@ -688,7 +688,7 @@ void EditorFileDialog::_item_menu_id_pressed(int p_option) {
 	switch (p_option) {
 		case ITEM_MENU_COPY_PATH: {
 			Dictionary item_meta = item_list->get_item_metadata(item_list->get_current());
-			DisplayServer::get_singleton()->clipboard_set(item_meta["path"]);
+			DisplayServer::get_singleton()->clipboard_set_text(item_meta["path"]);
 		} break;
 
 		case ITEM_MENU_DELETE: {

editor/plugins/script_editor_plugin.cpp

@@ -875,7 +875,7 @@ void ScriptEditor::_copy_script_path() {
 	ScriptEditorBase *se = _get_current_editor();
 	if (se) {
 		Ref<Resource> scr = se->get_edited_resource();
-		DisplayServer::get_singleton()->clipboard_set(scr->get_path());
+		DisplayServer::get_singleton()->clipboard_set_text(scr->get_path());
 	}
 }
 

editor/project_manager.cpp

@@ -2546,7 +2546,7 @@ void ProjectManager::_open_asset_library() {
 }
 
 void ProjectManager::_version_button_pressed() {
-	DisplayServer::get_singleton()->clipboard_set(version_btn->get_text());
+	DisplayServer::get_singleton()->clipboard_set_text(version_btn->get_text());
 }
 
 ProjectManager::ProjectManager() {

editor/scene_tree_dock.cpp

@@ -974,7 +974,7 @@ void SceneTreeDock::_tool_selected(int p_tool, bool p_confirm_override) {
 				if (node) {
 					Node *root = EditorNode::get_singleton()->get_edited_scene();
 					NodePath path = root->get_path().rel_path_to(node->get_path());
-					DisplayServer::get_singleton()->clipboard_set(path);
+					DisplayServer::get_singleton()->clipboard_set_text(path);
 				}
 			}
 		} break;

modules/mono/editor/GodotTools/GodotTools/Build/BuildOutputView.cs

@@ -318,7 +318,7 @@ private void IssuesListContextOptionPressed(long id)
                     }
 
                     if (text != null)
-                        DisplayServer.ClipboardSet(text);
+                        DisplayServer.ClipboardSetText(text);
                     break;
                 }
                 default:

platform/android/display_server_android.cpp

@@ -107,36 +107,36 @@ void DisplayServerAndroid::tts_stop() {
 	TTS_Android::stop();
 }
 
-void DisplayServerAndroid::clipboard_set(const String &p_text) {
+void DisplayServerAndroid::clipboard_set_text(const String &p_text) {
 	GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
 	ERR_FAIL_NULL(godot_java);
 
 	if (godot_java->has_set_clipboard()) {
 		godot_java->set_clipboard(p_text);
 	} else {
-		DisplayServer::clipboard_set(p_text);
+		DisplayServer::clipboard_set_text(p_text);
 	}
 }
 
-String DisplayServerAndroid::clipboard_get() const {
+String DisplayServerAndroid::clipboard_get_text() const {
 	GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
 	ERR_FAIL_NULL_V(godot_java, String());
 
 	if (godot_java->has_get_clipboard()) {
 		return godot_java->get_clipboard();
 	} else {
-		return DisplayServer::clipboard_get();
+		return DisplayServer::clipboard_get_text();
 	}
 }
 
-bool DisplayServerAndroid::clipboard_has() const {
+bool DisplayServerAndroid::clipboard_has_text() const {
 	GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
 	ERR_FAIL_NULL_V(godot_java, false);
 
 	if (godot_java->has_has_clipboard()) {
 		return godot_java->has_clipboard();
 	} else {
-		return DisplayServer::clipboard_has();
+		return DisplayServer::clipboard_has_text();
 	}
 }
 

platform/android/display_server_android.h

@@ -101,9 +101,9 @@ class DisplayServerAndroid : public DisplayServer {
 	virtual void tts_resume() override;
 	virtual void tts_stop() override;
 
-	virtual void clipboard_set(const String &p_text) override;
-	virtual String clipboard_get() const override;
-	virtual bool clipboard_has() const override;
+	virtual void clipboard_set_text(const String &p_text) override;
+	virtual String clipboard_get_text() const override;
+	virtual bool clipboard_has_text() const override;
 
 	virtual TypedArray<Rect2> get_display_cutouts() const override;
 	virtual Rect2i get_display_safe_area() const override;

platform/ios/display_server_ios.h

@@ -214,8 +214,11 @@ class DisplayServerIOS : public DisplayServer {
 	void virtual_keyboard_set_height(int height);
 	virtual int virtual_keyboard_get_height() const override;
 
-	virtual void clipboard_set(const String &p_text) override;
-	virtual String clipboard_get() const override;
+	virtual void clipboard_set_text(const String &p_text) override;
+	virtual String clipboard_get_text() const override;
+	virtual Ref<Image> clipboard_get_image() const override;
+	virtual bool clipboard_has_text() const override;
+	virtual bool clipboard_has_image() const override;
 
 	virtual void screen_set_keep_on(bool p_enable) override;
 	virtual bool screen_is_kept_on() const override;

platform/ios/display_server_ios.mm

@@ -44,6 +44,8 @@
 
 #import <sys/utsname.h>
 
+#include <drivers/png/png_driver_common.h>
+
 static const float kDisplayServerIOSAcceleration = 1.f;
 
 DisplayServerIOS *DisplayServerIOS::get_singleton() {
@@ -650,16 +652,39 @@ _FORCE_INLINE_ int _convert_utf32_offset_to_utf16(const String &p_existing_text,
 	return virtual_keyboard_height;
 }
 
-void DisplayServerIOS::clipboard_set(const String &p_text) {
+void DisplayServerIOS::clipboard_set_text(const String &p_text) {
 	[UIPasteboard generalPasteboard].string = [NSString stringWithUTF8String:p_text.utf8()];
 }
 
-String DisplayServerIOS::clipboard_get() const {
+String DisplayServerIOS::clipboard_get_text() const {
 	NSString *text = [UIPasteboard generalPasteboard].string;
 
 	return String::utf8([text UTF8String]);
 }
 
+bool DisplayServerIOS::clipboard_has_text() {
+	return [UIPasteboard generalPasteboard].hasStrings;
+}
+
+Ref<Image> DisplayServerIOS::clipboard_get_image() const {
+	Ref<Image> image;
+	UIPasteboard *pasteboard = [UIPasteboard generalPasteboard];
+	if (!pasteboard.hasImages) {
+		return image;
+	}
+	UIImage *data = pasteboard.image;
+	NSData *pngData = UIImagePNGRepresentation(data);
+	image.instantiate();
+	UInt8 buf[pngData.length];
+	[pngData getBytes:buf length:pngData.length];
+	PNGDriverCommon::png_to_image(buf, pngData.length, false, image);
+	return image;
+}
+
+bool DisplayServerIOS::clipboard_has_image() {
+	return [UIPasteboard generalPasteboard].hasImages;
+}
+
 void DisplayServerIOS::screen_set_keep_on(bool p_enable) {
 	[UIApplication sharedApplication].idleTimerDisabled = p_enable;
 }

platform/linuxbsd/x11/display_server_x11.cpp

@@ -463,7 +463,7 @@ BitField<MouseButtonMask> DisplayServerX11::mouse_get_button_state() const {
 	return last_button_state;
 }
 
-void DisplayServerX11::clipboard_set(const String &p_text) {
+void DisplayServerX11::clipboard_set_text(const String &p_text) {
 	_THREAD_SAFE_METHOD_
 
 	{
@@ -644,7 +644,7 @@ String DisplayServerX11::_clipboard_get_impl(Atom p_source, Window x11_window, A
 	return ret;
 }
 
-String DisplayServerX11::_clipboard_get(Atom p_source, Window x11_window) const {
+String DisplayServerX11::_clipboard_get_text(Atom p_source, Window x11_window) const {
 	String ret;
 	Atom utf8_atom = XInternAtom(x11_display, "UTF8_STRING", True);
 	if (utf8_atom != None) {

platform/linuxbsd/x11/display_server_x11.h

@@ -300,7 +300,7 @@ class DisplayServerX11 : public DisplayServer {
 	void _update_window_mouse_passthrough(WindowID p_window);
 
 	String _clipboard_get_impl(Atom p_source, Window x11_window, Atom target) const;
-	String _clipboard_get(Atom p_source, Window x11_window) const;
+	String _clipboard_get_text(Atom p_source, Window x11_window) const;
 	void _clipboard_transfer_ownership(Atom p_source, Window x11_window) const;
 
 	bool do_mouse_warp = false;
@@ -399,8 +399,8 @@ class DisplayServerX11 : public DisplayServer {
 	virtual Point2i mouse_get_position() const override;
 	virtual BitField<MouseButtonMask> mouse_get_button_state() const override;
 
-	virtual void clipboard_set(const String &p_text) override;
-	virtual String clipboard_get() const override;
+	virtual void clipboard_set_text(const String &p_text) override;
+	virtual String clipboard_get_text() const override;
 	virtual void clipboard_set_primary(const String &p_text) override;
 	virtual String clipboard_get_primary() const override;