| Gtk2Hs | Contents | Index

Graphics.UI.Gtk.General.Clipboard

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Contents

Detail
Class Hierarchy
Types
Constants
Methods

Description
Storing data on clipboards
Synopsis

data Clipboard
class GObjectClass o => ClipboardClass o
castToClipboard :: GObjectClass obj => obj -> Clipboard
toClipboard :: ClipboardClass o => o -> Clipboard
selectionPrimary :: SelectionTag
selectionSecondary :: SelectionTag
selectionClipboard :: SelectionTag
clipboardGet :: SelectionTag -> IO Clipboard
clipboardGetForDisplay :: Display -> SelectionTag -> IO Clipboard
clipboardGetDisplay :: ClipboardClass self => self -> IO Display
clipboardSetWithData :: ClipboardClass self => self -> [(TargetTag, InfoId)] -> (InfoId -> SelectionDataM ()) -> IO () -> IO Bool
clipboardSetWithOwner :: (ClipboardClass self, GObjectClass owner) => self -> [(TargetTag, InfoId)] -> (InfoId -> SelectionDataM ()) -> IO () -> owner -> IO Bool
clipboardGetOwner :: ClipboardClass self => self -> IO (Maybe GObject)
clipboardClear :: ClipboardClass self => self -> IO ()
clipboardSetText :: ClipboardClass self => self -> String -> IO ()
clipboardSetImage :: ClipboardClass self => self -> Pixbuf -> IO ()
clipboardRequestContents :: ClipboardClass self => self -> TargetTag -> SelectionDataM () -> IO ()
clipboardRequestText :: ClipboardClass self => self -> (Maybe String -> IO ()) -> IO ()
clipboardRequestImage :: ClipboardClass self => self -> (Maybe Pixbuf -> IO ()) -> IO ()
clipboardRequestTargets :: ClipboardClass self => self -> (Maybe [TargetTag] -> IO ()) -> IO ()
clipboardRequestRichText :: (ClipboardClass self, TextBufferClass buffer) => self -> buffer -> (Maybe (TargetTag, String) -> IO ()) -> IO ()
clipboardSetCanStore :: ClipboardClass self => self -> Maybe [(TargetTag, InfoId)] -> IO ()
clipboardStore :: ClipboardClass self => self -> IO ()

Detail

The `Clipboard` object represents a clipboard of data shared between different processes or between different widgets in the same process. Each clipboard is identified by a `SelectionTag` which itself is an `Atom`. The default clipboard corresponds to the `selectionClipboard` tag; another commonly used clipboard is the `selectionPrimary` tag, which, in X, traditionally contains the currently selected text.

To support having a number of different formats on the clipboard at the same time, the clipboard mechanism allows providing callbacks instead of the actual data. When you set the contents of the clipboard, you can either supply the data directly (via functions like `clipboardSetText`), or you can supply a callback to be called at a later time when the data is needed (via `clipboardSetWithData`). Providing a callback also avoids having to make copies of the data when it is not needed.

