# Copyright (C) 2011 Chris Dekter
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
GtkClipboard Functions
"""
from gi.repository import Gtk, Gdk
from pathlib import Path
[docs]class GtkClipboard:
"""
Read/write access to the X selection and clipboard - GTK version
"""
def __init__(self, app):
"""
Initialize the Gtk version of the Clipboard
Usage: Called when GtkClipboard is imported
@param app: refers to the application instance
"""
self.clipBoard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
"""
Refers to the data contained in the Gtk Clipboard (conventional clipboard)
"""
self.selection = Gtk.Clipboard.get(Gdk.SELECTION_PRIMARY)
"""
Refers to the selection of the clipboard or the highlighted text
"""
self.app = app
"""
Refers to the application instance
"""
[docs] def fill_selection(self, contents):
"""
Copy text into the selection
Usage: C{clipboard.fill_selection(contents)}
@param contents: string to be placed in the selection
"""
#self.__execAsync(self.__fillSelection, contents)
self.__fillSelection(contents)
def __fillSelection(self, string):
"""
Backend for the C{fill_selection} method
Sets the selection text to the C{string} value
@param string: Value to change the selection to
"""
Gdk.threads_enter()
self.selection.set_text(string, -1)
Gdk.threads_leave()
#self.sem.release()
[docs] def get_selection(self):
"""
Read text from the selection
Refers to the currently-highlighted text
Usage: C{clipboard.get_selection()}
@return: text contents of the selection
@rtype: C{str}
@raise Exception: if no text was found in the selection
"""
Gdk.threads_enter()
text = self.selection.wait_for_text()
Gdk.threads_leave()
if text is not None:
return text
else:
raise Exception("No text found in X selection")
[docs] def fill_clipboard(self, contents):
"""
Copy text into the clipboard
Usage: C{clipboard.fill_clipboard(contents)}
@param contents: string to be placed onto the clipboard
"""
Gdk.threads_enter()
if Gtk.get_major_version() >= 3:
self.clipBoard.set_text(contents, -1)
else:
self.clipBoard.set_text(contents)
Gdk.threads_leave()
[docs] def get_clipboard(self):
"""
Read text from the clipboard
Usage: C{clipboard.get_clipboard()}
@return: text contents of the clipboard
@rtype: C{str}
@raise Exception: if no text was found on the clipboard
"""
Gdk.threads_enter()
text = self.clipBoard.wait_for_text()
Gdk.threads_leave()
if text is not None:
return text
else:
raise Exception("No text found on clipboard")
[docs] def set_clipboard_image(self, path):
"""
Set clipboard to image
Usage: C{clipboard.set_clipboard_image(path)}
@param path: path to image file
@raise OSError: if path does not exist
"""
image_path = Path(path).expanduser()
if image_path.exists():
Gdk.threads_enter()
copied_image = Gtk.Image.new_from_file(str(image_path))
self.clipBoard.set_image(copied_image.get_pixbuf())
Gdk.threads_leave()
else:
raise OSError("Image file not found")