Nasal library/clipboard

This page contains documentation for the clipboard namespace in Nasal. This namespace provides functions for working with text stored in the clipboard . The clipboard namespace is implemented in flightgear/src/Scripting/NasalClipboard.cxx. There are also several files in the Scripting folder that implement the backend depending on the OS.

Tip  Copy & paste the examples into your Nasal Console and execute them to see what they do.

Functions

getText()

clipboard.getText([type]);

Source

Returns the contents of the clipboard as a string.

type

Optional argument that specifies the source of the text. If clipboard.CLIPBOARD (the default) is given, the contents of the clipboard are returned. If clipboard.SELECTION is given, the contents of the selection buffer are given. Note that only X11 systems properly implement clipboard.SELECTION, but this argument may still be used with setText() (see example 2).

Examples

var text = clipboard.getText(); # make sure you copy some text first
print("'", text, "'");

clipboard.setText("Demo", clipboard.SELECTION);
var text = clipboard.getText(clipboard.SELECTION);
print("'", text, "'"); # prints 'Demo'

setText()

clipboard.setText(text[, type]);

Source

Sets the contents of the clipboard. If the operation is successful, 1 (true) is returned, otherwise 0 (false) is returned.

text

A string that will be put into the clipboard.

type

Optional argument that specifies into which part of the clipboard the text should be put. If clipboard.CLIPBOARD (the default) is given, it will go to the normal clipboard. If clipboard.SELECTION is given, the text will be added to the selection buffer. Note that only X11 systems properly implement clipboard.SELECTION, but this argument may still be used with setText() (see example 2).

Examples

clipboard.setText("Demo");
print("'", clipboard.getText(), "'"); # prints 'Demo'

clipboard.setText("Demo", clipboard.SELECTION);
print("'", clipboard.getText(clipboard.SELECTION), "'"); # prints 'Demo'