FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-86726: Document tkinter.simpledialog query options and Dialog.result by serhiy-storchaka · Pull Request #151851 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-86726: Document tkinter.simpledialog query options and Dialog.result #151851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
serhiy-storchaka merged 1 commit into from
Jun 21, 2026
+22 −6
Conversation 5 Commits 1 Checks 46 Files changed 1
Merged

gh-86726: Document tkinter.simpledialog query options and Dialog.result #151851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
28 changes: 22 additions & 6 deletions Doc/library/dialog.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,31 @@ The :mod:`!tkinter.simpledialog` module contains convenience classes and
functions for creating simple modal dialogs to get a value from the user.


.. function:: askfloat(title, prompt, **kw)
askinteger(title, prompt, **kw)
askstring(title, prompt, **kw)
.. function:: askfloat(title, prompt, *, initialvalue=None, minvalue=None, maxvalue=None, parent=None)
askinteger(title, prompt, *, initialvalue=None, minvalue=None, maxvalue=None, parent=None)
askstring(title, prompt, *, initialvalue=None, show=None, parent=None)

The above three functions provide dialogs that prompt the user to enter a value
of the desired type.
Prompt the user to enter a value of the desired type and return it, or
``None`` if the dialog is cancelled.

*title* is the dialog title and *prompt* the message shown above the entry.
*initialvalue* is the value initially placed in the entry.
*parent* is the window over which the dialog is shown.
:func:`askinteger` and :func:`askfloat` also accept *minvalue* and
*maxvalue*, which bound the accepted value.
:func:`askstring` also accepts *show*, a character used to mask the entered
text, for example ``'*'`` to hide a password.

.. class:: Dialog(parent, title=None)

The base class for custom dialogs.
Instantiating it shows the dialog modally and returns once the user closes
it; the entered value is then available in the :attr:`!result` attribute.

.. attribute:: result

The value produced by :meth:`apply`, or ``None`` if the dialog was
cancelled.

.. method:: body(master)

Expand All @@ -46,7 +61,8 @@ functions for creating simple modal dialogs to get a value from the user.

.. method:: apply()

Process the data entered by the user.
Process the data entered by the user, for example by storing it in the
:attr:`!result` attribute.
Called after :meth:`validate` succeeds and just before the dialog is
destroyed.
The default implementation does nothing; override it to act on or store
Expand Down
Loading
Back | FazBrowse Home | New Git URL