Source code for pyface.color_dialog

# (C) Copyright 2005-2022 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in 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!

""" The implementation of a dialog that allows the user to select a color.
"""

from .constant import OK
from .toolkit import toolkit_object


ColorDialog = toolkit_object("color_dialog:ColorDialog")


[docs]def get_color(parent, color, show_alpha=False): """ Convenience function that displays a color dialog. Parameters ---------- parent : toolkit control The parent toolkit control for the modal dialog. color : Color or color description The initial Color object, rgb(a) tuple or a string holding a valid color description. show_alpha : bool Whether or not to show alpha channel information. Returns ------- color : Color or None The selected color, or None if the user made no selection. """ dialog = ColorDialog(parent=parent, color=color, show_alpha=show_alpha) result = dialog.open() if result == OK: return dialog.color else: return None