Nasal library/clipboard: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) m (Change Template:Flightgear file to Template:Flightgear source) |
Red Leader (talk | contribs) (Doc setText()) |
||
(One intermediate revision by the same user not shown) | |||
Line 8: | Line 8: | ||
{{Nasal doc | {{Nasal doc | ||
|syntax = clipboard.getText([type]); | |syntax = clipboard.getText([type]); | ||
|source = {{flightgear source|src/Scripting/NasalClipboard.cxx|l=69|t=Source}} | |||
|text = Returns the contents of the clipboard as a string. | |text = Returns the contents of the clipboard as a string. | ||
|param1 = type | |param1 = type | ||
Line 20: | Line 20: | ||
=== setText() === | === setText() === | ||
{{Nasal doc | |||
|syntax = clipboard.setText(text[, type]); | |||
|source = {{flightgear source|src/Scripting/NasalClipboard.cxx|l=54|t=Source}} | |||
|text = Sets the contents of the clipboard. If the operation is successful, 1 (true) is returned, otherwise 0 (false) is returned. | |||
|param1 = text | |||
|param1text = A string that will be put into the clipboard. | |||
|param2 = type | |||
|param2text = Optional argument that specifies into which part of the clipboard the text should be put. If <code>clipboard.CLIPBOARD</code> (the default) is given, it will go to the normal clipboard. If <code>clipboard.SELECTION</code> is given, the text will be added to the selection buffer. Note that only X11 systems properly implement <code>clipboard.SELECTION</code>, but this argument may still be used with <code>[[#setText()|setText()]]</code> (see example 2). | |||
|example1 = clipboard.setText("Demo"); | |||
print("'", clipboard.getText(), "'"); # prints 'Demo' | |||
|example2 = clipboard.setText("Demo", clipboard.SELECTION); | |||
print("'", clipboard.getText(clipboard.SELECTION), "'"); # prints 'Demo' | |||
}} | |||
== Constants == | == Constants == |
Latest revision as of 13:05, 27 April 2018
The FlightGear forum has a subforum related to: Nasal Scripting |
Nasal scripting |
---|
Nasal internals |
---|
Memory Management (GC) |
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]);
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. Ifclipboard.SELECTION
is given, the contents of the selection buffer are given. Note that only X11 systems properly implementclipboard.SELECTION
, but this argument may still be used withsetText()
(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]);
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. Ifclipboard.SELECTION
is given, the text will be added to the selection buffer. Note that only X11 systems properly implementclipboard.SELECTION
, but this argument may still be used withsetText()
(see example 2).
Examples
clipboard.setText("Demo");
print("'", clipboard.getText(), "'"); # prints 'Demo'
clipboard.setText("Demo", clipboard.SELECTION);
print("'", clipboard.getText(clipboard.SELECTION), "'"); # prints 'Demo'