hiSetClipboard

hiSetClipboard(
t_text
[ s_mode ]
) 
=> t / nil

Description

Sets the text to be pushed to the system clipboard.

Arguments

t_text	The text that needs to be pushed to the clipboard.
s_mode	The clipboard buffer to inspect. Possible values are: 'selection: The UNIX middle-mouse-paste selection. 'clipboard: Copies buffer and used during the copy operation in a GUI. Default value is 'selection.

Values Returned

t	The text is pushed to the system clipboard.
nil	No text is specified as an argument.

Examples

hiGetClipboard()
=> ""   

hiSetClipboard( "text to copy" )
=> t

hiGetClipboard()
=> "text to copy"

hiGetClipboard( 'clipboard )
=> ""  ; defaults to 'selection, so 'clipboard is not set

hiSetClipboard( "some stuff for the clipboard" 'clipboard)
=> t

hiGetClipboard()
=> "text to copy"

hiGetClipboard( 'clipboard )
=> "some stuff for the clipboard"

hiGetClipboard( 'selection )
=> "text to copy"

hiClearClipboard()
=> t

hiGetClipboard()
=> ""

Related Topics

Functions of Viewfile Window

Return to top