Clipboard

The clipboard provides a temporary memory store of data, and is typically used to allow objects such as text, images, audio, video or files to be transferred between locations or applications. The most typical way of using the clipboard involves cutting/copying and subsequently pasting in the desired location, and this is done using keyboard shortcuts or a widget such as a Button or MenuItem.

On the Linux system, there are two clipboards. The most commonly used is the standard clipboard used to store images, files, etc. in addition to text. The other is the primary which holds the currently highlighted text and is accessed by middle-clicking in the desired location.

Note

A clipboard and its associated methods are quite complex and will require good understanding of GTK+.

Constructor

The Clipboard can be constructed using the following:

clipboard = Gtk.Clipboard.get(selection)

The selection value should be set to either Gdk.SELECTION_CLIPBOARD or Gdk.SELECTION_PRIMARY. The Gdk.SELECTION_CLIPBOARD item allows content to be transferred to and from the general clipboard. Alternatively, Gdk.SELECTION_PRIMARY is used to capture content when it is highlighted.

Note

The use Gdk.SELECTION_CLIPBOARD or Gdk.SELECTION_PRIMARY, you will need to import the Gdk module before calling a Gdk constant.

Methods

To clear the current contents of the Clipboard use:

clipboard.clear()

Note

The .clear() method will clear the contents of the clipboard regardless of which application stored the data.

Setting text on the Clipboard can be achieved via:

clipboard.set_text(text, length)

The text value is the string of text which is to be stored on the clipboard. The length value allows for the number of characters to be limited. If all the content should be stored, use -1.

Images can also be stored using:

clipboard.set_image(image)

The image paramter should be a Pixbuf object representing the image.

By default, when an application closes, any data saved to the clipboard using it will be cleared. To store the data after the application closes call:

clipboard.store()

Example

Below is an example of a Clipboard:

#!/usr/bin/env python3

from gi.repository import Gtk, Gdk

class Clipboard(Gtk.Window):
    def __init__(self):
        Gtk.Window.__init__(self)
        self.connect("destroy", Gtk.main_quit)

        self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

        grid = Gtk.Grid()
        self.add(grid)

        self.entry = Gtk.Entry()
        grid.attach(self.entry, 0, 0, 1, 1)

        buttonCutText = Gtk.Button(label="Cut Text")
        buttonCutText.connect("clicked", self.on_copy_text, "cut")
        grid.attach(buttonCutText, 1, 0, 1, 1)

        buttonCopyText = Gtk.Button(label="Copy Text")
        buttonCopyText.connect("clicked", self.on_copy_text, "copy")
        grid.attach(buttonCopyText, 2, 0, 1, 1)

        buttonPasteText = Gtk.Button(label="Paste Text")
        buttonPasteText.connect("clicked", self.on_paste_text)
        grid.attach(buttonPasteText, 3, 0, 1, 1)

    def on_copy_text(self, button, action):
        content = self.entry.get_text()

        if action == "cut":
            self.entry.set_text("")

        self.clipboard.set_text(content, -1)

    def on_paste_text(self, button):
        content = self.clipboard.wait_for_text()
        self.entry.set_text(content)

window = Clipboard()
window.show_all()

Gtk.main()

Download: Clipboard