gtk.SelectionData

gtk.SelectionData
Prev	The gtk Class Reference	Next

gtk.SelectionData — an object that stores information about a selection

Synopsis

class gtk.SelectionData(gobject.GBoxed):
    def set(type, format, data)
    def set_text(str, len)
    def get_text()
    def get_targets()
    def targets_include_text()
    def tree_set_row_drag_data(tree_model, path)
    def tree_get_row_drag_data()
    def set_pixbuf(pixbuf)
    def get_pixbuf()
    def set_uris(uris)
    def get_uris()
    def targets_include_image(writable)
    def targets_include_rich_text(buffer)
    def targets_include_uri()

Functions

    def gtk.selection_owner_set_for_display(display, widget, selection, time=0)
    def gtk.target_list_add_image_targets(list=None, info=0, writable=FALSE)
    def gtk.target_list_add_text_targets(list=None, info=0)
    def gtk.target_list_add_uri_targets(list=None, info=0)
    def gtk.target_list_add_rich_text_targets(list, info, deserializable, buffer)
    def gtk.targets_include_image(targets, writable)
    def gtk.targets_include_rich_text(targets, buffer)
    def gtk.targets_include_text(targets)
    def gtk.targets_include_uri(targets)

Attributes

"selection"	Read	A `gtk.gdk.Atom` indicating the selection type (e.g. "PRIMARY").
"target"	Read	A `gtk.gdk.Atom` indicating the selection target type (e.g. "TARGETS").
"type"	Read	A `gtk.gdk.Atom` indicating the selection data type (e.g. "STRING").
"format"	Read	The unit length of the data in bits (e.g. 8 for a string or 32 of an integer).
"data"	Read	The data as a string.

Description

A gtk.SelectionData object is used to store information about a chunk of data associated with a selection. In PyGTK the selection data is always a string so the application will have to provide functions to convert the data to and from a string to support data types other than strings and targets. The string and targets types are directly supported using the set_text(), get_text() and get_targets() methods.

Methods

gtk.SelectionData.set

    def set(type, format, data)

`type` :	a `gtk.gdk.Atom` or string that specifies a `gtk.gdk.Atom`
`format` :	the number of bits in a unit
`data` :	a string containing the data

The set() method sets the data for a selection in the gtk.SelectionData object. data is a string containing the data to be set; format is the number of bits in a unit of the data (e.g. integer data has a format of 32 on most systems; string data format is 8); and, type is a gtk.gdk.Atom or a string that specifies a gtk.gdk.Atom.

gtk.SelectionData.set_text

    def set_text(str, len)

`str` :	a string
`len` :	the length of `str`, or -1 if `str` for the full length.
Returns :	`TRUE`, if the selection was successfully set; otherwise, `FALSE`.

The set_text() method sets the contents of the selection from the string specified by str. The string is converted to the form specified by the selection_data.target attribute. This method returns TRUE if the selection data was successfully set.

gtk.SelectionData.get_text

    def get_text()

Returns : a string containing the converted text, or None.

The get_text() method returns the contents of the selection data as a string.

gtk.SelectionData.get_targets

    def get_targets()

Returns : a tuple containing a list of targets (gtk.gdk.Atoms) or None if no valid targets are available.

The get_targets() method returns a tuple containing a list of valid targets for the selection as a list of gtk.gdk.Atoms or None if there are no valid targets.

gtk.SelectionData.targets_include_text

    def targets_include_text()

Returns : TRUE if the selection data holds a list of targets, and a suitable target for text is included.

The targets_include_text() method returns TRUE if any of the selection data targets can be used to provide text.

gtk.SelectionData.tree_set_row_drag_data

    def tree_set_row_drag_data(tree_model, path)

`tree_model` :	a `gtk.TreeModel`
`path` :	a row in `tree_model`
Returns :	`TRUE` if the `gtk.SelectionData` had the proper target type to allow us to set a tree row

The tree_set_row_drag_data() method sets the selection data of target type GTK_TREE_MODEL_ROW for the row (specified by path) in the gtk.TreeModel (specified by tree_model). Normally used in a "drag-data-get" signal handler.

gtk.SelectionData.tree_get_row_drag_data

    def tree_get_row_drag_data()

Returns : a tuple containing a gtk.TreeModel and one of its rows.

The tree_get_row_drag_data() method returns a tuple containing a gtk.TreeModel and a row from that gtk.TreeModel from selection data of target type GTK_TREE_MODEL_ROW. Normally called from a "drag-data-received" signal handler. This method can only be used if the selection data originates from the same process that's calling this method, because a pointer to the tree model is being passed around. In the "drag-data-received" signal handler, you can assume that selection data of type "GTK_TREE_MODEL_ROW" is from the current process.