Difference between revisions of "Application:getClipboard"

From GiderosMobile
m (Text replacement - "</source" to "</syntaxhighlight")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
'''Available since:''' Gideros 2020.4<br/>
 
'''Available since:''' Gideros 2020.4<br/>
 
'''Class:''' [[Application]]<br/>
 
'''Class:''' [[Application]]<br/>
Line 4: Line 5:
 
=== Description ===
 
=== Description ===
 
Returns the data and its type stored in the clipboard.
 
Returns the data and its type stored in the clipboard.
<source lang="lua">
+
Note that some platforms don't support the synchronous form. On these (UWP,Html5) you'll need to provide a callback to get the function result.
 +
 
 +
<syntaxhighlight lang="lua">
 
(data) (type) = application:getClipboard(type,callback)
 
(data) (type) = application:getClipboard(type,callback)
</source>
+
</syntaxhighlight>
 +
 
 +
=== Parameters ===
 +
'''type''' (string) the mime type of data to be stored<br/>
 +
'''callback''' (function) if provided, enable the async form. The given function will be called with the results of the call<br/>
  
 
=== Return values ===
 
=== Return values ===
Line 13: Line 20:
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
application:setClipboard("Gideros rocks!")
 
application:setClipboard("Gideros rocks!")
 
local data, type = application:getClipboard()
 
local data, type = application:getClipboard()
 
print(data, type) --> Gideros rocks! text/plain
 
print(data, type) --> Gideros rocks! text/plain
</source>
+
</syntaxhighlight>
  
 
{{Application}}
 
{{Application}}

Latest revision as of 16:42, 12 July 2023

Available since: Gideros 2020.4
Class: Application

Description

Returns the data and its type stored in the clipboard. Note that some platforms don't support the synchronous form. On these (UWP,Html5) you'll need to provide a callback to get the function result.

(data) (type) = application:getClipboard(type,callback)

Parameters

type (string) the mime type of data to be stored
callback (function) if provided, enable the async form. The given function will be called with the results of the call

Return values

Returns (string) the data in the clipboard
Returns (string) the type of the data

Example

application:setClipboard("Gideros rocks!")
local data, type = application:getClipboard()
print(data, type) --> Gideros rocks!	text/plain