Source code for pyface.i_directory_dialog
# (C) Copyright 2005-2023 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 interface for a dialog that allows the user to browse for a directory.
"""
from traits.api import Bool, HasTraits, Str
from pyface.i_dialog import IDialog
[docs]class IDirectoryDialog(IDialog):
""" The interface for a dialog that allows the user to browse for a
directory.
"""
# 'IDirectoryDialog' interface -----------------------------------------
#: The default path. The default (ie. the default default path) is toolkit
#: specific.
# FIXME v3: The default should be the current directory. (It seems wx is
# the problem, although the file dialog does the right thing.)
default_path = Str()
#: The message to display in the dialog. The default is toolkit specific.
message = Str()
#: True iff the dialog should include a button that allows the user to
#: create a new directory.
new_directory = Bool(True)
#: The path of the chosen directory.
path = Str()
[docs]class MDirectoryDialog(HasTraits):
""" The mixin class that contains common code for toolkit specific
implementations of the IDirectoryDialog interface.
"""