Dialog.md

Dialog Boxes

The thing is self-explanatory aslong you don't try to use ResponseTypes. For example, to catch input after closing the MessageBox. If you want to use ResponseTypes you have overall two options.

Option No 1

dialog.add_buttons("OK", Gtk.ResponseType.OK, "Cancel", Gtk.ResponseType.CANCEL)

This adds two buttons to the MessageBox (it works with dialog.add_button as well). The first parameter is a string that adds a label to the Button. The second parameter adds the Response code as integer. The code should be in your init for GTK.Dialog or a subclass.

Option No 2

You define a custom button in Dialog init, and finally add it with the following loc:

area = dialog.get_content_area()
btn = Gtk.Button(label="OK")
btn.connect("clicked", self.dialogok_clicked)
area.append (btn) # add btn to area, therefore to dialog

Then in your dialog_clicked Listener you will trigger the .response event using the ResponseCode (e.g. .Cancel)

   def dialogok_clicked (self, btn):
       return self.response(Gtk.ResponseType.CANCEL) # or .OK whatever

Then you can use it if you have abstracted GTK.Dialog in e.g. MessageBox with a return value. Because you have linked the response event of the object created using MessageBox (GTK.Dialog) class using connect

  #dialog.connect("response", on_dialog_response)
  def on_dialog_response(self, widget, response_id):
    match response_id:
     # if OK
     case Gtk.ResponseType.OK:
         print("Ok")
         widget.destroy() # destroy Messagebox after doing what you want to do (handling event)
     # if cancel
     case Gtk.ResponseType.CANCEL:
         print("cancel")
         widget.destroy() # destroy Messagebox after doing what you want to do (handling event)
     # if destroyed e.g. by ESC or X Button
     case Gtk.ResponseType.DELETE_EVENT:
         print("dialog closed or cancelled")
         widget.destroy() # destroy Messagebox after doing what you want to do (handling event)

Full Example

Sounds complicated huh? Here the full example:

import gi,sys
gi.require_version('Gtk', '4.0')
gi.require_version('Adw', '1')
from gi.repository import Gtk, Adw

class MessageBox (Gtk.Dialog):
    def __init__ (self, text="Hi", *args, **kwargs):
        super ().__init__(*args, **kwargs)
        self.area = self.get_content_area()
        message= Gtk.Label()
        message.set_text(text)
        self.area.append(message)
        # option 2
        #btn = Gtk.Button(label="OK")
        #btn.connect("clicked", self.dialogok_clicked)
        #self.area.append(btn)

        # option 1
        self.add_button ("OK", Gtk.ResponseType.OK)
        #self.add_buttons("OK", Gtk.ResponseType.OK, "Cancel", Gtk.ResponseType.CANCEL)
        self.show()

    # option 2
    # def dialogok_clicked (self, btn):
    #    # ok if label "ok"; .cancel if not
    #    return self.response(Gtk.ResponseType.CANCEL) if not btn.get_label().lower() == "ok" else self.response(Gtk.ResponseType.OK)

class EntryWindow(Gtk.ApplicationWindow):
        def __init__(self, *args, **kwargs):
            super().__init__(*args, **kwargs)
            self.close()

            self.set_size_request (100,100)

            l=Gtk.Label()
            l.set_text("This App is a Test App for Messagebox Testing")
            self.set_child(l)

        # show dialog after load
        def showDialog(self,):
            dialog = MessageBox("This is a Test MessageBox")
            dialog.connect("response", self.on_dialog_response)

        # for both options in Window class
        def on_dialog_response (self, widget, response_id):
            match response_id:
                # if OK
                case Gtk.ResponseType.OK:
                    print("Ok")
                    widget.destroy() # destroy Messagebox after doing what you want to do (handling event)
                # if cancel
                case Gtk.ResponseType.CANCEL:
                    print("cancel")
                    widget.destroy() # destroy Messagebox after doing what you want to do (handling event)
                # if destroyed e.g. by ESC or X Button
                case Gtk.ResponseType.DELETE_EVENT:
                    print("dialog closed or cancelled")
                    widget.destroy() # destroy Messagebox after doing what you want to do (handling event)


class MyApp(Adw.Application):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.connect('activate', self.on_activate)

    def on_activate(self, app):
        self.win = EntryWindow (application=app)
        self.win.present()
        self.win.showDialog()



app = MyApp(application_id="de.b00bs.test")
app.run(sys.argv)