mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-07 04:34:28 +08:00
add types for tkinter geometry manager (aka pack,grid,place) methods (#4379)
This commit is contained in:
Akuli
@@ -3,7 +3,7 @@ from enum import Enum
|
||||
from tkinter.constants import * # noqa: F403
|
||||
from types import TracebackType
|
||||
from typing import Any, Callable, Dict, Generic, List, Optional, Tuple, Type, TypeVar, Union, overload
|
||||
from typing_extensions import Literal
|
||||
from typing_extensions import Literal, TypedDict
|
||||
|
||||
TclError: Any
|
||||
wantobjects: Any
|
||||
@@ -13,6 +13,16 @@ READABLE: Any
|
||||
WRITABLE: Any
|
||||
EXCEPTION: Any
|
||||
|
||||
# If a manual page mentions Tk_GetAnchor or refers to another manual page named
|
||||
# 'options', then it means this. Note that some ttk widgets have other things
|
||||
# named 'anchor' with a different set of allowed values.
|
||||
_Anchor = Literal["nw", "n", "ne", "w", "center", "e", "sw", "s", "se"]
|
||||
|
||||
# string must be e.g. '12.34', '12.34c', '12.34i', '12.34m', '12.34p'
|
||||
# see Tk_GetPixels man page for what each suffix means
|
||||
# Some ttk widgets also use empty string.
|
||||
_ScreenUnits = Union[str, float]
|
||||
|
||||
if sys.version_info >= (3, 6):
|
||||
class EventType(str, Enum):
|
||||
Activate: str = ...
|
||||
@@ -280,31 +290,44 @@ class Misc:
|
||||
def nametowidget(self, name): ...
|
||||
register: Any
|
||||
def configure(self, cnf: Optional[Any] = ..., **kw): ...
|
||||
config: Any
|
||||
config = configure
|
||||
def cget(self, key): ...
|
||||
__getitem__: Any
|
||||
def __setitem__(self, key, value): ...
|
||||
def keys(self): ...
|
||||
def pack_propagate(self, flag=...): ...
|
||||
propagate: Any
|
||||
def pack_slaves(self): ...
|
||||
slaves: Any
|
||||
def place_slaves(self): ...
|
||||
def grid_anchor(self, anchor: Optional[Any] = ...): ...
|
||||
anchor: Any
|
||||
@overload
|
||||
def pack_propagate(self, flag: bool) -> Optional[bool]: ...
|
||||
@overload
|
||||
def pack_propagate(self) -> None: ...
|
||||
propagate = pack_propagate
|
||||
def grid_anchor(self, anchor: Optional[_Anchor] = ...) -> None: ...
|
||||
anchor = grid_anchor
|
||||
@overload
|
||||
def grid_bbox(
|
||||
self, column: Optional[Any] = ..., row: Optional[Any] = ..., col2: Optional[Any] = ..., row2: Optional[Any] = ...
|
||||
): ...
|
||||
bbox: Any
|
||||
def grid_columnconfigure(self, index, cnf=..., **kw): ...
|
||||
columnconfigure: Any
|
||||
def grid_location(self, x, y): ...
|
||||
def grid_propagate(self, flag=...): ...
|
||||
def grid_rowconfigure(self, index, cnf=..., **kw): ...
|
||||
rowconfigure: Any
|
||||
def grid_size(self): ...
|
||||
size: Any
|
||||
def grid_slaves(self, row: Optional[Any] = ..., column: Optional[Any] = ...): ...
|
||||
self, column: None = ..., row: None = ..., col2: None = ..., row2: None = ...
|
||||
) -> Optional[Tuple[int, int, int, int]]: ...
|
||||
@overload
|
||||
def grid_bbox(self, column: int, row: int, col2: None = ..., row2: None = ...) -> Optional[Tuple[int, int, int, int]]: ...
|
||||
@overload
|
||||
def grid_bbox(self, column: int, row: int, col2: int, row2: int) -> Optional[Tuple[int, int, int, int]]: ...
|
||||
# commented out to avoid conflicting with other bbox methods
|
||||
# bbox = grid_bbox
|
||||
def grid_columnconfigure(self, index, cnf=..., **kw): ... # TODO
|
||||
def grid_rowconfigure(self, index, cnf=..., **kw): ... # TODO
|
||||
columnconfigure = grid_columnconfigure
|
||||
rowconfigure = grid_rowconfigure
|
||||
def grid_location(self, x: _ScreenUnits, y: _ScreenUnits) -> Tuple[int, int]: ...
|
||||
@overload
|
||||
def grid_propagate(self, flag: bool) -> None: ...
|
||||
@overload
|
||||
def grid_propagate(self) -> bool: ...
|
||||
def grid_size(self) -> Tuple[int, int]: ...
|
||||
size = grid_size
|
||||
# Widget because Toplevel or Tk is never a slave
|
||||
def pack_slaves(self) -> List[Widget]: ...
|
||||
def grid_slaves(self, row: Optional[int] = ..., column: Optional[int] = ...) -> List[Widget]: ...
|
||||
def place_slaves(self) -> List[Widget]: ...
|
||||
slaves = pack_slaves
|
||||
def event_add(self, virtual, *sequences): ...
|
||||
def event_delete(self, virtual, *sequences): ...
|
||||
def event_generate(self, sequence, **kw): ...
|
||||
@@ -426,40 +449,149 @@ class Tk(Misc, Wm):
|
||||
|
||||
def Tcl(screenName: Optional[Any] = ..., baseName: Optional[Any] = ..., className: str = ..., useTk: bool = ...): ...
|
||||
|
||||
_InMiscTotal = TypedDict("_InMiscTotal", {"in": Misc})
|
||||
_InMiscNonTotal = TypedDict("_InMiscNonTotal", {"in": Misc}, total=False)
|
||||
|
||||
class _PackInfo(_InMiscTotal):
|
||||
# 'before' and 'after' never appear in _PackInfo
|
||||
anchor: _Anchor
|
||||
expand: Literal[0, 1]
|
||||
fill: Literal["none", "x", "y", "both"]
|
||||
side: Literal["left", "right", "top", "bottom"]
|
||||
# Paddings come out as int or tuple of int, even though any _ScreenUnits
|
||||
# can be specified in pack().
|
||||
ipadx: Union[int, Tuple[int, int]]
|
||||
ipady: Union[int, Tuple[int, int]]
|
||||
padx: Union[int, Tuple[int, int]]
|
||||
pady: Union[int, Tuple[int, int]]
|
||||
|
||||
class Pack:
|
||||
def pack_configure(self, cnf=..., **kw): ...
|
||||
pack: Any
|
||||
def pack_forget(self): ...
|
||||
forget: Any
|
||||
def pack_info(self): ...
|
||||
info: Any
|
||||
propagate: Any
|
||||
slaves: Any
|
||||
# _PackInfo is not the valid type for cnf because pad stuff accepts any
|
||||
# _ScreenUnits instead of int only. I didn't bother to create another
|
||||
# TypedDict for cnf because it appears to be a legacy thing that was
|
||||
# replaced by **kwargs.
|
||||
def pack_configure(
|
||||
self,
|
||||
cnf: Optional[Dict[str, Any]] = ...,
|
||||
*,
|
||||
after: Misc = ...,
|
||||
anchor: _Anchor = ...,
|
||||
before: Misc = ...,
|
||||
expand: bool = ...,
|
||||
fill: Literal["none", "x", "y", "both"] = ...,
|
||||
side: Literal["left", "right", "top", "bottom"] = ...,
|
||||
ipadx: Union[_ScreenUnits, Tuple[_ScreenUnits, _ScreenUnits]] = ...,
|
||||
ipady: Union[_ScreenUnits, Tuple[_ScreenUnits, _ScreenUnits]] = ...,
|
||||
padx: Union[_ScreenUnits, Tuple[_ScreenUnits, _ScreenUnits]] = ...,
|
||||
pady: Union[_ScreenUnits, Tuple[_ScreenUnits, _ScreenUnits]] = ...,
|
||||
in_: Misc = ...,
|
||||
) -> None: ...
|
||||
def pack_forget(self) -> None: ...
|
||||
def pack_info(self) -> _PackInfo: ... # errors if widget hasn't been packed
|
||||
pack = pack_configure
|
||||
forget = pack_forget
|
||||
propagate = Misc.pack_propagate
|
||||
# commented out to avoid mypy getting confused with multiple
|
||||
# inheritance and how things get overrided with different things
|
||||
# info = pack_info
|
||||
# pack_propagate = Misc.pack_propagate
|
||||
# configure = pack_configure
|
||||
# config = pack_configure
|
||||
# slaves = Misc.pack_slaves
|
||||
# pack_slaves = Misc.pack_slaves
|
||||
|
||||
class _PlaceInfo(_InMiscNonTotal, total=False): # empty dict if widget hasn't been placed
|
||||
anchor: _Anchor
|
||||
bordermode: Literal["inside", "outside", "ignore"]
|
||||
width: str # can be int()ed (even after e.g. widget.place(height='2.3c') or similar)
|
||||
height: str # can be int()ed
|
||||
x: str # can be int()ed
|
||||
y: str # can be int()ed
|
||||
relheight: str # can be float()ed if not empty string
|
||||
relwidth: str # can be float()ed if not empty string
|
||||
relx: float # can be float()ed if not empty string
|
||||
rely: float # can be float()ed if not empty string
|
||||
|
||||
class Place:
|
||||
def place_configure(self, cnf=..., **kw): ...
|
||||
place: Any
|
||||
def place_forget(self): ...
|
||||
forget: Any
|
||||
def place_info(self): ...
|
||||
info: Any
|
||||
slaves: Any
|
||||
def place_configure(
|
||||
self,
|
||||
cnf: Optional[Dict[str, Any]] = ...,
|
||||
*,
|
||||
anchor: _Anchor = ...,
|
||||
bordermode: Literal["inside", "outside", "ignore"] = ...,
|
||||
width: _ScreenUnits = ...,
|
||||
height: _ScreenUnits = ...,
|
||||
x: _ScreenUnits = ...,
|
||||
y: _ScreenUnits = ...,
|
||||
relheight: float = ...,
|
||||
relwidth: float = ...,
|
||||
relx: float = ...,
|
||||
rely: float = ...,
|
||||
in_: Misc = ...,
|
||||
) -> None: ...
|
||||
def place_forget(self) -> None: ...
|
||||
def place_info(self) -> _PlaceInfo: ...
|
||||
place = place_configure
|
||||
info = place_info
|
||||
# commented out to avoid mypy getting confused with multiple
|
||||
# inheritance and how things get overrided with different things
|
||||
# config = place_configure
|
||||
# configure = place_configure
|
||||
# forget = place_forget
|
||||
# slaves = Misc.place_slaves
|
||||
# place_slaves = Misc.place_slaves
|
||||
|
||||
class _GridInfo(_InMiscNonTotal, total=False): # empty dict if widget hasn't been gridded
|
||||
column: int
|
||||
columnspan: int
|
||||
row: int
|
||||
rowspan: int
|
||||
ipadx: int
|
||||
ipady: int
|
||||
padx: int
|
||||
pady: int
|
||||
sticky: str # consists of letters 'n', 's', 'w', 'e', no repeats, may be empty
|
||||
|
||||
class Grid:
|
||||
def grid_configure(self, cnf=..., **kw): ...
|
||||
grid: Any
|
||||
bbox: Any
|
||||
columnconfigure: Any
|
||||
def grid_forget(self): ...
|
||||
forget: Any
|
||||
def grid_remove(self): ...
|
||||
def grid_info(self): ...
|
||||
info: Any
|
||||
location: Any
|
||||
propagate: Any
|
||||
rowconfigure: Any
|
||||
size: Any
|
||||
slaves: Any
|
||||
def grid_configure(
|
||||
self,
|
||||
cnf: Optional[Dict[str, Any]] = ...,
|
||||
*,
|
||||
column: int = ...,
|
||||
columnspan: int = ...,
|
||||
row: int = ...,
|
||||
rowspan: int = ...,
|
||||
ipadx: _ScreenUnits = ...,
|
||||
ipady: _ScreenUnits = ...,
|
||||
padx: _ScreenUnits = ...,
|
||||
pady: _ScreenUnits = ...,
|
||||
sticky: str = ..., # consists of letters 'n', 's', 'w', 'e', may contain repeats, may be empty
|
||||
in_: Misc = ...,
|
||||
) -> None: ...
|
||||
def grid_forget(self) -> None: ...
|
||||
def grid_remove(self) -> None: ...
|
||||
def grid_info(self) -> _GridInfo: ...
|
||||
grid = grid_configure
|
||||
location = Misc.grid_location
|
||||
size = Misc.grid_size
|
||||
# commented out to avoid mypy getting confused with multiple
|
||||
# inheritance and how things get overrided with different things
|
||||
# bbox = Misc.grid_bbox
|
||||
# grid_bbox = Misc.grid_bbox
|
||||
# forget = grid_forget
|
||||
# info = grid_info
|
||||
# grid_location = Misc.grid_location
|
||||
# grid_propagate = Misc.grid_propagate
|
||||
# grid_size = Misc.grid_size
|
||||
# rowconfigure = Misc.grid_rowconfigure
|
||||
# grid_rowconfigure = Misc.grid_rowconfigure
|
||||
# grid_columnconfigure = Misc.grid_columnconfigure
|
||||
# columnconfigure = Misc.grid_columnconfigure
|
||||
# config = grid_configure
|
||||
# configure = grid_configure
|
||||
# propagate = Misc.grid_propagate
|
||||
# slaves = Misc.grid_slaves
|
||||
# grid_slaves = Misc.grid_slaves
|
||||
|
||||
class BaseWidget(Misc):
|
||||
widgetName: Any
|
||||
|
||||
@@ -1,79 +1,79 @@
|
||||
from typing import Any
|
||||
from typing_extensions import Literal
|
||||
|
||||
NO: Any
|
||||
YES: Any
|
||||
TRUE: Any
|
||||
FALSE: Any
|
||||
ON: Any
|
||||
OFF: Any
|
||||
N: Any
|
||||
S: Any
|
||||
W: Any
|
||||
E: Any
|
||||
NW: Any
|
||||
SW: Any
|
||||
NE: Any
|
||||
SE: Any
|
||||
NS: Any
|
||||
EW: Any
|
||||
NSEW: Any
|
||||
CENTER: Any
|
||||
NONE: Any
|
||||
X: Any
|
||||
Y: Any
|
||||
BOTH: Any
|
||||
LEFT: Any
|
||||
TOP: Any
|
||||
RIGHT: Any
|
||||
BOTTOM: Any
|
||||
RAISED: Any
|
||||
SUNKEN: Any
|
||||
FLAT: Any
|
||||
RIDGE: Any
|
||||
GROOVE: Any
|
||||
SOLID: Any
|
||||
HORIZONTAL: Any
|
||||
VERTICAL: Any
|
||||
NUMERIC: Any
|
||||
CHAR: Any
|
||||
WORD: Any
|
||||
BASELINE: Any
|
||||
INSIDE: Any
|
||||
OUTSIDE: Any
|
||||
SEL: Any
|
||||
SEL_FIRST: Any
|
||||
SEL_LAST: Any
|
||||
END: Any
|
||||
INSERT: Any
|
||||
CURRENT: Any
|
||||
ANCHOR: Any
|
||||
ALL: Any
|
||||
NORMAL: Any
|
||||
DISABLED: Any
|
||||
ACTIVE: Any
|
||||
HIDDEN: Any
|
||||
CASCADE: Any
|
||||
CHECKBUTTON: Any
|
||||
COMMAND: Any
|
||||
RADIOBUTTON: Any
|
||||
SEPARATOR: Any
|
||||
SINGLE: Any
|
||||
BROWSE: Any
|
||||
MULTIPLE: Any
|
||||
EXTENDED: Any
|
||||
DOTBOX: Any
|
||||
UNDERLINE: Any
|
||||
PIESLICE: Any
|
||||
CHORD: Any
|
||||
ARC: Any
|
||||
FIRST: Any
|
||||
LAST: Any
|
||||
BUTT: Any
|
||||
PROJECTING: Any
|
||||
ROUND: Any
|
||||
BEVEL: Any
|
||||
MITER: Any
|
||||
MOVETO: Any
|
||||
SCROLL: Any
|
||||
UNITS: Any
|
||||
PAGES: Any
|
||||
NO: Literal[0]
|
||||
YES: Literal[1]
|
||||
TRUE: Literal[1]
|
||||
FALSE: Literal[0]
|
||||
ON: Literal[1]
|
||||
OFF: Literal[0]
|
||||
N: Literal["n"]
|
||||
S: Literal["s"]
|
||||
W: Literal["w"]
|
||||
E: Literal["e"]
|
||||
NW: Literal["nw"]
|
||||
SW: Literal["sw"]
|
||||
NE: Literal["ne"]
|
||||
SE: Literal["se"]
|
||||
NS: Literal["ns"]
|
||||
EW: Literal["ew"]
|
||||
NSEW: Literal["nsew"]
|
||||
CENTER: Literal["center"]
|
||||
NONE: Literal["none"]
|
||||
X: Literal["x"]
|
||||
Y: Literal["y"]
|
||||
BOTH: Literal["both"]
|
||||
LEFT: Literal["left"]
|
||||
TOP: Literal["top"]
|
||||
RIGHT: Literal["right"]
|
||||
BOTTOM: Literal["bottom"]
|
||||
RAISED: Literal["raised"]
|
||||
SUNKEN: Literal["sunken"]
|
||||
FLAT: Literal["flat"]
|
||||
RIDGE: Literal["ridge"]
|
||||
GROOVE: Literal["groove"]
|
||||
SOLID: Literal["solid"]
|
||||
HORIZONTAL: Literal["horizontal"]
|
||||
VERTICAL: Literal["vertical"]
|
||||
NUMERIC: Literal["numeric"]
|
||||
CHAR: Literal["char"]
|
||||
WORD: Literal["word"]
|
||||
BASELINE: Literal["baseline"]
|
||||
INSIDE: Literal["inside"]
|
||||
OUTSIDE: Literal["outside"]
|
||||
SEL: Literal["sel"]
|
||||
SEL_FIRST: Literal["sel.first"]
|
||||
SEL_LAST: Literal["sel.last"]
|
||||
END: Literal["end"]
|
||||
INSERT: Literal["insert"]
|
||||
CURRENT: Literal["current"]
|
||||
ANCHOR: Literal["anchor"]
|
||||
ALL: Literal["all"]
|
||||
NORMAL: Literal["normal"]
|
||||
DISABLED: Literal["disabled"]
|
||||
ACTIVE: Literal["active"]
|
||||
HIDDEN: Literal["hidden"]
|
||||
CASCADE: Literal["cascade"]
|
||||
CHECKBUTTON: Literal["checkbutton"]
|
||||
COMMAND: Literal["command"]
|
||||
RADIOBUTTON: Literal["radiobutton"]
|
||||
SEPARATOR: Literal["separator"]
|
||||
SINGLE: Literal["single"]
|
||||
BROWSE: Literal["browse"]
|
||||
MULTIPLE: Literal["multiple"]
|
||||
EXTENDED: Literal["extended"]
|
||||
DOTBOX: Literal["dotbox"]
|
||||
UNDERLINE: Literal["underline"]
|
||||
PIESLICE: Literal["pieslice"]
|
||||
CHORD: Literal["chord"]
|
||||
ARC: Literal["arc"]
|
||||
FIRST: Literal["first"]
|
||||
LAST: Literal["last"]
|
||||
BUTT: Literal["butt"]
|
||||
PROJECTING: Literal["projecting"]
|
||||
ROUND: Literal["round"]
|
||||
BEVEL: Literal["bevel"]
|
||||
MITER: Literal["miter"]
|
||||
MOVETO: Literal["moveto"]
|
||||
SCROLL: Literal["scroll"]
|
||||
UNITS: Literal["units"]
|
||||
PAGES: Literal["pages"]
|
||||
|
||||
Reference in New Issue
Block a user