comictagger/comictaggerlib/optionalmsgdialog.py

"""
A PyQt4 dialog to show a message and let the user check a box
"""

"""
Copyright 2012-2014  Anthony Beville

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

"""
example usage:

checked = OptionalMessageDialog.msg(self, "Disclaimer",
                            "This is beta software, and you are using it at your own risk!",
                         )

said_yes, checked =  OptionalMessageDialog.question(self,  "Question",
                            "Are you sure you wish to do this?",
                         )
"""

from PyQt4.QtCore import *
from PyQt4.QtGui import *


StyleMessage = 0
StyleQuestion = 1


class OptionalMessageDialog(QDialog):

    def __init__(self, parent, style, title, msg,
                 check_state=Qt.Unchecked, check_text=None):
        QDialog.__init__(self, parent)

        self.setWindowTitle(title)
        self.was_accepted = False

        l = QVBoxLayout(self)

        self.theLabel = QLabel(msg)
        self.theLabel.setWordWrap(True)
        self.theLabel.setTextFormat(Qt.RichText)
        self.theLabel.setOpenExternalLinks(True)
        self.theLabel.setTextInteractionFlags(
            Qt.TextSelectableByMouse | Qt.LinksAccessibleByMouse | Qt.LinksAccessibleByKeyboard)

        l.addWidget(self.theLabel)
        l.insertSpacing(-1, 10)

        if check_text is None:
            if style == StyleQuestion:
                check_text = "Remember this answer"
            else:
                check_text = "Don't show this message again"

        self.theCheckBox = QCheckBox(check_text)

        self.theCheckBox.setCheckState(check_state)

        l.addWidget(self.theCheckBox)

        btnbox_style = QDialogButtonBox.Ok
        if style == StyleQuestion:
            btnbox_style = QDialogButtonBox.Yes | QDialogButtonBox.No

        self.theButtonBox = QDialogButtonBox(
            btnbox_style,
            parent=self,
            accepted=self.accept,
            rejected=self.reject)

        l.addWidget(self.theButtonBox)

    def accept(self):
        self.was_accepted = True
        QDialog.accept(self)

    def reject(self):
        self.was_accepted = False
        QDialog.reject(self)

    @staticmethod
    def msg(parent, title, msg, check_state=Qt.Unchecked, check_text=None):

        d = OptionalMessageDialog(
            parent,
            StyleMessage,
            title,
            msg,
            check_state=check_state,
            check_text=check_text)

        d.exec_()
        return d.theCheckBox.isChecked()

    @staticmethod
    def question(
            parent, title, msg, check_state=Qt.Unchecked, check_text=None):

        d = OptionalMessageDialog(
            parent,
            StyleQuestion,
            title,
            msg,
            check_state=check_state,
            check_text=check_text)

        d.exec_()

        return d.was_accepted, d.theCheckBox.isChecked()