MCPcopy Index your code
hub / github.com/PySimpleGUI/PySimpleGUI / popup_scrolled

Function popup_scrolled

PySimpleGUI/PySimpleGUI.py:20511–20627  ·  view source on GitHub ↗

Show a scrolled Popup window containing the user's text that was supplied. Use with as many items to print as you want, just like a print statement. :param *args: Variable number of items to display :type *args: (Any) :param title:

(*args, title=None, button_color=None, background_color=None, text_color=None, yes_no=False, no_buttons=False, button_justification='l', auto_close=False,
                   auto_close_duration=None, size=(None, None), location=(None, None), relative_location=(None, None), non_blocking=False, no_titlebar=False, grab_anywhere=False,
                   keep_on_top=None, font=None, image=None, icon=None, modal=True, no_sizegrip=False)

Source from the content-addressed store, hash-verified

20509# ======================== Scrolled Text Box =====#
20510# ===================================================#
20511def popup_scrolled(*args, title=None, button_color=None, background_color=None, text_color=None, yes_no=False, no_buttons=False, button_justification='l', auto_close=False,
20512 auto_close_duration=None, size=(None, None), location=(None, None), relative_location=(None, None), non_blocking=False, no_titlebar=False, grab_anywhere=False,
20513 keep_on_top=None, font=None, image=None, icon=None, modal=True, no_sizegrip=False):
20514 """
20515 Show a scrolled Popup window containing the user's text that was supplied. Use with as many items to print as you
20516 want, just like a print statement.
20517
20518 :param *args: Variable number of items to display
20519 :type *args: (Any)
20520 :param title: Title to display in the window.
20521 :type title: (str)
20522 :param button_color: button color (foreground, background)
20523 :type button_color: (str, str) | str
20524 :param yes_no: If True, displays Yes and No buttons instead of Ok
20525 :type yes_no: (bool)
20526 :param no_buttons: If True, no buttons will be shown. User will have to close using the "X"
20527 :type no_buttons: (bool)
20528 :param button_justification: How buttons should be arranged. l, c, r for Left, Center or Right justified
20529 :type button_justification: (str)
20530 :param auto_close: if True window will close itself
20531 :type auto_close: (bool)
20532 :param auto_close_duration: Older versions only accept int. Time in seconds until window will close
20533 :type auto_close_duration: int | float
20534 :param size: (w,h) w=characters-wide, h=rows-high
20535 :type size: (int, int)
20536 :param location: Location on the screen to place the upper left corner of the window
20537 :type location: (int, int)
20538 :param relative_location: (x,y) location relative to the default location of the window, in pixels. Normally the window centers. This location is relative to the location the window would be created. Note they can be negative.
20539 :type relative_location: (int, int)
20540 :param non_blocking: if True the call will immediately return rather than waiting on user input
20541 :type non_blocking: (bool)
20542 :param background_color: color of background
20543 :type background_color: (str)
20544 :param text_color: color of the text
20545 :type text_color: (str)
20546 :param no_titlebar: If True no titlebar will be shown
20547 :type no_titlebar: (bool)
20548 :param grab_anywhere: If True, than can grab anywhere to move the window (Default = False)
20549 :type grab_anywhere: (bool)
20550 :param keep_on_top: If True the window will remain above all current windows
20551 :type keep_on_top: (bool)
20552 :param font: specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike
20553 :type font: (str or (str, int[, str]) or None)
20554 :param image: Image to include at the top of the popup window
20555 :type image: (str) or (bytes)
20556 :param icon: filename or base64 string to be used for the window's icon
20557 :type icon: bytes | str
20558 :param modal: If True then makes the popup will behave like a Modal window... all other windows are non-operational until this one is closed. Default = True
20559 :type modal: bool
20560 :param no_sizegrip: If True no Sizegrip will be shown when there is no titlebar. It's only shown if there is no titlebar
20561 :type no_sizegrip: (bool)
20562 :return: Returns text of the button that was pressed. None will be returned if user closed window with X
20563 :rtype: str | None | TIMEOUT_KEY
20564 """
20565
20566 if not args:
20567 return
20568 width, height = size

Callers 5

_display_all_varsMethod · 0.85
upgrade_PySimpleGUI_guiFunction · 0.85
main_get_debug_dataFunction · 0.85
mainFunction · 0.85

Calls 8

readMethod · 0.95
closeMethod · 0.95
ImageClass · 0.85
_GetNumLinesNeededFunction · 0.85
MultilineClass · 0.85
PushFunction · 0.85
SizegripClass · 0.85
WindowClass · 0.85

Tested by

no test coverage detected