Setting clipboard data is done using `clipboardSetWithData` and `clipboardSetWithOwner`. Both functions are quite similar; the choice between the two depends mostly on which is more convenient in a particular situation. The former is most useful when you want to have a blob of data with callbacks to convert it into the various data types that you advertise. When the `clearFunc` you provided is called, you simply free the data blob. The latter is more useful when the contents of clipboard reflect the internal state of a `GObject` (As an example, for the `selectionPrimary` clipboard, when an entry widget provides the clipboard's contents the contents are simply the text within the selected region.) If the contents change, the entry widget can call `clipboardSetWithOwner` to update the timestamp for clipboard ownership, without having to worry about `clearFunc` being called.

Requesting the data from the clipboard is essentially asynchronous. If the contents of the clipboard are provided within the same process, then a direct function call will be made to retrieve the data, but if they are provided by another process, then the data needs to be retrieved from the other process, which may take some time. To avoid blocking the user interface, the call to request the selection, `clipboardRequestContents` takes a callback that will be called when the contents are received (or when the request fails.) If you don't want to deal with providing a separate callback, you can also use clipboardWaitForContents. What this does is run the GLib main loop recursively waiting for the contents. This can simplify the code flow, but you still have to be aware that other callbacks in your program can be called while this recursive mainloop is running.

Along with the functions to get the clipboard contents as an arbitrary data chunk, there are also functions to retrieve it as text, `clipboardRequestText` and clipboardWaitForText. These functions take care of determining which formats are advertised by the clipboard provider, asking for the clipboard in the best available format and converting the its content.

Class Hierarchy

     |  GObject
     |   +----Clipboard

Types
data Clipboard

Instances

GObjectClass Clipboard
ClipboardClass Clipboard

class GObjectClass o => ClipboardClass o

Instances

ClipboardClass Clipboard

castToClipboard :: GObjectClass obj => obj -> Clipboard
toClipboard :: ClipboardClass o => o -> Clipboard
Constants
selectionPrimary :: SelectionTag
The primary selection (the currently highlighted text in X11 that can in many applications be pasted using the middle button).
selectionSecondary :: SelectionTag
The secondary selection. Rarely used.
selectionClipboard :: SelectionTag
The modern clipboard that is filled by copy or cut commands.
Methods
clipboardGet

:: SelectionTag | `selection` - a `SelectionTag` which identifies the clipboard to use.
-> IO Clipboard | returns the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent.
Returns the clipboard object for the given selection. See `clipboardGetForDisplay` for complete details.

clipboardGetForDisplay

:: Display | `display` - the display for which the clipboard is to be retrieved or created
-> SelectionTag | `selection` - a `SelectionTag` which identifies the clipboard to use.
-> IO Clipboard | returns the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent.

Returns the clipboard object for the given selection. Cut/copy/paste menu items and keyboard shortcuts should use the default clipboard, returned by passing `selectionClipboard` for `selection`. The currently-selected object or text should be provided on the clipboard identified by `selectionPrimary`. Cut/copy/paste menu items conceptually copy the contents of the `selectionPrimary` clipboard to the default clipboard, i.e. they copy the selection to what the user sees as the clipboard.

See http://www.freedesktop.org/Standards/clipboards-spec for a detailed discussion of the `selectionClipboard` vs. `selectionPrimary` selections under the X window system. On Win32 the `selectionPrimary` clipboard is essentially ignored.

It's possible to have arbitrary named clipboards; if you do invent new clipboards, you should prefix the selection name with an underscore (because the ICCCM requires that nonstandard atoms are underscore-prefixed), and namespace it as well. For example, if your application called "Foo" has a special-purpose clipboard, you could create it using Graphics.UI.Gtk.General.Selection.atomNew "_FOO_SPECIAL_CLIPBOARD".

- Available since Gtk+ version 2.2

clipboardGetDisplay

:: ClipboardClass self |
=> self |
-> IO Display | returns the `Display` associated with `clipboard`

Gets the `Display` associated with `clipboard`

- Available since Gtk+ version 2.2

clipboardSetWithData

:: ClipboardClass self |
=> self |
-> [(TargetTag, InfoId)] | `targets` - a list containing information about the available forms for the clipboard data
-> InfoId -> SelectionDataM () | `getFunc` - function to call to get the actual clipboard data, should call Graphics.UI.Gtk.General.Selection.selectionDataSet.
-> IO () | `clearFunc` - when the clipboard contents are set again, this function will be called, and `getFunc` will not be subsequently called.
-> IO Bool | returns `True` if setting the clipboard data succeeded. If setting the clipboard data failed the provided callback functions will be ignored.
Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested.

clipboardSetWithOwner

:: (ClipboardClass self, GObjectClass owner) |
=> self |
-> [(TargetTag, InfoId)] | `targets` - a list containing information about the available forms for the clipboard data
-> InfoId -> SelectionDataM () | `getFunc` - function to call to get the actual clipboard data, should call Graphics.UI.Gtk.General.Selection.selectionDataSet.
-> IO () | `clearFunc` - when the clipboard contents are set again, this function will be called, and `getFunc` will not be subsequently called.
-> owner | `owner` - an object that "owns" the data.
-> IO Bool | returns `True` if setting the clipboard data succeeded. If setting the clipboard data failed the provided callback functions will be ignored.
Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested. The difference between this function and `clipboardSetWithData` is that a `GObject` is passed in. If this function is called repeatedly with the same `GObject` then the `clearFunc` is not called each time.

clipboardGetOwner

:: ClipboardClass self |
=> self |
-> IO (Maybe GObject) | returns the owner of the clipboard, if any; otherwise `Nothing`.
If the clipboard contents callbacks were set with `clipboardSetWithOwner`, and the `clipboardSetWithData` or `clipboardClear` has not subsequently called, returns the owner set by `clipboardSetWithOwner`.

clipboardClear :: ClipboardClass self => self -> IO ()
Clears the contents of the clipboard. Generally this should only be called between the time you call `clipboardSetWithOwner` or `clipboardSetWithData`, and when the `clearFunc` you supplied is called. Otherwise, the clipboard may be owned by someone else.
clipboardSetText

:: ClipboardClass self |
=> self |
-> String | `text` - the text to be set as clipboard content
-> IO () |
Sets the contents of the clipboard to the given UTF-8 string. Gtk+ will make a copy of the text and take responsibility for responding for requests for the text, and for converting the text into the requested format.

clipboardSetImage

:: ClipboardClass self |
=> self |
-> Pixbuf | `pixbuf` - a `Pixbuf`
-> IO () |

Sets the contents of the clipboard to the given `Pixbuf`. Gtk+ will take responsibility for responding for requests for the image, and for converting the image into the requested format.

- Available since Gtk+ version 2.6

clipboardRequestContents

:: ClipboardClass self |
=> self |
-> TargetTag | `target` - an atom representing the form into which the clipboard owner should convert the selection.
-> SelectionDataM () | `callback` - A function to call when the results are received (or the retrieval fails). If the retrieval fails, Graphics.UI.Gtk.General.Selection.selectionDataIsValid returns `False`.
-> IO () |
Requests the contents of clipboard as the given target. When the results of the result are later received the supplied callback will be called.

clipboardRequestText

:: ClipboardClass self |
=> self |
-> Maybe String -> IO () | `callback` - a function to call when the text is received, or the retrieval fails. (It will always be called one way or the other.)
-> IO () |

Requests the contents of the clipboard as text. When the text is later received, it will be converted if it is stored in a different character set if necessary, and `callback` will be called.

The `text` parameter to `callback` will contain the resulting text if the request succeeded, or `Nothing` if it failed. This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form.

clipboardRequestImage

:: ClipboardClass self |
=> self |
-> Maybe Pixbuf -> IO () | `callback` - a function to call when the image is received, or the retrieval fails. (It will always be called one way or the other.)
-> IO () |

Requests the contents of the clipboard as image. When the image is later received, it will be converted to a `Pixbuf`, and `callback` will be called.

The `pixbuf` parameter to `callback` will contain the resulting `Pixbuf` if the request succeeded, or `Nothing` if it failed. This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into an image.

- Available since Gtk+ version 2.6

clipboardRequestTargets

:: ClipboardClass self |
=> self |
-> Maybe [TargetTag] -> IO () | `callback` - a function to call when the targets are received, or the retrieval fails. (It will always be called one way or the other.)
-> IO () |

Requests the contents of the clipboard as list of supported targets. When the list is later received, `callback` will be called.

The `targets` parameter to `callback` will contain the resulting targets if the request succeeded, or `Nothing` if it failed.

- Available since Gtk+ version 2.4

clipboardRequestRichText

:: (ClipboardClass self, TextBufferClass buffer) |
=> self |
-> buffer | `buffer` - a `TextBuffer` that determines the supported rich text formats
-> Maybe (TargetTag, String) -> IO () | `callback` - a function to call when the text is received, or the retrieval fails. (It will always be called one way or the other.)
-> IO () |

Requests the contents of the clipboard as rich text. When the rich text is later received, `callback` will be called.

The `text` parameter to `callback` will contain the resulting rich text if the request succeeded, or `Nothing` if it failed. This function can fail for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into rich text form.

- Available since Gtk+ version 2.10

clipboardSetCanStore

:: ClipboardClass self |
=> self |
-> Maybe [(TargetTag, InfoId)] | `targets` - list containing information about which forms should be stored or `Nothing` to indicate that all forms should be stored.
-> IO () |

Hints that the clipboard data should be stored somewhere when the application exits or when `clipboardStore` is called.

This value is reset when the clipboard owner changes. Where the clipboard data is stored is platform dependent, see displayStoreClipboard for more information.

- Available since Gtk+ version 2.6

clipboardStore :: ClipboardClass self => self -> IO ()

Stores the current clipboard data somewhere so that it will stay around after the application has quit.

- Available since Gtk+ version 2.6

Produced by Haddock version 2.4.2