tkinter API Reference
Full documentation for tkinter (Standard Library / Native)
tkinter.ACTIVE
Error rendering doc: No Python documentation found for 'active'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.ALL
Python Library Documentation: built-in function all in module builtins
all(iterable, /)
Return True if bool(x) is True for all values x in the iterable.
If the iterable is empty, return True.
tkinter.ANCHOR
Error rendering doc: No Python documentation found for 'anchor'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.ARC
Error rendering doc: No Python documentation found for 'arc'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BASELINE
Error rendering doc: No Python documentation found for 'baseline'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BEVEL
Error rendering doc: No Python documentation found for 'bevel'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BOTH
Error rendering doc: No Python documentation found for 'both'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BOTTOM
Error rendering doc: No Python documentation found for 'bottom'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BROWSE
Error rendering doc: No Python documentation found for 'browse'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BUTT
Error rendering doc: No Python documentation found for 'butt'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.BaseWidget
Python Library Documentation: class BaseWidget in module tkinter
class BaseWidget(Misc)
| BaseWidget(master, widgetName, cnf={}, kw={}, extra=())
|
| Internal class.
|
| Method resolution order:
| BaseWidget
| Misc
| builtins.object
|
| Methods defined here:
|
| __init__(self, master, widgetName, cnf={}, kw={}, extra=())
| Construct a widget with the parent widget MASTER, a name WIDGETNAME
| and appropriate options.
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.BitmapImage
Python Library Documentation: class BitmapImage in module tkinter
class BitmapImage(Image)
| BitmapImage(name=None, cnf={}, master=None, **kw)
|
| Widget which can display images in XBM format.
|
| Method resolution order:
| BitmapImage
| Image
| builtins.object
|
| Methods defined here:
|
| __init__(self, name=None, cnf={}, master=None, **kw)
| Create a bitmap with NAME.
|
| Valid resource names: background, data, file, foreground, maskdata, maskfile.
|
| ----------------------------------------------------------------------
| Methods inherited from Image:
|
| __del__(self)
|
| __getitem__(self, key)
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return str(self).
|
| config = configure(self, **kw)
|
| configure(self, **kw)
| Configure the image.
|
| height(self)
| Return the height of the image.
|
| type(self)
| Return the type of the image, e.g. "photo" or "bitmap".
|
| width(self)
| Return the width of the image.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Image:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.BooleanVar
Python Library Documentation: class BooleanVar in module tkinter class BooleanVar(Variable) | BooleanVar(master=None, value=None, name=None) | | Value holder for boolean variables. | | Method resolution order: | BooleanVar | Variable | builtins.object | | Methods defined here: | | __init__(self, master=None, value=None, name=None) | Construct a boolean variable. | | MASTER can be given as master widget. | VALUE is an optional value (defaults to False) | NAME is an optional Tcl name (defaults to PY_VARnum). | | If NAME matches an existing variable and VALUE is omitted | then the existing value is retained. | | get(self) | Return the value of the variable as a bool. | | initialize = set(self, value) | | set(self, value) | Set the variable to VALUE. | | ---------------------------------------------------------------------- | Methods inherited from Variable: | | __del__(self) | Unset the variable in Tcl. | | __eq__(self, other) | Return self==value. | | __str__(self) | Return the name of the variable in Tcl. | | trace = trace_variable(self, mode, callback) | | trace_add(self, mode, callback) | Define a trace callback for the variable. | | Mode is one of "read", "write", "unset", or a list or tuple of | such strings. | Callback must be a function which is called when the variable is | read, written or unset. | | Return the name of the callback. | | trace_info(self) | Return all trace callback information. | | trace_remove(self, mode, cbname) | Delete the trace callback for a variable. | | Mode is one of "read", "write", "unset" or a list or tuple of | such strings. Must be same as were specified in trace_add(). | cbname is the name of the callback returned from trace_add(). | | trace_variable(self, mode, callback) | Define a trace callback for the variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CALLBACK must be a function which is called when | the variable is read, written or undefined. | | Return the name of the callback. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_add() instead. | | trace_vdelete(self, mode, cbname) | Delete the trace callback for a variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CBNAME is the name of the callback returned from trace_variable or trace. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_remove() instead. | | trace_vinfo(self) | Return all trace callback information. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_info() instead. | | ---------------------------------------------------------------------- | Data descriptors inherited from Variable: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes inherited from Variable: | | __hash__ = None
tkinter.Button
Python Library Documentation: class Button in module tkinter
class Button(Widget)
| Button(master=None, cnf={}, **kw)
|
| Button widget.
|
| Method resolution order:
| Button
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a button widget with the parent MASTER.
|
| STANDARD OPTIONS
|
| activebackground, activeforeground, anchor,
| background, bitmap, borderwidth, cursor,
| disabledforeground, font, foreground
| highlightbackground, highlightcolor,
| highlightthickness, image, justify,
| padx, pady, relief, repeatdelay,
| repeatinterval, takefocus, text,
| textvariable, underline, wraplength
|
| WIDGET-SPECIFIC OPTIONS
|
| command, compound, default, height,
| overrelief, state, width
|
| flash(self)
| Flash the button.
|
| This is accomplished by redisplaying
| the button several times, alternating between active and
| normal colors. At the end of the flash the button is left
| in the same normal/active state as when the command was
| invoked. This command is ignored if the button's state is
| disabled.
|
| invoke(self)
| Invoke the command associated with the button.
|
| The return value is the return value from the command,
| or an empty string if there is no command associated with
| the button. This command is ignored if the button's state
| is disabled.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.CASCADE
Error rendering doc: No Python documentation found for 'cascade'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.CENTER
Error rendering doc: No Python documentation found for 'center'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.CHAR
Error rendering doc: No Python documentation found for 'char'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.CHECKBUTTON
Error rendering doc: No Python documentation found for 'checkbutton'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.CHORD
Error rendering doc: No Python documentation found for 'chord'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.COMMAND
Error rendering doc: No Python documentation found for 'command'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.CURRENT
Error rendering doc: No Python documentation found for 'current'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.CallWrapper
Python Library Documentation: class CallWrapper in module tkinter class CallWrapper(builtins.object) | CallWrapper(func, subst, widget) | | Internal class. Stores function to call when some user | defined Tcl function is called e.g. after an event occurred. | | Methods defined here: | | __call__(self, *args) | Apply first function SUBST to arguments, than FUNC. | | __init__(self, func, subst, widget) | Store FUNC, SUBST and WIDGET as members. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
tkinter.Canvas
Python Library Documentation: class Canvas in module tkinter
class Canvas(Widget, XView, YView)
| Canvas(master=None, cnf={}, **kw)
|
| Canvas widget to display graphical elements like lines or text.
|
| Method resolution order:
| Canvas
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| XView
| YView
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a canvas widget with the parent MASTER.
|
| Valid resource names: background, bd, bg, borderwidth, closeenough,
| confine, cursor, height, highlightbackground, highlightcolor,
| highlightthickness, insertbackground, insertborderwidth,
| insertofftime, insertontime, insertwidth, offset, relief,
| scrollregion, selectbackground, selectborderwidth, selectforeground,
| state, takefocus, width, xscrollcommand, xscrollincrement,
| yscrollcommand, yscrollincrement.
|
| addtag(self, *args)
| Internal function.
|
| addtag_above(self, newtag, tagOrId)
| Add tag NEWTAG to all items above TAGORID.
|
| addtag_all(self, newtag)
| Add tag NEWTAG to all items.
|
| addtag_below(self, newtag, tagOrId)
| Add tag NEWTAG to all items below TAGORID.
|
| addtag_closest(self, newtag, x, y, halo=None, start=None)
| Add tag NEWTAG to item which is closest to pixel at X, Y.
| If several match take the top-most.
| All items closer than HALO are considered overlapping (all are
| closest). If START is specified the next below this tag is taken.
|
| addtag_enclosed(self, newtag, x1, y1, x2, y2)
| Add tag NEWTAG to all items in the rectangle defined
| by X1,Y1,X2,Y2.
|
| addtag_overlapping(self, newtag, x1, y1, x2, y2)
| Add tag NEWTAG to all items which overlap the rectangle
| defined by X1,Y1,X2,Y2.
|
| addtag_withtag(self, newtag, tagOrId)
| Add tag NEWTAG to all items with TAGORID.
|
| bbox(self, *args)
| Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
| which encloses all items with tags specified as arguments.
|
| canvasx(self, screenx, gridspacing=None)
| Return the canvas x coordinate of pixel position SCREENX rounded
| to nearest multiple of GRIDSPACING units.
|
| canvasy(self, screeny, gridspacing=None)
| Return the canvas y coordinate of pixel position SCREENY rounded
| to nearest multiple of GRIDSPACING units.
|
| coords(self, *args)
| Return a list of coordinates for the item given in ARGS.
|
| create_arc(self, *args, **kw)
| Create arc shaped region with coordinates x1,y1,x2,y2.
|
| create_bitmap(self, *args, **kw)
| Create bitmap with coordinates x1,y1.
|
| create_image(self, *args, **kw)
| Create image item with coordinates x1,y1.
|
| create_line(self, *args, **kw)
| Create line with coordinates x1,y1,...,xn,yn.
|
| create_oval(self, *args, **kw)
| Create oval with coordinates x1,y1,x2,y2.
|
| create_polygon(self, *args, **kw)
| Create polygon with coordinates x1,y1,...,xn,yn.
|
| create_rectangle(self, *args, **kw)
| Create rectangle with coordinates x1,y1,x2,y2.
|
| create_text(self, *args, **kw)
| Create text with coordinates x1,y1.
|
| create_window(self, *args, **kw)
| Create window with coordinates x1,y1,x2,y2.
|
| dchars(self, *args)
| Delete characters of text items identified by tag or id in ARGS (possibly
| several times) from FIRST to LAST character (including).
|
| delete(self, *args)
| Delete items identified by all tag or ids contained in ARGS.
|
| dtag(self, *args)
| Delete tag or id given as last arguments in ARGS from items
| identified by first argument in ARGS.
|
| find(self, *args)
| Internal function.
|
| find_above(self, tagOrId)
| Return items above TAGORID.
|
| find_all(self)
| Return all items.
|
| find_below(self, tagOrId)
| Return all items below TAGORID.
|
| find_closest(self, x, y, halo=None, start=None)
| Return item which is closest to pixel at X, Y.
| If several match take the top-most.
| All items closer than HALO are considered overlapping (all are
| closest). If START is specified the next below this tag is taken.
|
| find_enclosed(self, x1, y1, x2, y2)
| Return all items in rectangle defined
| by X1,Y1,X2,Y2.
|
| find_overlapping(self, x1, y1, x2, y2)
| Return all items which overlap the rectangle
| defined by X1,Y1,X2,Y2.
|
| find_withtag(self, tagOrId)
| Return all items with TAGORID.
|
| focus(self, *args)
| Set focus to the first item specified in ARGS.
|
| gettags(self, *args)
| Return tags associated with the first item specified in ARGS.
|
| icursor(self, *args)
| Set cursor at position POS in the item identified by TAGORID.
| In ARGS TAGORID must be first.
|
| index(self, *args)
| Return position of cursor as integer in item specified in ARGS.
|
| insert(self, *args)
| Insert TEXT in item TAGORID at position POS. ARGS must
| be TAGORID POS TEXT.
|
| itemcget(self, tagOrId, option)
| Return the resource value for an OPTION for item TAGORID.
|
| itemconfig = itemconfigure(self, tagOrId, cnf=None, **kw)
|
| itemconfigure(self, tagOrId, cnf=None, **kw)
| Configure resources of an item TAGORID.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method without arguments.
|
| lift = tag_raise(self, *args)
|
| lower = tag_lower(self, *args)
|
| move(self, *args)
| Move an item TAGORID given in ARGS.
|
| moveto(self, tagOrId, x='', y='')
| Move the items given by TAGORID in the canvas coordinate
| space so that the first coordinate pair of the bottommost
| item with tag TAGORID is located at position (X,Y).
| X and Y may be the empty string, in which case the
| corresponding coordinate will be unchanged. All items matching
| TAGORID remain in the same positions relative to each other.
|
| postscript(self, cnf={}, **kw)
| Print the contents of the canvas to a postscript
| file. Valid options: colormap, colormode, file, fontmap,
| height, pageanchor, pageheight, pagewidth, pagex, pagey,
| rotate, width, x, y.
|
| scale(self, *args)
| Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE.
|
| scan_dragto(self, x, y, gain=10)
| Adjust the view of the canvas to GAIN times the
| difference between X and Y and the coordinates given in
| scan_mark.
|
| scan_mark(self, x, y)
| Remember the current X, Y coordinates.
|
| select_adjust(self, tagOrId, index)
| Adjust the end of the selection near the cursor of an item TAGORID to index.
|
| select_clear(self)
| Clear the selection if it is in this widget.
|
| select_from(self, tagOrId, index)
| Set the fixed end of a selection in item TAGORID to INDEX.
|
| select_item(self)
| Return the item which has the selection.
|
| select_to(self, tagOrId, index)
| Set the variable end of a selection in item TAGORID to INDEX.
|
| tag_bind(self, tagOrId, sequence=None, func=None, add=None)
| Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.
|
| An additional boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or whether it will
| replace the previous function. See bind for the return value.
|
| tag_lower(self, *args)
| Lower an item TAGORID given in ARGS
| (optional below another item).
|
| tag_raise(self, *args)
| Raise an item TAGORID given in ARGS
| (optional above another item).
|
| tag_unbind(self, tagOrId, sequence, funcid=None)
| Unbind for all items with TAGORID for event SEQUENCE the
| function identified with FUNCID.
|
| tkraise = tag_raise(self, *args)
|
| type(self, tagOrId)
| Return the type of the item TAGORID.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
|
| ----------------------------------------------------------------------
| Methods inherited from XView:
|
| xview(self, *args)
| Query and change the horizontal position of the view.
|
| xview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total width of the canvas is off-screen to the left.
|
| xview_scroll(self, number, what)
| Shift the x-view according to NUMBER which is measured in "units"
| or "pages" (WHAT).
|
| ----------------------------------------------------------------------
| Methods inherited from YView:
|
| yview(self, *args)
| Query and change the vertical position of the view.
|
| yview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total height of the canvas is off-screen to the top.
|
| yview_scroll(self, number, what)
| Shift the y-view according to NUMBER which is measured in
| "units" or "pages" (WHAT).
tkinter.Checkbutton
Python Library Documentation: class Checkbutton in module tkinter
class Checkbutton(Widget)
| Checkbutton(master=None, cnf={}, **kw)
|
| Checkbutton widget which is either in on- or off-state.
|
| Method resolution order:
| Checkbutton
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a checkbutton widget with the parent MASTER.
|
| Valid resource names: activebackground, activeforeground, anchor,
| background, bd, bg, bitmap, borderwidth, command, cursor,
| disabledforeground, fg, font, foreground, height,
| highlightbackground, highlightcolor, highlightthickness, image,
| indicatoron, justify, offvalue, onvalue, padx, pady, relief,
| selectcolor, selectimage, state, takefocus, text, textvariable,
| underline, variable, width, wraplength.
|
| deselect(self)
| Put the button in off-state.
|
| flash(self)
| Flash the button.
|
| invoke(self)
| Toggle the button and invoke a command if given as resource.
|
| select(self)
| Put the button in on-state.
|
| toggle(self)
| Toggle the button.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.DISABLED
Error rendering doc: No Python documentation found for 'disabled'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.DOTBOX
Error rendering doc: No Python documentation found for 'dotbox'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.DoubleVar
Python Library Documentation: class DoubleVar in module tkinter class DoubleVar(Variable) | DoubleVar(master=None, value=None, name=None) | | Value holder for float variables. | | Method resolution order: | DoubleVar | Variable | builtins.object | | Methods defined here: | | __init__(self, master=None, value=None, name=None) | Construct a float variable. | | MASTER can be given as master widget. | VALUE is an optional value (defaults to 0.0) | NAME is an optional Tcl name (defaults to PY_VARnum). | | If NAME matches an existing variable and VALUE is omitted | then the existing value is retained. | | get(self) | Return the value of the variable as a float. | | ---------------------------------------------------------------------- | Methods inherited from Variable: | | __del__(self) | Unset the variable in Tcl. | | __eq__(self, other) | Return self==value. | | __str__(self) | Return the name of the variable in Tcl. | | initialize = set(self, value) | | set(self, value) | Set the variable to VALUE. | | trace = trace_variable(self, mode, callback) | | trace_add(self, mode, callback) | Define a trace callback for the variable. | | Mode is one of "read", "write", "unset", or a list or tuple of | such strings. | Callback must be a function which is called when the variable is | read, written or unset. | | Return the name of the callback. | | trace_info(self) | Return all trace callback information. | | trace_remove(self, mode, cbname) | Delete the trace callback for a variable. | | Mode is one of "read", "write", "unset" or a list or tuple of | such strings. Must be same as were specified in trace_add(). | cbname is the name of the callback returned from trace_add(). | | trace_variable(self, mode, callback) | Define a trace callback for the variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CALLBACK must be a function which is called when | the variable is read, written or undefined. | | Return the name of the callback. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_add() instead. | | trace_vdelete(self, mode, cbname) | Delete the trace callback for a variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CBNAME is the name of the callback returned from trace_variable or trace. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_remove() instead. | | trace_vinfo(self) | Return all trace callback information. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_info() instead. | | ---------------------------------------------------------------------- | Data descriptors inherited from Variable: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes inherited from Variable: | | __hash__ = None
tkinter.E
Error rendering doc: No Python documentation found for 'e'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.END
Error rendering doc: No Python documentation found for 'end'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.EW
Error rendering doc: No Python documentation found for 'ew'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.EXCEPTION
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.EXTENDED
Error rendering doc: No Python documentation found for 'extended'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Entry
Python Library Documentation: class Entry in module tkinter
class Entry(Widget, XView)
| Entry(master=None, cnf={}, **kw)
|
| Entry widget which allows displaying simple text.
|
| Method resolution order:
| Entry
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| XView
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct an entry widget with the parent MASTER.
|
| Valid resource names: background, bd, bg, borderwidth, cursor,
| exportselection, fg, font, foreground, highlightbackground,
| highlightcolor, highlightthickness, insertbackground,
| insertborderwidth, insertofftime, insertontime, insertwidth,
| invalidcommand, invcmd, justify, relief, selectbackground,
| selectborderwidth, selectforeground, show, state, takefocus,
| textvariable, validate, validatecommand, vcmd, width,
| xscrollcommand.
|
| delete(self, first, last=None)
| Delete text from FIRST to LAST (not included).
|
| get(self)
| Return the text.
|
| icursor(self, index)
| Insert cursor at INDEX.
|
| index(self, index)
| Return position of cursor.
|
| insert(self, index, string)
| Insert STRING at INDEX.
|
| scan_dragto(self, x)
| Adjust the view of the canvas to 10 times the
| difference between X and Y and the coordinates given in
| scan_mark.
|
| scan_mark(self, x)
| Remember the current X, Y coordinates.
|
| select_adjust = selection_adjust(self, index)
|
| select_clear = selection_clear(self)
|
| select_from = selection_from(self, index)
|
| select_present = selection_present(self)
|
| select_range = selection_range(self, start, end)
|
| select_to = selection_to(self, index)
|
| selection_adjust(self, index)
| Adjust the end of the selection near the cursor to INDEX.
|
| selection_clear(self)
| Clear the selection if it is in this widget.
|
| selection_from(self, index)
| Set the fixed end of a selection to INDEX.
|
| selection_present(self)
| Return True if there are characters selected in the entry, False
| otherwise.
|
| selection_range(self, start, end)
| Set the selection from START to END (not included).
|
| selection_to(self, index)
| Set the variable end of a selection to INDEX.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
|
| ----------------------------------------------------------------------
| Methods inherited from XView:
|
| xview(self, *args)
| Query and change the horizontal position of the view.
|
| xview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total width of the canvas is off-screen to the left.
|
| xview_scroll(self, number, what)
| Shift the x-view according to NUMBER which is measured in "units"
| or "pages" (WHAT).
tkinter.Event
Python Library Documentation: class Event in module tkinter class Event(builtins.object) | Container for the properties of an event. | | Instances of this type are generated if one of the following events occurs: | | KeyPress, KeyRelease - for keyboard events | ButtonPress, ButtonRelease, Motion, Enter, Leave, MouseWheel - for mouse events | Visibility, Unmap, Map, Expose, FocusIn, FocusOut, Circulate, | Colormap, Gravity, Reparent, Property, Destroy, Activate, | Deactivate - for window events. | | If a callback function for one of these events is registered | using bind, bind_all, bind_class, or tag_bind, the callback is | called with an Event as first argument. It will have the | following attributes (in braces are the event types for which | the attribute is valid): | | serial - serial number of event | num - mouse button pressed (ButtonPress, ButtonRelease) | focus - whether the window has the focus (Enter, Leave) | height - height of the exposed window (Configure, Expose) | width - width of the exposed window (Configure, Expose) | keycode - keycode of the pressed key (KeyPress, KeyRelease) | state - state of the event as a number (ButtonPress, ButtonRelease, | Enter, KeyPress, KeyRelease, | Leave, Motion) | state - state as a string (Visibility) | time - when the event occurred | x - x-position of the mouse | y - y-position of the mouse | x_root - x-position of the mouse on the screen | (ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion) | y_root - y-position of the mouse on the screen | (ButtonPress, ButtonRelease, KeyPress, KeyRelease, Motion) | char - pressed character (KeyPress, KeyRelease) | send_event - see X/Windows documentation | keysym - keysym of the event as a string (KeyPress, KeyRelease) | keysym_num - keysym of the event as a number (KeyPress, KeyRelease) | type - type of the event as a number | widget - widget in which the event occurred | delta - delta of wheel movement (MouseWheel) | | Methods defined here: | | __repr__(self) | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
tkinter.EventType
Python Library Documentation: class EventType in module tkinter
class EventType(enum.StrEnum)
| EventType(*values)
|
| An enumeration.
|
| Method resolution order:
| EventType
| enum.StrEnum
| builtins.str
| enum.ReprEnum
| enum.Enum
| builtins.object
|
| Methods defined here:
|
| __format__(self, format_spec, /) from builtins.str
| Return a formatted version of the string as described by format_spec.
|
| __new__(cls, value) from enum.Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __str__(self, /) from builtins.str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| Activate = <EventType.Activate: '36'>
|
| ButtonPress = <EventType.ButtonPress: '4'>
|
| ButtonRelease = <EventType.ButtonRelease: '5'>
|
| Circulate = <EventType.Circulate: '26'>
|
| CirculateRequest = <EventType.CirculateRequest: '27'>
|
| ClientMessage = <EventType.ClientMessage: '33'>
|
| Colormap = <EventType.Colormap: '32'>
|
| Configure = <EventType.Configure: '22'>
|
| ConfigureRequest = <EventType.ConfigureRequest: '23'>
|
| Create = <EventType.Create: '16'>
|
| Deactivate = <EventType.Deactivate: '37'>
|
| Destroy = <EventType.Destroy: '17'>
|
| Enter = <EventType.Enter: '7'>
|
| Expose = <EventType.Expose: '12'>
|
| FocusIn = <EventType.FocusIn: '9'>
|
| FocusOut = <EventType.FocusOut: '10'>
|
| GraphicsExpose = <EventType.GraphicsExpose: '13'>
|
| Gravity = <EventType.Gravity: '24'>
|
| KeyPress = <EventType.KeyPress: '2'>
|
| KeyRelease = <EventType.KeyRelease: '3'>
|
| Keymap = <EventType.Keymap: '11'>
|
| Leave = <EventType.Leave: '8'>
|
| Map = <EventType.Map: '19'>
|
| MapRequest = <EventType.MapRequest: '20'>
|
| Mapping = <EventType.Mapping: '34'>
|
| Motion = <EventType.Motion: '6'>
|
| MouseWheel = <EventType.MouseWheel: '38'>
|
| NoExpose = <EventType.NoExpose: '14'>
|
| Property = <EventType.Property: '28'>
|
| Reparent = <EventType.Reparent: '21'>
|
| ResizeRequest = <EventType.ResizeRequest: '25'>
|
| Selection = <EventType.Selection: '31'>
|
| SelectionClear = <EventType.SelectionClear: '29'>
|
| SelectionRequest = <EventType.SelectionRequest: '30'>
|
| Unmap = <EventType.Unmap: '18'>
|
| VirtualEvent = <EventType.VirtualEvent: '35'>
|
| Visibility = <EventType.Visibility: '15'>
|
| ----------------------------------------------------------------------
| Methods inherited from enum.StrEnum:
|
| __repr__(self) from enum.Enum
| Return repr(self).
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.str:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __sizeof__(self, /)
| Return the size of the string in memory, in bytes.
|
| capitalize(self, /)
| Return a capitalized version of the string.
|
| More specifically, make the first character have upper case and the rest lower
| case.
|
| casefold(self, /)
| Return a version of the string suitable for caseless comparisons.
|
| center(self, width, fillchar=' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| count(...)
| S.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of substring sub in
| string S[start:end]. Optional arguments start and end are
| interpreted as in slice notation.
|
| encode(self, /, encoding='utf-8', errors='strict')
| Encode the string using the codec registered for encoding.
|
| encoding
| The encoding in which to encode the string.
| errors
| The error handling scheme to use for encoding errors.
| The default is 'strict' meaning that encoding errors raise a
| UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
| 'xmlcharrefreplace' as well as any other name registered with
| codecs.register_error that can handle UnicodeEncodeErrors.
|
| endswith(...)
| S.endswith(suffix[, start[, end]]) -> bool
|
| Return True if S ends with the specified suffix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| suffix can also be a tuple of strings to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| S.find(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| format(...)
| S.format(*args, **kwargs) -> str
|
| Return a formatted version of S, using substitutions from args and kwargs.
| The substitutions are identified by braces ('{' and '}').
|
| format_map(...)
| S.format_map(mapping) -> str
|
| Return a formatted version of S, using substitutions from mapping.
| The substitutions are identified by braces ('{' and '}').
|
| index(...)
| S.index(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| isalnum(self, /)
| Return True if the string is an alpha-numeric string, False otherwise.
|
| A string is alpha-numeric if all characters in the string are alpha-numeric and
| there is at least one character in the string.
|
| isalpha(self, /)
| Return True if the string is an alphabetic string, False otherwise.
|
| A string is alphabetic if all characters in the string are alphabetic and there
| is at least one character in the string.
|
| isascii(self, /)
| Return True if all characters in the string are ASCII, False otherwise.
|
| ASCII characters have code points in the range U+0000-U+007F.
| Empty string is ASCII too.
|
| isdecimal(self, /)
| Return True if the string is a decimal string, False otherwise.
|
| A string is a decimal string if all characters in the string are decimal and
| there is at least one character in the string.
|
| isdigit(self, /)
| Return True if the string is a digit string, False otherwise.
|
| A string is a digit string if all characters in the string are digits and there
| is at least one character in the string.
|
| isidentifier(self, /)
| Return True if the string is a valid Python identifier, False otherwise.
|
| Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
| such as "def" or "class".
|
| islower(self, /)
| Return True if the string is a lowercase string, False otherwise.
|
| A string is lowercase if all cased characters in the string are lowercase and
| there is at least one cased character in the string.
|
| isnumeric(self, /)
| Return True if the string is a numeric string, False otherwise.
|
| A string is numeric if all characters in the string are numeric and there is at
| least one character in the string.
|
| isprintable(self, /)
| Return True if the string is printable, False otherwise.
|
| A string is printable if all of its characters are considered printable in
| repr() or if it is empty.
|
| isspace(self, /)
| Return True if the string is a whitespace string, False otherwise.
|
| A string is whitespace if all characters in the string are whitespace and there
| is at least one character in the string.
|
| istitle(self, /)
| Return True if the string is a title-cased string, False otherwise.
|
| In a title-cased string, upper- and title-case characters may only
| follow uncased characters and lowercase characters only cased ones.
|
| isupper(self, /)
| Return True if the string is an uppercase string, False otherwise.
|
| A string is uppercase if all cased characters in the string are uppercase and
| there is at least one cased character in the string.
|
| join(self, iterable, /)
| Concatenate any number of strings.
|
| The string whose method is called is inserted in between each given string.
| The result is returned as a new string.
|
| Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
|
| ljust(self, width, fillchar=' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| lower(self, /)
| Return a copy of the string converted to lowercase.
|
| lstrip(self, chars=None, /)
| Return a copy of the string with leading whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| partition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original string
| and two empty strings.
|
| removeprefix(self, prefix, /)
| Return a str with the given prefix string removed if present.
|
| If the string starts with the prefix string, return string[len(prefix):].
| Otherwise, return a copy of the original string.
|
| removesuffix(self, suffix, /)
| Return a str with the given suffix string removed if present.
|
| If the string ends with the suffix string and that suffix is not empty,
| return string[:-len(suffix)]. Otherwise, return a copy of the original
| string.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| S.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| S.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| rjust(self, width, fillchar=' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| rpartition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty strings
| and the original string.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the end of the string and works to the front.
|
| rstrip(self, chars=None, /)
| Return a copy of the string with trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the front of the string and works to the end.
|
| Note, str.split() is mainly useful for data that has been intentionally
| delimited. With natural text that includes punctuation, consider using
| the regular expression module.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the string, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| S.startswith(prefix[, start[, end]]) -> bool
|
| Return True if S starts with the specified prefix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| prefix can also be a tuple of strings to try.
|
| strip(self, chars=None, /)
| Return a copy of the string with leading and trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| swapcase(self, /)
| Convert uppercase characters to lowercase and lowercase characters to uppercase.
|
| title(self, /)
| Return a version of the string where each word is titlecased.
|
| More specifically, words start with uppercased characters and all remaining
| cased characters have lower case.
|
| translate(self, table, /)
| Replace each character in the string using the given translation table.
|
| table
| Translation table, which must be a mapping of Unicode ordinals to
| Unicode ordinals, strings, or None.
|
| The table must implement lookup/indexing via __getitem__, for instance a
| dictionary or list. If this operation raises LookupError, the character is
| left untouched. Characters mapped to None are deleted.
|
| upper(self, /)
| Return a copy of the string converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The string is never truncated.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.str:
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
|
| ----------------------------------------------------------------------
| Methods inherited from enum.Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from enum.Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from enum.EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
tkinter.FALSE
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.FIRST
Error rendering doc: No Python documentation found for 'first'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.FLAT
Error rendering doc: No Python documentation found for 'flat'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Frame
Python Library Documentation: class Frame in module tkinter
class Frame(Widget)
| Frame(master=None, cnf={}, **kw)
|
| Frame widget which may contain other widgets and can have a 3D border.
|
| Method resolution order:
| Frame
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a frame widget with the parent MASTER.
|
| Valid resource names: background, bd, bg, borderwidth, class,
| colormap, container, cursor, height, highlightbackground,
| highlightcolor, highlightthickness, relief, takefocus, visual, width.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.GROOVE
Error rendering doc: No Python documentation found for 'groove'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Grid
Python Library Documentation: class Grid in module tkinter
class Grid(builtins.object)
| Geometry manager Grid.
|
| Base class to use the methods grid_* in every widget.
|
| Methods defined here:
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = grid_configure(self, cnf={}, **kw)
|
| configure = grid_configure(self, cnf={}, **kw)
|
| forget = grid_forget(self)
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None) from tkinter.Misc
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw) from tkinter.Misc
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_location(self, x, y) from tkinter.Misc
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_']) from tkinter.Misc
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| grid_rowconfigure(self, index, cnf={}, **kw) from tkinter.Misc
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self) from tkinter.Misc
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None) from tkinter.Misc
| Return a list of all slaves of this widget
| in its packing order.
|
| info = grid_info(self)
|
| location = grid_location(self, x, y)
|
| propagate = grid_propagate(self, flag=['_noarg_'])
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| size = grid_size(self)
|
| slaves = grid_slaves(self, row=None, column=None)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.HIDDEN
Error rendering doc: No Python documentation found for 'hidden'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.HORIZONTAL
Error rendering doc: No Python documentation found for 'horizontal'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.INSERT
Error rendering doc: No Python documentation found for 'insert'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.INSIDE
Error rendering doc: No Python documentation found for 'inside'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Image
Python Library Documentation: class Image in module tkinter
class Image(builtins.object)
| Image(imgtype, name=None, cnf={}, master=None, **kw)
|
| Base class for images.
|
| Methods defined here:
|
| __del__(self)
|
| __getitem__(self, key)
|
| __init__(self, imgtype, name=None, cnf={}, master=None, **kw)
| Initialize self. See help(type(self)) for accurate signature.
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return str(self).
|
| config = configure(self, **kw)
|
| configure(self, **kw)
| Configure the image.
|
| height(self)
| Return the height of the image.
|
| type(self)
| Return the type of the image, e.g. "photo" or "bitmap".
|
| width(self)
| Return the width of the image.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.IntVar
Python Library Documentation: class IntVar in module tkinter class IntVar(Variable) | IntVar(master=None, value=None, name=None) | | Value holder for integer variables. | | Method resolution order: | IntVar | Variable | builtins.object | | Methods defined here: | | __init__(self, master=None, value=None, name=None) | Construct an integer variable. | | MASTER can be given as master widget. | VALUE is an optional value (defaults to 0) | NAME is an optional Tcl name (defaults to PY_VARnum). | | If NAME matches an existing variable and VALUE is omitted | then the existing value is retained. | | get(self) | Return the value of the variable as an integer. | | ---------------------------------------------------------------------- | Methods inherited from Variable: | | __del__(self) | Unset the variable in Tcl. | | __eq__(self, other) | Return self==value. | | __str__(self) | Return the name of the variable in Tcl. | | initialize = set(self, value) | | set(self, value) | Set the variable to VALUE. | | trace = trace_variable(self, mode, callback) | | trace_add(self, mode, callback) | Define a trace callback for the variable. | | Mode is one of "read", "write", "unset", or a list or tuple of | such strings. | Callback must be a function which is called when the variable is | read, written or unset. | | Return the name of the callback. | | trace_info(self) | Return all trace callback information. | | trace_remove(self, mode, cbname) | Delete the trace callback for a variable. | | Mode is one of "read", "write", "unset" or a list or tuple of | such strings. Must be same as were specified in trace_add(). | cbname is the name of the callback returned from trace_add(). | | trace_variable(self, mode, callback) | Define a trace callback for the variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CALLBACK must be a function which is called when | the variable is read, written or undefined. | | Return the name of the callback. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_add() instead. | | trace_vdelete(self, mode, cbname) | Delete the trace callback for a variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CBNAME is the name of the callback returned from trace_variable or trace. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_remove() instead. | | trace_vinfo(self) | Return all trace callback information. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_info() instead. | | ---------------------------------------------------------------------- | Data descriptors inherited from Variable: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes inherited from Variable: | | __hash__ = None
tkinter.LAST
Error rendering doc: No Python documentation found for 'last'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.LEFT
Error rendering doc: No Python documentation found for 'left'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Label
Python Library Documentation: class Label in module tkinter
class Label(Widget)
| Label(master=None, cnf={}, **kw)
|
| Label widget which can display text and bitmaps.
|
| Method resolution order:
| Label
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a label widget with the parent MASTER.
|
| STANDARD OPTIONS
|
| activebackground, activeforeground, anchor,
| background, bitmap, borderwidth, cursor,
| disabledforeground, font, foreground,
| highlightbackground, highlightcolor,
| highlightthickness, image, justify,
| padx, pady, relief, takefocus, text,
| textvariable, underline, wraplength
|
| WIDGET-SPECIFIC OPTIONS
|
| height, state, width
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.LabelFrame
Python Library Documentation: class LabelFrame in module tkinter
class LabelFrame(Widget)
| LabelFrame(master=None, cnf={}, **kw)
|
| labelframe widget.
|
| Method resolution order:
| LabelFrame
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a labelframe widget with the parent MASTER.
|
| STANDARD OPTIONS
|
| borderwidth, cursor, font, foreground,
| highlightbackground, highlightcolor,
| highlightthickness, padx, pady, relief,
| takefocus, text
|
| WIDGET-SPECIFIC OPTIONS
|
| background, class, colormap, container,
| height, labelanchor, labelwidget,
| visual, width
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Listbox
Python Library Documentation: class Listbox in module tkinter
class Listbox(Widget, XView, YView)
| Listbox(master=None, cnf={}, **kw)
|
| Listbox widget which can display a list of strings.
|
| Method resolution order:
| Listbox
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| XView
| YView
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a listbox widget with the parent MASTER.
|
| Valid resource names: background, bd, bg, borderwidth, cursor,
| exportselection, fg, font, foreground, height, highlightbackground,
| highlightcolor, highlightthickness, relief, selectbackground,
| selectborderwidth, selectforeground, selectmode, setgrid, takefocus,
| width, xscrollcommand, yscrollcommand, listvariable.
|
| activate(self, index)
| Activate item identified by INDEX.
|
| bbox(self, index)
| Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle
| which encloses the item identified by the given index.
|
| curselection(self)
| Return the indices of currently selected item.
|
| delete(self, first, last=None)
| Delete items from FIRST to LAST (included).
|
| get(self, first, last=None)
| Get list of items from FIRST to LAST (included).
|
| index(self, index)
| Return index of item identified with INDEX.
|
| insert(self, index, *elements)
| Insert ELEMENTS at INDEX.
|
| itemcget(self, index, option)
| Return the resource value for an ITEM and an OPTION.
|
| itemconfig = itemconfigure(self, index, cnf=None, **kw)
|
| itemconfigure(self, index, cnf=None, **kw)
| Configure resources of an ITEM.
|
| The values for resources are specified as keyword arguments.
| To get an overview about the allowed keyword arguments
| call the method without arguments.
| Valid resource names: background, bg, foreground, fg,
| selectbackground, selectforeground.
|
| nearest(self, y)
| Get index of item which is nearest to y coordinate Y.
|
| scan_dragto(self, x, y)
| Adjust the view of the listbox to 10 times the
| difference between X and Y and the coordinates given in
| scan_mark.
|
| scan_mark(self, x, y)
| Remember the current X, Y coordinates.
|
| see(self, index)
| Scroll such that INDEX is visible.
|
| select_anchor = selection_anchor(self, index)
|
| select_clear = selection_clear(self, first, last=None)
|
| select_includes = selection_includes(self, index)
|
| select_set = selection_set(self, first, last=None)
|
| selection_anchor(self, index)
| Set the fixed end oft the selection to INDEX.
|
| selection_clear(self, first, last=None)
| Clear the selection from FIRST to LAST (included).
|
| selection_includes(self, index)
| Return True if INDEX is part of the selection.
|
| selection_set(self, first, last=None)
| Set the selection from FIRST to LAST (included) without
| changing the currently selected elements.
|
| size(self)
| Return the number of elements in the listbox.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
|
| ----------------------------------------------------------------------
| Methods inherited from XView:
|
| xview(self, *args)
| Query and change the horizontal position of the view.
|
| xview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total width of the canvas is off-screen to the left.
|
| xview_scroll(self, number, what)
| Shift the x-view according to NUMBER which is measured in "units"
| or "pages" (WHAT).
|
| ----------------------------------------------------------------------
| Methods inherited from YView:
|
| yview(self, *args)
| Query and change the vertical position of the view.
|
| yview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total height of the canvas is off-screen to the top.
|
| yview_scroll(self, number, what)
| Shift the y-view according to NUMBER which is measured in
| "units" or "pages" (WHAT).
tkinter.MITER
Error rendering doc: No Python documentation found for 'miter'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.MOVETO
Error rendering doc: No Python documentation found for 'moveto'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.MULTIPLE
Error rendering doc: No Python documentation found for 'multiple'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Menu
Python Library Documentation: class Menu in module tkinter
class Menu(Widget)
| Menu(master=None, cnf={}, **kw)
|
| Menu widget which allows displaying menu bars, pull-down menus and pop-up menus.
|
| Method resolution order:
| Menu
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct menu widget with the parent MASTER.
|
| Valid resource names: activebackground, activeborderwidth,
| activeforeground, background, bd, bg, borderwidth, cursor,
| disabledforeground, fg, font, foreground, postcommand, relief,
| selectcolor, takefocus, tearoff, tearoffcommand, title, type.
|
| activate(self, index)
| Activate entry at INDEX.
|
| add(self, itemType, cnf={}, **kw)
| Internal function.
|
| add_cascade(self, cnf={}, **kw)
| Add hierarchical menu item.
|
| add_checkbutton(self, cnf={}, **kw)
| Add checkbutton menu item.
|
| add_command(self, cnf={}, **kw)
| Add command menu item.
|
| add_radiobutton(self, cnf={}, **kw)
| Add radio menu item.
|
| add_separator(self, cnf={}, **kw)
| Add separator.
|
| delete(self, index1, index2=None)
| Delete menu items between INDEX1 and INDEX2 (included).
|
| entrycget(self, index, option)
| Return the resource value of a menu item for OPTION at INDEX.
|
| entryconfig = entryconfigure(self, index, cnf=None, **kw)
|
| entryconfigure(self, index, cnf=None, **kw)
| Configure a menu item at INDEX.
|
| index(self, index)
| Return the index of a menu item identified by INDEX.
|
| insert(self, index, itemType, cnf={}, **kw)
| Internal function.
|
| insert_cascade(self, index, cnf={}, **kw)
| Add hierarchical menu item at INDEX.
|
| insert_checkbutton(self, index, cnf={}, **kw)
| Add checkbutton menu item at INDEX.
|
| insert_command(self, index, cnf={}, **kw)
| Add command menu item at INDEX.
|
| insert_radiobutton(self, index, cnf={}, **kw)
| Add radio menu item at INDEX.
|
| insert_separator(self, index, cnf={}, **kw)
| Add separator at INDEX.
|
| invoke(self, index)
| Invoke a menu item identified by INDEX and execute
| the associated command.
|
| post(self, x, y)
| Display a menu at position X,Y.
|
| tk_popup(self, x, y, entry='')
| Post the menu at position X,Y with entry ENTRY.
|
| type(self, index)
| Return the type of the menu item at INDEX.
|
| unpost(self)
| Unmap a menu.
|
| xposition(self, index)
| Return the x-position of the leftmost pixel of the menu item
| at INDEX.
|
| yposition(self, index)
| Return the y-position of the topmost pixel of the menu item at INDEX.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Menubutton
Python Library Documentation: class Menubutton in module tkinter
class Menubutton(Widget)
| Menubutton(master=None, cnf={}, **kw)
|
| Menubutton widget, obsolete since Tk8.0.
|
| Method resolution order:
| Menubutton
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a widget with the parent widget MASTER, a name WIDGETNAME
| and appropriate options.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Message
Python Library Documentation: class Message in module tkinter
class Message(Widget)
| Message(master=None, cnf={}, **kw)
|
| Message widget to display multiline text. Obsolete since Label does it too.
|
| Method resolution order:
| Message
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a widget with the parent widget MASTER, a name WIDGETNAME
| and appropriate options.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Misc
Python Library Documentation: class Misc in module tkinter
class Misc(builtins.object)
| Internal class.
|
| Base class which defines methods common for interior widgets.
|
| Methods defined here:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| destroy(self)
| Internal function.
|
| Delete all Tcl commands created for
| this widget in the Tcl interpreter.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.N
Error rendering doc: No Python documentation found for 'n'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NE
Error rendering doc: No Python documentation found for 'ne'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NO
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.NONE
Error rendering doc: No Python documentation found for 'none'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NORMAL
Error rendering doc: No Python documentation found for 'normal'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NS
Error rendering doc: No Python documentation found for 'ns'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NSEW
Error rendering doc: No Python documentation found for 'nsew'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NUMERIC
Error rendering doc: No Python documentation found for 'numeric'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NW
Error rendering doc: No Python documentation found for 'nw'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.NoDefaultRoot
Python Library Documentation: function NoDefaultRoot in module tkinter
NoDefaultRoot()
Inhibit setting of default root window.
Call this function to inhibit that the first instance of
Tk is used for windows without an explicit parent window.
tkinter.OFF
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.ON
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.OUTSIDE
Error rendering doc: No Python documentation found for 'outside'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.OptionMenu
Python Library Documentation: class OptionMenu in module tkinter
class OptionMenu(Menubutton)
| OptionMenu(master, variable, value, *values, **kwargs)
|
| OptionMenu which allows the user to select a value from a menu.
|
| Method resolution order:
| OptionMenu
| Menubutton
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __getitem__(self, name)
| Return the resource value for a KEY given as string.
|
| __init__(self, master, variable, value, *values, **kwargs)
| Construct an optionmenu widget with the parent MASTER, with
| the resource textvariable set to VARIABLE, the initially selected
| value VALUE, the other menu values VALUES and an additional
| keyword argument command.
|
| destroy(self)
| Destroy this widget and the associated menu.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.PAGES
Error rendering doc: No Python documentation found for 'pages'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.PIESLICE
Error rendering doc: No Python documentation found for 'pieslice'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.PROJECTING
Error rendering doc: No Python documentation found for 'projecting'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Pack
Python Library Documentation: class Pack in module tkinter
class Pack(builtins.object)
| Geometry manager Pack.
|
| Base class to use the methods pack_* in every widget.
|
| Methods defined here:
|
| config = pack_configure(self, cnf={}, **kw)
|
| configure = pack_configure(self, cnf={}, **kw)
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| pack_propagate(self, flag=['_noarg_']) from tkinter.Misc
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self) from tkinter.Misc
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| slaves = pack_slaves(self)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.PanedWindow
Python Library Documentation: class PanedWindow in module tkinter
class PanedWindow(Widget)
| PanedWindow(master=None, cnf={}, **kw)
|
| panedwindow widget.
|
| Method resolution order:
| PanedWindow
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a panedwindow widget with the parent MASTER.
|
| STANDARD OPTIONS
|
| background, borderwidth, cursor, height,
| orient, relief, width
|
| WIDGET-SPECIFIC OPTIONS
|
| handlepad, handlesize, opaqueresize,
| sashcursor, sashpad, sashrelief,
| sashwidth, showhandle,
|
| add(self, child, **kw)
| Add a child widget to the panedwindow in a new pane.
|
| The child argument is the name of the child widget
| followed by pairs of arguments that specify how to
| manage the windows. The possible options and values
| are the ones accepted by the paneconfigure method.
|
| forget = remove(self, child)
|
| identify(self, x, y)
| Identify the panedwindow component at point x, y
|
| If the point is over a sash or a sash handle, the result
| is a two element list containing the index of the sash or
| handle, and a word indicating whether it is over a sash
| or a handle, such as {0 sash} or {2 handle}. If the point
| is over any other part of the panedwindow, the result is
| an empty list.
|
| panecget(self, child, option)
| Query a management option for window.
|
| Option may be any value allowed by the paneconfigure subcommand
|
| paneconfig = paneconfigure(self, tagOrId, cnf=None, **kw)
|
| paneconfigure(self, tagOrId, cnf=None, **kw)
| Query or modify the management options for window.
|
| If no option is specified, returns a list describing all
| of the available options for pathName. If option is
| specified with no value, then the command returns a list
| describing the one named option (this list will be identical
| to the corresponding sublist of the value returned if no
| option is specified). If one or more option-value pairs are
| specified, then the command modifies the given widget
| option(s) to have the given value(s); in this case the
| command returns an empty string. The following options
| are supported:
|
| after window
| Insert the window after the window specified. window
| should be the name of a window already managed by pathName.
| before window
| Insert the window before the window specified. window
| should be the name of a window already managed by pathName.
| height size
| Specify a height for the window. The height will be the
| outer dimension of the window including its border, if
| any. If size is an empty string, or if -height is not
| specified, then the height requested internally by the
| window will be used initially; the height may later be
| adjusted by the movement of sashes in the panedwindow.
| Size may be any value accepted by Tk_GetPixels.
| minsize n
| Specifies that the size of the window cannot be made
| less than n. This constraint only affects the size of
| the widget in the paned dimension -- the x dimension
| for horizontal panedwindows, the y dimension for
| vertical panedwindows. May be any value accepted by
| Tk_GetPixels.
| padx n
| Specifies a non-negative value indicating how much
| extra space to leave on each side of the window in
| the X-direction. The value may have any of the forms
| accepted by Tk_GetPixels.
| pady n
| Specifies a non-negative value indicating how much
| extra space to leave on each side of the window in
| the Y-direction. The value may have any of the forms
| accepted by Tk_GetPixels.
| sticky style
| If a window's pane is larger than the requested
| dimensions of the window, this option may be used
| to position (or stretch) the window within its pane.
| Style is a string that contains zero or more of the
| characters n, s, e or w. The string can optionally
| contains spaces or commas, but they are ignored. Each
| letter refers to a side (north, south, east, or west)
| that the window will "stick" to. If both n and s
| (or e and w) are specified, the window will be
| stretched to fill the entire height (or width) of
| its cavity.
| width size
| Specify a width for the window. The width will be
| the outer dimension of the window including its
| border, if any. If size is an empty string, or
| if -width is not specified, then the width requested
| internally by the window will be used initially; the
| width may later be adjusted by the movement of sashes
| in the panedwindow. Size may be any value accepted by
| Tk_GetPixels.
|
| panes(self)
| Returns an ordered list of the child panes.
|
| proxy(self, *args)
| Internal function.
|
| proxy_coord(self)
| Return the x and y pair of the most recent proxy location
|
| proxy_forget(self)
| Remove the proxy from the display.
|
| proxy_place(self, x, y)
| Place the proxy at the given x and y coordinates.
|
| remove(self, child)
| Remove the pane containing child from the panedwindow
|
| All geometry management options for child will be forgotten.
|
| sash(self, *args)
| Internal function.
|
| sash_coord(self, index)
| Return the current x and y pair for the sash given by index.
|
| Index must be an integer between 0 and 1 less than the
| number of panes in the panedwindow. The coordinates given are
| those of the top left corner of the region containing the sash.
| pathName sash dragto index x y This command computes the
| difference between the given coordinates and the coordinates
| given to the last sash coord command for the given sash. It then
| moves that sash the computed difference. The return value is the
| empty string.
|
| sash_mark(self, index)
| Records x and y for the sash given by index;
|
| Used in conjunction with later dragto commands to move the sash.
|
| sash_place(self, index, x, y)
| Place the sash given by index at the given coordinates
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.PhotoImage
Python Library Documentation: class PhotoImage in module tkinter
class PhotoImage(Image)
| PhotoImage(name=None, cnf={}, master=None, **kw)
|
| Widget which can display images in PGM, PPM, GIF, PNG format.
|
| Method resolution order:
| PhotoImage
| Image
| builtins.object
|
| Methods defined here:
|
| __getitem__(self, key)
|
| __init__(self, name=None, cnf={}, master=None, **kw)
| Create an image with NAME.
|
| Valid resource names: data, format, file, gamma, height, palette,
| width.
|
| blank(self)
| Display a transparent image.
|
| cget(self, option)
| Return the value of OPTION.
|
| copy(self)
| Return a new PhotoImage with the same image as this widget.
|
| get(self, x, y)
| Return the color (red, green, blue) of the pixel at X,Y.
|
| put(self, data, to=None)
| Put row formatted colors to image starting from
| position TO, e.g. image.put("{red green} {blue yellow}", to=(4,6))
|
| subsample(self, x, y='')
| Return a new PhotoImage based on the same image as this widget
| but use only every Xth or Yth pixel. If y is not given, the
| default value is the same as x.
|
| transparency_get(self, x, y)
| Return True if the pixel at x,y is transparent.
|
| transparency_set(self, x, y, boolean)
| Set the transparency of the pixel at x,y.
|
| write(self, filename, format=None, from_coords=None)
| Write image to file FILENAME in FORMAT starting from
| position FROM_COORDS.
|
| zoom(self, x, y='')
| Return a new PhotoImage with the same image as this widget
| but zoom it with a factor of x in the X direction and y in the Y
| direction. If y is not given, the default value is the same as x.
|
| ----------------------------------------------------------------------
| Methods inherited from Image:
|
| __del__(self)
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return str(self).
|
| config = configure(self, **kw)
|
| configure(self, **kw)
| Configure the image.
|
| height(self)
| Return the height of the image.
|
| type(self)
| Return the type of the image, e.g. "photo" or "bitmap".
|
| width(self)
| Return the width of the image.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Image:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.Place
Python Library Documentation: class Place in module tkinter
class Place(builtins.object)
| Geometry manager Place.
|
| Base class to use the methods place_* in every widget.
|
| Methods defined here:
|
| config = place_configure(self, cnf={}, **kw)
|
| configure = place_configure(self, cnf={}, **kw)
|
| forget = place_forget(self)
|
| info = place_info(self)
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| place_slaves(self) from tkinter.Misc
| Return a list of all slaves of this widget
| in its packing order.
|
| slaves = place_slaves(self)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
tkinter.RADIOBUTTON
Error rendering doc: No Python documentation found for 'radiobutton'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.RAISED
Error rendering doc: No Python documentation found for 'raised'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.READABLE
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.RIDGE
Error rendering doc: No Python documentation found for 'ridge'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.RIGHT
Error rendering doc: No Python documentation found for 'right'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.ROUND
Python Library Documentation: built-in function round in module builtins
round(number, ndigits=None)
Round a number to a given precision in decimal digits.
The return value is an integer if ndigits is omitted or None. Otherwise
the return value has the same type as the number. ndigits may be negative.
tkinter.Radiobutton
Python Library Documentation: class Radiobutton in module tkinter
class Radiobutton(Widget)
| Radiobutton(master=None, cnf={}, **kw)
|
| Radiobutton widget which shows only one of several buttons in on-state.
|
| Method resolution order:
| Radiobutton
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a radiobutton widget with the parent MASTER.
|
| Valid resource names: activebackground, activeforeground, anchor,
| background, bd, bg, bitmap, borderwidth, command, cursor,
| disabledforeground, fg, font, foreground, height,
| highlightbackground, highlightcolor, highlightthickness, image,
| indicatoron, justify, padx, pady, relief, selectcolor, selectimage,
| state, takefocus, text, textvariable, underline, value, variable,
| width, wraplength.
|
| deselect(self)
| Put the button in off-state.
|
| flash(self)
| Flash the button.
|
| invoke(self)
| Toggle the button and invoke a command if given as resource.
|
| select(self)
| Put the button in on-state.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.S
Error rendering doc: No Python documentation found for 's'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SCROLL
Error rendering doc: No Python documentation found for 'scroll'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SE
Error rendering doc: No Python documentation found for 'se'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SEL
Error rendering doc: No Python documentation found for 'sel'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SEL_FIRST
Error rendering doc: No Python documentation found for 'sel.first'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SEL_LAST
Error rendering doc: No Python documentation found for 'sel.last'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SEPARATOR
Error rendering doc: No Python documentation found for 'separator'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SINGLE
Error rendering doc: No Python documentation found for 'single'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SOLID
Error rendering doc: No Python documentation found for 'solid'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SUNKEN
Error rendering doc: No Python documentation found for 'sunken'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.SW
Error rendering doc: No Python documentation found for 'sw'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Scale
Python Library Documentation: class Scale in module tkinter
class Scale(Widget)
| Scale(master=None, cnf={}, **kw)
|
| Scale widget which can display a numerical scale.
|
| Method resolution order:
| Scale
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a scale widget with the parent MASTER.
|
| Valid resource names: activebackground, background, bigincrement, bd,
| bg, borderwidth, command, cursor, digits, fg, font, foreground, from,
| highlightbackground, highlightcolor, highlightthickness, label,
| length, orient, relief, repeatdelay, repeatinterval, resolution,
| showvalue, sliderlength, sliderrelief, state, takefocus,
| tickinterval, to, troughcolor, variable, width.
|
| coords(self, value=None)
| Return a tuple (X,Y) of the point along the centerline of the
| trough that corresponds to VALUE or the current value if None is
| given.
|
| get(self)
| Get the current value as integer or float.
|
| identify(self, x, y)
| Return where the point X,Y lies. Valid return values are "slider",
| "though1" and "though2".
|
| set(self, value)
| Set the value to VALUE.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Scrollbar
Python Library Documentation: class Scrollbar in module tkinter
class Scrollbar(Widget)
| Scrollbar(master=None, cnf={}, **kw)
|
| Scrollbar widget which displays a slider at a certain position.
|
| Method resolution order:
| Scrollbar
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a scrollbar widget with the parent MASTER.
|
| Valid resource names: activebackground, activerelief,
| background, bd, bg, borderwidth, command, cursor,
| elementborderwidth, highlightbackground,
| highlightcolor, highlightthickness, jump, orient,
| relief, repeatdelay, repeatinterval, takefocus,
| troughcolor, width.
|
| activate(self, index=None)
| Marks the element indicated by index as active.
| The only index values understood by this method are "arrow1",
| "slider", or "arrow2". If any other value is specified then no
| element of the scrollbar will be active. If index is not specified,
| the method returns the name of the element that is currently active,
| or None if no element is active.
|
| delta(self, deltax, deltay)
| Return the fractional change of the scrollbar setting if it
| would be moved by DELTAX or DELTAY pixels.
|
| fraction(self, x, y)
| Return the fractional value which corresponds to a slider
| position of X,Y.
|
| get(self)
| Return the current fractional values (upper and lower end)
| of the slider position.
|
| identify(self, x, y)
| Return the element under position X,Y as one of
| "arrow1","slider","arrow2" or "".
|
| set(self, first, last)
| Set the fractional values of the slider position (upper and
| lower ends as value between 0 and 1).
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Spinbox
Python Library Documentation: class Spinbox in module tkinter
class Spinbox(Widget, XView)
| Spinbox(master=None, cnf={}, **kw)
|
| spinbox widget.
|
| Method resolution order:
| Spinbox
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| XView
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a spinbox widget with the parent MASTER.
|
| STANDARD OPTIONS
|
| activebackground, background, borderwidth,
| cursor, exportselection, font, foreground,
| highlightbackground, highlightcolor,
| highlightthickness, insertbackground,
| insertborderwidth, insertofftime,
| insertontime, insertwidth, justify, relief,
| repeatdelay, repeatinterval,
| selectbackground, selectborderwidth
| selectforeground, takefocus, textvariable
| xscrollcommand.
|
| WIDGET-SPECIFIC OPTIONS
|
| buttonbackground, buttoncursor,
| buttondownrelief, buttonuprelief,
| command, disabledbackground,
| disabledforeground, format, from,
| invalidcommand, increment,
| readonlybackground, state, to,
| validate, validatecommand values,
| width, wrap,
|
| bbox(self, index)
| Return a tuple of X1,Y1,X2,Y2 coordinates for a
| rectangle which encloses the character given by index.
|
| The first two elements of the list give the x and y
| coordinates of the upper-left corner of the screen
| area covered by the character (in pixels relative
| to the widget) and the last two elements give the
| width and height of the character, in pixels. The
| bounding box may refer to a region outside the
| visible area of the window.
|
| delete(self, first, last=None)
| Delete one or more elements of the spinbox.
|
| First is the index of the first character to delete,
| and last is the index of the character just after
| the last one to delete. If last isn't specified it
| defaults to first+1, i.e. a single character is
| deleted. This command returns an empty string.
|
| get(self)
| Returns the spinbox's string
|
| icursor(self, index)
| Alter the position of the insertion cursor.
|
| The insertion cursor will be displayed just before
| the character given by index. Returns an empty string
|
| identify(self, x, y)
| Returns the name of the widget at position x, y
|
| Return value is one of: none, buttondown, buttonup, entry
|
| index(self, index)
| Returns the numerical index corresponding to index
|
| insert(self, index, s)
| Insert string s at index
|
| Returns an empty string.
|
| invoke(self, element)
| Causes the specified element to be invoked
|
| The element could be buttondown or buttonup
| triggering the action associated with it.
|
| scan(self, *args)
| Internal function.
|
| scan_dragto(self, x)
| Compute the difference between the given x argument
| and the x argument to the last scan mark command
|
| It then adjusts the view left or right by 10 times the
| difference in x-coordinates. This command is typically
| associated with mouse motion events in the widget, to
| produce the effect of dragging the spinbox at high speed
| through the window. The return value is an empty string.
|
| scan_mark(self, x)
| Records x and the current view in the spinbox window;
|
| used in conjunction with later scan dragto commands.
| Typically this command is associated with a mouse button
| press in the widget. It returns an empty string.
|
| selection(self, *args)
| Internal function.
|
| selection_adjust(self, index)
| Locate the end of the selection nearest to the character
| given by index,
|
| Then adjust that end of the selection to be at index
| (i.e including but not going beyond index). The other
| end of the selection is made the anchor point for future
| select to commands. If the selection isn't currently in
| the spinbox, then a new selection is created to include
| the characters between index and the most recent selection
| anchor point, inclusive.
|
| selection_clear(self)
| Clear the selection
|
| If the selection isn't in this widget then the
| command has no effect.
|
| selection_element(self, element=None)
| Sets or gets the currently selected element.
|
| If a spinbutton element is specified, it will be
| displayed depressed.
|
| selection_from(self, index)
| Set the fixed end of a selection to INDEX.
|
| selection_present(self)
| Return True if there are characters selected in the spinbox, False
| otherwise.
|
| selection_range(self, start, end)
| Set the selection from START to END (not included).
|
| selection_to(self, index)
| Set the variable end of a selection to INDEX.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
|
| ----------------------------------------------------------------------
| Methods inherited from XView:
|
| xview(self, *args)
| Query and change the horizontal position of the view.
|
| xview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total width of the canvas is off-screen to the left.
|
| xview_scroll(self, number, what)
| Shift the x-view according to NUMBER which is measured in "units"
| or "pages" (WHAT).
tkinter.StringVar
Python Library Documentation: class StringVar in module tkinter class StringVar(Variable) | StringVar(master=None, value=None, name=None) | | Value holder for strings variables. | | Method resolution order: | StringVar | Variable | builtins.object | | Methods defined here: | | __init__(self, master=None, value=None, name=None) | Construct a string variable. | | MASTER can be given as master widget. | VALUE is an optional value (defaults to "") | NAME is an optional Tcl name (defaults to PY_VARnum). | | If NAME matches an existing variable and VALUE is omitted | then the existing value is retained. | | get(self) | Return value of variable as string. | | ---------------------------------------------------------------------- | Methods inherited from Variable: | | __del__(self) | Unset the variable in Tcl. | | __eq__(self, other) | Return self==value. | | __str__(self) | Return the name of the variable in Tcl. | | initialize = set(self, value) | | set(self, value) | Set the variable to VALUE. | | trace = trace_variable(self, mode, callback) | | trace_add(self, mode, callback) | Define a trace callback for the variable. | | Mode is one of "read", "write", "unset", or a list or tuple of | such strings. | Callback must be a function which is called when the variable is | read, written or unset. | | Return the name of the callback. | | trace_info(self) | Return all trace callback information. | | trace_remove(self, mode, cbname) | Delete the trace callback for a variable. | | Mode is one of "read", "write", "unset" or a list or tuple of | such strings. Must be same as were specified in trace_add(). | cbname is the name of the callback returned from trace_add(). | | trace_variable(self, mode, callback) | Define a trace callback for the variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CALLBACK must be a function which is called when | the variable is read, written or undefined. | | Return the name of the callback. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_add() instead. | | trace_vdelete(self, mode, cbname) | Delete the trace callback for a variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CBNAME is the name of the callback returned from trace_variable or trace. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_remove() instead. | | trace_vinfo(self) | Return all trace callback information. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_info() instead. | | ---------------------------------------------------------------------- | Data descriptors inherited from Variable: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes inherited from Variable: | | __hash__ = None
tkinter.TOP
Error rendering doc: No Python documentation found for 'top'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.TRUE
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.Tcl
Python Library Documentation: function Tcl in module tkinter Tcl(screenName=None, baseName=None, className='Tk', useTk=False)
tkinter.TclError
Python Library Documentation: class TclError in module _tkinter class TclError(builtins.Exception) | Method resolution order: | TclError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
tkinter.TclVersion
Python Library Documentation: float object
class float(object)
| float(x=0, /)
|
| Convert a string or number to a floating-point number, if possible.
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(self, /)
| Return the ceiling as an Integral.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(self, /)
| Return the floor as an Integral.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Formats the float according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(self, ndigits=None, /)
| Return the Integral closest to x, rounding half toward even.
|
| When an argument is passed, work like built-in round(x, ndigits).
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(self, /)
| Return the Integral closest to x between 0 and x.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is exactly equal to the original float.
|
| The ratio is in lowest terms and has a positive denominator. Raise
| OverflowError on infinities and a ValueError on NaNs.
|
| >>> (10.0).as_integer_ratio()
| (10, 1)
| >>> (0.0).as_integer_ratio()
| (0, 1)
| >>> (-.25).as_integer_ratio()
| (-1, 4)
|
| conjugate(self, /)
| Return self, the complex conjugate of any float.
|
| hex(self, /)
| Return a hexadecimal representation of a floating-point number.
|
| >>> (-0.1).hex()
| '-0x1.999999999999ap-4'
| >>> 3.14159.hex()
| '0x1.921f9f01b866ep+1'
|
| is_integer(self, /)
| Return True if the float is an integer.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __getformat__(typestr, /)
| You probably don't want to use this function.
|
| typestr
| Must be 'double' or 'float'.
|
| It exists mainly to be used in Python's test suite.
|
| This function returns whichever of 'unknown', 'IEEE, big-endian' or 'IEEE,
| little-endian' best describes the format of floating-point numbers used by the
| C type named by typestr.
|
| fromhex(string, /)
| Create a floating-point number from a hexadecimal string.
|
| >>> float.fromhex('0x1.ffffp10')
| 2047.984375
| >>> float.fromhex('-0x1p-1074')
| -5e-324
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| imag
| the imaginary part of a complex number
|
| real
| the real part of a complex number
tkinter.Text
Python Library Documentation: class Text in module tkinter
class Text(Widget, XView, YView)
| Text(master=None, cnf={}, **kw)
|
| Text widget which can display text in various forms.
|
| Method resolution order:
| Text
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| XView
| YView
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a text widget with the parent MASTER.
|
| STANDARD OPTIONS
|
| background, borderwidth, cursor,
| exportselection, font, foreground,
| highlightbackground, highlightcolor,
| highlightthickness, insertbackground,
| insertborderwidth, insertofftime,
| insertontime, insertwidth, padx, pady,
| relief, selectbackground,
| selectborderwidth, selectforeground,
| setgrid, takefocus,
| xscrollcommand, yscrollcommand,
|
| WIDGET-SPECIFIC OPTIONS
|
| autoseparators, height, maxundo,
| spacing1, spacing2, spacing3,
| state, tabs, undo, width, wrap,
|
| bbox(self, index)
| Return a tuple of (x,y,width,height) which gives the bounding
| box of the visible part of the character at the given index.
|
| compare(self, index1, op, index2)
| Return whether between index INDEX1 and index INDEX2 the
| relation OP is satisfied. OP is one of <, <=, ==, >=, >, or !=.
|
| count(self, index1, index2, *args)
| Counts the number of relevant things between the two indices.
| If index1 is after index2, the result will be a negative number
| (and this holds for each of the possible options).
|
| The actual items which are counted depends on the options given by
| args. The result is a list of integers, one for the result of each
| counting option given. Valid counting options are "chars",
| "displaychars", "displayindices", "displaylines", "indices",
| "lines", "xpixels" and "ypixels". There is an additional possible
| option "update", which if given then all subsequent options ensure
| that any possible out of date information is recalculated.
|
| debug(self, boolean=None)
| Turn on the internal consistency checks of the B-Tree inside the text
| widget according to BOOLEAN.
|
| delete(self, index1, index2=None)
| Delete the characters between INDEX1 and INDEX2 (not included).
|
| dlineinfo(self, index)
| Return tuple (x,y,width,height,baseline) giving the bounding box
| and baseline position of the visible part of the line containing
| the character at INDEX.
|
| dump(self, index1, index2=None, command=None, **kw)
| Return the contents of the widget between index1 and index2.
|
| The type of contents returned in filtered based on the keyword
| parameters; if 'all', 'image', 'mark', 'tag', 'text', or 'window' are
| given and true, then the corresponding items are returned. The result
| is a list of triples of the form (key, value, index). If none of the
| keywords are true then 'all' is used by default.
|
| If the 'command' argument is given, it is called once for each element
| of the list of triples, with the values of each triple serving as the
| arguments to the function. In this case the list is not returned.
|
| edit(self, *args)
| Internal method
|
| This method controls the undo mechanism and
| the modified flag. The exact behavior of the
| command depends on the option argument that
| follows the edit argument. The following forms
| of the command are currently supported:
|
| edit_modified, edit_redo, edit_reset, edit_separator
| and edit_undo
|
| edit_modified(self, arg=None)
| Get or Set the modified flag
|
| If arg is not specified, returns the modified
| flag of the widget. The insert, delete, edit undo and
| edit redo commands or the user can set or clear the
| modified flag. If boolean is specified, sets the
| modified flag of the widget to arg.
|
| edit_redo(self)
| Redo the last undone edit
|
| When the undo option is true, reapplies the last
| undone edits provided no other edits were done since
| then. Generates an error when the redo stack is empty.
| Does nothing when the undo option is false.
|
| edit_reset(self)
| Clears the undo and redo stacks
|
| edit_separator(self)
| Inserts a separator (boundary) on the undo stack.
|
| Does nothing when the undo option is false
|
| edit_undo(self)
| Undoes the last edit action
|
| If the undo option is true. An edit action is defined
| as all the insert and delete commands that are recorded
| on the undo stack in between two separators. Generates
| an error when the undo stack is empty. Does nothing
| when the undo option is false
|
| get(self, index1, index2=None)
| Return the text from INDEX1 to INDEX2 (not included).
|
| image_cget(self, index, option)
| Return the value of OPTION of an embedded image at INDEX.
|
| image_configure(self, index, cnf=None, **kw)
| Configure an embedded image at INDEX.
|
| image_create(self, index, cnf={}, **kw)
| Create an embedded image at INDEX.
|
| image_names(self)
| Return all names of embedded images in this widget.
|
| index(self, index)
| Return the index in the form line.char for INDEX.
|
| insert(self, index, chars, *args)
| Insert CHARS before the characters at INDEX. An additional
| tag can be given in ARGS. Additional CHARS and tags can follow in ARGS.
|
| mark_gravity(self, markName, direction=None)
| Change the gravity of a mark MARKNAME to DIRECTION (LEFT or RIGHT).
| Return the current value if None is given for DIRECTION.
|
| mark_names(self)
| Return all mark names.
|
| mark_next(self, index)
| Return the name of the next mark after INDEX.
|
| mark_previous(self, index)
| Return the name of the previous mark before INDEX.
|
| mark_set(self, markName, index)
| Set mark MARKNAME before the character at INDEX.
|
| mark_unset(self, *markNames)
| Delete all marks in MARKNAMES.
|
| peer_create(self, newPathName, cnf={}, **kw)
| Creates a peer text widget with the given newPathName, and any
| optional standard configuration options. By default the peer will
| have the same start and end line as the parent widget, but
| these can be overridden with the standard configuration options.
|
| peer_names(self)
| Returns a list of peers of this widget (this does not include
| the widget itself).
|
| replace(self, index1, index2, chars, *args)
| Replaces the range of characters between index1 and index2 with
| the given characters and tags specified by args.
|
| See the method insert for some more information about args, and the
| method delete for information about the indices.
|
| scan_dragto(self, x, y)
| Adjust the view of the text to 10 times the
| difference between X and Y and the coordinates given in
| scan_mark.
|
| scan_mark(self, x, y)
| Remember the current X, Y coordinates.
|
| search(self, pattern, index, stopindex=None, forwards=None, backwards=None, exact=None, regexp=None, nocase=None, count=None, elide=None)
| Search PATTERN beginning from INDEX until STOPINDEX.
| Return the index of the first character of a match or an
| empty string.
|
| see(self, index)
| Scroll such that the character at INDEX is visible.
|
| tag_add(self, tagName, index1, *args)
| Add tag TAGNAME to all characters between INDEX1 and index2 in ARGS.
| Additional pairs of indices may follow in ARGS.
|
| tag_bind(self, tagName, sequence, func, add=None)
| Bind to all characters with TAGNAME at event SEQUENCE a call to function FUNC.
|
| An additional boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or whether it will
| replace the previous function. See bind for the return value.
|
| tag_cget(self, tagName, option)
| Return the value of OPTION for tag TAGNAME.
|
| tag_config = tag_configure(self, tagName, cnf=None, **kw)
|
| tag_configure(self, tagName, cnf=None, **kw)
| Configure a tag TAGNAME.
|
| tag_delete(self, *tagNames)
| Delete all tags in TAGNAMES.
|
| tag_lower(self, tagName, belowThis=None)
| Change the priority of tag TAGNAME such that it is lower
| than the priority of BELOWTHIS.
|
| tag_names(self, index=None)
| Return a list of all tag names.
|
| tag_nextrange(self, tagName, index1, index2=None)
| Return a list of start and end index for the first sequence of
| characters between INDEX1 and INDEX2 which all have tag TAGNAME.
| The text is searched forward from INDEX1.
|
| tag_prevrange(self, tagName, index1, index2=None)
| Return a list of start and end index for the first sequence of
| characters between INDEX1 and INDEX2 which all have tag TAGNAME.
| The text is searched backwards from INDEX1.
|
| tag_raise(self, tagName, aboveThis=None)
| Change the priority of tag TAGNAME such that it is higher
| than the priority of ABOVETHIS.
|
| tag_ranges(self, tagName)
| Return a list of ranges of text which have tag TAGNAME.
|
| tag_remove(self, tagName, index1, index2=None)
| Remove tag TAGNAME from all characters between INDEX1 and INDEX2.
|
| tag_unbind(self, tagName, sequence, funcid=None)
| Unbind for all characters with TAGNAME for event SEQUENCE the
| function identified with FUNCID.
|
| window_cget(self, index, option)
| Return the value of OPTION of an embedded window at INDEX.
|
| window_config = window_configure(self, index, cnf=None, **kw)
|
| window_configure(self, index, cnf=None, **kw)
| Configure an embedded window at INDEX.
|
| window_create(self, index, cnf={}, **kw)
| Create a window at INDEX.
|
| window_names(self)
| Return all names of embedded windows in this widget.
|
| yview_pickplace(self, *what)
| Obsolete function, use see.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
|
| ----------------------------------------------------------------------
| Methods inherited from XView:
|
| xview(self, *args)
| Query and change the horizontal position of the view.
|
| xview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total width of the canvas is off-screen to the left.
|
| xview_scroll(self, number, what)
| Shift the x-view according to NUMBER which is measured in "units"
| or "pages" (WHAT).
|
| ----------------------------------------------------------------------
| Methods inherited from YView:
|
| yview(self, *args)
| Query and change the vertical position of the view.
|
| yview_moveto(self, fraction)
| Adjusts the view in the window so that FRACTION of the
| total height of the canvas is off-screen to the top.
|
| yview_scroll(self, number, what)
| Shift the y-view according to NUMBER which is measured in
| "units" or "pages" (WHAT).
tkinter.Tk
Python Library Documentation: class Tk in module tkinter
class Tk(Misc, Wm)
| Tk(screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)
|
| Toplevel widget of Tk which represents mostly the main window
| of an application. It has an associated Tcl interpreter.
|
| Method resolution order:
| Tk
| Misc
| Wm
| builtins.object
|
| Methods defined here:
|
| __getattr__(self, attr)
| Delegate attribute access to the interpreter object
|
| __init__(self, screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)
| Return a new top level widget on screen SCREENNAME. A new Tcl interpreter will
| be created. BASENAME will be used for the identification of the profile file (see
| readprofile).
| It is constructed from sys.argv[0] without extensions if None is given. CLASSNAME
| is the name of the widget class.
|
| destroy(self)
| Destroy this and all descendants widgets. This will
| end the application of this Tcl interpreter.
|
| loadtk(self)
|
| readprofile(self, baseName, className)
| Internal function. It reads .BASENAME.tcl and .CLASSNAME.tcl into
| the Tcl Interpreter and calls exec on the contents of .BASENAME.py and
| .CLASSNAME.py if such a file exists in the home directory.
|
| report_callback_exception(self, exc, val, tb)
| Report callback exception on sys.stderr.
|
| Applications may want to override this internal function, and
| should when sys.stderr is None.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Wm:
|
| aspect = wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None)
|
| attributes = wm_attributes(self, *args)
|
| client = wm_client(self, name=None)
|
| colormapwindows = wm_colormapwindows(self, *wlist)
|
| command = wm_command(self, value=None)
|
| deiconify = wm_deiconify(self)
|
| focusmodel = wm_focusmodel(self, model=None)
|
| forget = wm_forget(self, window)
|
| frame = wm_frame(self)
|
| geometry = wm_geometry(self, newGeometry=None)
|
| grid = wm_grid(self, baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)
|
| group = wm_group(self, pathName=None)
|
| iconbitmap = wm_iconbitmap(self, bitmap=None, default=None)
|
| iconify = wm_iconify(self)
|
| iconmask = wm_iconmask(self, bitmap=None)
|
| iconname = wm_iconname(self, newName=None)
|
| iconphoto = wm_iconphoto(self, default=False, *args)
|
| iconposition = wm_iconposition(self, x=None, y=None)
|
| iconwindow = wm_iconwindow(self, pathName=None)
|
| manage = wm_manage(self, widget)
|
| maxsize = wm_maxsize(self, width=None, height=None)
|
| minsize = wm_minsize(self, width=None, height=None)
|
| overrideredirect = wm_overrideredirect(self, boolean=None)
|
| positionfrom = wm_positionfrom(self, who=None)
|
| protocol = wm_protocol(self, name=None, func=None)
|
| resizable = wm_resizable(self, width=None, height=None)
|
| sizefrom = wm_sizefrom(self, who=None)
|
| state = wm_state(self, newstate=None)
|
| title = wm_title(self, string=None)
|
| transient = wm_transient(self, master=None)
|
| withdraw = wm_withdraw(self)
|
| wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None)
| Instruct the window manager to set the aspect ratio (width/height)
| of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple
| of the actual values if no argument is given.
|
| wm_attributes(self, *args)
| This subcommand returns or sets platform specific attributes
|
| The first form returns a list of the platform specific flags and
| their values. The second form returns the value for the specific
| option. The third form sets one or more of the values. The values
| are as follows:
|
| On Windows, -disabled gets or sets whether the window is in a
| disabled state. -toolwindow gets or sets the style of the window
| to toolwindow (as defined in the MSDN). -topmost gets or sets
| whether this is a topmost window (displays above all other
| windows).
|
| On Macintosh, XXXXX
|
| On Unix, there are currently no special attribute values.
|
| wm_client(self, name=None)
| Store NAME in WM_CLIENT_MACHINE property of this widget. Return
| current value.
|
| wm_colormapwindows(self, *wlist)
| Store list of window names (WLIST) into WM_COLORMAPWINDOWS property
| of this widget. This list contains windows whose colormaps differ from their
| parents. Return current list of widgets if WLIST is empty.
|
| wm_command(self, value=None)
| Store VALUE in WM_COMMAND property. It is the command
| which shall be used to invoke the application. Return current
| command if VALUE is None.
|
| wm_deiconify(self)
| Deiconify this widget. If it was never mapped it will not be mapped.
| On Windows it will raise this widget and give it the focus.
|
| wm_focusmodel(self, model=None)
| Set focus model to MODEL. "active" means that this widget will claim
| the focus itself, "passive" means that the window manager shall give
| the focus. Return current focus model if MODEL is None.
|
| wm_forget(self, window)
| The window will be unmapped from the screen and will no longer
| be managed by wm. toplevel windows will be treated like frame
| windows once they are no longer managed by wm, however, the menu
| option configuration will be remembered and the menus will return
| once the widget is managed again.
|
| wm_frame(self)
| Return identifier for decorative frame of this widget if present.
|
| wm_geometry(self, newGeometry=None)
| Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return
| current value if None is given.
|
| wm_grid(self, baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)
| Instruct the window manager that this widget shall only be
| resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and
| height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the
| number of grid units requested in Tk_GeometryRequest.
|
| wm_group(self, pathName=None)
| Set the group leader widgets for related widgets to PATHNAME. Return
| the group leader of this widget if None is given.
|
| wm_iconbitmap(self, bitmap=None, default=None)
| Set bitmap for the iconified widget to BITMAP. Return
| the bitmap if None is given.
|
| Under Windows, the DEFAULT parameter can be used to set the icon
| for the widget and any descendants that don't have an icon set
| explicitly. DEFAULT can be the relative path to a .ico file
| (example: root.iconbitmap(default='myicon.ico') ). See Tk
| documentation for more information.
|
| wm_iconify(self)
| Display widget as icon.
|
| wm_iconmask(self, bitmap=None)
| Set mask for the icon bitmap of this widget. Return the
| mask if None is given.
|
| wm_iconname(self, newName=None)
| Set the name of the icon for this widget. Return the name if
| None is given.
|
| wm_iconphoto(self, default=False, *args)
| Sets the titlebar icon for this window based on the named photo
| images passed through args. If default is True, this is applied to
| all future created toplevels as well.
|
| The data in the images is taken as a snapshot at the time of
| invocation. If the images are later changed, this is not reflected
| to the titlebar icons. Multiple images are accepted to allow
| different images sizes to be provided. The window manager may scale
| provided icons to an appropriate size.
|
| On Windows, the images are packed into a Windows icon structure.
| This will override an icon specified to wm_iconbitmap, and vice
| versa.
|
| On X, the images are arranged into the _NET_WM_ICON X property,
| which most modern window managers support. An icon specified by
| wm_iconbitmap may exist simultaneously.
|
| On Macintosh, this currently does nothing.
|
| wm_iconposition(self, x=None, y=None)
| Set the position of the icon of this widget to X and Y. Return
| a tuple of the current values of X and X if None is given.
|
| wm_iconwindow(self, pathName=None)
| Set widget PATHNAME to be displayed instead of icon. Return the current
| value if None is given.
|
| wm_manage(self, widget)
| The widget specified will become a stand alone top-level window.
| The window will be decorated with the window managers title bar,
| etc.
|
| wm_maxsize(self, width=None, height=None)
| Set max WIDTH and HEIGHT for this widget. If the window is gridded
| the values are given in grid units. Return the current values if None
| is given.
|
| wm_minsize(self, width=None, height=None)
| Set min WIDTH and HEIGHT for this widget. If the window is gridded
| the values are given in grid units. Return the current values if None
| is given.
|
| wm_overrideredirect(self, boolean=None)
| Instruct the window manager to ignore this widget
| if BOOLEAN is given with 1. Return the current value if None
| is given.
|
| wm_positionfrom(self, who=None)
| Instruct the window manager that the position of this widget shall
| be defined by the user if WHO is "user", and by its own policy if WHO is
| "program".
|
| wm_protocol(self, name=None, func=None)
| Bind function FUNC to command NAME for this widget.
| Return the function bound to NAME if None is given. NAME could be
| e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW".
|
| wm_resizable(self, width=None, height=None)
| Instruct the window manager whether this width can be resized
| in WIDTH or HEIGHT. Both values are boolean values.
|
| wm_sizefrom(self, who=None)
| Instruct the window manager that the size of this widget shall
| be defined by the user if WHO is "user", and by its own policy if WHO is
| "program".
|
| wm_state(self, newstate=None)
| Query or set the state of this widget as one of normal, icon,
| iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only).
|
| wm_title(self, string=None)
| Set the title of this widget.
|
| wm_transient(self, master=None)
| Instruct the window manager that this widget is transient
| with regard to widget MASTER.
|
| wm_withdraw(self)
| Withdraw this widget from the screen such that it is unmapped
| and forgotten by the window manager. Re-draw it with wm_deiconify.
tkinter.TkVersion
Python Library Documentation: float object
class float(object)
| float(x=0, /)
|
| Convert a string or number to a floating-point number, if possible.
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(self, /)
| Return the ceiling as an Integral.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(self, /)
| Return the floor as an Integral.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Formats the float according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(self, ndigits=None, /)
| Return the Integral closest to x, rounding half toward even.
|
| When an argument is passed, work like built-in round(x, ndigits).
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(self, /)
| Return the Integral closest to x between 0 and x.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is exactly equal to the original float.
|
| The ratio is in lowest terms and has a positive denominator. Raise
| OverflowError on infinities and a ValueError on NaNs.
|
| >>> (10.0).as_integer_ratio()
| (10, 1)
| >>> (0.0).as_integer_ratio()
| (0, 1)
| >>> (-.25).as_integer_ratio()
| (-1, 4)
|
| conjugate(self, /)
| Return self, the complex conjugate of any float.
|
| hex(self, /)
| Return a hexadecimal representation of a floating-point number.
|
| >>> (-0.1).hex()
| '-0x1.999999999999ap-4'
| >>> 3.14159.hex()
| '0x1.921f9f01b866ep+1'
|
| is_integer(self, /)
| Return True if the float is an integer.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __getformat__(typestr, /)
| You probably don't want to use this function.
|
| typestr
| Must be 'double' or 'float'.
|
| It exists mainly to be used in Python's test suite.
|
| This function returns whichever of 'unknown', 'IEEE, big-endian' or 'IEEE,
| little-endian' best describes the format of floating-point numbers used by the
| C type named by typestr.
|
| fromhex(string, /)
| Create a floating-point number from a hexadecimal string.
|
| >>> float.fromhex('0x1.ffffp10')
| 2047.984375
| >>> float.fromhex('-0x1p-1074')
| -5e-324
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| imag
| the imaginary part of a complex number
|
| real
| the real part of a complex number
tkinter.Toplevel
Python Library Documentation: class Toplevel in module tkinter
class Toplevel(BaseWidget, Wm)
| Toplevel(master=None, cnf={}, **kw)
|
| Toplevel widget, e.g. for dialogs.
|
| Method resolution order:
| Toplevel
| BaseWidget
| Misc
| Wm
| builtins.object
|
| Methods defined here:
|
| __init__(self, master=None, cnf={}, **kw)
| Construct a toplevel widget with the parent MASTER.
|
| Valid resource names: background, bd, bg, borderwidth, class,
| colormap, container, cursor, height, highlightbackground,
| highlightcolor, highlightthickness, menu, relief, screen, takefocus,
| use, visual, width.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseWidget:
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Wm:
|
| aspect = wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None)
|
| attributes = wm_attributes(self, *args)
|
| client = wm_client(self, name=None)
|
| colormapwindows = wm_colormapwindows(self, *wlist)
|
| command = wm_command(self, value=None)
|
| deiconify = wm_deiconify(self)
|
| focusmodel = wm_focusmodel(self, model=None)
|
| forget = wm_forget(self, window)
|
| frame = wm_frame(self)
|
| geometry = wm_geometry(self, newGeometry=None)
|
| grid = wm_grid(self, baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)
|
| group = wm_group(self, pathName=None)
|
| iconbitmap = wm_iconbitmap(self, bitmap=None, default=None)
|
| iconify = wm_iconify(self)
|
| iconmask = wm_iconmask(self, bitmap=None)
|
| iconname = wm_iconname(self, newName=None)
|
| iconphoto = wm_iconphoto(self, default=False, *args)
|
| iconposition = wm_iconposition(self, x=None, y=None)
|
| iconwindow = wm_iconwindow(self, pathName=None)
|
| manage = wm_manage(self, widget)
|
| maxsize = wm_maxsize(self, width=None, height=None)
|
| minsize = wm_minsize(self, width=None, height=None)
|
| overrideredirect = wm_overrideredirect(self, boolean=None)
|
| positionfrom = wm_positionfrom(self, who=None)
|
| protocol = wm_protocol(self, name=None, func=None)
|
| resizable = wm_resizable(self, width=None, height=None)
|
| sizefrom = wm_sizefrom(self, who=None)
|
| state = wm_state(self, newstate=None)
|
| title = wm_title(self, string=None)
|
| transient = wm_transient(self, master=None)
|
| withdraw = wm_withdraw(self)
|
| wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None)
| Instruct the window manager to set the aspect ratio (width/height)
| of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple
| of the actual values if no argument is given.
|
| wm_attributes(self, *args)
| This subcommand returns or sets platform specific attributes
|
| The first form returns a list of the platform specific flags and
| their values. The second form returns the value for the specific
| option. The third form sets one or more of the values. The values
| are as follows:
|
| On Windows, -disabled gets or sets whether the window is in a
| disabled state. -toolwindow gets or sets the style of the window
| to toolwindow (as defined in the MSDN). -topmost gets or sets
| whether this is a topmost window (displays above all other
| windows).
|
| On Macintosh, XXXXX
|
| On Unix, there are currently no special attribute values.
|
| wm_client(self, name=None)
| Store NAME in WM_CLIENT_MACHINE property of this widget. Return
| current value.
|
| wm_colormapwindows(self, *wlist)
| Store list of window names (WLIST) into WM_COLORMAPWINDOWS property
| of this widget. This list contains windows whose colormaps differ from their
| parents. Return current list of widgets if WLIST is empty.
|
| wm_command(self, value=None)
| Store VALUE in WM_COMMAND property. It is the command
| which shall be used to invoke the application. Return current
| command if VALUE is None.
|
| wm_deiconify(self)
| Deiconify this widget. If it was never mapped it will not be mapped.
| On Windows it will raise this widget and give it the focus.
|
| wm_focusmodel(self, model=None)
| Set focus model to MODEL. "active" means that this widget will claim
| the focus itself, "passive" means that the window manager shall give
| the focus. Return current focus model if MODEL is None.
|
| wm_forget(self, window)
| The window will be unmapped from the screen and will no longer
| be managed by wm. toplevel windows will be treated like frame
| windows once they are no longer managed by wm, however, the menu
| option configuration will be remembered and the menus will return
| once the widget is managed again.
|
| wm_frame(self)
| Return identifier for decorative frame of this widget if present.
|
| wm_geometry(self, newGeometry=None)
| Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return
| current value if None is given.
|
| wm_grid(self, baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)
| Instruct the window manager that this widget shall only be
| resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and
| height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the
| number of grid units requested in Tk_GeometryRequest.
|
| wm_group(self, pathName=None)
| Set the group leader widgets for related widgets to PATHNAME. Return
| the group leader of this widget if None is given.
|
| wm_iconbitmap(self, bitmap=None, default=None)
| Set bitmap for the iconified widget to BITMAP. Return
| the bitmap if None is given.
|
| Under Windows, the DEFAULT parameter can be used to set the icon
| for the widget and any descendants that don't have an icon set
| explicitly. DEFAULT can be the relative path to a .ico file
| (example: root.iconbitmap(default='myicon.ico') ). See Tk
| documentation for more information.
|
| wm_iconify(self)
| Display widget as icon.
|
| wm_iconmask(self, bitmap=None)
| Set mask for the icon bitmap of this widget. Return the
| mask if None is given.
|
| wm_iconname(self, newName=None)
| Set the name of the icon for this widget. Return the name if
| None is given.
|
| wm_iconphoto(self, default=False, *args)
| Sets the titlebar icon for this window based on the named photo
| images passed through args. If default is True, this is applied to
| all future created toplevels as well.
|
| The data in the images is taken as a snapshot at the time of
| invocation. If the images are later changed, this is not reflected
| to the titlebar icons. Multiple images are accepted to allow
| different images sizes to be provided. The window manager may scale
| provided icons to an appropriate size.
|
| On Windows, the images are packed into a Windows icon structure.
| This will override an icon specified to wm_iconbitmap, and vice
| versa.
|
| On X, the images are arranged into the _NET_WM_ICON X property,
| which most modern window managers support. An icon specified by
| wm_iconbitmap may exist simultaneously.
|
| On Macintosh, this currently does nothing.
|
| wm_iconposition(self, x=None, y=None)
| Set the position of the icon of this widget to X and Y. Return
| a tuple of the current values of X and X if None is given.
|
| wm_iconwindow(self, pathName=None)
| Set widget PATHNAME to be displayed instead of icon. Return the current
| value if None is given.
|
| wm_manage(self, widget)
| The widget specified will become a stand alone top-level window.
| The window will be decorated with the window managers title bar,
| etc.
|
| wm_maxsize(self, width=None, height=None)
| Set max WIDTH and HEIGHT for this widget. If the window is gridded
| the values are given in grid units. Return the current values if None
| is given.
|
| wm_minsize(self, width=None, height=None)
| Set min WIDTH and HEIGHT for this widget. If the window is gridded
| the values are given in grid units. Return the current values if None
| is given.
|
| wm_overrideredirect(self, boolean=None)
| Instruct the window manager to ignore this widget
| if BOOLEAN is given with 1. Return the current value if None
| is given.
|
| wm_positionfrom(self, who=None)
| Instruct the window manager that the position of this widget shall
| be defined by the user if WHO is "user", and by its own policy if WHO is
| "program".
|
| wm_protocol(self, name=None, func=None)
| Bind function FUNC to command NAME for this widget.
| Return the function bound to NAME if None is given. NAME could be
| e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW".
|
| wm_resizable(self, width=None, height=None)
| Instruct the window manager whether this width can be resized
| in WIDTH or HEIGHT. Both values are boolean values.
|
| wm_sizefrom(self, who=None)
| Instruct the window manager that the size of this widget shall
| be defined by the user if WHO is "user", and by its own policy if WHO is
| "program".
|
| wm_state(self, newstate=None)
| Query or set the state of this widget as one of normal, icon,
| iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only).
|
| wm_title(self, string=None)
| Set the title of this widget.
|
| wm_transient(self, master=None)
| Instruct the window manager that this widget is transient
| with regard to widget MASTER.
|
| wm_withdraw(self)
| Withdraw this widget from the screen such that it is unmapped
| and forgotten by the window manager. Re-draw it with wm_deiconify.
tkinter.UNDERLINE
Error rendering doc: No Python documentation found for 'underline'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.UNITS
Error rendering doc: No Python documentation found for 'units'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.VERTICAL
Error rendering doc: No Python documentation found for 'vertical'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.Variable
Python Library Documentation: class Variable in module tkinter class Variable(builtins.object) | Variable(master=None, value=None, name=None) | | Class to define value holders for e.g. buttons. | | Subclasses StringVar, IntVar, DoubleVar, BooleanVar are specializations | that constrain the type of the value returned from get(). | | Methods defined here: | | __del__(self) | Unset the variable in Tcl. | | __eq__(self, other) | Return self==value. | | __init__(self, master=None, value=None, name=None) | Construct a variable | | MASTER can be given as master widget. | VALUE is an optional value (defaults to "") | NAME is an optional Tcl name (defaults to PY_VARnum). | | If NAME matches an existing variable and VALUE is omitted | then the existing value is retained. | | __str__(self) | Return the name of the variable in Tcl. | | get(self) | Return value of variable. | | initialize = set(self, value) | | set(self, value) | Set the variable to VALUE. | | trace = trace_variable(self, mode, callback) | | trace_add(self, mode, callback) | Define a trace callback for the variable. | | Mode is one of "read", "write", "unset", or a list or tuple of | such strings. | Callback must be a function which is called when the variable is | read, written or unset. | | Return the name of the callback. | | trace_info(self) | Return all trace callback information. | | trace_remove(self, mode, cbname) | Delete the trace callback for a variable. | | Mode is one of "read", "write", "unset" or a list or tuple of | such strings. Must be same as were specified in trace_add(). | cbname is the name of the callback returned from trace_add(). | | trace_variable(self, mode, callback) | Define a trace callback for the variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CALLBACK must be a function which is called when | the variable is read, written or undefined. | | Return the name of the callback. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_add() instead. | | trace_vdelete(self, mode, cbname) | Delete the trace callback for a variable. | | MODE is one of "r", "w", "u" for read, write, undefine. | CBNAME is the name of the callback returned from trace_variable or trace. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_remove() instead. | | trace_vinfo(self) | Return all trace callback information. | | This deprecated method wraps a deprecated Tcl method that will | likely be removed in the future. Use trace_info() instead. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
tkinter.W
Error rendering doc: No Python documentation found for 'w'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.WORD
Error rendering doc: No Python documentation found for 'word'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.WRITABLE
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.Widget
Python Library Documentation: class Widget in module tkinter
class Widget(BaseWidget, Pack, Place, Grid)
| Widget(master, widgetName, cnf={}, kw={}, extra=())
|
| Internal class.
|
| Base class for a widget which can be positioned with the geometry managers
| Pack, Place or Grid.
|
| Method resolution order:
| Widget
| BaseWidget
| Misc
| Pack
| Place
| Grid
| builtins.object
|
| Methods inherited from BaseWidget:
|
| __init__(self, master, widgetName, cnf={}, kw={}, extra=())
| Construct a widget with the parent widget MASTER, a name WIDGETNAME
| and appropriate options.
|
| destroy(self)
| Destroy this and all descendants widgets.
|
| ----------------------------------------------------------------------
| Methods inherited from Misc:
|
| __getitem__ = cget(self, key)
|
| __repr__(self)
| Return repr(self).
|
| __setitem__(self, key, value)
|
| __str__(self)
| Return the window path name of this widget.
|
| after(self, ms, func=None, *args)
| Call function once after given time.
|
| MS specifies the time in milliseconds. FUNC gives the
| function which shall be called. Additional parameters
| are given as parameters to the function call. Return
| identifier to cancel scheduling with after_cancel.
|
| after_cancel(self, id)
| Cancel scheduling of function identified with ID.
|
| Identifier returned by after or after_idle must be
| given as first parameter.
|
| after_idle(self, func, *args)
| Call FUNC once if the Tcl main loop has no event to
| process.
|
| Return an identifier to cancel the scheduling with
| after_cancel.
|
| anchor = grid_anchor(self, anchor=None)
|
| bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
|
| bell(self, displayof=0)
| Ring a display's bell.
|
| bind(self, sequence=None, func=None, add=None)
| Bind to this widget at event SEQUENCE a call to function FUNC.
|
| SEQUENCE is a string of concatenated event
| patterns. An event pattern is of the form
| <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
| of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
| Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
| B3, Alt, Button4, B4, Double, Button5, B5 Triple,
| Mod1, M1. TYPE is one of Activate, Enter, Map,
| ButtonPress, Button, Expose, Motion, ButtonRelease
| FocusIn, MouseWheel, Circulate, FocusOut, Property,
| Colormap, Gravity Reparent, Configure, KeyPress, Key,
| Unmap, Deactivate, KeyRelease Visibility, Destroy,
| Leave and DETAIL is the button number for ButtonPress,
| ButtonRelease and DETAIL is the Keysym for KeyPress and
| KeyRelease. Examples are
| <Control-Button-1> for pressing Control and mouse button 1 or
| <Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
| An event pattern can also be a virtual event of the form
| <<AString>> where AString can be arbitrary. This
| event can be generated by event_generate.
| If events are concatenated they must appear shortly
| after each other.
|
| FUNC will be called if the event sequence occurs with an
| instance of Event as argument. If the return value of FUNC is
| "break" no further bound function is invoked.
|
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function.
|
| Bind will return an identifier to allow deletion of the bound function with
| unbind without memory leak.
|
| If FUNC or SEQUENCE is omitted the bound function or list
| of bound events are returned.
|
| bind_all(self, sequence=None, func=None, add=None)
| Bind to all widgets at an event SEQUENCE a call to function FUNC.
| An additional boolean parameter ADD specifies whether FUNC will
| be called additionally to the other bound function or whether
| it will replace the previous function. See bind for the return value.
|
| bind_class(self, className, sequence=None, func=None, add=None)
| Bind to widgets with bindtag CLASSNAME at event
| SEQUENCE a call of function FUNC. An additional
| boolean parameter ADD specifies whether FUNC will be
| called additionally to the other bound function or
| whether it will replace the previous function. See bind for
| the return value.
|
| bindtags(self, tagList=None)
| Set or get the list of bindtags for this widget.
|
| With no argument return the list of all bindtags associated with
| this widget. With a list of strings as argument the bindtags are
| set to this list. The bindtags determine in which order events are
| processed (see bind).
|
| cget(self, key)
| Return the resource value for a KEY given as string.
|
| clipboard_append(self, string, **kw)
| Append STRING to the Tk clipboard.
|
| A widget specified at the optional displayof keyword
| argument specifies the target display. The clipboard
| can be retrieved with selection_get.
|
| clipboard_clear(self, **kw)
| Clear the data in the Tk clipboard.
|
| A widget specified for the optional displayof keyword
| argument specifies the target display.
|
| clipboard_get(self, **kw)
| Retrieve data from the clipboard on window's display.
|
| The window keyword defaults to the root window of the Tkinter
| application.
|
| The type keyword specifies the form in which the data is
| to be returned and should be an atom name such as STRING
| or FILE_NAME. Type defaults to STRING, except on X11, where the default
| is to try UTF8_STRING and fall back to STRING.
|
| This command is equivalent to:
|
| selection_get(CLIPBOARD)
|
| columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
|
| config = configure(self, cnf=None, **kw)
|
| configure(self, cnf=None, **kw)
| Configure resources of a widget.
|
| The values for resources are specified as keyword
| arguments. To get an overview about
| the allowed keyword arguments call the method keys.
|
| deletecommand(self, name)
| Internal function.
|
| Delete the Tcl command provided in NAME.
|
| event_add(self, virtual, *sequences)
| Bind a virtual event VIRTUAL (of the form <<Name>>)
| to an event SEQUENCE such that the virtual event is triggered
| whenever SEQUENCE occurs.
|
| event_delete(self, virtual, *sequences)
| Unbind a virtual event VIRTUAL from SEQUENCE.
|
| event_generate(self, sequence, **kw)
| Generate an event SEQUENCE. Additional
| keyword arguments specify parameter of the event
| (e.g. x, y, rootx, rooty).
|
| event_info(self, virtual=None)
| Return a list of all virtual events or the information
| about the SEQUENCE bound to the virtual event VIRTUAL.
|
| focus = focus_set(self)
|
| focus_displayof(self)
| Return the widget which has currently the focus on the
| display where this widget is located.
|
| Return None if the application does not have the focus.
|
| focus_force(self)
| Direct input focus to this widget even if the
| application does not have the focus. Use with
| caution!
|
| focus_get(self)
| Return the widget which has currently the focus in the
| application.
|
| Use focus_displayof to allow working with several
| displays. Return None if application does not have
| the focus.
|
| focus_lastfor(self)
| Return the widget which would have the focus if top level
| for this widget gets the focus from the window manager.
|
| focus_set(self)
| Direct input focus to this widget.
|
| If the application currently does not have the focus
| this widget will get the focus if the application gets
| the focus through the window manager.
|
| getboolean(self, s)
| Return a boolean value for Tcl boolean values true and false given as parameter.
|
| getdouble(self, s)
|
| getint(self, s)
|
| getvar(self, name='PY_VAR')
| Return value of Tcl variable NAME.
|
| grab_current(self)
| Return widget which has currently the grab in this application
| or None.
|
| grab_release(self)
| Release grab for this widget if currently set.
|
| grab_set(self)
| Set grab for this widget.
|
| A grab directs all events to this and descendant
| widgets in the application.
|
| grab_set_global(self)
| Set global grab for this widget.
|
| A global grab directs all events to this and
| descendant widgets on the display. Use with caution -
| other applications do not get events anymore.
|
| grab_status(self)
| Return None, "local" or "global" if this widget has
| no, a local or a global grab.
|
| grid_anchor(self, anchor=None)
| The anchor value controls how to place the grid within the
| master when no row/column has any weight.
|
| The default anchor is nw.
|
| grid_bbox(self, column=None, row=None, col2=None, row2=None)
| Return a tuple of integer coordinates for the bounding
| box of this widget controlled by the geometry manager grid.
|
| If COLUMN, ROW is given the bounding box applies from
| the cell with row and column 0 to the specified
| cell. If COL2 and ROW2 are given the bounding box
| starts at that cell.
|
| The returned integers specify the offset of the upper left
| corner in the master widget and the width and height.
|
| grid_columnconfigure(self, index, cnf={}, **kw)
| Configure column INDEX of a grid.
|
| Valid resources are minsize (minimum size of the column),
| weight (how much does additional space propagate to this column)
| and pad (how much space to let additionally).
|
| grid_location(self, x, y)
| Return a tuple of column and row which identify the cell
| at which the pixel at position X and Y inside the master
| widget is located.
|
| grid_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given, the current setting will be returned.
|
| grid_rowconfigure(self, index, cnf={}, **kw)
| Configure row INDEX of a grid.
|
| Valid resources are minsize (minimum size of the row),
| weight (how much does additional space propagate to this row)
| and pad (how much space to let additionally).
|
| grid_size(self)
| Return a tuple of the number of column and rows in the grid.
|
| grid_slaves(self, row=None, column=None)
| Return a list of all slaves of this widget
| in its packing order.
|
| image_names(self)
| Return a list of all existing image names.
|
| image_types(self)
| Return a list of all available image types (e.g. photo bitmap).
|
| info_patchlevel(self)
| Returns the exact version of the Tcl library.
|
| keys(self)
| Return a list of all resource names of this widget.
|
| lift = tkraise(self, aboveThis=None)
|
| lower(self, belowThis=None)
| Lower this widget in the stacking order.
|
| mainloop(self, n=0)
| Call the mainloop of Tk.
|
| nametowidget(self, name)
| Return the Tkinter instance of a widget identified by
| its Tcl name NAME.
|
| option_add(self, pattern, value, priority=None)
| Set a VALUE (second parameter) for an option
| PATTERN (first parameter).
|
| An optional third parameter gives the numeric priority
| (defaults to 80).
|
| option_clear(self)
| Clear the option database.
|
| It will be reloaded if option_add is called.
|
| option_get(self, name, className)
| Return the value for an option NAME for this widget
| with CLASSNAME.
|
| Values with higher priority override lower values.
|
| option_readfile(self, fileName, priority=None)
| Read file FILENAME into the option database.
|
| An optional second parameter gives the numeric
| priority.
|
| pack_propagate(self, flag=['_noarg_'])
| Set or get the status for propagation of geometry information.
|
| A boolean argument specifies whether the geometry information
| of the slaves will determine the size of this widget. If no argument
| is given the current setting will be returned.
|
| pack_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| place_slaves(self)
| Return a list of all slaves of this widget
| in its packing order.
|
| propagate = pack_propagate(self, flag=['_noarg_'])
|
| quit(self)
| Quit the Tcl interpreter. All widgets will be destroyed.
|
| register = _register(self, func, subst=None, needcleanup=1)
|
| rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
|
| selection_clear(self, **kw)
| Clear the current X selection.
|
| selection_get(self, **kw)
| Return the contents of the current X selection.
|
| A keyword parameter selection specifies the name of
| the selection and defaults to PRIMARY. A keyword
| parameter displayof specifies a widget on the display
| to use. A keyword parameter type specifies the form of data to be
| fetched, defaulting to STRING except on X11, where UTF8_STRING is tried
| before STRING.
|
| selection_handle(self, command, **kw)
| Specify a function COMMAND to call if the X
| selection owned by this widget is queried by another
| application.
|
| This function must return the contents of the
| selection. The function will be called with the
| arguments OFFSET and LENGTH which allows the chunking
| of very long selections. The following keyword
| parameters can be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| selection_own(self, **kw)
| Become owner of X selection.
|
| A keyword parameter selection specifies the name of
| the selection (default PRIMARY).
|
| selection_own_get(self, **kw)
| Return owner of X selection.
|
| The following keyword parameter can
| be provided:
| selection - name of the selection (default PRIMARY),
| type - type of the selection (e.g. STRING, FILE_NAME).
|
| send(self, interp, cmd, *args)
| Send Tcl command CMD to different interpreter INTERP to be executed.
|
| setvar(self, name='PY_VAR', value='1')
| Set Tcl variable NAME to VALUE.
|
| size = grid_size(self)
|
| slaves = pack_slaves(self)
|
| tk_bisque(self)
| Change the color scheme to light brown as used in Tk 3.6 and before.
|
| tk_focusFollowsMouse(self)
| The widget under mouse will get automatically focus. Can not
| be disabled easily.
|
| tk_focusNext(self)
| Return the next widget in the focus order which follows
| widget which has currently the focus.
|
| The focus order first goes to the next child, then to
| the children of the child recursively and then to the
| next sibling which is higher in the stacking order. A
| widget is omitted if it has the takefocus resource set
| to 0.
|
| tk_focusPrev(self)
| Return previous widget in the focus order. See tk_focusNext for details.
|
| tk_setPalette(self, *args, **kw)
| Set a new color scheme for all widget elements.
|
| A single color as argument will cause that all colors of Tk
| widget elements are derived from this.
| Alternatively several keyword parameters and its associated
| colors can be given. The following keywords are valid:
| activeBackground, foreground, selectColor,
| activeForeground, highlightBackground, selectBackground,
| background, highlightColor, selectForeground,
| disabledForeground, insertBackground, troughColor.
|
| tk_strictMotif(self, boolean=None)
| Set Tcl internal variable, whether the look and feel
| should adhere to Motif.
|
| A parameter of 1 means adhere to Motif (e.g. no color
| change if mouse passes over slider).
| Returns the set value.
|
| tkraise(self, aboveThis=None)
| Raise this widget in the stacking order.
|
| unbind(self, sequence, funcid=None)
| Unbind for this widget the event SEQUENCE.
|
| If FUNCID is given, only unbind the function identified with FUNCID
| and also delete the corresponding Tcl command.
|
| Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE
| unbound.
|
| unbind_all(self, sequence)
| Unbind for all widgets for event SEQUENCE all functions.
|
| unbind_class(self, className, sequence)
| Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
| all functions.
|
| update(self)
| Enter event loop until all pending events have been processed by Tcl.
|
| update_idletasks(self)
| Enter event loop until all idle callbacks have been called. This
| will update the display of windows but not process events caused by
| the user.
|
| wait_variable(self, name='PY_VAR')
| Wait until the variable is modified.
|
| A parameter of type IntVar, StringVar, DoubleVar or
| BooleanVar must be given.
|
| wait_visibility(self, window=None)
| Wait until the visibility of a WIDGET changes
| (e.g. it appears).
|
| If no parameter is given self is used.
|
| wait_window(self, window=None)
| Wait until a WIDGET is destroyed.
|
| If no parameter is given self is used.
|
| waitvar = wait_variable(self, name='PY_VAR')
|
| winfo_atom(self, name, displayof=0)
| Return integer which represents atom NAME.
|
| winfo_atomname(self, id, displayof=0)
| Return name of atom with identifier ID.
|
| winfo_cells(self)
| Return number of cells in the colormap for this widget.
|
| winfo_children(self)
| Return a list of all widgets which are children of this widget.
|
| winfo_class(self)
| Return window class name of this widget.
|
| winfo_colormapfull(self)
| Return True if at the last color request the colormap was full.
|
| winfo_containing(self, rootX, rootY, displayof=0)
| Return the widget which is at the root coordinates ROOTX, ROOTY.
|
| winfo_depth(self)
| Return the number of bits per pixel.
|
| winfo_exists(self)
| Return true if this widget exists.
|
| winfo_fpixels(self, number)
| Return the number of pixels for the given distance NUMBER
| (e.g. "3c") as float.
|
| winfo_geometry(self)
| Return geometry string for this widget in the form "widthxheight+X+Y".
|
| winfo_height(self)
| Return height of this widget.
|
| winfo_id(self)
| Return identifier ID for this widget.
|
| winfo_interps(self, displayof=0)
| Return the name of all Tcl interpreters for this display.
|
| winfo_ismapped(self)
| Return true if this widget is mapped.
|
| winfo_manager(self)
| Return the window manager name for this widget.
|
| winfo_name(self)
| Return the name of this widget.
|
| winfo_parent(self)
| Return the name of the parent of this widget.
|
| winfo_pathname(self, id, displayof=0)
| Return the pathname of the widget given by ID.
|
| winfo_pixels(self, number)
| Rounded integer value of winfo_fpixels.
|
| winfo_pointerx(self)
| Return the x coordinate of the pointer on the root window.
|
| winfo_pointerxy(self)
| Return a tuple of x and y coordinates of the pointer on the root window.
|
| winfo_pointery(self)
| Return the y coordinate of the pointer on the root window.
|
| winfo_reqheight(self)
| Return requested height of this widget.
|
| winfo_reqwidth(self)
| Return requested width of this widget.
|
| winfo_rgb(self, color)
| Return a tuple of integer RGB values in range(65536) for color in this widget.
|
| winfo_rootx(self)
| Return x coordinate of upper left corner of this widget on the
| root window.
|
| winfo_rooty(self)
| Return y coordinate of upper left corner of this widget on the
| root window.
|
| winfo_screen(self)
| Return the screen name of this widget.
|
| winfo_screencells(self)
| Return the number of the cells in the colormap of the screen
| of this widget.
|
| winfo_screendepth(self)
| Return the number of bits per pixel of the root window of the
| screen of this widget.
|
| winfo_screenheight(self)
| Return the number of pixels of the height of the screen of this widget
| in pixel.
|
| winfo_screenmmheight(self)
| Return the number of pixels of the height of the screen of
| this widget in mm.
|
| winfo_screenmmwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in mm.
|
| winfo_screenvisual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the default
| colormodel of this screen.
|
| winfo_screenwidth(self)
| Return the number of pixels of the width of the screen of
| this widget in pixel.
|
| winfo_server(self)
| Return information of the X-Server of the screen of this widget in
| the form "XmajorRminor vendor vendorVersion".
|
| winfo_toplevel(self)
| Return the toplevel widget of this widget.
|
| winfo_viewable(self)
| Return true if the widget and all its higher ancestors are mapped.
|
| winfo_visual(self)
| Return one of the strings directcolor, grayscale, pseudocolor,
| staticcolor, staticgray, or truecolor for the
| colormodel of this widget.
|
| winfo_visualid(self)
| Return the X identifier for the visual for this widget.
|
| winfo_visualsavailable(self, includeids=False)
| Return a list of all visuals available for the screen
| of this widget.
|
| Each item in the list consists of a visual name (see winfo_visual), a
| depth and if includeids is true is given also the X identifier.
|
| winfo_vrootheight(self)
| Return the height of the virtual root window associated with this
| widget in pixels. If there is no virtual root window return the
| height of the screen.
|
| winfo_vrootwidth(self)
| Return the width of the virtual root window associated with this
| widget in pixel. If there is no virtual root window return the
| width of the screen.
|
| winfo_vrootx(self)
| Return the x offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_vrooty(self)
| Return the y offset of the virtual root relative to the root
| window of the screen of this widget.
|
| winfo_width(self)
| Return the width of this widget.
|
| winfo_x(self)
| Return the x coordinate of the upper left corner of this widget
| in the parent.
|
| winfo_y(self)
| Return the y coordinate of the upper left corner of this widget
| in the parent.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Misc:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from Pack:
|
| forget = pack_forget(self)
|
| info = pack_info(self)
|
| pack = pack_configure(self, cnf={}, **kw)
|
| pack_configure(self, cnf={}, **kw)
| Pack a widget in the parent widget. Use as options:
| after=widget - pack it after you have packed widget
| anchor=NSEW (or subset) - position widget according to
| given direction
| before=widget - pack it before you will pack widget
| expand=bool - expand widget if parent size grows
| fill=NONE or X or Y or BOTH - fill widget if widget grows
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.
|
| pack_forget(self)
| Unmap this widget and do not use it for the packing order.
|
| pack_info(self)
| Return information about the packing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Place:
|
| place = place_configure(self, cnf={}, **kw)
|
| place_configure(self, cnf={}, **kw)
| Place a widget in the parent widget. Use as options:
| in=master - master relative to which the widget is placed
| in_=master - see 'in' option description
| x=amount - locate anchor of this widget at position x of master
| y=amount - locate anchor of this widget at position y of master
| relx=amount - locate anchor of this widget between 0.0 and 1.0
| relative to width of master (1.0 is right edge)
| rely=amount - locate anchor of this widget between 0.0 and 1.0
| relative to height of master (1.0 is bottom edge)
| anchor=NSEW (or subset) - position anchor according to given direction
| width=amount - width of this widget in pixel
| height=amount - height of this widget in pixel
| relwidth=amount - width of this widget between 0.0 and 1.0
| relative to width of master (1.0 is the same width
| as the master)
| relheight=amount - height of this widget between 0.0 and 1.0
| relative to height of master (1.0 is the same
| height as the master)
| bordermode="inside" or "outside" - whether to take border width of
| master widget into account
|
| place_forget(self)
| Unmap this widget.
|
| place_info(self)
| Return information about the placing options
| for this widget.
|
| ----------------------------------------------------------------------
| Methods inherited from Grid:
|
| grid = grid_configure(self, cnf={}, **kw)
|
| grid_configure(self, cnf={}, **kw)
| Position a widget in the parent widget in a grid. Use as options:
| column=number - use cell identified with given column (starting with 0)
| columnspan=number - this widget will span several columns
| in=master - use master to contain this widget
| in_=master - see 'in' option description
| ipadx=amount - add internal padding in x direction
| ipady=amount - add internal padding in y direction
| padx=amount - add padding in x direction
| pady=amount - add padding in y direction
| row=number - use cell identified with given row (starting with 0)
| rowspan=number - this widget will span several rows
| sticky=NSEW - if cell is larger on which sides will this
| widget stick to the cell boundary
|
| grid_forget(self)
| Unmap this widget.
|
| grid_info(self)
| Return information about the options
| for positioning this widget in a grid.
|
| grid_remove(self)
| Unmap this widget but remember the grid options.
|
| location = grid_location(self, x, y)
tkinter.Wm
Python Library Documentation: class Wm in module tkinter class Wm(builtins.object) | Provides functions for the communication with the window manager. | | Methods defined here: | | aspect = wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None) | | attributes = wm_attributes(self, *args) | | client = wm_client(self, name=None) | | colormapwindows = wm_colormapwindows(self, *wlist) | | command = wm_command(self, value=None) | | deiconify = wm_deiconify(self) | | focusmodel = wm_focusmodel(self, model=None) | | forget = wm_forget(self, window) | | frame = wm_frame(self) | | geometry = wm_geometry(self, newGeometry=None) | | grid = wm_grid(self, baseWidth=None, baseHeight=None, widthInc=None, heightInc=None) | | group = wm_group(self, pathName=None) | | iconbitmap = wm_iconbitmap(self, bitmap=None, default=None) | | iconify = wm_iconify(self) | | iconmask = wm_iconmask(self, bitmap=None) | | iconname = wm_iconname(self, newName=None) | | iconphoto = wm_iconphoto(self, default=False, *args) | | iconposition = wm_iconposition(self, x=None, y=None) | | iconwindow = wm_iconwindow(self, pathName=None) | | manage = wm_manage(self, widget) | | maxsize = wm_maxsize(self, width=None, height=None) | | minsize = wm_minsize(self, width=None, height=None) | | overrideredirect = wm_overrideredirect(self, boolean=None) | | positionfrom = wm_positionfrom(self, who=None) | | protocol = wm_protocol(self, name=None, func=None) | | resizable = wm_resizable(self, width=None, height=None) | | sizefrom = wm_sizefrom(self, who=None) | | state = wm_state(self, newstate=None) | | title = wm_title(self, string=None) | | transient = wm_transient(self, master=None) | | withdraw = wm_withdraw(self) | | wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None) | Instruct the window manager to set the aspect ratio (width/height) | of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple | of the actual values if no argument is given. | | wm_attributes(self, *args) | This subcommand returns or sets platform specific attributes | | The first form returns a list of the platform specific flags and | their values. The second form returns the value for the specific | option. The third form sets one or more of the values. The values | are as follows: | | On Windows, -disabled gets or sets whether the window is in a | disabled state. -toolwindow gets or sets the style of the window | to toolwindow (as defined in the MSDN). -topmost gets or sets | whether this is a topmost window (displays above all other | windows). | | On Macintosh, XXXXX | | On Unix, there are currently no special attribute values. | | wm_client(self, name=None) | Store NAME in WM_CLIENT_MACHINE property of this widget. Return | current value. | | wm_colormapwindows(self, *wlist) | Store list of window names (WLIST) into WM_COLORMAPWINDOWS property | of this widget. This list contains windows whose colormaps differ from their | parents. Return current list of widgets if WLIST is empty. | | wm_command(self, value=None) | Store VALUE in WM_COMMAND property. It is the command | which shall be used to invoke the application. Return current | command if VALUE is None. | | wm_deiconify(self) | Deiconify this widget. If it was never mapped it will not be mapped. | On Windows it will raise this widget and give it the focus. | | wm_focusmodel(self, model=None) | Set focus model to MODEL. "active" means that this widget will claim | the focus itself, "passive" means that the window manager shall give | the focus. Return current focus model if MODEL is None. | | wm_forget(self, window) | The window will be unmapped from the screen and will no longer | be managed by wm. toplevel windows will be treated like frame | windows once they are no longer managed by wm, however, the menu | option configuration will be remembered and the menus will return | once the widget is managed again. | | wm_frame(self) | Return identifier for decorative frame of this widget if present. | | wm_geometry(self, newGeometry=None) | Set geometry to NEWGEOMETRY of the form =widthxheight+x+y. Return | current value if None is given. | | wm_grid(self, baseWidth=None, baseHeight=None, widthInc=None, heightInc=None) | Instruct the window manager that this widget shall only be | resized on grid boundaries. WIDTHINC and HEIGHTINC are the width and | height of a grid unit in pixels. BASEWIDTH and BASEHEIGHT are the | number of grid units requested in Tk_GeometryRequest. | | wm_group(self, pathName=None) | Set the group leader widgets for related widgets to PATHNAME. Return | the group leader of this widget if None is given. | | wm_iconbitmap(self, bitmap=None, default=None) | Set bitmap for the iconified widget to BITMAP. Return | the bitmap if None is given. | | Under Windows, the DEFAULT parameter can be used to set the icon | for the widget and any descendants that don't have an icon set | explicitly. DEFAULT can be the relative path to a .ico file | (example: root.iconbitmap(default='myicon.ico') ). See Tk | documentation for more information. | | wm_iconify(self) | Display widget as icon. | | wm_iconmask(self, bitmap=None) | Set mask for the icon bitmap of this widget. Return the | mask if None is given. | | wm_iconname(self, newName=None) | Set the name of the icon for this widget. Return the name if | None is given. | | wm_iconphoto(self, default=False, *args) | Sets the titlebar icon for this window based on the named photo | images passed through args. If default is True, this is applied to | all future created toplevels as well. | | The data in the images is taken as a snapshot at the time of | invocation. If the images are later changed, this is not reflected | to the titlebar icons. Multiple images are accepted to allow | different images sizes to be provided. The window manager may scale | provided icons to an appropriate size. | | On Windows, the images are packed into a Windows icon structure. | This will override an icon specified to wm_iconbitmap, and vice | versa. | | On X, the images are arranged into the _NET_WM_ICON X property, | which most modern window managers support. An icon specified by | wm_iconbitmap may exist simultaneously. | | On Macintosh, this currently does nothing. | | wm_iconposition(self, x=None, y=None) | Set the position of the icon of this widget to X and Y. Return | a tuple of the current values of X and X if None is given. | | wm_iconwindow(self, pathName=None) | Set widget PATHNAME to be displayed instead of icon. Return the current | value if None is given. | | wm_manage(self, widget) | The widget specified will become a stand alone top-level window. | The window will be decorated with the window managers title bar, | etc. | | wm_maxsize(self, width=None, height=None) | Set max WIDTH and HEIGHT for this widget. If the window is gridded | the values are given in grid units. Return the current values if None | is given. | | wm_minsize(self, width=None, height=None) | Set min WIDTH and HEIGHT for this widget. If the window is gridded | the values are given in grid units. Return the current values if None | is given. | | wm_overrideredirect(self, boolean=None) | Instruct the window manager to ignore this widget | if BOOLEAN is given with 1. Return the current value if None | is given. | | wm_positionfrom(self, who=None) | Instruct the window manager that the position of this widget shall | be defined by the user if WHO is "user", and by its own policy if WHO is | "program". | | wm_protocol(self, name=None, func=None) | Bind function FUNC to command NAME for this widget. | Return the function bound to NAME if None is given. NAME could be | e.g. "WM_SAVE_YOURSELF" or "WM_DELETE_WINDOW". | | wm_resizable(self, width=None, height=None) | Instruct the window manager whether this width can be resized | in WIDTH or HEIGHT. Both values are boolean values. | | wm_sizefrom(self, who=None) | Instruct the window manager that the size of this widget shall | be defined by the user if WHO is "user", and by its own policy if WHO is | "program". | | wm_state(self, newstate=None) | Query or set the state of this widget as one of normal, icon, | iconic (see wm_iconwindow), withdrawn, or zoomed (Windows only). | | wm_title(self, string=None) | Set the title of this widget. | | wm_transient(self, master=None) | Instruct the window manager that this widget is transient | with regard to widget MASTER. | | wm_withdraw(self) | Withdraw this widget from the screen such that it is unmapped | and forgotten by the window manager. Re-draw it with wm_deiconify. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
tkinter.X
Error rendering doc: No Python documentation found for 'x'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.XView
Python Library Documentation: class XView in module tkinter class XView(builtins.object) | Mix-in class for querying and changing the horizontal position | of a widget's window. | | Methods defined here: | | xview(self, *args) | Query and change the horizontal position of the view. | | xview_moveto(self, fraction) | Adjusts the view in the window so that FRACTION of the | total width of the canvas is off-screen to the left. | | xview_scroll(self, number, what) | Shift the x-view according to NUMBER which is measured in "units" | or "pages" (WHAT). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
tkinter.Y
Error rendering doc: No Python documentation found for 'y'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
tkinter.YES
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.YView
Python Library Documentation: class YView in module tkinter class YView(builtins.object) | Mix-in class for querying and changing the vertical position | of a widget's window. | | Methods defined here: | | yview(self, *args) | Query and change the vertical position of the view. | | yview_moveto(self, fraction) | Adjusts the view in the window so that FRACTION of the | total height of the canvas is off-screen to the top. | | yview_scroll(self, number, what) | Shift the y-view according to NUMBER which is measured in | "units" or "pages" (WHAT). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
tkinter.collections
Python Library Documentation: package collections
NAME
collections
MODULE REFERENCE
https://docs.python.org/3.12/library/collections.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
DESCRIPTION
This module implements specialized container datatypes providing
alternatives to Python's general purpose built-in containers, dict,
list, set, and tuple.
* namedtuple factory function for creating tuple subclasses with named fields
* deque list-like container with fast appends and pops on either end
* ChainMap dict-like class for creating a single view of multiple mappings
* Counter dict subclass for counting hashable objects
* OrderedDict dict subclass that remembers the order entries were added
* defaultdict dict subclass that calls a factory function to supply missing values
* UserDict wrapper around dictionary objects for easier dict subclassing
* UserList wrapper around list objects for easier list subclassing
* UserString wrapper around string objects for easier string subclassing
PACKAGE CONTENTS
abc
SUBMODULES
_collections_abc
CLASSES
builtins.dict(builtins.object)
Counter
OrderedDict
defaultdict
builtins.object
deque
collections.abc.MutableMapping(collections.abc.Mapping)
ChainMap
UserDict
collections.abc.MutableSequence(collections.abc.Sequence)
UserList
collections.abc.Sequence(collections.abc.Reversible, collections.abc.Collection)
UserString
class ChainMap(collections.abc.MutableMapping)
| ChainMap(*maps)
|
| A ChainMap groups multiple dicts (or other mappings) together
| to create a single, updateable view.
|
| The underlying mappings are stored in a list. That list is public and can
| be accessed or updated using the *maps* attribute. There is no other
| state.
|
| Lookups search the underlying mappings successively until a key is found.
| In contrast, writes, updates, and deletions only operate on the first
| mapping.
|
| Method resolution order:
| ChainMap
| collections.abc.MutableMapping
| collections.abc.Mapping
| collections.abc.Collection
| collections.abc.Sized
| collections.abc.Iterable
| collections.abc.Container
| builtins.object
|
| Methods defined here:
|
| __bool__(self)
|
| __contains__(self, key)
|
| __copy__ = copy(self)
|
| __delitem__(self, key)
|
| __getitem__(self, key)
|
| __init__(self, *maps)
| Initialize a ChainMap by setting *maps* to the given mappings.
| If no mappings are provided, a single empty dictionary is used.
|
| __ior__(self, other)
|
| __iter__(self)
|
| __len__(self)
|
| __missing__(self, key)
|
| __or__(self, other)
| Return self|value.
|
| __repr__(self)
| Return repr(self).
|
| __ror__(self, other)
| Return value|self.
|
| __setitem__(self, key, value)
|
| clear(self)
| Clear maps[0], leaving maps[1:] intact.
|
| copy(self)
| New ChainMap or subclass with a new copy of maps[0] and refs to maps[1:]
|
| get(self, key, default=None)
| D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
|
| new_child(self, m=None, **kwargs)
| New ChainMap with a new map followed by all previous maps.
| If no map is provided, an empty dict is used.
| Keyword arguments update the map or new empty dict.
|
| pop(self, key, *args)
| Remove *key* from maps[0] and return its value. Raise KeyError if *key* not in maps[0].
|
| popitem(self)
| Remove and return an item pair from maps[0]. Raise KeyError is maps[0] is empty.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| fromkeys(iterable, *args)
| Create a ChainMap with a single dict created from the iterable.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| parents
| New ChainMap from maps[1:].
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.MutableMapping:
|
| setdefault(self, key, default=None)
| D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
|
| update(self, other=(), /, **kwds)
| D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.
| If E present and has a .keys() method, does: for k in E: D[k] = E[k]
| If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v
| In either case, this is followed by: for k, v in F.items(): D[k] = v
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.Mapping:
|
| __eq__(self, other)
| Return self==value.
|
| items(self)
| D.items() -> a set-like object providing a view on D's items
|
| keys(self)
| D.keys() -> a set-like object providing a view on D's keys
|
| values(self)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from collections.abc.Mapping:
|
| __hash__ = None
|
| __reversed__ = None
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Collection:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
class Counter(builtins.dict)
| Counter(iterable=None, /, **kwds)
|
| Dict subclass for counting hashable items. Sometimes called a bag
| or multiset. Elements are stored as dictionary keys and their counts
| are stored as dictionary values.
|
| >>> c = Counter('abcdeabcdabcaba') # count elements from a string
|
| >>> c.most_common(3) # three most common elements
| [('a', 5), ('b', 4), ('c', 3)]
| >>> sorted(c) # list all unique elements
| ['a', 'b', 'c', 'd', 'e']
| >>> ''.join(sorted(c.elements())) # list elements with repetitions
| 'aaaaabbbbcccdde'
| >>> sum(c.values()) # total of all counts
| 15
|
| >>> c['a'] # count of letter 'a'
| 5
| >>> for elem in 'shazam': # update counts from an iterable
| ... c[elem] += 1 # by adding 1 to each element's count
| >>> c['a'] # now there are seven 'a'
| 7
| >>> del c['b'] # remove all 'b'
| >>> c['b'] # now there are zero 'b'
| 0
|
| >>> d = Counter('simsalabim') # make another counter
| >>> c.update(d) # add in the second counter
| >>> c['a'] # now there are nine 'a'
| 9
|
| >>> c.clear() # empty the counter
| >>> c
| Counter()
|
| Note: If a count is set to zero or reduced to zero, it will remain
| in the counter until the entry is deleted or the counter is cleared:
|
| >>> c = Counter('aaabbc')
| >>> c['b'] -= 2 # reduce the count of 'b' by two
| >>> c.most_common() # 'b' is still in, but its count is zero
| [('a', 3), ('c', 1), ('b', 0)]
|
| Method resolution order:
| Counter
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __add__(self, other)
| Add counts from two counters.
|
| >>> Counter('abbb') + Counter('bcc')
| Counter({'b': 4, 'c': 2, 'a': 1})
|
| __and__(self, other)
| Intersection is the minimum of corresponding counts.
|
| >>> Counter('abbb') & Counter('bcc')
| Counter({'b': 1})
|
| __delitem__(self, elem)
| Like dict.__delitem__() but does not raise KeyError for missing values.
|
| __eq__(self, other)
| True if all counts agree. Missing counts are treated as zero.
|
| __ge__(self, other)
| True if all counts in self are a superset of those in other.
|
| __gt__(self, other)
| True if all counts in self are a proper superset of those in other.
|
| __iadd__(self, other)
| Inplace add from another counter, keeping only positive counts.
|
| >>> c = Counter('abbb')
| >>> c += Counter('bcc')
| >>> c
| Counter({'b': 4, 'c': 2, 'a': 1})
|
| __iand__(self, other)
| Inplace intersection is the minimum of corresponding counts.
|
| >>> c = Counter('abbb')
| >>> c &= Counter('bcc')
| >>> c
| Counter({'b': 1})
|
| __init__(self, iterable=None, /, **kwds)
| Create a new, empty Counter object. And if given, count elements
| from an input iterable. Or, initialize the count from another mapping
| of elements to their counts.
|
| >>> c = Counter() # a new, empty counter
| >>> c = Counter('gallahad') # a new counter from an iterable
| >>> c = Counter({'a': 4, 'b': 2}) # a new counter from a mapping
| >>> c = Counter(a=4, b=2) # a new counter from keyword args
|
| __ior__(self, other)
| Inplace union is the maximum of value from either counter.
|
| >>> c = Counter('abbb')
| >>> c |= Counter('bcc')
| >>> c
| Counter({'b': 3, 'c': 2, 'a': 1})
|
| __isub__(self, other)
| Inplace subtract counter, but keep only results with positive counts.
|
| >>> c = Counter('abbbc')
| >>> c -= Counter('bccd')
| >>> c
| Counter({'b': 2, 'a': 1})
|
| __le__(self, other)
| True if all counts in self are a subset of those in other.
|
| __lt__(self, other)
| True if all counts in self are a proper subset of those in other.
|
| __missing__(self, key)
| The count of elements not in the Counter is zero.
|
| __ne__(self, other)
| True if any counts disagree. Missing counts are treated as zero.
|
| __neg__(self)
| Subtracts from an empty counter. Strips positive and zero counts,
| and flips the sign on negative counts.
|
| __or__(self, other)
| Union is the maximum of value in either of the input counters.
|
| >>> Counter('abbb') | Counter('bcc')
| Counter({'b': 3, 'c': 2, 'a': 1})
|
| __pos__(self)
| Adds an empty counter, effectively stripping negative and zero counts
|
| __reduce__(self)
| Helper for pickle.
|
| __repr__(self)
| Return repr(self).
|
| __sub__(self, other)
| Subtract count, but keep only results with positive counts.
|
| >>> Counter('abbbc') - Counter('bccd')
| Counter({'b': 2, 'a': 1})
|
| copy(self)
| Return a shallow copy.
|
| elements(self)
| Iterator over elements repeating each as many times as its count.
|
| >>> c = Counter('ABCABC')
| >>> sorted(c.elements())
| ['A', 'A', 'B', 'B', 'C', 'C']
|
| Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1
|
| >>> import math
| >>> prime_factors = Counter({2: 2, 3: 3, 17: 1})
| >>> math.prod(prime_factors.elements())
| 1836
|
| Note, if an element's count has been set to zero or is a negative
| number, elements() will ignore it.
|
| most_common(self, n=None)
| List the n most common elements and their counts from the most
| common to the least. If n is None, then list all element counts.
|
| >>> Counter('abracadabra').most_common(3)
| [('a', 5), ('b', 2), ('r', 2)]
|
| subtract(self, iterable=None, /, **kwds)
| Like dict.update() but subtracts counts instead of replacing them.
| Counts can be reduced below zero. Both the inputs and outputs are
| allowed to contain zero and negative counts.
|
| Source can be an iterable, a dictionary, or another Counter instance.
|
| >>> c = Counter('which')
| >>> c.subtract('witch') # subtract elements from another iterable
| >>> c.subtract(Counter('watch')) # subtract elements from another counter
| >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch
| 0
| >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch
| -1
|
| total(self)
| Sum of the counts
|
| update(self, iterable=None, /, **kwds)
| Like dict.update() but add counts instead of replacing them.
|
| Source can be an iterable, a dictionary, or another Counter instance.
|
| >>> c = Counter('which')
| >>> c.update('witch') # add elements from another iterable
| >>> d = Counter('watch')
| >>> c.update(d) # add elements from another counter
| >>> c['h'] # four 'h' in which, witch, and watch
| 4
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| fromkeys(iterable, v=None)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __iter__(self, /)
| Implement iter(self).
|
| __len__(self, /)
| Return len(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
class OrderedDict(builtins.dict)
| Dictionary that remembers insertion order
|
| Method resolution order:
| OrderedDict
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __reduce__(...)
| Return state information for pickling
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(...)
| od.__reversed__() <==> reversed(od)
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| od.clear() -> None. Remove all items from od.
|
| copy(...)
| od.copy() -> a shallow copy of od
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| move_to_end(self, /, key, last=True)
| Move an existing element to the end (or beginning if last is false).
|
| Raise KeyError if the element does not exist.
|
| pop(...)
| od.pop(key[,default]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /, last=True)
| Remove and return a (key, value) pair from the dictionary.
|
| Pairs are returned in LIFO order if last is true or FIFO order if false.
|
| setdefault(self, /, key, default=None)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| fromkeys(iterable, value=None)
| Create a new ordered dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __len__(self, /)
| Return len(self).
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
class UserDict(collections.abc.MutableMapping)
| UserDict(dict=None, /, **kwargs)
|
| Method resolution order:
| UserDict
| collections.abc.MutableMapping
| collections.abc.Mapping
| collections.abc.Collection
| collections.abc.Sized
| collections.abc.Iterable
| collections.abc.Container
| builtins.object
|
| Methods defined here:
|
| __contains__(self, key)
| # Modify __contains__ and get() to work like dict
| # does when __missing__ is present.
|
| __copy__(self)
|
| __delitem__(self, key)
|
| __getitem__(self, key)
|
| __init__(self, dict=None, /, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __ior__(self, other)
|
| __iter__(self)
|
| __len__(self)
|
| __or__(self, other)
| Return self|value.
|
| __repr__(self)
| Return repr(self).
|
| __ror__(self, other)
| Return value|self.
|
| __setitem__(self, key, item)
|
| copy(self)
|
| get(self, key, default=None)
| D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| fromkeys(iterable, value=None)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.MutableMapping:
|
| clear(self)
| D.clear() -> None. Remove all items from D.
|
| pop(self, key, default=<object object at 0x00000248F48A81F0>)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
| If key is not found, d is returned if given, otherwise KeyError is raised.
|
| popitem(self)
| D.popitem() -> (k, v), remove and return some (key, value) pair
| as a 2-tuple; but raise KeyError if D is empty.
|
| setdefault(self, key, default=None)
| D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
|
| update(self, other=(), /, **kwds)
| D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.
| If E present and has a .keys() method, does: for k in E: D[k] = E[k]
| If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v
| In either case, this is followed by: for k, v in F.items(): D[k] = v
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.Mapping:
|
| __eq__(self, other)
| Return self==value.
|
| items(self)
| D.items() -> a set-like object providing a view on D's items
|
| keys(self)
| D.keys() -> a set-like object providing a view on D's keys
|
| values(self)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from collections.abc.Mapping:
|
| __hash__ = None
|
| __reversed__ = None
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Collection:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
class UserList(collections.abc.MutableSequence)
| UserList(initlist=None)
|
| A more or less complete user-defined wrapper around list objects.
|
| Method resolution order:
| UserList
| collections.abc.MutableSequence
| collections.abc.Sequence
| collections.abc.Reversible
| collections.abc.Collection
| collections.abc.Sized
| collections.abc.Iterable
| collections.abc.Container
| builtins.object
|
| Methods defined here:
|
| __add__(self, other)
|
| __contains__(self, item)
|
| __copy__(self)
|
| __delitem__(self, i)
|
| __eq__(self, other)
| Return self==value.
|
| __ge__(self, other)
| Return self>=value.
|
| __getitem__(self, i)
|
| __gt__(self, other)
| Return self>value.
|
| __iadd__(self, other)
|
| __imul__(self, n)
|
| __init__(self, initlist=None)
| Initialize self. See help(type(self)) for accurate signature.
|
| __le__(self, other)
| Return self<=value.
|
| __len__(self)
|
| __lt__(self, other)
| Return self<value.
|
| __mul__(self, n)
|
| __radd__(self, other)
|
| __repr__(self)
| Return repr(self).
|
| __rmul__ = __mul__(self, n)
|
| __setitem__(self, i, item)
|
| append(self, item)
| S.append(value) -- append value to the end of the sequence
|
| clear(self)
| S.clear() -> None -- remove all items from S
|
| copy(self)
|
| count(self, item)
| S.count(value) -> integer -- return number of occurrences of value
|
| extend(self, other)
| S.extend(iterable) -- extend sequence by appending elements from the iterable
|
| index(self, item, *args)
| S.index(value, [start, [stop]]) -> integer -- return first index of value.
| Raises ValueError if the value is not present.
|
| Supporting start and stop arguments is optional, but
| recommended.
|
| insert(self, i, item)
| S.insert(index, value) -- insert value before index
|
| pop(self, i=-1)
| S.pop([index]) -> item -- remove and return item at index (default last).
| Raise IndexError if list is empty or index is out of range.
|
| remove(self, item)
| S.remove(value) -- remove first occurrence of value.
| Raise ValueError if the value is not present.
|
| reverse(self)
| S.reverse() -- reverse *IN PLACE*
|
| sort(self, /, *args, **kwds)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __hash__ = None
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.Sequence:
|
| __iter__(self)
|
| __reversed__(self)
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Reversible:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
class UserString(collections.abc.Sequence)
| UserString(seq)
|
| Method resolution order:
| UserString
| collections.abc.Sequence
| collections.abc.Reversible
| collections.abc.Collection
| collections.abc.Sized
| collections.abc.Iterable
| collections.abc.Container
| builtins.object
|
| Methods defined here:
|
| __add__(self, other)
|
| __complex__(self)
|
| __contains__(self, char)
|
| __eq__(self, string)
| Return self==value.
|
| __float__(self)
|
| __ge__(self, string)
| Return self>=value.
|
| __getitem__(self, index)
|
| __getnewargs__(self)
|
| __gt__(self, string)
| Return self>value.
|
| __hash__(self)
| Return hash(self).
|
| __init__(self, seq)
| Initialize self. See help(type(self)) for accurate signature.
|
| __int__(self)
|
| __le__(self, string)
| Return self<=value.
|
| __len__(self)
|
| __lt__(self, string)
| Return self<value.
|
| __mod__(self, args)
|
| __mul__(self, n)
|
| __radd__(self, other)
|
| __repr__(self)
| Return repr(self).
|
| __rmod__(self, template)
|
| __rmul__ = __mul__(self, n)
|
| __str__(self)
| Return str(self).
|
| capitalize(self)
| # the following methods are defined in alphabetical order:
|
| casefold(self)
|
| center(self, width, *args)
|
| count(self, sub, start=0, end=9223372036854775807)
| S.count(value) -> integer -- return number of occurrences of value
|
| encode(self, encoding='utf-8', errors='strict')
|
| endswith(self, suffix, start=0, end=9223372036854775807)
|
| expandtabs(self, tabsize=8)
|
| find(self, sub, start=0, end=9223372036854775807)
|
| format(self, /, *args, **kwds)
|
| format_map(self, mapping)
|
| index(self, sub, start=0, end=9223372036854775807)
| S.index(value, [start, [stop]]) -> integer -- return first index of value.
| Raises ValueError if the value is not present.
|
| Supporting start and stop arguments is optional, but
| recommended.
|
| isalnum(self)
|
| isalpha(self)
|
| isascii(self)
|
| isdecimal(self)
|
| isdigit(self)
|
| isidentifier(self)
|
| islower(self)
|
| isnumeric(self)
|
| isprintable(self)
|
| isspace(self)
|
| istitle(self)
|
| isupper(self)
|
| join(self, seq)
|
| ljust(self, width, *args)
|
| lower(self)
|
| lstrip(self, chars=None)
|
| partition(self, sep)
|
| removeprefix(self, prefix, /)
|
| removesuffix(self, suffix, /)
|
| replace(self, old, new, maxsplit=-1)
|
| rfind(self, sub, start=0, end=9223372036854775807)
|
| rindex(self, sub, start=0, end=9223372036854775807)
|
| rjust(self, width, *args)
|
| rpartition(self, sep)
|
| rsplit(self, sep=None, maxsplit=-1)
|
| rstrip(self, chars=None)
|
| split(self, sep=None, maxsplit=-1)
|
| splitlines(self, keepends=False)
|
| startswith(self, prefix, start=0, end=9223372036854775807)
|
| strip(self, chars=None)
|
| swapcase(self)
|
| title(self)
|
| translate(self, *args)
|
| upper(self)
|
| zfill(self, width)
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.Sequence:
|
| __iter__(self)
|
| __reversed__(self)
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Reversible:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
class defaultdict(builtins.dict)
| defaultdict(default_factory=None, /, [...]) --> dict with default factory
|
| The default factory is called without arguments to produce
| a new value when a key is not present, in __getitem__ only.
| A defaultdict compares equal to a dict with the same items.
| All remaining arguments are treated the same as if they were
| passed to the dict constructor, including keyword arguments.
|
| Method resolution order:
| defaultdict
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __copy__(...)
| D.copy() -> a shallow copy of D.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __missing__(...)
| __missing__(key) # Called by __getitem__ for missing key; pseudo-code:
| if self.default_factory is None: raise KeyError((key,))
| self[key] = value = self.default_factory()
| return value
|
| __or__(self, value, /)
| Return self|value.
|
| __reduce__(...)
| Return state information for pickling.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| copy(...)
| D.copy() -> a shallow copy of D.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| default_factory
| Factory for default value called by __missing__().
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class deque(builtins.object)
| deque([iterable[, maxlen]]) --> deque object
|
| A list-like sequence optimized for data accesses near its endpoints.
|
| Methods defined here:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __copy__(...)
| Return a shallow copy of a deque.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(...)
| Return state information for pickling.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(...)
| D.__reversed__() -- return a reverse iterator over the deque
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -- size of D in memory, in bytes
|
| append(...)
| Add an element to the right side of the deque.
|
| appendleft(...)
| Add an element to the left side of the deque.
|
| clear(...)
| Remove all elements from the deque.
|
| copy(...)
| Return a shallow copy of a deque.
|
| count(...)
| D.count(value) -- return number of occurrences of value
|
| extend(...)
| Extend the right side of the deque with elements from the iterable
|
| extendleft(...)
| Extend the left side of the deque with elements from the iterable
|
| index(...)
| D.index(value, [start, [stop]]) -- return first index of value.
| Raises ValueError if the value is not present.
|
| insert(...)
| D.insert(index, object) -- insert object before index
|
| pop(...)
| Remove and return the rightmost element.
|
| popleft(...)
| Remove and return the leftmost element.
|
| remove(...)
| D.remove(value) -- remove first occurrence of value.
|
| reverse(...)
| D.reverse() -- reverse *IN PLACE*
|
| rotate(...)
| Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| maxlen
| maximum size of a deque or None if unbounded
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
FUNCTIONS
namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)
Returns a new subclass of tuple with named fields.
>>> Point = namedtuple('Point', ['x', 'y'])
>>> Point.__doc__ # docstring for the new class
'Point(x, y)'
>>> p = Point(11, y=22) # instantiate with positional args or keywords
>>> p[0] + p[1] # indexable like a plain tuple
33
>>> x, y = p # unpack like a regular tuple
>>> x, y
(11, 22)
>>> p.x + p.y # fields also accessible by name
33
>>> d = p._asdict() # convert to a dictionary
>>> d['x']
11
>>> Point(**d) # convert from a dictionary
Point(x=11, y=22)
>>> p._replace(x=100) # _replace() is like str.replace() but targets named fields
Point(x=100, y=22)
DATA
__all__ = ['ChainMap', 'Counter', 'OrderedDict', 'UserDict', 'UserList...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\collections\__init__.py
tkinter.constants
Python Library Documentation: module tkinter.constants in tkinter
NAME
tkinter.constants - # Symbolic constants for Tk
MODULE REFERENCE
https://docs.python.org/3.12/library/tkinter.constants.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
DATA
ACTIVE = 'active'
ALL = 'all'
ANCHOR = 'anchor'
ARC = 'arc'
BASELINE = 'baseline'
BEVEL = 'bevel'
BOTH = 'both'
BOTTOM = 'bottom'
BROWSE = 'browse'
BUTT = 'butt'
CASCADE = 'cascade'
CENTER = 'center'
CHAR = 'char'
CHECKBUTTON = 'checkbutton'
CHORD = 'chord'
COMMAND = 'command'
CURRENT = 'current'
DISABLED = 'disabled'
DOTBOX = 'dotbox'
E = 'e'
END = 'end'
EW = 'ew'
EXTENDED = 'extended'
FALSE = 0
FIRST = 'first'
FLAT = 'flat'
GROOVE = 'groove'
HIDDEN = 'hidden'
HORIZONTAL = 'horizontal'
INSERT = 'insert'
INSIDE = 'inside'
LAST = 'last'
LEFT = 'left'
MITER = 'miter'
MOVETO = 'moveto'
MULTIPLE = 'multiple'
N = 'n'
NE = 'ne'
NO = 0
NONE = 'none'
NORMAL = 'normal'
NS = 'ns'
NSEW = 'nsew'
NUMERIC = 'numeric'
NW = 'nw'
OFF = 0
ON = 1
OUTSIDE = 'outside'
PAGES = 'pages'
PIESLICE = 'pieslice'
PROJECTING = 'projecting'
RADIOBUTTON = 'radiobutton'
RAISED = 'raised'
RIDGE = 'ridge'
RIGHT = 'right'
ROUND = 'round'
S = 's'
SCROLL = 'scroll'
SE = 'se'
SEL = 'sel'
SEL_FIRST = 'sel.first'
SEL_LAST = 'sel.last'
SEPARATOR = 'separator'
SINGLE = 'single'
SOLID = 'solid'
SUNKEN = 'sunken'
SW = 'sw'
TOP = 'top'
TRUE = 1
UNDERLINE = 'underline'
UNITS = 'units'
VERTICAL = 'vertical'
W = 'w'
WORD = 'word'
X = 'x'
Y = 'y'
YES = 1
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\tkinter\constants.py
tkinter.enum
Python Library Documentation: module enum
NAME
enum
MODULE REFERENCE
https://docs.python.org/3.12/library/enum.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
CLASSES
builtins.int(builtins.object)
IntEnum(builtins.int, ReprEnum)
IntFlag(builtins.int, ReprEnum, Flag)
builtins.object
Enum
Flag
ReprEnum
IntEnum(builtins.int, ReprEnum)
IntFlag(builtins.int, ReprEnum, Flag)
StrEnum(builtins.str, ReprEnum)
EnumCheck
FlagBoundary
auto
member
nonmember
verify
builtins.str(builtins.object)
StrEnum(builtins.str, ReprEnum)
EnumCheck
FlagBoundary
builtins.type(builtins.object)
EnumType
types.DynamicClassAttribute(builtins.object)
property
class Enum(builtins.object)
| Enum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)
|
| Create a collection of name/value pairs.
|
| Example enumeration:
|
| >>> class Color(Enum):
| ... RED = 1
| ... BLUE = 2
| ... GREEN = 3
|
| Access them by:
|
| - attribute access:
|
| >>> Color.RED
| <Color.RED: 1>
|
| - value lookup:
|
| >>> Color(1)
| <Color.RED: 1>
|
| - name lookup:
|
| >>> Color['RED']
| <Color.RED: 1>
|
| Enumerations can be iterated over, and know how many members they have:
|
| >>> len(Color)
| 3
|
| >>> list(Color)
| [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
|
| Methods can be added to enumerations, and members can have their own
| attributes -- see the documentation for details.
|
| Static methods defined here:
|
| __new__(cls, value)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Static methods inherited from EnumType:
|
| __contains__(value)
| Return True if `value` is in `cls`.
|
| `value` is in `cls` if:
| 1) `value` is a member of `cls`, or
| 2) `value` is the value of one of the `cls`'s members.
|
| __getitem__(name)
| Return the member matching `name`.
|
| __iter__()
| Return members in definition order.
|
| __len__()
| Return the number of members (no aliases)
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class EnumCheck(StrEnum)
| EnumCheck(*values)
|
| various conditions to check an enumeration for
|
| Method resolution order:
| EnumCheck
| StrEnum
| builtins.str
| ReprEnum
| Enum
| builtins.object
|
| Methods defined here:
|
| __format__(self, format_spec, /) from builtins.str
| Return a formatted version of the string as described by format_spec.
|
| __new__(cls, value) from Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __str__(self, /) from builtins.str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| CONTINUOUS = <EnumCheck.CONTINUOUS: 'no skipped integer values'>
|
| NAMED_FLAGS = <EnumCheck.NAMED_FLAGS: 'multi-flag aliases may not cont...
|
| UNIQUE = <EnumCheck.UNIQUE: 'one name per value'>
|
| ----------------------------------------------------------------------
| Methods inherited from StrEnum:
|
| __repr__(self) from Enum
| Return repr(self).
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.str:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __sizeof__(self, /)
| Return the size of the string in memory, in bytes.
|
| capitalize(self, /)
| Return a capitalized version of the string.
|
| More specifically, make the first character have upper case and the rest lower
| case.
|
| casefold(self, /)
| Return a version of the string suitable for caseless comparisons.
|
| center(self, width, fillchar=' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| count(...)
| S.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of substring sub in
| string S[start:end]. Optional arguments start and end are
| interpreted as in slice notation.
|
| encode(self, /, encoding='utf-8', errors='strict')
| Encode the string using the codec registered for encoding.
|
| encoding
| The encoding in which to encode the string.
| errors
| The error handling scheme to use for encoding errors.
| The default is 'strict' meaning that encoding errors raise a
| UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
| 'xmlcharrefreplace' as well as any other name registered with
| codecs.register_error that can handle UnicodeEncodeErrors.
|
| endswith(...)
| S.endswith(suffix[, start[, end]]) -> bool
|
| Return True if S ends with the specified suffix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| suffix can also be a tuple of strings to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| S.find(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| format(...)
| S.format(*args, **kwargs) -> str
|
| Return a formatted version of S, using substitutions from args and kwargs.
| The substitutions are identified by braces ('{' and '}').
|
| format_map(...)
| S.format_map(mapping) -> str
|
| Return a formatted version of S, using substitutions from mapping.
| The substitutions are identified by braces ('{' and '}').
|
| index(...)
| S.index(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| isalnum(self, /)
| Return True if the string is an alpha-numeric string, False otherwise.
|
| A string is alpha-numeric if all characters in the string are alpha-numeric and
| there is at least one character in the string.
|
| isalpha(self, /)
| Return True if the string is an alphabetic string, False otherwise.
|
| A string is alphabetic if all characters in the string are alphabetic and there
| is at least one character in the string.
|
| isascii(self, /)
| Return True if all characters in the string are ASCII, False otherwise.
|
| ASCII characters have code points in the range U+0000-U+007F.
| Empty string is ASCII too.
|
| isdecimal(self, /)
| Return True if the string is a decimal string, False otherwise.
|
| A string is a decimal string if all characters in the string are decimal and
| there is at least one character in the string.
|
| isdigit(self, /)
| Return True if the string is a digit string, False otherwise.
|
| A string is a digit string if all characters in the string are digits and there
| is at least one character in the string.
|
| isidentifier(self, /)
| Return True if the string is a valid Python identifier, False otherwise.
|
| Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
| such as "def" or "class".
|
| islower(self, /)
| Return True if the string is a lowercase string, False otherwise.
|
| A string is lowercase if all cased characters in the string are lowercase and
| there is at least one cased character in the string.
|
| isnumeric(self, /)
| Return True if the string is a numeric string, False otherwise.
|
| A string is numeric if all characters in the string are numeric and there is at
| least one character in the string.
|
| isprintable(self, /)
| Return True if the string is printable, False otherwise.
|
| A string is printable if all of its characters are considered printable in
| repr() or if it is empty.
|
| isspace(self, /)
| Return True if the string is a whitespace string, False otherwise.
|
| A string is whitespace if all characters in the string are whitespace and there
| is at least one character in the string.
|
| istitle(self, /)
| Return True if the string is a title-cased string, False otherwise.
|
| In a title-cased string, upper- and title-case characters may only
| follow uncased characters and lowercase characters only cased ones.
|
| isupper(self, /)
| Return True if the string is an uppercase string, False otherwise.
|
| A string is uppercase if all cased characters in the string are uppercase and
| there is at least one cased character in the string.
|
| join(self, iterable, /)
| Concatenate any number of strings.
|
| The string whose method is called is inserted in between each given string.
| The result is returned as a new string.
|
| Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
|
| ljust(self, width, fillchar=' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| lower(self, /)
| Return a copy of the string converted to lowercase.
|
| lstrip(self, chars=None, /)
| Return a copy of the string with leading whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| partition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original string
| and two empty strings.
|
| removeprefix(self, prefix, /)
| Return a str with the given prefix string removed if present.
|
| If the string starts with the prefix string, return string[len(prefix):].
| Otherwise, return a copy of the original string.
|
| removesuffix(self, suffix, /)
| Return a str with the given suffix string removed if present.
|
| If the string ends with the suffix string and that suffix is not empty,
| return string[:-len(suffix)]. Otherwise, return a copy of the original
| string.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| S.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| S.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| rjust(self, width, fillchar=' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| rpartition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty strings
| and the original string.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the end of the string and works to the front.
|
| rstrip(self, chars=None, /)
| Return a copy of the string with trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the front of the string and works to the end.
|
| Note, str.split() is mainly useful for data that has been intentionally
| delimited. With natural text that includes punctuation, consider using
| the regular expression module.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the string, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| S.startswith(prefix[, start[, end]]) -> bool
|
| Return True if S starts with the specified prefix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| prefix can also be a tuple of strings to try.
|
| strip(self, chars=None, /)
| Return a copy of the string with leading and trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| swapcase(self, /)
| Convert uppercase characters to lowercase and lowercase characters to uppercase.
|
| title(self, /)
| Return a version of the string where each word is titlecased.
|
| More specifically, words start with uppercased characters and all remaining
| cased characters have lower case.
|
| translate(self, table, /)
| Replace each character in the string using the given translation table.
|
| table
| Translation table, which must be a mapping of Unicode ordinals to
| Unicode ordinals, strings, or None.
|
| The table must implement lookup/indexing via __getitem__, for instance a
| dictionary or list. If this operation raises LookupError, the character is
| left untouched. Characters mapped to None are deleted.
|
| upper(self, /)
| Return a copy of the string converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The string is never truncated.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.str:
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
|
| ----------------------------------------------------------------------
| Methods inherited from Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
EnumMeta = class EnumType(builtins.type)
| EnumMeta(cls, bases, classdict, *, boundary=None, _simple=False, **kwds)
|
| Metaclass for Enum
|
| Method resolution order:
| EnumType
| builtins.type
| builtins.object
|
| Methods defined here:
|
| __bool__(cls)
| classes/types should always be True.
|
| __call__(cls, value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
| Either returns an existing member, or creates a new enum class.
|
| This method is used both when an enum class is given a value to match
| to an enumeration member (i.e. Color(3)) and for the functional API
| (i.e. Color = Enum('Color', names='RED GREEN BLUE')).
|
| The value lookup branch is chosen if the enum is final.
|
| When used for the functional API:
|
| `value` will be the name of the new class.
|
| `names` should be either a string of white-space/comma delimited names
| (values will start at `start`), or an iterator/mapping of name, value pairs.
|
| `module` should be set to the module this class is being created in;
| if it is not set, an attempt to find that module will be made, but if
| it fails the class will not be picklable.
|
| `qualname` should be set to the actual location this class can be found
| at in its module; by default it is set to the global scope. If this is
| not correct, unpickling will fail in some circumstances.
|
| `type`, if set, will be mixed in as the first base class.
|
| __contains__(cls, value)
| Return True if `value` is in `cls`.
|
| `value` is in `cls` if:
| 1) `value` is a member of `cls`, or
| 2) `value` is the value of one of the `cls`'s members.
|
| __delattr__(cls, attr)
| Implement delattr(self, name).
|
| __dir__(cls)
| Specialized __dir__ implementation for types.
|
| __getitem__(cls, name)
| Return the member matching `name`.
|
| __iter__(cls)
| Return members in definition order.
|
| __len__(cls)
| Return the number of members (no aliases)
|
| __repr__(cls)
| Return repr(self).
|
| __reversed__(cls)
| Return members in reverse definition order.
|
| __setattr__(cls, name, value)
| Block attempts to reassign Enum members.
|
| A simple assignment to the class namespace only changes one of the
| several possible ways to get an Enum member from the Enum class,
| resulting in an inconsistent Enumeration.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __prepare__(cls, bases, **kwds)
| __prepare__() -> dict
| used to create the namespace for the class statement
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(metacls, cls, bases, classdict, *, boundary=None, _simple=False, **kwds)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.type:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __instancecheck__(self, instance, /)
| Check if an object is an instance.
|
| __or__(self, value, /)
| Return self|value.
|
| __ror__(self, value, /)
| Return value|self.
|
| __sizeof__(self, /)
| Return memory consumption of the type object.
|
| __subclasscheck__(self, subclass, /)
| Check if a class is a subclass.
|
| __subclasses__(self, /)
| Return a list of immediate subclasses.
|
| mro(self, /)
| Return a type's method resolution order.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.type:
|
| __abstractmethods__
|
| __dict__
|
| __text_signature__
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.type:
|
| __base__ = <class 'type'>
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
|
|
| __bases__ = (<class 'type'>,)
|
| __basicsize__ = 920
|
| __dictoffset__ = 264
|
| __flags__ = 2156418560
|
| __itemsize__ = 40
|
| __mro__ = (<class 'enum.EnumType'>, <class 'type'>, <class 'object'>)
|
| __type_params__ = ()
|
| __weakrefoffset__ = 368
class EnumType(builtins.type)
| EnumType(cls, bases, classdict, *, boundary=None, _simple=False, **kwds)
|
| Metaclass for Enum
|
| Method resolution order:
| EnumType
| builtins.type
| builtins.object
|
| Methods defined here:
|
| __bool__(cls)
| classes/types should always be True.
|
| __call__(cls, value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
| Either returns an existing member, or creates a new enum class.
|
| This method is used both when an enum class is given a value to match
| to an enumeration member (i.e. Color(3)) and for the functional API
| (i.e. Color = Enum('Color', names='RED GREEN BLUE')).
|
| The value lookup branch is chosen if the enum is final.
|
| When used for the functional API:
|
| `value` will be the name of the new class.
|
| `names` should be either a string of white-space/comma delimited names
| (values will start at `start`), or an iterator/mapping of name, value pairs.
|
| `module` should be set to the module this class is being created in;
| if it is not set, an attempt to find that module will be made, but if
| it fails the class will not be picklable.
|
| `qualname` should be set to the actual location this class can be found
| at in its module; by default it is set to the global scope. If this is
| not correct, unpickling will fail in some circumstances.
|
| `type`, if set, will be mixed in as the first base class.
|
| __contains__(cls, value)
| Return True if `value` is in `cls`.
|
| `value` is in `cls` if:
| 1) `value` is a member of `cls`, or
| 2) `value` is the value of one of the `cls`'s members.
|
| __delattr__(cls, attr)
| Implement delattr(self, name).
|
| __dir__(cls)
| Specialized __dir__ implementation for types.
|
| __getitem__(cls, name)
| Return the member matching `name`.
|
| __iter__(cls)
| Return members in definition order.
|
| __len__(cls)
| Return the number of members (no aliases)
|
| __repr__(cls)
| Return repr(self).
|
| __reversed__(cls)
| Return members in reverse definition order.
|
| __setattr__(cls, name, value)
| Block attempts to reassign Enum members.
|
| A simple assignment to the class namespace only changes one of the
| several possible ways to get an Enum member from the Enum class,
| resulting in an inconsistent Enumeration.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __prepare__(cls, bases, **kwds)
| __prepare__() -> dict
| used to create the namespace for the class statement
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(metacls, cls, bases, classdict, *, boundary=None, _simple=False, **kwds)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.type:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __instancecheck__(self, instance, /)
| Check if an object is an instance.
|
| __or__(self, value, /)
| Return self|value.
|
| __ror__(self, value, /)
| Return value|self.
|
| __sizeof__(self, /)
| Return memory consumption of the type object.
|
| __subclasscheck__(self, subclass, /)
| Check if a class is a subclass.
|
| __subclasses__(self, /)
| Return a list of immediate subclasses.
|
| mro(self, /)
| Return a type's method resolution order.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.type:
|
| __abstractmethods__
|
| __dict__
|
| __text_signature__
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.type:
|
| __base__ = <class 'type'>
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
|
|
| __bases__ = (<class 'type'>,)
|
| __basicsize__ = 920
|
| __dictoffset__ = 264
|
| __flags__ = 2156418560
|
| __itemsize__ = 40
|
| __mro__ = (<class 'enum.EnumType'>, <class 'type'>, <class 'object'>)
|
| __type_params__ = ()
|
| __weakrefoffset__ = 368
class Flag(Enum)
| Flag(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)
|
| Support for flags
|
| Method resolution order:
| Flag
| Enum
| builtins.object
|
| Methods defined here:
|
| __contains__(self, other)
| Returns True if self has at least the same flags set as other.
|
| __iter__(self)
| Returns flags in definition order.
|
| __len__(self)
| Return the number of members (no aliases)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Static methods inherited from EnumType:
|
| __getitem__(name)
| Return the member matching `name`.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class FlagBoundary(StrEnum)
| FlagBoundary(*values)
|
| control how out of range values are handled
| "strict" -> error is raised [default for Flag]
| "conform" -> extra bits are discarded
| "eject" -> lose flag status
| "keep" -> keep flag status and all bits [default for IntFlag]
|
| Method resolution order:
| FlagBoundary
| StrEnum
| builtins.str
| ReprEnum
| Enum
| builtins.object
|
| Methods defined here:
|
| __format__(self, format_spec, /) from builtins.str
| Return a formatted version of the string as described by format_spec.
|
| __new__(cls, value) from Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __str__(self, /) from builtins.str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| CONFORM = <FlagBoundary.CONFORM: 'conform'>
|
| EJECT = <FlagBoundary.EJECT: 'eject'>
|
| KEEP = <FlagBoundary.KEEP: 'keep'>
|
| STRICT = <FlagBoundary.STRICT: 'strict'>
|
| ----------------------------------------------------------------------
| Methods inherited from StrEnum:
|
| __repr__(self) from Enum
| Return repr(self).
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.str:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __sizeof__(self, /)
| Return the size of the string in memory, in bytes.
|
| capitalize(self, /)
| Return a capitalized version of the string.
|
| More specifically, make the first character have upper case and the rest lower
| case.
|
| casefold(self, /)
| Return a version of the string suitable for caseless comparisons.
|
| center(self, width, fillchar=' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| count(...)
| S.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of substring sub in
| string S[start:end]. Optional arguments start and end are
| interpreted as in slice notation.
|
| encode(self, /, encoding='utf-8', errors='strict')
| Encode the string using the codec registered for encoding.
|
| encoding
| The encoding in which to encode the string.
| errors
| The error handling scheme to use for encoding errors.
| The default is 'strict' meaning that encoding errors raise a
| UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
| 'xmlcharrefreplace' as well as any other name registered with
| codecs.register_error that can handle UnicodeEncodeErrors.
|
| endswith(...)
| S.endswith(suffix[, start[, end]]) -> bool
|
| Return True if S ends with the specified suffix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| suffix can also be a tuple of strings to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| S.find(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| format(...)
| S.format(*args, **kwargs) -> str
|
| Return a formatted version of S, using substitutions from args and kwargs.
| The substitutions are identified by braces ('{' and '}').
|
| format_map(...)
| S.format_map(mapping) -> str
|
| Return a formatted version of S, using substitutions from mapping.
| The substitutions are identified by braces ('{' and '}').
|
| index(...)
| S.index(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| isalnum(self, /)
| Return True if the string is an alpha-numeric string, False otherwise.
|
| A string is alpha-numeric if all characters in the string are alpha-numeric and
| there is at least one character in the string.
|
| isalpha(self, /)
| Return True if the string is an alphabetic string, False otherwise.
|
| A string is alphabetic if all characters in the string are alphabetic and there
| is at least one character in the string.
|
| isascii(self, /)
| Return True if all characters in the string are ASCII, False otherwise.
|
| ASCII characters have code points in the range U+0000-U+007F.
| Empty string is ASCII too.
|
| isdecimal(self, /)
| Return True if the string is a decimal string, False otherwise.
|
| A string is a decimal string if all characters in the string are decimal and
| there is at least one character in the string.
|
| isdigit(self, /)
| Return True if the string is a digit string, False otherwise.
|
| A string is a digit string if all characters in the string are digits and there
| is at least one character in the string.
|
| isidentifier(self, /)
| Return True if the string is a valid Python identifier, False otherwise.
|
| Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
| such as "def" or "class".
|
| islower(self, /)
| Return True if the string is a lowercase string, False otherwise.
|
| A string is lowercase if all cased characters in the string are lowercase and
| there is at least one cased character in the string.
|
| isnumeric(self, /)
| Return True if the string is a numeric string, False otherwise.
|
| A string is numeric if all characters in the string are numeric and there is at
| least one character in the string.
|
| isprintable(self, /)
| Return True if the string is printable, False otherwise.
|
| A string is printable if all of its characters are considered printable in
| repr() or if it is empty.
|
| isspace(self, /)
| Return True if the string is a whitespace string, False otherwise.
|
| A string is whitespace if all characters in the string are whitespace and there
| is at least one character in the string.
|
| istitle(self, /)
| Return True if the string is a title-cased string, False otherwise.
|
| In a title-cased string, upper- and title-case characters may only
| follow uncased characters and lowercase characters only cased ones.
|
| isupper(self, /)
| Return True if the string is an uppercase string, False otherwise.
|
| A string is uppercase if all cased characters in the string are uppercase and
| there is at least one cased character in the string.
|
| join(self, iterable, /)
| Concatenate any number of strings.
|
| The string whose method is called is inserted in between each given string.
| The result is returned as a new string.
|
| Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
|
| ljust(self, width, fillchar=' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| lower(self, /)
| Return a copy of the string converted to lowercase.
|
| lstrip(self, chars=None, /)
| Return a copy of the string with leading whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| partition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original string
| and two empty strings.
|
| removeprefix(self, prefix, /)
| Return a str with the given prefix string removed if present.
|
| If the string starts with the prefix string, return string[len(prefix):].
| Otherwise, return a copy of the original string.
|
| removesuffix(self, suffix, /)
| Return a str with the given suffix string removed if present.
|
| If the string ends with the suffix string and that suffix is not empty,
| return string[:-len(suffix)]. Otherwise, return a copy of the original
| string.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| S.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| S.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| rjust(self, width, fillchar=' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| rpartition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty strings
| and the original string.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the end of the string and works to the front.
|
| rstrip(self, chars=None, /)
| Return a copy of the string with trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the front of the string and works to the end.
|
| Note, str.split() is mainly useful for data that has been intentionally
| delimited. With natural text that includes punctuation, consider using
| the regular expression module.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the string, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| S.startswith(prefix[, start[, end]]) -> bool
|
| Return True if S starts with the specified prefix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| prefix can also be a tuple of strings to try.
|
| strip(self, chars=None, /)
| Return a copy of the string with leading and trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| swapcase(self, /)
| Convert uppercase characters to lowercase and lowercase characters to uppercase.
|
| title(self, /)
| Return a version of the string where each word is titlecased.
|
| More specifically, words start with uppercased characters and all remaining
| cased characters have lower case.
|
| translate(self, table, /)
| Replace each character in the string using the given translation table.
|
| table
| Translation table, which must be a mapping of Unicode ordinals to
| Unicode ordinals, strings, or None.
|
| The table must implement lookup/indexing via __getitem__, for instance a
| dictionary or list. If this operation raises LookupError, the character is
| left untouched. Characters mapped to None are deleted.
|
| upper(self, /)
| Return a copy of the string converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The string is never truncated.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.str:
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
|
| ----------------------------------------------------------------------
| Methods inherited from Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class IntEnum(builtins.int, ReprEnum)
| IntEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)
|
| Enum where members are also (and must be) ints
|
| Method resolution order:
| IntEnum
| builtins.int
| ReprEnum
| Enum
| builtins.object
|
| Methods defined here:
|
| __format__(self, format_spec, /) from builtins.int
| Convert to a string according to format_spec.
|
| __new__(cls, value) from Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __repr__(self) from Enum
| Return repr(self).
|
| __str__ = __repr__(self, /) from builtins.int
| Return repr(self).
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.int:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.int:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.int:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
|
| ----------------------------------------------------------------------
| Methods inherited from Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Static methods inherited from EnumType:
|
| __contains__(value)
| Return True if `value` is in `cls`.
|
| `value` is in `cls` if:
| 1) `value` is a member of `cls`, or
| 2) `value` is the value of one of the `cls`'s members.
|
| __getitem__(name)
| Return the member matching `name`.
|
| __iter__()
| Return members in definition order.
|
| __len__()
| Return the number of members (no aliases)
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class IntFlag(builtins.int, ReprEnum, Flag)
| IntFlag(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)
|
| Support for integer-based Flags
|
| Method resolution order:
| IntFlag
| builtins.int
| ReprEnum
| Flag
| Enum
| builtins.object
|
| Methods defined here:
|
| __and__(self, other) from Flag
|
| __format__(self, format_spec, /) from builtins.int
| Convert to a string according to format_spec.
|
| __invert__(self) from Flag
|
| __new__(cls, value) from Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __or__(self, other) from Flag
| Return self|value.
|
| __rand__ = __and__(self, other)
|
| __repr__(self) from Flag
| Return repr(self).
|
| __ror__ = __or__(self, other)
|
| __rxor__ = __xor__(self, other)
|
| __str__ = __repr__(self, /) from builtins.int
| Return repr(self).
|
| __xor__(self, other) from Flag
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.int:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.int:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.int:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
|
| ----------------------------------------------------------------------
| Methods inherited from Flag:
|
| __contains__(self, other)
| Returns True if self has at least the same flags set as other.
|
| __iter__(self)
| Returns flags in definition order.
|
| __len__(self)
| Return the number of members (no aliases)
|
| ----------------------------------------------------------------------
| Methods inherited from Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Static methods inherited from EnumType:
|
| __getitem__(name)
| Return the member matching `name`.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class ReprEnum(Enum)
| ReprEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)
|
| Only changes the repr(), leaving str() and format() to the mixed-in type.
|
| Method resolution order:
| ReprEnum
| Enum
| builtins.object
|
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Static methods inherited from EnumType:
|
| __contains__(value)
| Return True if `value` is in `cls`.
|
| `value` is in `cls` if:
| 1) `value` is a member of `cls`, or
| 2) `value` is the value of one of the `cls`'s members.
|
| __getitem__(name)
| Return the member matching `name`.
|
| __iter__()
| Return members in definition order.
|
| __len__()
| Return the number of members (no aliases)
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class StrEnum(builtins.str, ReprEnum)
| StrEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)
|
| Enum where members are also (and must be) strings
|
| Method resolution order:
| StrEnum
| builtins.str
| ReprEnum
| Enum
| builtins.object
|
| Methods defined here:
|
| __format__(self, format_spec, /) from builtins.str
| Return a formatted version of the string as described by format_spec.
|
| __new__(cls, value) from Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __repr__(self) from Enum
| Return repr(self).
|
| __str__(self, /) from builtins.str
| Return str(self).
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.str:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __sizeof__(self, /)
| Return the size of the string in memory, in bytes.
|
| capitalize(self, /)
| Return a capitalized version of the string.
|
| More specifically, make the first character have upper case and the rest lower
| case.
|
| casefold(self, /)
| Return a version of the string suitable for caseless comparisons.
|
| center(self, width, fillchar=' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| count(...)
| S.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of substring sub in
| string S[start:end]. Optional arguments start and end are
| interpreted as in slice notation.
|
| encode(self, /, encoding='utf-8', errors='strict')
| Encode the string using the codec registered for encoding.
|
| encoding
| The encoding in which to encode the string.
| errors
| The error handling scheme to use for encoding errors.
| The default is 'strict' meaning that encoding errors raise a
| UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
| 'xmlcharrefreplace' as well as any other name registered with
| codecs.register_error that can handle UnicodeEncodeErrors.
|
| endswith(...)
| S.endswith(suffix[, start[, end]]) -> bool
|
| Return True if S ends with the specified suffix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| suffix can also be a tuple of strings to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| S.find(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| format(...)
| S.format(*args, **kwargs) -> str
|
| Return a formatted version of S, using substitutions from args and kwargs.
| The substitutions are identified by braces ('{' and '}').
|
| format_map(...)
| S.format_map(mapping) -> str
|
| Return a formatted version of S, using substitutions from mapping.
| The substitutions are identified by braces ('{' and '}').
|
| index(...)
| S.index(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| isalnum(self, /)
| Return True if the string is an alpha-numeric string, False otherwise.
|
| A string is alpha-numeric if all characters in the string are alpha-numeric and
| there is at least one character in the string.
|
| isalpha(self, /)
| Return True if the string is an alphabetic string, False otherwise.
|
| A string is alphabetic if all characters in the string are alphabetic and there
| is at least one character in the string.
|
| isascii(self, /)
| Return True if all characters in the string are ASCII, False otherwise.
|
| ASCII characters have code points in the range U+0000-U+007F.
| Empty string is ASCII too.
|
| isdecimal(self, /)
| Return True if the string is a decimal string, False otherwise.
|
| A string is a decimal string if all characters in the string are decimal and
| there is at least one character in the string.
|
| isdigit(self, /)
| Return True if the string is a digit string, False otherwise.
|
| A string is a digit string if all characters in the string are digits and there
| is at least one character in the string.
|
| isidentifier(self, /)
| Return True if the string is a valid Python identifier, False otherwise.
|
| Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
| such as "def" or "class".
|
| islower(self, /)
| Return True if the string is a lowercase string, False otherwise.
|
| A string is lowercase if all cased characters in the string are lowercase and
| there is at least one cased character in the string.
|
| isnumeric(self, /)
| Return True if the string is a numeric string, False otherwise.
|
| A string is numeric if all characters in the string are numeric and there is at
| least one character in the string.
|
| isprintable(self, /)
| Return True if the string is printable, False otherwise.
|
| A string is printable if all of its characters are considered printable in
| repr() or if it is empty.
|
| isspace(self, /)
| Return True if the string is a whitespace string, False otherwise.
|
| A string is whitespace if all characters in the string are whitespace and there
| is at least one character in the string.
|
| istitle(self, /)
| Return True if the string is a title-cased string, False otherwise.
|
| In a title-cased string, upper- and title-case characters may only
| follow uncased characters and lowercase characters only cased ones.
|
| isupper(self, /)
| Return True if the string is an uppercase string, False otherwise.
|
| A string is uppercase if all cased characters in the string are uppercase and
| there is at least one cased character in the string.
|
| join(self, iterable, /)
| Concatenate any number of strings.
|
| The string whose method is called is inserted in between each given string.
| The result is returned as a new string.
|
| Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
|
| ljust(self, width, fillchar=' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| lower(self, /)
| Return a copy of the string converted to lowercase.
|
| lstrip(self, chars=None, /)
| Return a copy of the string with leading whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| partition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original string
| and two empty strings.
|
| removeprefix(self, prefix, /)
| Return a str with the given prefix string removed if present.
|
| If the string starts with the prefix string, return string[len(prefix):].
| Otherwise, return a copy of the original string.
|
| removesuffix(self, suffix, /)
| Return a str with the given suffix string removed if present.
|
| If the string ends with the suffix string and that suffix is not empty,
| return string[:-len(suffix)]. Otherwise, return a copy of the original
| string.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| S.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| S.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| rjust(self, width, fillchar=' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| rpartition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty strings
| and the original string.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the end of the string and works to the front.
|
| rstrip(self, chars=None, /)
| Return a copy of the string with trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the front of the string and works to the end.
|
| Note, str.split() is mainly useful for data that has been intentionally
| delimited. With natural text that includes punctuation, consider using
| the regular expression module.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the string, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| S.startswith(prefix[, start[, end]]) -> bool
|
| Return True if S starts with the specified prefix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| prefix can also be a tuple of strings to try.
|
| strip(self, chars=None, /)
| Return a copy of the string with leading and trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| swapcase(self, /)
| Convert uppercase characters to lowercase and lowercase characters to uppercase.
|
| title(self, /)
| Return a version of the string where each word is titlecased.
|
| More specifically, words start with uppercased characters and all remaining
| cased characters have lower case.
|
| translate(self, table, /)
| Replace each character in the string using the given translation table.
|
| table
| Translation table, which must be a mapping of Unicode ordinals to
| Unicode ordinals, strings, or None.
|
| The table must implement lookup/indexing via __getitem__, for instance a
| dictionary or list. If this operation raises LookupError, the character is
| left untouched. Characters mapped to None are deleted.
|
| upper(self, /)
| Return a copy of the string converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The string is never truncated.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.str:
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
|
| ----------------------------------------------------------------------
| Methods inherited from Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class auto(builtins.object)
| auto(value=_auto_null)
|
| Instances are replaced with an appropriate value in Enum class suites.
|
| Methods defined here:
|
| __init__(self, value=_auto_null)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class member(builtins.object)
| member(value)
|
| Forces item to become an Enum member during class creation.
|
| Methods defined here:
|
| __init__(self, value)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class nonmember(builtins.object)
| nonmember(value)
|
| Protects item from becoming an Enum member during class creation.
|
| Methods defined here:
|
| __init__(self, value)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class property(types.DynamicClassAttribute)
| property(fget=None, fset=None, fdel=None, doc=None)
|
| This is a descriptor, used to define attributes that act differently
| when accessed through an enum member and through an enum class.
| Instance access is the same as property(), but access to an attribute
| through the enum class will instead look in the class' _member_map_ for
| a corresponding enum member.
|
| Method resolution order:
| property
| types.DynamicClassAttribute
| builtins.object
|
| Methods defined here:
|
| __delete__(self, instance)
|
| __get__(self, instance, ownerclass=None)
|
| __set__(self, instance, value)
|
| __set_name__(self, ownerclass, name)
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| member = None
|
| ----------------------------------------------------------------------
| Methods inherited from types.DynamicClassAttribute:
|
| __init__(self, fget=None, fset=None, fdel=None, doc=None)
| Initialize self. See help(type(self)) for accurate signature.
|
| deleter(self, fdel)
|
| getter(self, fget)
|
| setter(self, fset)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from types.DynamicClassAttribute:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class verify(builtins.object)
| verify(*checks)
|
| Check an enumeration for various constraints. (see EnumCheck)
|
| Methods defined here:
|
| __call__(self, enumeration)
| Call self as a function.
|
| __init__(self, *checks)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FUNCTIONS
global_enum(cls, update_str=False)
decorator that makes the repr() of an enum member reference its module
instead of its class; also exports all members to the enum's module's
global namespace
global_enum_repr(self)
use module.enum_name instead of class.enum_name
the module is the last module in case of a multi-module name
global_flag_repr(self)
use module.flag_name instead of class.flag_name
the module is the last module in case of a multi-module name
global_str(self)
use enum_name instead of class.enum_name
pickle_by_enum_name(self, proto)
pickle_by_global_name(self, proto)
unique(enumeration)
Class decorator for enumerations ensuring unique member values.
DATA
CONFORM = <FlagBoundary.CONFORM: 'conform'>
CONTINUOUS = <EnumCheck.CONTINUOUS: 'no skipped integer values'>
EJECT = <FlagBoundary.EJECT: 'eject'>
KEEP = <FlagBoundary.KEEP: 'keep'>
NAMED_FLAGS = <EnumCheck.NAMED_FLAGS: 'multi-flag aliases may not cont...
STRICT = <FlagBoundary.STRICT: 'strict'>
UNIQUE = <EnumCheck.UNIQUE: 'one name per value'>
__all__ = ['EnumType', 'EnumMeta', 'Enum', 'IntEnum', 'StrEnum', 'Flag...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\enum.py
tkinter.getboolean
Python Library Documentation: function getboolean in module tkinter
getboolean(s)
Convert Tcl object to True or False.
tkinter.getdouble
Python Library Documentation: class float in module builtins
class float(object)
| float(x=0, /)
|
| Convert a string or number to a floating-point number, if possible.
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(self, /)
| Return the ceiling as an Integral.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(self, /)
| Return the floor as an Integral.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Formats the float according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(self, ndigits=None, /)
| Return the Integral closest to x, rounding half toward even.
|
| When an argument is passed, work like built-in round(x, ndigits).
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(self, /)
| Return the Integral closest to x between 0 and x.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is exactly equal to the original float.
|
| The ratio is in lowest terms and has a positive denominator. Raise
| OverflowError on infinities and a ValueError on NaNs.
|
| >>> (10.0).as_integer_ratio()
| (10, 1)
| >>> (0.0).as_integer_ratio()
| (0, 1)
| >>> (-.25).as_integer_ratio()
| (-1, 4)
|
| conjugate(self, /)
| Return self, the complex conjugate of any float.
|
| hex(self, /)
| Return a hexadecimal representation of a floating-point number.
|
| >>> (-0.1).hex()
| '-0x1.999999999999ap-4'
| >>> 3.14159.hex()
| '0x1.921f9f01b866ep+1'
|
| is_integer(self, /)
| Return True if the float is an integer.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __getformat__(typestr, /)
| You probably don't want to use this function.
|
| typestr
| Must be 'double' or 'float'.
|
| It exists mainly to be used in Python's test suite.
|
| This function returns whichever of 'unknown', 'IEEE, big-endian' or 'IEEE,
| little-endian' best describes the format of floating-point numbers used by the
| C type named by typestr.
|
| fromhex(string, /)
| Create a floating-point number from a hexadecimal string.
|
| >>> float.fromhex('0x1.ffffp10')
| 2047.984375
| >>> float.fromhex('-0x1p-1074')
| -5e-324
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| imag
| the imaginary part of a complex number
|
| real
| the real part of a complex number
tkinter.getint
Python Library Documentation: class int in module builtins
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
tkinter.image_names
Python Library Documentation: function image_names in module tkinter image_names()
tkinter.image_types
Python Library Documentation: function image_types in module tkinter image_types()
tkinter.mainloop
Python Library Documentation: function mainloop in module tkinter
mainloop(n=0)
Run the main loop of Tcl.
tkinter.re
Python Library Documentation: package re
NAME
re - Support for regular expressions (RE).
MODULE REFERENCE
https://docs.python.org/3.12/library/re.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
DESCRIPTION
This module provides regular expression matching operations similar to
those found in Perl. It supports both 8-bit and Unicode strings; both
the pattern and the strings being processed can contain null bytes and
characters outside the US ASCII range.
Regular expressions can contain both special and ordinary characters.
Most ordinary characters, like "A", "a", or "0", are the simplest
regular expressions; they simply match themselves. You can
concatenate ordinary characters, so last matches the string 'last'.
The special characters are:
"." Matches any character except a newline.
"^" Matches the start of the string.
"$" Matches the end of the string or just before the newline at
the end of the string.
"*" Matches 0 or more (greedy) repetitions of the preceding RE.
Greedy means that it will match as many repetitions as possible.
"+" Matches 1 or more (greedy) repetitions of the preceding RE.
"?" Matches 0 or 1 (greedy) of the preceding RE.
*?,+?,?? Non-greedy versions of the previous three special characters.
{m,n} Matches from m to n repetitions of the preceding RE.
{m,n}? Non-greedy version of the above.
"\\" Either escapes special characters or signals a special sequence.
[] Indicates a set of characters.
A "^" as the first character indicates a complementing set.
"|" A|B, creates an RE that will match either A or B.
(...) Matches the RE inside the parentheses.
The contents can be retrieved or matched later in the string.
(?aiLmsux) The letters set the corresponding flags defined below.
(?:...) Non-grouping version of regular parentheses.
(?P<name>...) The substring matched by the group is accessible by name.
(?P=name) Matches the text matched earlier by the group named name.
(?#...) A comment; ignored.
(?=...) Matches if ... matches next, but doesn't consume the string.
(?!...) Matches if ... doesn't match next.
(?<=...) Matches if preceded by ... (must be fixed length).
(?<!...) Matches if not preceded by ... (must be fixed length).
(?(id/name)yes|no) Matches yes pattern if the group with id/name matched,
the (optional) no pattern otherwise.
The special sequences consist of "\\" and a character from the list
below. If the ordinary character is not on the list, then the
resulting RE will match the second character.
\number Matches the contents of the group of the same number.
\A Matches only at the start of the string.
\Z Matches only at the end of the string.
\b Matches the empty string, but only at the start or end of a word.
\B Matches the empty string, but not at the start or end of a word.
\d Matches any decimal digit; equivalent to the set [0-9] in
bytes patterns or string patterns with the ASCII flag.
In string patterns without the ASCII flag, it will match the whole
range of Unicode digits.
\D Matches any non-digit character; equivalent to [^\d].
\s Matches any whitespace character; equivalent to [ \t\n\r\f\v] in
bytes patterns or string patterns with the ASCII flag.
In string patterns without the ASCII flag, it will match the whole
range of Unicode whitespace characters.
\S Matches any non-whitespace character; equivalent to [^\s].
\w Matches any alphanumeric character; equivalent to [a-zA-Z0-9_]
in bytes patterns or string patterns with the ASCII flag.
In string patterns without the ASCII flag, it will match the
range of Unicode alphanumeric characters (letters plus digits
plus underscore).
With LOCALE, it will match the set [0-9_] plus characters defined
as letters for the current locale.
\W Matches the complement of \w.
\\ Matches a literal backslash.
This module exports the following functions:
match Match a regular expression pattern to the beginning of a string.
fullmatch Match a regular expression pattern to all of a string.
search Search a string for the presence of a pattern.
sub Substitute occurrences of a pattern found in a string.
subn Same as sub, but also return the number of substitutions made.
split Split a string by the occurrences of a pattern.
findall Find all occurrences of a pattern in a string.
finditer Return an iterator yielding a Match object for each match.
compile Compile a pattern into a Pattern object.
purge Clear the regular expression cache.
escape Backslash all non-alphanumerics in a string.
Each function other than purge and escape can take an optional 'flags' argument
consisting of one or more of the following module constants, joined by "|".
A, L, and U are mutually exclusive.
A ASCII For string patterns, make \w, \W, \b, \B, \d, \D
match the corresponding ASCII character categories
(rather than the whole Unicode categories, which is the
default).
For bytes patterns, this flag is the only available
behaviour and needn't be specified.
I IGNORECASE Perform case-insensitive matching.
L LOCALE Make \w, \W, \b, \B, dependent on the current locale.
M MULTILINE "^" matches the beginning of lines (after a newline)
as well as the string.
"$" matches the end of lines (before a newline) as well
as the end of the string.
S DOTALL "." matches any character at all, including the newline.
X VERBOSE Ignore whitespace and comments for nicer looking RE's.
U UNICODE For compatibility only. Ignored for string patterns (it
is the default), and forbidden for bytes patterns.
This module also defines an exception 'error'.
PACKAGE CONTENTS
_casefix
_compiler
_constants
_parser
CLASSES
builtins.Exception(builtins.BaseException)
error
builtins.object
Match
Pattern
enum.IntFlag(builtins.int, enum.ReprEnum, enum.Flag)
RegexFlag
class Match(builtins.object)
| The result of re.match() and re.search().
| Match objects always have a boolean value of True.
|
| Methods defined here:
|
| __copy__(self, /)
|
| __deepcopy__(self, memo, /)
|
| __getitem__(self, key, /)
| Return self[key].
|
| __repr__(self, /)
| Return repr(self).
|
| end(self, group=0, /)
| Return index of the end of the substring matched by group.
|
| expand(self, /, template)
| Return the string obtained by doing backslash substitution on the string template, as done by the sub() method.
|
| group(...)
| group([group1, ...]) -> str or tuple.
| Return subgroup(s) of the match by indices or names.
| For 0 returns the entire match.
|
| groupdict(self, /, default=None)
| Return a dictionary containing all the named subgroups of the match, keyed by the subgroup name.
|
| default
| Is used for groups that did not participate in the match.
|
| groups(self, /, default=None)
| Return a tuple containing all the subgroups of the match, from 1.
|
| default
| Is used for groups that did not participate in the match.
|
| span(self, group=0, /)
| For match object m, return the 2-tuple (m.start(group), m.end(group)).
|
| start(self, group=0, /)
| Return index of the start of the substring matched by group.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| endpos
| The index into the string beyond which the RE engine will not go.
|
| lastgroup
| The name of the last matched capturing group.
|
| lastindex
| The integer index of the last matched capturing group.
|
| pos
| The index into the string at which the RE engine started looking for a match.
|
| re
| The regular expression object.
|
| regs
|
| string
| The string passed to match() or search().
class Pattern(builtins.object)
| Compiled regular expression object.
|
| Methods defined here:
|
| __copy__(self, /)
|
| __deepcopy__(self, memo, /)
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| findall(self, /, string, pos=0, endpos=9223372036854775807)
| Return a list of all non-overlapping matches of pattern in string.
|
| finditer(self, /, string, pos=0, endpos=9223372036854775807)
| Return an iterator over all non-overlapping matches for the RE pattern in string.
|
| For each match, the iterator returns a match object.
|
| fullmatch(self, /, string, pos=0, endpos=9223372036854775807)
| Matches against all of the string.
|
| match(self, /, string, pos=0, endpos=9223372036854775807)
| Matches zero or more characters at the beginning of the string.
|
| scanner(self, /, string, pos=0, endpos=9223372036854775807)
|
| search(self, /, string, pos=0, endpos=9223372036854775807)
| Scan through string looking for a match, and return a corresponding match object instance.
|
| Return None if no position in the string matches.
|
| split(self, /, string, maxsplit=0)
| Split string by the occurrences of pattern.
|
| sub(self, /, repl, string, count=0)
| Return the string obtained by replacing the leftmost non-overlapping occurrences of pattern in string by the replacement repl.
|
| subn(self, /, repl, string, count=0)
| Return the tuple (new_string, number_of_subs_made) found by replacing the leftmost non-overlapping occurrences of pattern with the replacement repl.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| flags
| The regex matching flags.
|
| groupindex
| A dictionary mapping group names to group numbers.
|
| groups
| The number of capturing groups in the pattern.
|
| pattern
| The pattern string from which the RE object was compiled.
class RegexFlag(enum.IntFlag)
| RegexFlag(*values)
|
| An enumeration.
|
| Method resolution order:
| RegexFlag
| enum.IntFlag
| builtins.int
| enum.ReprEnum
| enum.Flag
| enum.Enum
| builtins.object
|
| Methods defined here:
|
| __and__(self, other) from enum.Flag
|
| __format__(self, format_spec, /) from builtins.int
| Convert to a string according to format_spec.
|
| __invert__(self) from enum.Flag
|
| __new__(cls, value) from enum.Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __or__(self, other) from enum.Flag
| Return self|value.
|
| __rand__ = __and__(self, other)
|
| __repr__ = global_flag_repr(self) from enum
| use module.flag_name instead of class.flag_name
|
| the module is the last module in case of a multi-module name
|
| __ror__ = __or__(self, other)
|
| __rxor__ = __xor__(self, other)
|
| __str__(self, /) from builtins.object
| Return str(self).
|
| __xor__(self, other) from enum.Flag
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| ASCII = re.ASCII
|
| DEBUG = re.DEBUG
|
| DOTALL = re.DOTALL
|
| IGNORECASE = re.IGNORECASE
|
| LOCALE = re.LOCALE
|
| MULTILINE = re.MULTILINE
|
| TEMPLATE = re.TEMPLATE
|
| UNICODE = re.UNICODE
|
| VERBOSE = re.VERBOSE
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.int:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.int:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.int:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
|
| ----------------------------------------------------------------------
| Methods inherited from enum.Flag:
|
| __contains__(self, other)
| Returns True if self has at least the same flags set as other.
|
| __iter__(self)
| Returns flags in definition order.
|
| __len__(self)
| Return the number of members (no aliases)
|
| ----------------------------------------------------------------------
| Methods inherited from enum.Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from enum.Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Static methods inherited from enum.EnumType:
|
| __getitem__(name)
| Return the member matching `name`.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from enum.EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
class error(builtins.Exception)
| error(msg, pattern=None, pos=None)
|
| Exception raised for invalid regular expressions.
|
| Attributes:
|
| msg: The unformatted error message
| pattern: The regular expression pattern
| pos: The index in the pattern where compilation failed (may be None)
| lineno: The line corresponding to pos (may be None)
| colno: The column corresponding to pos (may be None)
|
| Method resolution order:
| error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, msg, pattern=None, pos=None) from re._constants.error
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
FUNCTIONS
compile(pattern, flags=0)
Compile a regular expression pattern, returning a Pattern object.
escape(pattern)
Escape special characters in a string.
findall(pattern, string, flags=0)
Return a list of all non-overlapping matches in the string.
If one or more capturing groups are present in the pattern, return
a list of groups; this will be a list of tuples if the pattern
has more than one group.
Empty matches are included in the result.
finditer(pattern, string, flags=0)
Return an iterator over all non-overlapping matches in the
string. For each match, the iterator returns a Match object.
Empty matches are included in the result.
fullmatch(pattern, string, flags=0)
Try to apply the pattern to all of the string, returning
a Match object, or None if no match was found.
match(pattern, string, flags=0)
Try to apply the pattern at the start of the string, returning
a Match object, or None if no match was found.
purge()
Clear the regular expression caches
search(pattern, string, flags=0)
Scan through string looking for a match to the pattern, returning
a Match object, or None if no match was found.
split(pattern, string, maxsplit=0, flags=0)
Split the source string by the occurrences of the pattern,
returning a list containing the resulting substrings. If
capturing parentheses are used in pattern, then the text of all
groups in the pattern are also returned as part of the resulting
list. If maxsplit is nonzero, at most maxsplit splits occur,
and the remainder of the string is returned as the final element
of the list.
sub(pattern, repl, string, count=0, flags=0)
Return the string obtained by replacing the leftmost
non-overlapping occurrences of the pattern in string by the
replacement repl. repl can be either a string or a callable;
if a string, backslash escapes in it are processed. If it is
a callable, it's passed the Match object and must return
a replacement string to be used.
subn(pattern, repl, string, count=0, flags=0)
Return a 2-tuple containing (new_string, number).
new_string is the string obtained by replacing the leftmost
non-overlapping occurrences of the pattern in the source
string by the replacement repl. number is the number of
substitutions that were made. repl can be either a string or a
callable; if a string, backslash escapes in it are processed.
If it is a callable, it's passed the Match object and must
return a replacement string to be used.
template(pattern, flags=0)
Compile a template pattern, returning a Pattern object, deprecated
DATA
A = re.ASCII
ASCII = re.ASCII
DOTALL = re.DOTALL
I = re.IGNORECASE
IGNORECASE = re.IGNORECASE
L = re.LOCALE
LOCALE = re.LOCALE
M = re.MULTILINE
MULTILINE = re.MULTILINE
NOFLAG = re.NOFLAG
S = re.DOTALL
U = re.UNICODE
UNICODE = re.UNICODE
VERBOSE = re.VERBOSE
X = re.VERBOSE
__all__ = ['match', 'fullmatch', 'search', 'sub', 'subn', 'split', 'fi...
VERSION
2.2.1
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\re\__init__.py
tkinter.sys
Python Library Documentation: built-in module sys
NAME
sys
MODULE REFERENCE
https://docs.python.org/3.12/library/sys.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
DESCRIPTION
This module provides access to some objects used or maintained by the
interpreter and to functions that interact strongly with the interpreter.
Dynamic objects:
argv -- command line arguments; argv[0] is the script pathname if known
path -- module search path; path[0] is the script directory, else ''
modules -- dictionary of loaded modules
displayhook -- called to show results in an interactive session
excepthook -- called to handle any uncaught exception other than SystemExit
To customize printing in an interactive session or to install a custom
top-level exception handler, assign other functions to replace these.
stdin -- standard input file object; used by input()
stdout -- standard output file object; used by print()
stderr -- standard error object; used for error messages
By assigning other file objects (or objects that behave like files)
to these, it is possible to redirect all of the interpreter's I/O.
last_exc - the last uncaught exception
Only available in an interactive session after a
traceback has been printed.
last_type -- type of last uncaught exception
last_value -- value of last uncaught exception
last_traceback -- traceback of last uncaught exception
These three are the (deprecated) legacy representation of last_exc.
Static objects:
builtin_module_names -- tuple of module names built into this interpreter
copyright -- copyright notice pertaining to this interpreter
exec_prefix -- prefix used to find the machine-specific Python library
executable -- absolute path of the executable binary of the Python interpreter
float_info -- a named tuple with information about the float implementation.
float_repr_style -- string indicating the style of repr() output for floats
hash_info -- a named tuple with information about the hash algorithm.
hexversion -- version information encoded as a single integer
implementation -- Python implementation information.
int_info -- a named tuple with information about the int implementation.
maxsize -- the largest supported length of containers.
maxunicode -- the value of the largest Unicode code point
platform -- platform identifier
prefix -- prefix used to find the Python library
thread_info -- a named tuple with information about the thread implementation.
version -- the version of this interpreter as a string
version_info -- version information as a named tuple
dllhandle -- [Windows only] integer handle of the Python DLL
winver -- [Windows only] version number of the Python DLL
_enablelegacywindowsfsencoding -- [Windows only]
__stdin__ -- the original stdin; don't touch!
__stdout__ -- the original stdout; don't touch!
__stderr__ -- the original stderr; don't touch!
__displayhook__ -- the original displayhook; don't touch!
__excepthook__ -- the original excepthook; don't touch!
Functions:
displayhook() -- print an object to the screen, and save it in builtins._
excepthook() -- print an exception and its traceback to sys.stderr
exception() -- return the current thread's active exception
exc_info() -- return information about the current thread's active exception
exit() -- exit the interpreter by raising SystemExit
getdlopenflags() -- returns flags to be used for dlopen() calls
getprofile() -- get the global profiling function
getrefcount() -- return the reference count for an object (plus one :-)
getrecursionlimit() -- return the max recursion depth for the interpreter
getsizeof() -- return the size of an object in bytes
gettrace() -- get the global debug tracing function
setdlopenflags() -- set the flags to be used for dlopen() calls
setprofile() -- set the global profiling function
setrecursionlimit() -- set the max recursion depth for the interpreter
settrace() -- set the global debug tracing function
SUBMODULES
monitoring
FUNCTIONS
__breakpointhook__ = breakpointhook(...)
breakpointhook(*args, **kws)
This hook function is called by built-in breakpoint().
__displayhook__ = displayhook(object, /)
Print an object to sys.stdout and also save it in builtins._
__excepthook__ = excepthook(exctype, value, traceback, /)
Handle an exception by displaying it with a traceback on sys.stderr.
__unraisablehook__ = unraisablehook(unraisable, /)
Handle an unraisable exception.
The unraisable argument has the following attributes:
* exc_type: Exception type.
* exc_value: Exception value, can be None.
* exc_traceback: Exception traceback, can be None.
* err_msg: Error message, can be None.
* object: Object causing the exception, can be None.
activate_stack_trampoline(backend, /)
Activate stack profiler trampoline *backend*.
addaudithook(hook)
Adds a new audit hook callback.
audit(...)
audit(event, *args)
Passes the event to any audit hooks that are attached.
breakpointhook(...)
breakpointhook(*args, **kws)
This hook function is called by built-in breakpoint().
call_tracing(func, args, /)
Call func(*args), while tracing is enabled.
The tracing state is saved, and restored afterwards. This is intended
to be called from a debugger from a checkpoint, to recursively debug
some other code.
deactivate_stack_trampoline()
Deactivate the current stack profiler trampoline backend.
If no stack profiler is activated, this function has no effect.
displayhook(object, /)
Print an object to sys.stdout and also save it in builtins._
exc_info()
Return current exception information: (type, value, traceback).
Return information about the most recent exception caught by an except
clause in the current stack frame or in an older stack frame.
excepthook(exctype, value, traceback, /)
Handle an exception by displaying it with a traceback on sys.stderr.
exception()
Return the current exception.
Return the most recent exception caught by an except clause
in the current stack frame or in an older stack frame, or None
if no such exception exists.
exit(status=None, /)
Exit the interpreter by raising SystemExit(status).
If the status is omitted or None, it defaults to zero (i.e., success).
If the status is an integer, it will be used as the system exit status.
If it is another kind of object, it will be printed and the system
exit status will be one (i.e., failure).
get_asyncgen_hooks()
Return the installed asynchronous generators hooks.
This returns a namedtuple of the form (firstiter, finalizer).
get_coroutine_origin_tracking_depth()
Check status of origin tracking for coroutine objects in this thread.
get_int_max_str_digits()
Return the maximum string digits limit for non-binary int<->str conversions.
getallocatedblocks()
Return the number of memory blocks currently allocated.
getdefaultencoding()
Return the current default encoding used by the Unicode implementation.
getfilesystemencodeerrors()
Return the error mode used Unicode to OS filename conversion.
getfilesystemencoding()
Return the encoding used to convert Unicode filenames to OS filenames.
getprofile()
Return the profiling function set with sys.setprofile.
See the profiler chapter in the library manual.
getrecursionlimit()
Return the current value of the recursion limit.
The recursion limit is the maximum depth of the Python interpreter
stack. This limit prevents infinite recursion from causing an overflow
of the C stack and crashing Python.
getrefcount(object, /)
Return the reference count of object.
The count returned is generally one higher than you might expect,
because it includes the (temporary) reference as an argument to
getrefcount().
getsizeof(...)
getsizeof(object [, default]) -> int
Return the size of object in bytes.
getswitchinterval()
Return the current thread switch interval; see sys.setswitchinterval().
gettrace()
Return the global debug tracing function set with sys.settrace.
See the debugger chapter in the library manual.
getunicodeinternedsize()
Return the number of elements of the unicode interned dictionary
getwindowsversion()
Return info about the running version of Windows as a named tuple.
The members are named: major, minor, build, platform, service_pack,
service_pack_major, service_pack_minor, suite_mask, product_type and
platform_version. For backward compatibility, only the first 5 items
are available by indexing. All elements are numbers, except
service_pack and platform_type which are strings, and platform_version
which is a 3-tuple. Platform is always 2. Product_type may be 1 for a
workstation, 2 for a domain controller, 3 for a server.
Platform_version is a 3-tuple containing a version number that is
intended for identifying the OS rather than feature detection.
intern(string, /)
``Intern'' the given string.
This enters the string in the (global) table of interned strings whose
purpose is to speed up dictionary lookups. Return the string itself or
the previously interned string object with the same value.
is_finalizing()
Return True if Python is exiting.
is_stack_trampoline_active()
Return *True* if a stack profiler trampoline is active.
set_asyncgen_hooks(...)
set_asyncgen_hooks([firstiter] [, finalizer])
Set a finalizer for async generators objects.
set_coroutine_origin_tracking_depth(depth)
Enable or disable origin tracking for coroutine objects in this thread.
Coroutine objects will track 'depth' frames of traceback information
about where they came from, available in their cr_origin attribute.
Set a depth of 0 to disable.
set_int_max_str_digits(maxdigits)
Set the maximum string digits limit for non-binary int<->str conversions.
setprofile(...)
setprofile(function)
Set the profiling function. It will be called on each function call
and return. See the profiler chapter in the library manual.
setrecursionlimit(limit, /)
Set the maximum depth of the Python interpreter stack to n.
This limit prevents infinite recursion from causing an overflow of the C
stack and crashing Python. The highest possible limit is platform-
dependent.
setswitchinterval(interval, /)
Set the ideal thread switching delay inside the Python interpreter.
The actual frequency of switching threads can be lower if the
interpreter executes long sequences of uninterruptible code
(this is implementation-specific and workload-dependent).
The parameter must represent the desired switching delay in seconds
A typical value is 0.005 (5 milliseconds).
settrace(...)
settrace(function)
Set the global debug tracing function. It will be called on each
function call. See the debugger chapter in the library manual.
unraisablehook(unraisable, /)
Handle an unraisable exception.
The unraisable argument has the following attributes:
* exc_type: Exception type.
* exc_value: Exception value, can be None.
* exc_traceback: Exception traceback, can be None.
* err_msg: Error message, can be None.
* object: Object causing the exception, can be None.
DATA
__stderr__ = <_io.TextIOWrapper name='<stderr>' mode='w' encoding='cp1...
__stdin__ = <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8...
__stdout__ = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='cp1...
api_version = 1013
argv = [r'f:\JoeyCodes\PyDocs\py_docs.py', '--worker', 'tkinter', r'F:...
base_exec_prefix = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyth...
base_prefix = r'C:\Users\Youse\AppData\Local\Programs\Python\Python312...
builtin_module_names = ('_abc', '_ast', '_bisect', '_blake2', '_codecs...
byteorder = 'little'
copyright = 'Copyright (c) 2001-2023 Python Software Foundati...ematis...
dllhandle = 140727031824384
dont_write_bytecode = False
exec_prefix = r'C:\Users\Youse\AppData\Local\Programs\Python\Python312...
executable = r'C:\Users\Youse\AppData\Local\Programs\Python\Python312\...
flags = sys.flags(debug=0, inspect=0, interactive=0, opt...ding=0, saf...
float_info = sys.float_info(max=1.7976931348623157e+308, max_...epsilo...
float_repr_style = 'short'
hash_info = sys.hash_info(width=64, modulus=2305843009213693...iphash1...
hexversion = 51119856
implementation = namespace(name='cpython', cache_tag='cpython-312...as...
int_info = sys.int_info(bits_per_digit=30, sizeof_digit=4, ..._str_dig...
maxsize = 9223372036854775807
maxunicode = 1114111
meta_path = [<_distutils_hack.DistutilsMetaFinder object>, <class '_fr...
modules = {'__future__': <module '__future__' from 'C:\\Users\\Youse\\...
orig_argv = [r'C:\Users\Youse\AppData\Local\Programs\Python\Python312\...
path = [r'f:\JoeyCodes\PyDocs', r'C:\Users\Youse\AppData\Local\Program...
path_hooks = [<class 'zipimport.zipimporter'>, <function FileFinder.pa...
path_importer_cache = {r'C:\Users\Youse\AppData\Local\Programs\Python\...
platform = 'win32'
platlibdir = 'DLLs'
prefix = r'C:\Users\Youse\AppData\Local\Programs\Python\Python312'
pycache_prefix = None
stderr = <_io.TextIOWrapper name='<stderr>' mode='w' encoding='cp1252'...
stdin = <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>
stdlib_module_names = frozenset({'__future__', '_abc', '_aix_support',...
stdout = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='cp1252'...
thread_info = sys.thread_info(name='nt', lock=None, version=None)
version = '3.12.6 (tags/v3.12.6:a4a2d2b, Sep 6 2024, 20:11:23) [MSC v...
version_info = sys.version_info(major=3, minor=12, micro=6, releaselev...
warnoptions = []
winver = '3.12'
FILE
(built-in)
tkinter.types
Python Library Documentation: module types
NAME
types - Define names for built-in types that aren't directly accessible as a builtin.
MODULE REFERENCE
https://docs.python.org/3.12/library/types.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
CLASSES
builtins.object
builtins.NoneType
builtins.NotImplementedType
builtins.async_generator
builtins.builtin_function_or_method
builtins.cell
builtins.classmethod_descriptor
builtins.code
builtins.coroutine
builtins.ellipsis
builtins.frame
builtins.function
builtins.generator
builtins.getset_descriptor
builtins.mappingproxy
builtins.member_descriptor
builtins.method
builtins.method-wrapper
builtins.method_descriptor
builtins.module
builtins.traceback
builtins.wrapper_descriptor
DynamicClassAttribute
GenericAlias
SimpleNamespace
UnionType
AsyncGeneratorType = class async_generator(object)
| Methods defined here:
|
| __aiter__(self, /)
| Return an awaitable, that resolves in asynchronous iterator.
|
| __anext__(self, /)
| Return a value or raise StopAsyncIteration.
|
| __del__(...)
|
| __repr__(self, /)
| Return repr(self).
|
| __sizeof__(...)
| gen.__sizeof__() -> size of gen in memory, in bytes
|
| aclose(...)
| aclose() -> raise GeneratorExit inside generator.
|
| asend(...)
| asend(v) -> send 'v' in generator.
|
| athrow(...)
| athrow(value)
| athrow(type[,value[,tb]])
|
| raise exception in generator.
| the (type, val, tb) signature is deprecated,
| and may be removed in a future version of Python.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| ag_await
| object being awaited on, or None
|
| ag_code
|
| ag_frame
|
| ag_running
|
| ag_suspended
BuiltinFunctionType = class builtin_function_or_method(object)
| Built-in subclasses:
| builtin_method
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __self__
|
| __text_signature__
BuiltinMethodType = class builtin_function_or_method(object)
| Built-in subclasses:
| builtin_method
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __self__
|
| __text_signature__
CellType = class cell(object)
| Create a new cell object.
|
| contents
| the contents of the cell. If not specified, the cell will be empty,
| and
| further attempts to access its cell_contents attribute will
| raise a ValueError.
|
| Methods defined here:
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cell_contents
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
ClassMethodDescriptorType = class classmethod_descriptor(object)
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __objclass__
|
| __text_signature__
CodeType = class code(object)
| CodeType(argcount, posonlyargcount, kwonlyargcount, nlocals, stacksize, flags, codestring, constants, names, varnames, filename, name, qualname, firstlineno, linetable, exceptiontable, freevars=(), cellvars=(), /)
|
| Create a code object. Not for the faint of heart.
|
| Methods defined here:
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __sizeof__(...)
| Size of object in memory, in bytes.
|
| co_lines(...)
|
| co_positions(...)
|
| replace(self, /, **changes)
| Return a copy of the code object with new values for the specified fields.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| co_argcount
|
| co_cellvars
|
| co_code
|
| co_consts
|
| co_exceptiontable
|
| co_filename
|
| co_firstlineno
|
| co_flags
|
| co_freevars
|
| co_kwonlyargcount
|
| co_linetable
|
| co_lnotab
|
| co_name
|
| co_names
|
| co_nlocals
|
| co_posonlyargcount
|
| co_qualname
|
| co_stacksize
|
| co_varnames
CoroutineType = class coroutine(object)
| Methods defined here:
|
| __await__(self, /)
| Return an iterator to be used in await expression.
|
| __del__(...)
|
| __repr__(self, /)
| Return repr(self).
|
| __sizeof__(...)
| gen.__sizeof__() -> size of gen in memory, in bytes
|
| close(...)
| close() -> raise GeneratorExit inside coroutine.
|
| send(...)
| send(arg) -> send 'arg' into coroutine,
| return next iterated value or raise StopIteration.
|
| throw(...)
| throw(value)
| throw(type[,value[,traceback]])
|
| Raise exception in coroutine, return next iterated value or raise
| StopIteration.
| the (type, val, tb) signature is deprecated,
| and may be removed in a future version of Python.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cr_await
| object being awaited on, or None
|
| cr_code
|
| cr_frame
|
| cr_origin
|
| cr_running
|
| cr_suspended
class DynamicClassAttribute(builtins.object)
| DynamicClassAttribute(fget=None, fset=None, fdel=None, doc=None)
|
| Route attribute access on a class to __getattr__.
|
| This is a descriptor, used to define attributes that act differently when
| accessed through an instance and through a class. Instance access remains
| normal, but access to an attribute through a class will be routed to the
| class's __getattr__ method; this is done by raising AttributeError.
|
| This allows one to have properties active on an instance, and have virtual
| attributes on the class with the same name. (Enum used this between Python
| versions 3.4 - 3.9 .)
|
| Subclass from this to use a different method of accessing virtual attributes
| and still be treated properly by the inspect module. (Enum uses this since
| Python 3.10 .)
|
| Methods defined here:
|
| __delete__(self, instance)
|
| __get__(self, instance, ownerclass=None)
|
| __init__(self, fget=None, fset=None, fdel=None, doc=None)
| Initialize self. See help(type(self)) for accurate signature.
|
| __set__(self, instance, value)
|
| deleter(self, fdel)
|
| getter(self, fget)
|
| setter(self, fset)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
EllipsisType = class ellipsis(object)
| Methods defined here:
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
FrameType = class frame(object)
| Methods defined here:
|
| __repr__(self, /)
| Return repr(self).
|
| __sizeof__(...)
| F.__sizeof__() -> size of F in memory, in bytes
|
| clear(...)
| F.clear(): clear most references held by the frame
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| f_back
|
| f_builtins
|
| f_code
|
| f_globals
|
| f_lasti
|
| f_lineno
|
| f_locals
|
| f_trace
|
| f_trace_lines
|
| f_trace_opcodes
FunctionType = class function(object)
| FunctionType(code, globals, name=None, argdefs=None, closure=None)
|
| Create a function object.
|
| code
| a code object
| globals
| the globals dictionary
| name
| a string that overrides the name from the code object
| argdefs
| a tuple that specifies the default argument values
| closure
| a tuple that supplies the bindings for free variables
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __annotations__
|
| __closure__
|
| __code__
|
| __defaults__
|
| __dict__
|
| __globals__
|
| __kwdefaults__
|
| __type_params__
GeneratorType = class generator(object)
| Methods defined here:
|
| __del__(...)
|
| __iter__(self, /)
| Implement iter(self).
|
| __next__(self, /)
| Implement next(self).
|
| __repr__(self, /)
| Return repr(self).
|
| __sizeof__(...)
| gen.__sizeof__() -> size of gen in memory, in bytes
|
| close(...)
| close() -> raise GeneratorExit inside generator.
|
| send(...)
| send(arg) -> send 'arg' into generator,
| return next yielded value or raise StopIteration.
|
| throw(...)
| throw(value)
| throw(type[,value[,tb]])
|
| Raise exception in generator, return next yielded value or raise
| StopIteration.
| the (type, val, tb) signature is deprecated,
| and may be removed in a future version of Python.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| gi_code
|
| gi_frame
|
| gi_running
|
| gi_suspended
|
| gi_yieldfrom
| object being iterated by yield from, or None
class GenericAlias(builtins.object)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __dir__(...)
| Default dir() implementation.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __instancecheck__(...)
| Check if an object is an instance.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mro_entries__(...)
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __subclasscheck__(...)
| Check if a class is a subclass.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __args__
|
| __origin__
|
| __parameters__
| Type variables in the GenericAlias.
|
| __typing_unpacked_tuple_args__
|
| __unpacked__
GetSetDescriptorType = class getset_descriptor(object)
| Methods defined here:
|
| __delete__(self, instance, /)
| Delete an attribute of instance.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __repr__(self, /)
| Return repr(self).
|
| __set__(self, instance, value, /)
| Set an attribute of instance to value.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __objclass__
LambdaType = class function(object)
| LambdaType(code, globals, name=None, argdefs=None, closure=None)
|
| Create a function object.
|
| code
| a code object
| globals
| the globals dictionary
| name
| a string that overrides the name from the code object
| argdefs
| a tuple that specifies the default argument values
| closure
| a tuple that supplies the bindings for free variables
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __annotations__
|
| __closure__
|
| __code__
|
| __defaults__
|
| __dict__
|
| __globals__
|
| __kwdefaults__
|
| __type_params__
MappingProxyType = class mappingproxy(object)
| Methods defined here:
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(...)
| D.__reversed__() -> reverse iterator
|
| __ror__(self, value, /)
| Return value|self.
|
| __str__(self, /)
| Return str(self).
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(...)
| D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
MemberDescriptorType = class member_descriptor(object)
| Methods defined here:
|
| __delete__(self, instance, /)
| Delete an attribute of instance.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __set__(self, instance, value, /)
| Set an attribute of instance to value.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __objclass__
MethodDescriptorType = class method_descriptor(object)
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __objclass__
|
| __text_signature__
MethodType = class method(object)
| MethodType(function, instance, /)
|
| Create a bound instance method object.
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(self, /)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __func__
| the function (or other callable) implementing a method
|
| __self__
| the instance to which a method is bound
MethodWrapperType = class method-wrapper(object)
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __objclass__
|
| __self__
|
| __text_signature__
ModuleType = class module(object)
| ModuleType(name, doc=None)
|
| Create a module object.
|
| The name must be a string; the optional doc argument can have any type.
|
| Methods defined here:
|
| __dir__(...)
| __dir__() -> list
| specialized dir() implementation
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __annotations__
|
| __dict__
class NoneType(object)
| Methods defined here:
|
| __bool__(self, /)
| True if self else False
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class NotImplementedType(object)
| Methods defined here:
|
| __bool__(self, /)
| True if self else False
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class SimpleNamespace(builtins.object)
| A simple attribute-based namespace.
|
| SimpleNamespace(**kwargs)
|
| Methods defined here:
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(...)
| Return state information for pickling
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
TracebackType = class traceback(object)
| TracebackType(tb_next, tb_frame, tb_lasti, tb_lineno)
| --
|
| Create a new traceback object.
|
| Methods defined here:
|
| __dir__(...)
| Default dir() implementation.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| tb_frame
|
| tb_lasti
|
| tb_lineno
|
| tb_next
class UnionType(builtins.object)
| Represent a PEP 604 union type
|
| E.g. for int | str
|
| Methods defined here:
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __args__
|
| __parameters__
| Type variables in the types.UnionType.
WrapperDescriptorType = class wrapper_descriptor(object)
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __objclass__
|
| __text_signature__
FUNCTIONS
coroutine(func)
Convert regular generator function to a coroutine.
get_original_bases(cls, /)
Return the class's "original" bases prior to modification by `__mro_entries__`.
Examples::
from typing import TypeVar, Generic, NamedTuple, TypedDict
T = TypeVar("T")
class Foo(Generic[T]): ...
class Bar(Foo[int], float): ...
class Baz(list[str]): ...
Eggs = NamedTuple("Eggs", [("a", int), ("b", str)])
Spam = TypedDict("Spam", {"a": int, "b": str})
assert get_original_bases(Bar) == (Foo[int], float)
assert get_original_bases(Baz) == (list[str],)
assert get_original_bases(Eggs) == (NamedTuple,)
assert get_original_bases(Spam) == (TypedDict,)
assert get_original_bases(int) == (object,)
new_class(name, bases=(), kwds=None, exec_body=None)
Create a class object dynamically using the appropriate metaclass.
prepare_class(name, bases=(), kwds=None)
Call the __prepare__ method of the appropriate metaclass.
Returns (metaclass, namespace, kwds) as a 3-tuple
*metaclass* is the appropriate metaclass
*namespace* is the prepared class namespace
*kwds* is an updated copy of the passed in kwds argument with any
'metaclass' entry removed. If no kwds argument is passed in, this will
be an empty dict.
resolve_bases(bases)
Resolve MRO entries dynamically as specified by PEP 560.
DATA
__all__ = ['FunctionType', 'LambdaType', 'CodeType', 'MappingProxyType...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\types.py
tkinter.wantobjects
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number