pyqso/pyqso/auxiliary_dialogs.py

#!/usr/bin/env python3

#    Copyright (C) 2013 Christian T. Jacobs.

#    This file is part of PyQSO.

#    PyQSO 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.
#
#    PyQSO 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 PyQSO.  If not, see <http://www.gnu.org/licenses/>.

from gi.repository import Gtk
import logging

def error(parent, message):
   """ Display an error message.
   
   :arg parent: The Gtk parent window/dialog.
   :arg str message: The message to display to the user.
   """
   logging.error(message)
   _handle_gtk_dialog(parent, Gtk.MessageType.ERROR, message, "Error")

def info(parent, message):
   """ Display some information.
    
   :arg parent: The Gtk parent window/dialog.
   :arg str message: The message to display to the user.
   """
   logging.debug(message)
   _handle_gtk_dialog(parent, Gtk.MessageType.INFO, message, "Information")
   
def question(parent, message):
   """ Ask the user a question. The dialog comes with 'Yes' and 'No' response buttons.
      
   :arg parent: The Gtk parent window/dialog.
   :arg str message: The message to display to the user.
   :returns: The 'yes'/'no' response from the user.
   :rtype: Gtk.ResponseType
   """
   return _handle_gtk_dialog(parent, Gtk.MessageType.QUESTION, message, "Question")

def _handle_gtk_dialog(parent, msgtype, message, title):
   """ 
   Instantiate and present a dialog to the user.
   
   :arg parent: The Gtk parent window/dialog.
   :arg Gtk.MessageType msgtype: The type of message to present to the user (e.g. a question, or error message).
   :arg str message: The message to display in the dialog.
   :arg str title: The title to display at the top of the dialog.
   :returns: The response from the user, based on which button they pushed.
   :rtype: Gtk.ResponseType
   """
   bt = Gtk.ButtonsType
   buttons = bt.YES_NO if msgtype == Gtk.MessageType.QUESTION else bt.OK
   dialog = Gtk.MessageDialog(parent, Gtk.DialogFlags.DESTROY_WITH_PARENT,
         msgtype, buttons, message, title=title)
   response = dialog.run()
   dialog.destroy()
   return response