Permalink
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (44 sloc) 2.05 KB
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" The interface for a dialog that prompts the user for confirmation. """
# Enthought library imports.
from traits.api import Bool, Enum, Instance, Unicode
# Local imports.
from pyface.constant import CANCEL, NO, YES
from pyface.i_dialog import IDialog
from pyface.i_image_resource import IImageResource
class IConfirmationDialog(IDialog):
""" The interface for a dialog that prompts the user for confirmation. """
#### 'IConfirmationDialog' interface ######################################
#: Should the cancel button be displayed?
cancel = Bool(False)
#: The default button.
default = Enum(NO, YES, CANCEL)
#: The image displayed with the message. The default is toolkit specific.
image = Instance(IImageResource)
#: The message displayed in the body of the dialog (use the inherited
#: 'title' trait to set the title of the dialog itself).
message = Unicode
#: Some informative text to display below the main message
informative = Unicode
#: Some additional details that can be exposed by the user
detail = Unicode
#: The label for the 'no' button. The default is toolkit specific.
no_label = Unicode
#: The label for the 'yes' button. The default is toolkit specific.
yes_label = Unicode
class MConfirmationDialog(object):
""" The mixin class that contains common code for toolkit specific
implementations of the IConfirmationDialog interface.
"""