21. Arrastar e soltar

Nota

As versões do PyGObject < 3.0.3 contêm um bug que não permite arrastar e soltar para funcionar corretamente. Portanto, uma versão do PyGObject >= 3.0.3 é necessária para os exemplos a seguir funcionarem.

Configurar arrastar e soltar entre widgets consiste em selecionar uma fonte de arrasto (o widget do qual o usuário começa a arrastar) com o método Gtk.Widget.drag_source_set(), selecionando um destino de arrasto (o widget que o usuário coloca em) com o método Gtk.Widget.drag_dest_set() e depois manipular os sinais relevantes em ambos os widgets.

Em vez de usar Gtk.Widget.drag_source_set() e Gtk.Widget.drag_dest_set() alguns widgets especializados requerem o uso de funções específicas (como Gtk.TreeView e Gtk.IconView).

Um arrastar e soltar básico requer apenas que a fonte se conecte ao sinal “drag-data-get” e que o destino se conecte ao sinal “drag-data-received”. Coisas mais complexas, como áreas de queda específicas e ícones de arrastar personalizados, exigirão que você se conecte a sinais adicionais e interaja com o objeto Gdk.DragContext que fornece.

Para transferir dados entre a origem e o destino, você deve interagir com a variável Gtk.SelectionData fornecida nos sinais “drag-data-get” e “drag-data-received” usando os métodos get e set de Gtk.SelectionData.

21.1. Entradas de alvo

Para permitir que a origem e o destino do arrastar saibam quais dados estão recebendo e enviando, uma lista comum de Gtk.TargetEntrys é necessária. A Gtk.TargetEntry descreve um dado que será enviado pela fonte de arrasto e recebido pelo destino do arrasto.

Existem duas maneiras de adicionar Gtk.TargetEntrys a uma origem e destino. Se o arrastar e soltar for simples e cada entrada de destino for de um tipo diferente, você pode usar o grupo de métodos mencionado aqui <Gtk.Widget.drag_source_add_text_targets>().

Se você precisar de mais de um tipo de dados ou quiser fazer coisas mais complexas com os dados, você precisará criar o Gtk.TargetEntrys usando o método Gtk.TargetEntry.new().

21.2. Sinais de origem do arrasto

Nome	Quando é emitido	Propósito comum
drag-begin	Usuário inicia um arrasto	Configurar ícone de arrasto
drag-data-get	Quando dados do arrasto são solicitados pelo destino	Transferir dados do arrasto da origem para o destino
drag-data-delete	Quando um arrasto com a ação Gdk.DragAction.MOVE é concluído	Excluir dados da origem para concluir o “movimento”
drag-end	Quando o arrasto estiver concluído	Desfazer qualquer coisa feita no drag-begin

21.3. Sinais de destino do arrasto

Nome	Quando é emitido	Propósito comum
drag-motion	O ícone de arrasto se move sobre uma área de soltar	Permitir que apenas algumas áreas sejam soltas
drag-drop	O ícone é solto em uma área de arrasto	Permitir que apenas algumas áreas sejam soltas
drag-data-received	Quando dados do arrasto são recebidos pelo destino	Transferir dados do arrasto da origem para o destino

21.4. Exemplo

import gi

gi.require_version("Gtk", "3.0")
from gi.repository import Gtk, Gdk, GdkPixbuf

(TARGET_ENTRY_TEXT, TARGET_ENTRY_PIXBUF) = range(2)
(COLUMN_TEXT, COLUMN_PIXBUF) = range(2)

DRAG_ACTION = Gdk.DragAction.COPY


class DragDropWindow(Gtk.Window):
    def __init__(self):
        super().__init__(title="Drag and Drop Demo")

        vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=6)
        self.add(vbox)

        hbox = Gtk.Box(spacing=12)
        vbox.pack_start(hbox, True, True, 0)

        self.iconview = DragSourceIconView()
        self.drop_area = DropArea()

        hbox.pack_start(self.iconview, True, True, 0)
        hbox.pack_start(self.drop_area, True, True, 0)

        button_box = Gtk.Box(spacing=6)
        vbox.pack_start(button_box, True, False, 0)

        image_button = Gtk.RadioButton.new_with_label_from_widget(None, "Images")
        image_button.connect("toggled", self.add_image_targets)
        button_box.pack_start(image_button, True, False, 0)

        text_button = Gtk.RadioButton.new_with_label_from_widget(image_button, "Text")
        text_button.connect("toggled", self.add_text_targets)
        button_box.pack_start(text_button, True, False, 0)

        self.add_image_targets()

    def add_image_targets(self, button=None):
        targets = Gtk.TargetList.new([])
        targets.add_image_targets(TARGET_ENTRY_PIXBUF, True)

        self.drop_area.drag_dest_set_target_list(targets)
        self.iconview.drag_source_set_target_list(targets)

    def add_text_targets(self, button=None):
        self.drop_area.drag_dest_set_target_list(None)
        self.iconview.drag_source_set_target_list(None)

        self.drop_area.drag_dest_add_text_targets()
        self.iconview.drag_source_add_text_targets()


class DragSourceIconView(Gtk.IconView):
    def __init__(self):
        Gtk.IconView.__init__(self)
        self.set_text_column(COLUMN_TEXT)
        self.set_pixbuf_column(COLUMN_PIXBUF)

        model = Gtk.ListStore(str, GdkPixbuf.Pixbuf)
        self.set_model(model)
        self.add_item("Item 1", "image-missing")
        self.add_item("Item 2", "help-about")
        self.add_item("Item 3", "edit-copy")

        self.enable_model_drag_source(Gdk.ModifierType.BUTTON1_MASK, [], DRAG_ACTION)
        self.connect("drag-data-get", self.on_drag_data_get)

    def on_drag_data_get(self, widget, drag_context, data, info, time):
        selected_path = self.get_selected_items()[0]
        selected_iter = self.get_model().get_iter(selected_path)

        if info == TARGET_ENTRY_TEXT:
            text = self.get_model().get_value(selected_iter, COLUMN_TEXT)
            data.set_text(text, -1)
        elif info == TARGET_ENTRY_PIXBUF:
            pixbuf = self.get_model().get_value(selected_iter, COLUMN_PIXBUF)
            data.set_pixbuf(pixbuf)

    def add_item(self, text, icon_name):
        pixbuf = Gtk.IconTheme.get_default().load_icon(icon_name, 16, 0)
        self.get_model().append([text, pixbuf])


class DropArea(Gtk.Label):
    def __init__(self):
        Gtk.Label.__init__(self)
        self.set_label("Drop something on me!")
        self.drag_dest_set(Gtk.DestDefaults.ALL, [], DRAG_ACTION)

        self.connect("drag-data-received", self.on_drag_data_received)

    def on_drag_data_received(self, widget, drag_context, x, y, data, info, time):
        if info == TARGET_ENTRY_TEXT:
            text = data.get_text()
            print("Received text: %s" % text)

        elif info == TARGET_ENTRY_PIXBUF:
            pixbuf = data.get_pixbuf()
            width = pixbuf.get_width()
            height = pixbuf.get_height()

            print("Received pixbuf with width %spx and height %spx" % (width, height))


win = DragDropWindow()
win.connect("destroy", Gtk.main_quit)
win.show_all()
Gtk.main()