tk9_0

Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1 is released over the button window.

Default

Specifies one of three states for the default ring: normal, active, or disabled. In active state, the button is drawn with the platform specific appearance for a default button. In normal state, the button is drawn with the platform specific appearance for a non-default button, leaving enough space to draw the default button appearance. The normal and active states will result in buttons of the same size. In disabled state, the button is drawn with the non-default button appearance without leaving space for the default appearance. The disabled state may result in a smaller button than the active state.

Specifies a desired height for the button. If an image or bitmap is being displayed in the button then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in lines of text. If this option is not specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it.

Overrelief

Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring -relief flat -overrelief raised. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the button. The empty string is the default value.

Specifies one of three states for the button: normal, active, or disabled. In normal state the button is displayed using the -foreground and -background options. The active state is typically used when the pointer is over the button. In active state the button is displayed using the -activeforeground and -activebackground options. Disabled state means that the button should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. In this state the -disabledforeground and -background options determine how the button is displayed.

Specifies a desired width for the button. If an image or bitmap is being displayed in the button then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels). For a text button (no image or with -compound none) then the width specifies how much space in characters to allocate for the text label. If the width is negative then this specifies a minimum width. If this option is not specified, the button's desired width is computed from the size of the image or bitmap or text being displayed in it.

func Exit ¶ added in v0.5.18

func Exit(options ...Opt) *ButtonWidget

Exit provides a canned Button with default Txt "Exit", bound to the ExitHandler.

Use Window.Exit to create a Exit with a particular parent.

func (*ButtonWidget) Invoke ¶ added in v0.44.0

func (w *ButtonWidget) Invoke() string

button — Create and manipulate 'button' action widgets

Description ¶

Invoke the Tcl command associated with the button, if there is one. The return value is the return value from the Tcl 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.

Additional information might be available at the Tcl/Tk button page.

type CanvasWidget ¶ added in v0.11.0

type CanvasWidget struct {
	*Window
}

CanvasWidget represents the Tcl/Tk canvas widget/window

func Canvas ¶ added in v0.2.0

func Canvas(options ...Opt) *CanvasWidget

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Use Window.Canvas to create a Canvas with a particular parent.

More information might be available at the Tcl/Tk canvas page.

Standard options ¶

Background
Borderwidth
Cursor
Highlightbackground
Highlightcolor
Highlightthickness
Insertbackground
Insertborderwidth
Insertofftime
Insertontime
Insertwidth
Relief
Selectbackground
Selectborderwidth
Selectforeground
Takefocus
Xscrollcommand
Yscrollcommand

Widget specific options ¶

Closeenough

Specifies a floating-point value indicating how close the mouse cursor must be to an item before it is considered to be the item. Defaults to 1.0.

Confine

Specifies a boolean value that indicates whether or not it should be allowable to set the canvas's view outside the region defined by the scrollRegion argument. Defaults to true, which means that the view will be constrained within the scroll region.

Specifies a desired window height that the canvas widget should request from its geometry manager. The value may be specified in any of the forms described in the COORDINATES section below.

Scrollregion

Specifies a list with four coordinates describing the left, top, right, and bottom coordinates of a rectangular region. This region is used for scrolling purposes and is considered to be the boundary of the information in the canvas. Each of the coordinates may be specified in any of the forms given in the COORDINATES section below.

Modifies the default state of the canvas where state may be set to one of: normal, disabled, or hidden. Individual canvas objects all have their own state option which may override the default state. Many options can take separate specifications such that the appearance of the item can be different in different situations. The options that start with active control the appearance when the mouse pointer is over it, while the option starting with disabled controls the appearance when the state is disabled. Canvas items which are disabled will not react to canvas bindings.

Specifies a desired window width that the canvas widget should request from its geometry manager. The value may be specified in any of the forms described in the COORDINATES section below.

Xscrollincrement

Specifies an increment for horizontal scrolling, in any of the usual forms permitted for screen distances. If the value of this option is greater than zero, the horizontal view in the window will be constrained so that the canvas x coordinate at the left edge of the window is always an even multiple of xScrollIncrement; furthermore, the units for scrolling (e.g., the change in view when the left and right arrows of a scrollbar are selected) will also be xScrollIncrement. If the value of this option is negative or zero, then horizontal scrolling is unconstrained.

Yscrollincrement

Specifies an increment for vertical scrolling, in any of the usual forms permitted for screen distances. If the value of this option is greater than zero, the vertical view in the window will be constrained so that the canvas y coordinate at the top edge of the window is always an even multiple of yScrollIncrement; furthermore, the units for scrolling (e.g., the change in view when the top and bottom arrows of a scrollbar are selected) will also be yScrollIncrement. If the value of this option is negative or zero, then vertical scrolling is unconstrained.

func (*CanvasWidget) Bbox ¶ added in v0.62.1

func (w *CanvasWidget) Bbox(tagIds ...string) []string

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Returns a list with four elements giving an approximate bounding box for all the items named by the tagOrId arguments. The list has the form “x1 y1 x2 y2” such that the drawn areas of all the named elements are within the region bounded by x1 on the left, x2 on the right, y1 on the top, and y2 on the bottom. The return value may overestimate the actual bounding box by a few pixels. If no items match any of the tagOrId arguments or if the matching items have empty bounding boxes (i.e. they have nothing to display) then an empty string is returned.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateArc ¶ added in v0.62.0

func (w *CanvasWidget) CreateArc(x1, y1, x2, y2 any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Create a new arc in pathName of type type. The exact format of the arguments after type depends on type, but usually they consist of the coordinates for one or more points, followed by specifications for zero or more item options. See the subsections on individual item types below for more on the syntax of this command. This command returns the id for the new item.

Items of type arc appear on the display as arc-shaped regions. An arc is a section of an oval delimited by two angles (specified by either the -start and -extent options or the -height option) and displayed in one of several ways (specified by the -style option). Arcs are created with widget commands of the following form:

pathName create arc x1 y1 x2 y2 ?option value ...?

The arguments x1, y1, x2, and y2 or coordList give the coordinates of two diagonally opposite corners of a rectangular region enclosing the oval that defines the arc (except when -height is specified - see below). After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. An arc item becomes the current item when the mouse pointer is over any part that is painted or (when fully transparent) that would be painted if both the -fill and -outline options were non-empty.

The following standard options are supported by arcs:

The following extra options are supported for arcs:

Extent degrees
Start degrees
Height distance

Provides a shortcut for creating a circular arc segment by defining the distance of the mid-point of the arc from its chord. When this option is used the coordinates are interpreted as the start and end coordinates of the chord, and the options -start and -extent are ignored. The value of distance has the following meaning:

distance > 0 creates a clockwise arc,
distance < 0 creates an counter-clockwise arc,
distance = 0 creates an arc as if this option had not been specified.

If you want the arc to have a specific radius, r, use the formula:

distance = r ± sqrt(r**2 - (chordLength / 2)**2)

choosing the minus sign for the minor arc and the plus sign for the major arc.

Note that itemcget -height always returns 0 so that introspection code can be kept simple.

Style type

Specifies how to draw the arc. If type is pieslice (the default) then the arc's region is defined by a section of the oval's perimeter plus two line segments, one between the center of the oval and each end of the perimeter section. If type is chord then the arc's region is defined by a section of the oval's perimeter plus a single line segment connecting the two end points of the perimeter section. If type is arc then the arc's region consists of a section of the perimeter alone. In this last case the -fill option is ignored.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateBitmap ¶ added in v0.62.0

func (w *CanvasWidget) CreateBitmap(x, y any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type bitmap appear on the display as images with two colors, foreground and background. Bitmaps are created with widget commands of the following form:

pathName create bitmap x y ?option value ...?

The arguments x and y or coordList (which must have two elements) specify the coordinates of a point used to position the bitmap on the display, as controlled by the -anchor option. After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. A bitmap item becomes the current item when the mouse pointer is over any part of its bounding box.

The following standard options are supported by bitmaps:

Anchor
State
Tags

The following extra options are supported for bitmaps:

Background color
Activebackground color
Disabledbackground color
Specifies the color to use for each of the bitmap's “0” valued pixels in its normal, active and disabled states. Color may have any of the forms accepted by Tk_GetColor. If this option is not specified, or if it is specified as an empty string, then nothing is displayed where the bitmap pixels are 0; this produces a transparent effect.
Bitmap bitmap
Activebitmap bitmap
Disabledbitmap bitmap:
These options specify the bitmaps to display in the item in its normal, active and disabled states. Bitmap may have any of the forms accepted by Tk_GetBitmap.
Foreground color
Activeforeground color
Disabledforeground color:
These options specify the color to use for each of the bitmap's “1” valued pixels in its normal, active and disabled states. Color may have any of the forms accepted by Tk_GetColor.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateImage ¶ added in v0.62.0

func (w *CanvasWidget) CreateImage(x, y any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type image are used to display images on a canvas. Images are created with widget commands of the following form:

pathName create image x y ?option value ...?

The arguments x and y or coordList specify the coordinates of a point used to position the image on the display, as controlled by the -anchor option. After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. An image item becomes the current item when the mouse pointer is over any part of its bounding box.

The following standard options are supported by images:

Anchor
State
Tags

The following extra options are supported for images:

Image name
Activeimage name
Disabledimage name
Specifies the name of the images to display in the item in is normal, active and disabled states. This image must have been created previously with the image create command.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateLine ¶ added in v0.62.0

func (w *CanvasWidget) CreateLine(x1, y1 any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type line appear on the display as one or more connected line segments or curves. Line items support coordinate indexing operations using the dchars, index and insert widget commands. Lines are created with widget commands of the following form:

pathName create line x1 y1... xn yn ?option value ...?

The following standard options are supported by lines:

Dash
Activedash
Disableddash
Dashoffset
Fill
Activefill
Disabledfill
Stipple
Activestipple
Disabledstipple
State
Tags
Width
Activewidth
Disabledwidth

The following extra options are supported for lines:

Linearrow where
Arrowshape shape
Capstyle style
Joinstyle style
Smooth smoothMethod
Splinesteps number

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateOval ¶ added in v0.62.0

func (w *CanvasWidget) CreateOval(x1, y1, x2, y2 any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type oval appear as circular or oval regions on the display. Each oval may have an outline, a fill, or both. Ovals are created with widget commands of the following form:

pathName create oval x1 y1 x2 y2 ?option value ...?

The following standard options are supported by ovals:

There are no oval-specific options.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreatePolygon ¶ added in v0.62.0

func (w *CanvasWidget) CreatePolygon(x1, y1 any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type polygon appear as polygonal or curved filled regions on the display. Polygon items support coordinate indexing operations using the dchars, index and insert widget commands. Polygons are created with widget commands of the following form:

pathName create polygon x1 y1 ... xn yn ?option value ...?

The arguments x1 through yn or coordList specify the coordinates for three or more points that define a polygon. The first point should not be repeated as the last to close the shape; Tk will automatically close the periphery between the first and last points. After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. A polygon item is the current item whenever the mouse pointer is over any part of the polygon, whether drawn or not and whether or not the outline is smoothed.

The following standard options are supported by polygons:

The following extra options are supported for polygons:

Joinstyle style
Specifies the ways in which joints are to be drawn at the vertices of the outline. Style may have any of the forms accepted by Tk_GetJoinStyle (bevel, miter, or round). If this option is not specified then it defaults to round.
Smooth boolean
Boolean must have one of the forms accepted by Tcl_GetBoolean or a line smoothing method. Only true and raw are supported in the core (with bezier being an alias for true), but more can be added at runtime. If a boolean false value or empty string is given, no smoothing is applied. A boolean truth value assumes true smoothing. If the smoothing method is true, this indicates that the polygon should be drawn as a curve, rendered as a set of quadratic splines: one spline is drawn for the first and second line segments, one for the second and third, and so on. Straight-line segments can be generated within a curve by duplicating the end-points of the desired line segment. If the smoothing method is raw, this indicates that the polygon should also be drawn as a curve but where the list of coordinates is such that the first coordinate pair (and every third coordinate pair thereafter) is a knot point on a cubic Bezier curve, and the other coordinates are control points on the cubic Bezier curve. Straight line segments can be generated within a curve by making control points equal to their neighbouring knot points. If the last point is not the second point of a pair of control points, the point is repeated (one or two times) so that it also becomes the second point of a pair of control points (the associated knot point will be the first control point).
Splinesteps number
Specifies the degree of smoothness desired for curves: each spline will be approximated with number line segments. This option is ignored unless the -smooth option is true or raw.

Polygon items are different from other items such as rectangles, ovals and arcs in that interior points are considered to be “inside” a polygon (e.g. for purposes of the find closest and find overlapping widget commands) even if it is not filled. For most other item types, an interior point is considered to be inside the item only if the item is filled or if it has neither a fill nor an outline. If you would like an unfilled polygon whose interior points are not considered to be inside the polygon, use a line item instead.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateRectangle ¶ added in v0.62.0

func (w *CanvasWidget) CreateRectangle(x1, y1, x2, y2 any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type rectangle appear as rectangular regions on the display. Each rectangle may have an outline, a fill, or both. Rectangles are created with widget commands of the following form:

pathName create rectangle x1 y1 x2 y2 ?option value ...?

The arguments x1, y1, x2, and y2 or coordList (which must have four elements) give the coordinates of two diagonally opposite corners of the rectangle (the rectangle will include its upper and left edges but not its lower or right edges). After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. A rectangle item becomes the current item when the mouse pointer is over any part that is painted or (when fully transparent) that would be painted if both the -fill and -outline options were non-empty.

The following standard options are supported by rectangles:

There are no rectangle-specific options.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateText ¶ added in v0.62.0

func (w *CanvasWidget) CreateText(x, y any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

A text item displays a string of characters on the screen in one or more lines. Text items support indexing, editing and selection through the dchars widget command, the focus widget command, the icursor widget command, the index widget command, the insert widget command, and the select widget command. Text items are created with widget commands of the following form:

pathName create text x y ?option value ...?

The arguments x and y or coordList (which must have two elements) specify the coordinates of a point used to position the text on the display (see the options below for more information on how text is displayed). After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. A text item becomes the current item when the mouse pointer is over any part of its bounding box.

The following standard options are supported by text items:

Anchor
Fill
Activefill
Disabledfill
Stipple
Activestipple
Disabledstipple
State
Tags

The following extra options are supported for text items:

Angle rotationDegrees
RotationDegrees tells how many degrees to rotate the text anticlockwise about the positioning point for the text; it may have any floating-point value from 0.0 to 360.0. For example, if rotationDegrees is 90, then the text will be drawn vertically from bottom to top. This option defaults to 0.0.
Font fontName
Specifies the font to use for the text item. FontName may be any string acceptable to Tk_GetFont. If this option is not specified, it defaults to a system-dependent font.
Justify how
Specifies how to justify the text within its bounding region. How must be one of the values left, right, or center. This option will only matter if the text is displayed as multiple lines. If the option is omitted, it defaults to left.
Txt string
String specifies the characters to be displayed in the text item. Newline characters cause line breaks. The characters in the item may also be changed with the insert and delete widget commands. This option defaults to an empty string.
Underline number
Specifies the integer index of a character within the text to be underlined. 0 corresponds to the first character of the text displayed, 1 to the next character, and so on. -1 means that no underline should be drawn (if the whole text item is to be underlined, the appropriate font should be used instead).
Width lineLength
Specifies a maximum line length for the text, in any of the forms described in the COORDINATES section above. If this option is zero (the default) the text is broken into lines only at newline characters. However, if this option is non-zero then any line that would be longer than lineLength is broken just before a space character to make the line shorter than lineLength; the space character is treated as if it were a newline character.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) CreateWindow ¶ added in v0.62.0

func (w *CanvasWidget) CreateWindow(x, y any, options ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

Items of type window cause a particular window to be displayed at a given position on the canvas. Window items are created with widget commands of the following form:

pathName create window x y ?option value ...?

The arguments x and y or coordList (which must have two elements) specify the coordinates of a point used to position the window on the display, as controlled by the -anchor option. After the coordinates there may be any number of option-value pairs, each of which sets one of the configuration options for the item. These same option-value pairs may be used in itemconfigure widget commands to change the item's configuration. Theoretically, a window item becomes the current item when the mouse pointer is over any part of its bounding box, but in practice this typically does not happen because the mouse pointer ceases to be over the canvas at that point.

The following standard options are supported by window items:

Anchor
State
Tags

The following extra options are supported for window items:

Height pixels
Specifies the height to assign to the item's window. Pixels may have any of the forms described in the COORDINATES section above. If this option is not specified, or if it is specified as zero, then the window is given whatever height it requests internally.
Width pixels Specifies the width to assign to the item's window. Pixels may have any of the forms described in the COORDINATES section above. If this option is not specified, or if it is specified as zero, then the window is given whatever width it requests internally.
ItemWindow pathName
Specifies the window to associate with this item. The window specified by pathName must either be a child of the canvas widget or a child of some ancestor of the canvas widget. PathName may not refer to a top-level window.

Note that, due to restrictions in the ways that windows are managed, it is not possible to draw other graphical items (such as lines and images) on top of window items. A window item always obscures any graphics that overlap it, regardless of their order in the display list. Also note that window items, unlike other canvas items, are not clipped for display by their containing canvas's border, and are instead clipped by the parent widget of the window specified by the -window option; when the parent widget is the canvas, this means that the window item can overlap the canvas's border.

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) Delete ¶ added in v0.62.0

func (w *CanvasWidget) Delete(tagOrId ...any) (r string)

Canvas — Create and manipulate 'canvas' hypergraphics drawing surface widgets

Description ¶

More information might be available at the Tcl/Tk canvas page.

func (*CanvasWidget) Graph ¶ added in v0.11.0

func (w *CanvasWidget) Graph(script string) *CanvasWidget

Graph — use gnuplot to draw on a canvas. Graph returns 'w'.

The 'script' argument is passed to a gnuplot executable, which must be installed on the machine. See the gnuplot site for documentation about producing graphs. The script must not use the 'set term <device>' command.

type CheckbuttonWidget ¶ added in v0.11.0

type CheckbuttonWidget struct {
	*Window
}

CheckbuttonWidget represents the Tcl/Tk checkbutton widget/window

func Checkbutton ¶ added in v0.2.0

func Checkbutton(options ...Opt) *CheckbuttonWidget

Checkbutton — Create and manipulate 'checkbutton' boolean selection widgets

Description ¶

The checkbutton command creates a new window (given by the pathName argument) and makes it into a checkbutton widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the checkbutton such as its colors, font, text, and initial relief. The checkbutton command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A checkbutton is a widget that displays a textual string, bitmap or image and a square called an indicator. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines or if wrapping occurs because of the -wraplength option) and one of the characters may optionally be underlined using the A checkbutton has all of the behavior of a simple button, including the following: it can display itself in either of three different ways, according to the -state option; it can be made to appear raised, sunken, or flat; it can be made to flash; and it invokes a Tcl command whenever mouse button 1 is clicked over the checkbutton.

In addition, checkbuttons can be selected. If a checkbutton is selected then the indicator is normally drawn with a selected appearance, and a Tcl variable associated with the checkbutton is set to a particular value (normally 1). The indicator is drawn with a check mark inside. If the checkbutton is not selected, then the indicator is drawn with a deselected appearance, and the associated variable is set to a different value (typically 0). The indicator is drawn without a check mark inside. In the special case where the variable (if specified) has a value that matches the tristatevalue, the indicator is drawn with a tri-state appearance and is in the tri-state mode indicating mixed or multiple values. (This is used when the check box represents the state of multiple items.) The indicator is drawn in a platform dependent manner. Under Unix and Windows, the background interior of the box is grayed . Under Mac, the indicator is drawn with a dash mark inside. By default, the name of the variable associated with a checkbutton is the same as the name used to create the checkbutton. The variable name, and the on , off and tristate values stored in it, may be modified with options on the command line or in the option database. Configuration options may also be used to modify the way the indicator is displayed (or whether it is displayed at all). By default a checkbutton is configured to select and deselect itself on alternate button clicks. In addition, each checkbutton monitors its associated variable and automatically selects and deselects itself when the variables value changes to and from the button's on , off and tristate values.

Use Window.Checkbutton to create a Checkbutton with a particular parent.

More information might be available at the Tcl/Tk checkbutton page.

Standard options ¶

Widget specific options ¶

Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1 is released over the button window. The button's global variable (-variable option) will be updated before the command is invoked.

Specifies a desired height for the button. If an image or bitmap is being displayed in the button then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in lines of text. If this option is not specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it.

Indicatoron

Specifies whether or not the indicator should be drawn. Must be a proper boolean value. If false, the -relief option is ignored and the widget's relief is always sunken if the widget is selected and raised otherwise.

Offrelief

Specifies the relief for the checkbutton when the indicator is not drawn and the checkbutton is off. The default value is By setting this option to and setting -indicatoron to false and -overrelief to the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example.

Offvalue

Specifies value to store in the button's associated variable whenever this button is deselected. Defaults to

Onvalue

Specifies value to store in the button's associated variable whenever this button is selected. Defaults to

Overrelief

Specifies an alternative relief for the checkbutton, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring -relief flat -overrelief raised. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the checkbutton. The empty string is the default value.

Selectcolor

Specifies a background color to use when the button is selected. If indicatorOn is true then the color is used as the background for the indicator regardless of the select state. If indicatorOn is false, this color is used as the background for the entire widget, in place of background or activeBackground, whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected.

Selectimage

Specifies an image to display (in place of the -image option) when the checkbutton is selected. This option is ignored unless the -image option has been specified.

Specifies one of three states for the checkbutton: normal, active, or disabled. In normal state the checkbutton is displayed using the -foreground and -background options. The active state is typically used when the pointer is over the checkbutton. In active state the checkbutton is displayed using the -activeforeground and -activebackground options. Disabled state means that the checkbutton should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. In this state the -disabledforeground and -background options determine how the checkbutton is displayed.

Tristateimage

Specifies an image to display (in place of the -image option) when the checkbutton is in tri-state mode. This option is ignored unless the -image option has been specified.

Tristatevalue

Specifies the value that causes the checkbutton to display the multi-value selection, also known as the tri-state mode. Defaults to

Specifies the name of a global variable to set to indicate whether or not this button is selected. Defaults to the name of the button within its parent (i.e. the last element of the button window's path name).

Specifies a desired width for the button. If an image or bitmap is being displayed in the button then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in characters. If this option is not specified, the button's desired width is computed from the size of the image or bitmap or text being displayed in it.

func (*CheckbuttonWidget) Deselect ¶ added in v0.32.0

func (w *CheckbuttonWidget) Deselect()

checkbutton — Create and manipulate 'checkbutton' boolean selection widgets

Description ¶

Deselects the checkbutton and sets the associated variable to its “off” value.

More information might be available at the Tcl/Tk checkbutton page.

func (*CheckbuttonWidget) Invoke ¶ added in v0.52.0

func (w *CheckbuttonWidget) Invoke() string

checkbutton — Create and manipulate 'checkbutton' boolean selection widgets

Description ¶

Does just what would have happened if the user invoked the checkbutton with the mouse: toggle the selection state of the button and invoke the Tcl command associated with the checkbutton, if there is one. The return value is the return value from the Tcl command, or an empty string if there is no command associated with the checkbutton. This command is ignored if the checkbutton's state is disabled.

More information might be available at the Tcl/Tk checkbutton page.

func (*CheckbuttonWidget) Select ¶ added in v0.32.0

func (w *CheckbuttonWidget) Select()

checkbutton — Create and manipulate 'checkbutton' boolean selection widgets

Description ¶

Selects the checkbutton and sets the associated variable to its “on” value.

More information might be available at the Tcl/Tk checkbutton page.

type EntryWidget ¶ added in v0.11.0

type EntryWidget struct {
	*Window
}

EntryWidget represents the Tcl/Tk entry widget/window

func Entry ¶ added in v0.2.0

func Entry(options ...Opt) *EntryWidget

Entry — Create and manipulate 'entry' one-line text entry widgets

Description ¶

The entry command creates a new window (given by the pathName argument) and makes it into an entry widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the entry such as its colors, font, and relief. The entry command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

An entry is a widget that displays a one-line text string and allows that string to be edited using widget commands described below, which are typically bound to keystrokes and mouse actions. When first created, an entry's string is empty. A portion of the entry may be selected as described below. If an entry is exporting its selection (see the -exportselection option), then it will observe the standard X11 protocols for handling the selection; entry selections are available as type STRING. Entries also observe the standard Tk rules for dealing with the input focus. When an entry has the input focus it displays an insertion cursor to indicate where new characters will be inserted.

Entries are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below may be used to change the view in the window. Entries use the standard -xscrollcommand mechanism for interacting with scrollbars (see the description of the -xscrollcommand option for details). They also support scanning, as described below.

Use Window.Entry to create a Entry with a particular parent.

More information might be available at the Tcl/Tk entry page.

Standard options ¶

Widget specific options ¶

Disabledbackground

Specifies the background color to use when the entry is disabled. If this option is the empty string, the normal background color is used.

Disabledforeground

Specifies the foreground color to use when the entry is disabled. If this option is the empty string, the normal foreground color is used.

Invalidcommand

Specifies a script to eval when -validatecommand returns 0. Setting it to {} disables this feature (the default). The best use of this option is to set it to bell. See VALIDATION below for more information.

Readonlybackground

Specifies the background color to use when the entry is readonly. If this option is the empty string, the normal background color is used.

Show

If this option is specified, then the true contents of the entry are not displayed in the window. Instead, each character in the entry's value will be displayed as the first character in the value of this option, such as This is useful, for example, if the entry is to be used to enter a password. If characters in the entry are selected and copied elsewhere, the information copied will be what is displayed, not the true contents of the entry.

Specifies one of three states for the entry: normal, disabled, or readonly. If the entry is readonly, then the value may not be changed using widget commands and no insertion cursor will be displayed, even if the input focus is in the widget; the contents of the widget may still be selected. If the entry is disabled, the value may not be changed, no insertion cursor will be displayed, the contents will not be selectable, and the entry may be displayed in a different color, depending on the values of the -disabledforeground and -disabledbackground options.

Validate

Specifies the mode in which validation should operate: none, focus, focusin, focusout, key, or all. It defaults to none. When you want validation, you must explicitly state which mode you wish to use. See VALIDATION below for more.

Validatecommand

Specifies a script to eval when you want to validate the input into the entry widget. Setting it to {} disables this feature (the default). This command must return a valid Tcl boolean value. If it returns 0 (or the valid Tcl boolean equivalent) then it means you reject the new edition and it will not occur and the -invalidcommand will be evaluated if it is set. If it returns 1, then the new edition occurs. See VALIDATION below for more information.

Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. If the value is negative or zero, the widget picks a size just large enough to hold its current text.

func (*EntryWidget) Icursor ¶ added in v0.58.0

func (w *EntryWidget) Icursor(index any) (r string)

Entry — Create and manipulate 'entry' one-line text entry widgets

Description ¶

Arrange for the insertion cursor to be displayed just before the character given by index. Returns an empty string.

More information might be available at the Tcl/Tk entry page.

type Event ¶ added in v0.17.0

type Event struct {
	// Event handlers should set Err on failure.
	Err error
	// Result can be optionally set by the handler. The field is returned by
	// certain methods, for example [TCheckbuttonWidget.Invoke].
	Result string
	// Event source, if any. This field is set when the event handler was
	// created.
	W *Window

	// The window to which the event was reported (the window field from
	// the event). Valid for all event types.  This field is set when the
	// event is handled.
	EventWindow *Window
	// The keysym corresponding to the event, substituted as a textual string.
	// Valid only for Key and KeyRelease events.
	Keysym string
	// The number of the last client request processed by the server (the serial
	// field from the event). Valid for all event types.
	Serial int64
	// The width field from the event. Indicates the new or requested width of the
	// window. Valid only for Configure, ConfigureRequest, Create, ResizeRequest,
	// and Expose events.
	Width string
	// The height field from the event. Valid for the Configure, ConfigureRequest,
	// Create, ResizeRequest, and Expose events. Indicates the new or requested
	// height of the window.
	Height string
	// The x and y fields from the event. For Button, ButtonRelease, Motion, Key,
	// KeyRelease, and MouseWheel events, X and Y indicate the position of the
	// mouse pointer relative to the receiving window. For key events on the
	// Macintosh these are the coordinates of the mouse at the moment when an X11
	// KeyEvent is sent to Tk, which could be slightly later than the time of the
	// physical press or release. For Enter and Leave events, the position where
	// the mouse pointer crossed the window, relative to the receiving window. For
	// Configure and Create requests, the x and y coordinates of the window
	// relative to its parent window.
	X, Y int
	// The x_root and y_root fields from the event. If a virtual-root window
	// manager is being used then the substituted values are the corresponding
	// x-coordinate and y-coordinate in the virtual root. Valid only for Button,
	// ButtonRelease, Enter, Key, KeyRelease, Leave and Motion events. Same meaning
	// as X and Y, except relative to the (virtual) root window.
	XRoot, YRoot int
	// The delta value of a MouseWheel event. The delta value represents
	// the rotation units the mouse wheel has been moved. The sign of the
	// value represents the direction the mouse wheel was scrolled.
	Delta int
	// The state field from the event. For KeyPress, KeyRelease, ButtonPress,
	// ButtonRelease, Enter, Leave, and Motion events, it is a bit field.
	// Visibility events are not currently supported, and the value will be 0.
	State Modifier
	// contains filtered or unexported fields
}

Event communicates information with an event handler. All handlers can use the Err field. Simple handlers, like in

Button(..., Command(func(e *Event) {...}))

can use the 'W' field, if applicable. All other fields are valid only in handlers bound using Bind.

func (*Event) ScrollSet ¶ added in v0.17.0

func (e *Event) ScrollSet(w Widget)

ScrollSet communicates events to scrollbars. Example:

var scroll *TScrollbarWidget
// tcl: text .text -yscrollcommand ".scroll set"
t := Text(..., Yscrollcommand(func(e *Event) { e.ScrollSet(scroll) }))

func (*Event) SetReturnCodeBreak ¶ added in v0.46.0

func (e *Event) SetReturnCodeBreak()

SetReturnCodeBreak sets return code of 'e' to TCL_BREAK.

func (*Event) SetReturnCodeContinue ¶ added in v0.46.0

func (e *Event) SetReturnCodeContinue()

SetReturnCodeContinue sets return code of 'e' to TCL_CONTINUE.

func (*Event) SetReturnCodeError ¶ added in v0.46.0

func (e *Event) SetReturnCodeError()

SetReturnCodeError sets return code of 'e' to TCL_ERROR.

func (*Event) SetReturnCodeOK ¶ added in v0.46.0

func (e *Event) SetReturnCodeOK()

SetReturnCodeOK sets return code of 'e' to TCL_OK.

func (*Event) SetReturnCodeReturn ¶ added in v0.46.0

func (e *Event) SetReturnCodeReturn()

SetReturnCodeReturn sets return code of 'e' to TCL_RETURN.

func (*Event) Xview ¶ added in v0.17.0

func (e *Event) Xview(w Widget)

Xview communicates events to views. Example:

var scroll *TScrollbarWidget
t := Text(...)
// tcl: ttk::scrollbar .scroll -command ".text xview"
scroll = TScrollbar(Command(func(e *Event) { e.Xview(t)}))

func (*Event) Yview ¶ added in v0.17.0

func (e *Event) Yview(w Widget)

Yview communicates events to views. Example:

var scroll *TScrollbarWidget
t := Text(...)
// tcl: ttk::scrollbar .scroll -command ".text yview"
scroll = TScrollbar(Command(func(e *Event) { e.Yview(t)}))

type EventHandler ¶ added in v0.3.0

type EventHandler func(*Event)

EventHandler is the type used by call backs.

type Extension ¶ added in v0.58.0

type Extension interface {
	// Initialize is called to perform any one-time initialization of an extension.
	// The Initialize method of an extension in Extensions can be called multiple
	// times but only the first successful call to Initialize will have any effect.
	Initialize(context ExtensionContext) error
}

Extension handles Tk extensions. When calling Extension methods registered in Extension, the context argument is ignored and an instance is created automatically.

type ExtensionContext ¶ added in v0.58.0

type ExtensionContext interface {
	// Eval evaluates the tcl script.
	Eval(tcl string) (r string, err error)
	// EvalErr is like Eval, but handles errors according to the current value of
	// [ErrorMode].
	EvalErr(tcl string) (r string)
	RegisterWindow(path string) *Window
	Collect(w *Window, options ...any) string
	// Returns a single Tcl string, no braces, except "{}" is returned for s == "".
	TclSafeString(string) string
}

ExtensionContext provides context to Extension methods.

type ExtensionKey ¶ added in v0.58.0

type ExtensionKey struct {
	Type string
	Name string
}

ExtensionKey indexes Extensions

func RegisterExtension ¶ added in v0.58.0

func RegisterExtension(name string, e Extension) (r ExtensionKey, err error)

RegisterExtension registers e.

type FileType ¶ added in v0.4.10

type FileType struct {
	TypeName   string   // Eg. "Go files"
	Extensions []string // Eg. []string{".go"}
	MacType    string   // Eg. "TEXT"
}

FileType specifies a single file type for the Filetypes option.

type FontFace ¶ added in v0.19.3

type FontFace struct {
	// contains filtered or unexported fields
}

FontFace represents a Tk font.

func NewFont ¶ added in v0.5.18

func NewFont(options ...Opt) *FontFace

NewFont — Create and inspect fonts.

Description ¶

Creates a new font.

The following options are supported on all platforms, and are used when creating/specifying a font:

Family name

The case-insensitive font family name. Tk guarantees to support the font families named Courier (a monospaced “typewriter” font), Times (a serifed “newspaper” font), and Helvetica (a sans-serif “European” font). The most closely matching native font family will automatically be substituted when one of the above font families is used. The name may also be the name of a native, platform-specific font family; in that case it will work as desired on one platform but may not display correctly on other platforms. If the family is unspecified or unrecognized, a platform-specific default font will be chosen.

Size size

The desired size of the font. If the size argument is a positive number, it is interpreted as a size in points. If size is a negative number, its absolute value is interpreted as a size in pixels. If a font cannot be displayed at the specified size, a nearby size will be chosen. If size is unspecified or zero, a platform-dependent default size will be chosen.

Sizes should normally be specified in points so the application will remain the same ruler size on the screen, even when changing screen resolutions or moving scripts across platforms. However, specifying pixels is useful in certain circumstances such as when a piece of text must line up with respect to a fixed-size bitmap. The mapping between points and pixels is set when the application starts, based on properties of the installed monitor, but it can be overridden by calling the tk scaling command.

Weight weight

The nominal thickness of the characters in the font. The value normal specifies a normal weight font, while bold specifies a bold font. The closest available weight to the one specified will be chosen. The default weight is normal.

Slant slant

The amount the characters in the font are slanted away from the vertical. Valid values for slant are roman and italic. A roman font is the normal, upright appearance of a font, while an italic font is one that is tilted some number of degrees from upright. The closest available slant to the one specified will be chosen. The default slant is roman.

Underline boolean

The value is a boolean flag that specifies whether characters in this font should be underlined. The default value for underline is false.

Overstrike boolean

The value is a boolean flag that specifies whether a horizontal line should be drawn through the middle of characters in this font. The default value for overstrike is false.

Additional information might be available at the Tcl/Tk font page.

func (*FontFace) Delete ¶ added in v0.19.3

func (f *FontFace) Delete()

Delete — Manipulate fonts.

Description ¶

Delete the font. If there are widgets using the named font, the named font will not actually be deleted until all the instances are released. Those widgets will continue to display using the last known values for the named font. If a deleted named font is subsequently recreated with another call to font create, the widgets will use the new named font and redisplay themselves using the new attributes of that font.

Additional information might be available at the Tcl/Tk font page.

func (*FontFace) MetricsAscent ¶ added in v0.62.2

func (f *FontFace) MetricsAscent(window *Window) int

NewFont — Create and inspect fonts.

Description ¶

Returns the amount in pixels that the tallest letter sticks up above the baseline of the font, plus any extra blank space added by the designer of the font.

Additional information might be available at the Tcl/Tk font page.

func (*FontFace) MetricsDescent ¶ added in v0.62.2

func (f *FontFace) MetricsDescent(window *Window) int

NewFont — Create and inspect fonts.

Description ¶

Returns the largest amount in pixels that any letter sticks down below the baseline of the font, plus any extra blank space added by the designer of the font.

Additional information might be available at the Tcl/Tk font page.

func (*FontFace) MetricsFixed ¶ added in v0.62.2

func (f *FontFace) MetricsFixed(window *Window) bool

NewFont — Create and inspect fonts.

Description ¶

Returns a boolean flag that is true if this is a fixed-width font, where each normal character is the same width as all the other characters, or is false if this is a proportionally-spaced font, where individual characters have different widths. The widths of control characters, tab characters, and other non-printing characters are not included when calculating this value.

Additional information might be available at the Tcl/Tk font page.

func (*FontFace) MetricsLinespace ¶ added in v0.62.2

func (f *FontFace) MetricsLinespace(window *Window) int

NewFont — Create and inspect fonts.

Description ¶

Returns how far apart vertically in pixels two lines of text using the same font should be placed so that none of the characters in one line overlap any of the characters in the other line. This is generally the sum of the ascent above the baseline line plus the descent below the baseline.

Additional information might be available at the Tcl/Tk font page.

func (*FontFace) String ¶ added in v0.19.3

func (f *FontFace) String() string

String implements fmt.Stringer.

type FrameWidget ¶ added in v0.11.0

type FrameWidget struct {
	*Window
}

FrameWidget represents the Tcl/Tk frame widget/window

func Frame ¶ added in v0.2.0

func Frame(options ...Opt) *FrameWidget

Frame — Create and manipulate 'frame' simple container widgets

Description ¶

The frame command creates a new window (given by the pathName argument) and makes it into a frame widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the frame such as its background color and relief. The frame command returns the path name of the new window.

A frame is a simple widget. Its primary purpose is to act as a spacer or container for complex window layouts. The only features of a frame are its background and an optional 3-D border to make the frame appear raised or sunken.

Use Window.Frame to create a Frame with a particular parent.

More information might be available at the Tcl/Tk frame page.

Widget specific options ¶

This option is the same as the standard -background option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background and border. An empty background will disable drawing the background image.

Backgroundimage

This specifies an image to display on the frame's background within the border of the frame (i.e., the image will be clipped by the frame's highlight ring and border, if either are present); subwidgets of the frame will be drawn on top. The image must have been created with the image create command. If specified as the empty string, no image will be displayed.

Class

Specifies a class for the window. This class will be used when querying the option database for the window's other options, and it will also be used later for other purposes such as bindings. The -class option may not be changed with the configure widget command.

Colormap

Specifies a colormap to use for the window. The value may be either new, in which case a new colormap is created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as pathName), in which case the new window will use the colormap from the specified window. If the -colormap option is not specified, the new window uses the same colormap as its parent. This option may not be changed with the configure widget command.

Container

The value must be a boolean. If true, it means that this window will be used as a container in which some other application will be embedded (for example, a Tk toplevel can be embedded using the -use option). The window will support the appropriate window manager protocols for things like geometry requests. The window should not have any children of its own in this application. This option may not be changed with the configure widget command. Note that -borderwidth, -padx and -pady are ignored when configured as a container since a container has no border.

Specifies the desired height for the window in any of the forms acceptable to Tk_GetPixels. If this option is negative or zero then the window will not request any size at all. Note that this sets the total height of the frame, any -borderwidth or similar is not added. Normally -height should not be used if a propagating geometry manager, such as grid or pack, is used within the frame since the geometry manager will override the height of the frame.

Tile

This specifies how to draw the background image (see -backgroundimage) on the frame. If true (according to Tcl_GetBoolean), the image will be tiled to fill the whole frame, with the origin of the first copy of the image being the top left of the interior of the frame. If false (the default), the image will be centered within the frame.

Visual

Specifies visual information for the new window in any of the forms accepted by Tk_GetVisual. If this option is not specified, the new window will use the same visual as its parent. The -visual option may not be modified with the configure widget command.

Specifies the desired width for the window in any of the forms acceptable to Tk_GetPixels. If this option is negative or zero then the window will not request any size at all. Note that this sets the total width of the frame, any -borderwidth or similar is not added. Normally -width should not be used if a propagating geometry manager, such as grid or pack, is used within the frame since the geometry manager will override the width of the frame.

type Img ¶ added in v0.4.10

type Img struct {
	// contains filtered or unexported fields
}

Img represents a Tk image.

func NewBitmap ¶ added in v0.5.18

func NewBitmap(options ...Opt) *Img

Bitmap — Images that display two colors

Description ¶

A bitmap is an image whose pixels can display either of two colors or be transparent. A bitmap image is defined by four things: a background color, a foreground color, and two bitmaps, called the source and the mask. Each of the bitmaps specifies 0/1 values for a rectangular array of pixels, and the two bitmaps must have the same dimensions. For pixels where the mask is zero, the image displays nothing, producing a transparent effect. For other pixels, the image displays the foreground color if the source data is one and the background color if the source data is zero.

Additional information might be available at the Tcl/Tk bitmap page.

Background color

Specifies a background color for the image in any of the standard ways accepted by Tk. If this option is set to an empty string then the background pixels will be transparent. This effect is achieved by using the source bitmap as the mask bitmap, ignoring any -maskdata or -maskfile options.

Data string

Specifies the contents of the source bitmap as a string. The string must adhere to X11 bitmap format (e.g., as generated by the bitmap program). If both the -data and -file options are specified, the -data option takes precedence.

File name

name gives the name of a file whose contents define the source bitmap. The file must adhere to X11 bitmap format (e.g., as generated by the bitmap program).

Foreground color

Specifies a foreground color for the image in any of the standard ways accepted by Tk.

Maskdata string

Specifies the contents of the mask as a string. The string must adhere to X11 bitmap format (e.g., as generated by the bitmap program). If both the -maskdata and -maskfile options are specified, the -maskdata option takes precedence.

Maskfile name

name gives the name of a file whose contents define the mask. The file must adhere to X11 bitmap format (e.g., as generated by the bitmap program).

func NewPhoto ¶ added in v0.5.18

func NewPhoto(options ...Opt) *Img

Photo — Full-color images

A photo is an image whose pixels can display any color with a varying degree of transparency (the alpha channel). A photo image is stored internally in full color (32 bits per pixel), and is displayed using dithering if necessary. Image data for a photo image can be obtained from a file or a string, or it can be supplied from C code through a procedural interface. At present, only PNG, GIF, PPM/PGM, and (read-only) SVG formats are supported, but an interface exists to allow additional image file formats to be added easily. A photo image is (semi)transparent if the image data it was obtained from had transparency information. In regions where no image data has been supplied, it is fully transparent. Transparency may also be modified with the transparency set subcommand.

Data string

Specifies the contents of the image as a string. The string should contain binary data or, for some formats, base64-encoded data (this is currently guaranteed to be supported for PNG and GIF images). The format of the string must be one of those for which there is an image file format handler that will accept string data. If both the -data and -file options are specified, the -file option takes precedence.

Format format-name

Specifies the name of the file format for the data specified with the -data or -file option.

File name

name gives the name of a file that is to be read to supply data for the photo image. The file format must be one of those for which there is an image file format handler that can read data.

Gamma value

Specifies that the colors allocated for displaying this image in a window should be corrected for a non-linear display with the specified gamma exponent value. (The intensity produced by most CRT displays is a power function of the input value, to a good approximation; gamma is the exponent and is typically around 2). The value specified must be greater than zero. The default value is one (no correction). In general, values greater than one will make the image lighter, and values less than one will make it darker.

Height number

Specifies the height of the image, in pixels. This option is useful primarily in situations where the user wishes to build up the contents of the image piece by piece. A value of zero (the default) allows the image to expand or shrink vertically to fit the data stored in it.

Palette palette-spec

Specifies the resolution of the color cube to be allocated for displaying this image, and thus the number of colors used from the colormaps of the windows where it is displayed. The palette-spec string may be either a single decimal number, specifying the number of shades of gray to use, or three decimal numbers separated by slashes (/), specifying the number of shades of red, green and blue to use, respectively. If the first form (a single number) is used, the image will be displayed in monochrome (i.e., grayscale).

Width number

Specifies the width of the image, in pixels. This option is useful primarily in situations where the user wishes to build up the contents of the image piece by piece. A value of zero (the default) allows the image to expand or shrink horizontally to fit the data stored in it.

Additional information might be available at the Tcl/Tk photo page.

func (*Img) Copy ¶ added in v0.20.0

func (m *Img) Copy(src *Img, options ...Opt) (r *Img)

photo — Full-color images

Copies a region from the image called sourceImage (which must be a photo image) to the image called imageName, possibly with pixel zooming and/or subsampling. If no options are specified, this command copies the whole of sourceImage into imageName, starting at coordinates (0,0) in imageName.

The following options may be specified:

From x1 y1 x2 y2

Specifies a rectangular sub-region of the source image to be copied. (x1,y1) and (x2,y2) specify diagonally opposite corners of the rectangle. If x2 and y2 are not specified, the default value is the bottom-right corner of the source image. The pixels copied will include the left and top edges of the specified rectangle but not the bottom or right edges. If the -from option is not given, the default is the whole source image.

To x1 y1 x2 y2

Specifies a rectangular sub-region of the destination image to be affected. (x1,y1) and (x2,y2) specify diagonally opposite corners of the rectangle. If x2 and y2 are not specified, the default value is (x1,y1) plus the size of the source region (after subsampling and zooming, if specified). If x2 and y2 are specified, the source region will be replicated if necessary to fill the destination region in a tiled fashion.

The function returns 'm'.

Additional information might be available at the Tcl/Tk photo page.

func (*Img) Delete ¶ added in v0.31.0

func (m *Img) Delete()

image — Create and manipulate images

Description ¶

Deletes 'm!. If there are instances of the image displayed in widgets, the image will not actually be deleted until all of the instances are released. However, the association between the instances and the image manager will be dropped. Existing instances will retain their sizes but redisplay as empty areas. If a deleted image is recreated with another call to image create, the existing instances will use the new image.

func (*Img) Graph ¶ added in v0.9.1

func (m *Img) Graph(script string) *Img

Graph — use gnuplot to draw on a photo. Graph returns 'm'

The 'script' argument is passed to a gnuplot executable, which must be installed on the machine. See the gnuplot site for documentation about producing graphs. The script must not use the 'set term <device>' command.

The content of 'm' is replaced, including its internal name.

func (*Img) Height ¶ added in v0.9.0

func (m *Img) Height() string

Height — Get the configured option value.

Additional information might be available at the Tcl/Tk photo page.

func (*Img) String ¶ added in v0.5.18

func (m *Img) String() string

String implements fmt.Stringer.

func (*Img) Width ¶ added in v0.9.0

func (m *Img) Width() string

Width — Get the configured option value.

Additional information might be available at the Tcl/Tk photo page.

type LC ¶ added in v0.5.18

type LC struct {
	Line int // 1-based line number within the text content.
	Char int // 0-based char number within the line.
}

LC encodes a text index consisting of a line and char number.

func (LC) String ¶ added in v0.5.18

func (lc LC) String() string

String implements fmt.Stringer.

type LabelWidget ¶ added in v0.11.0

type LabelWidget struct {
	*Window
}

LabelWidget represents the Tcl/Tk label widget/window

func Label ¶ added in v0.2.0

func Label(options ...Opt) *LabelWidget

Label — Create and manipulate 'label' non-interactive text or image widgets

Description ¶

The label command creates a new window (given by the pathName argument) and makes it into a label widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the label such as its colors, font, text, and initial relief. The label command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A label is a widget that displays a textual string, bitmap or image. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines or if wrapping occurs because of the -wraplength option) and one of the characters may optionally be underlined using the The label can be manipulated in a few simple ways, such as changing its relief or text, using the commands described below.

Use Window.Label to create a Label with a particular parent.

More information might be available at the Tcl/Tk label page.

Standard options ¶

Widget specific options ¶

Specifies a desired height for the label. If an image or bitmap is being displayed in the label then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in lines of text. If this option is not specified, the label's desired height is computed from the size of the image or bitmap or text being displayed in it.

Specifies one of three states for the label: normal, active, or disabled. In normal state the button is displayed using the -foreground and -background options. In active state the label is displayed using the -activeforeground and -activebackground options. In the disabled state the -disabledforeground and -background options determine how the button is displayed.

Specifies a desired width for the label. If an image or bitmap is being displayed in the label then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in characters. If this option is not specified, the label's desired width is computed from the size of the image or bitmap or text being displayed in it.

type LabelframeWidget ¶ added in v0.11.0

type LabelframeWidget struct {
	*Window
}

LabelframeWidget represents the Tcl/Tk labelframe widget/window

func Labelframe ¶ added in v0.2.0

func Labelframe(options ...Opt) *LabelframeWidget

Labelframe — Create and manipulate 'labelframe' labelled container widgets

Description ¶

The labelframe command creates a new window (given by the pathName argument) and makes it into a labelframe widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the labelframe such as its background color and relief. The labelframe command returns the path name of the new window.

A labelframe is a simple widget. Its primary purpose is to act as a spacer or container for complex window layouts. It has the features of a frame plus the ability to display a label.

Use Window.Labelframe to create a Labelframe with a particular parent.

More information might be available at the Tcl/Tk labelframe page.

Standard options ¶

Borderwidth
Cursor
Foreground
Highlightbackground
Highlightcolor
Highlightthickness
Padx
Pady
Relief
Takefocus
Txt

Widget specific options ¶

This option is the same as the standard -background option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background and border.

Class

Specifies a class for the window. This class will be used when querying the option database for the window's other options, and it will also be used later for other purposes such as bindings. The -class option may not be changed with the configure widget command.

Colormap

Specifies a colormap to use for the window. The value may be either new, in which case a new colormap is created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as pathName), in which case the new window will use the colormap from the specified window. If the -colormap option is not specified, the new window uses the same colormap as its parent. This option may not be changed with the configure widget command.

Specifies the desired height for the window in any of the forms acceptable to Tk_GetPixels. If this option is negative or zero then the window will not request any size at all.

Labelanchor

Specifies where to place the label. A label is only displayed if the -text option is not the empty string. Valid values for this option are (listing them clockwise) nw, n, ne, en, e, es, se, s,sw, ws, w and wn. The default value is nw.

Labelwidget

Specifies a widget to use as label. This overrides any -text option. The widget must exist before being used as -labelwidget and if it is not a descendant of this window, it will be raised above it in the stacking order.

Visual

Specifies visual information for the new window in any of the forms accepted by Tk_GetVisual. If this option is not specified, the new window will use the same visual as its parent. The -visual option may not be modified with the configure widget command.

Specifies the desired width for the window in any of the forms acceptable to Tk_GetPixels. If this option is negative or zero then the window will not request any size at all.

type ListboxWidget ¶ added in v0.11.0

type ListboxWidget struct {
	*Window
}

ListboxWidget represents the Tcl/Tk listbox widget/window

func Listbox ¶ added in v0.2.0

func Listbox(options ...Opt) *ListboxWidget

Listbox — Create and manipulate 'listbox' item list widgets

Description ¶

The listbox command creates a new window (given by the pathName argument) and makes it into a listbox widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the listbox such as its colors, font, text, and relief. The listbox command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A listbox is a widget that displays a list of strings, one per line. When first created, a new listbox has no elements. Elements may be added or deleted using widget commands described below. In addition, one or more elements may be selected as described below. If a listbox is exporting its selection (see -exportselection option), then it will observe the standard X11 protocols for handling the selection. Listbox selections are available as type STRING; the value of the selection will be the text of the selected elements, with newlines separating the elements.

It is not necessary for all the elements to be displayed in the listbox window at once; commands described below may be used to change the view in the window. Listboxes allow scrolling in both directions using the standard -xscrollcommand and -yscrollcommand options. They also support scanning, as described below.

Use Window.Listbox to create a Listbox with a particular parent.

More information might be available at the Tcl/Tk listbox page.

Standard options ¶

Background
Borderwidth
Cursor
Disabledforeground
Exportselection
Foreground
Highlightbackground
Highlightcolor
Highlightthickness
Justify
Relief
Selectbackground
Selectborderwidth
Selectforeground
Setgrid
Takefocus
Xscrollcommand
Yscrollcommand

Widget specific options ¶

Activestyle

Specifies the style in which to draw the active element. This must be one of dotbox (show a focus ring around the active element), none (no special indication of active element) or underline (underline the active element). The default is underline on Windows, and dotbox elsewhere.

Specifies the desired height for the window, in lines. If zero or less, then the desired height for the window is made just large enough to hold all the elements in the listbox.

Listvariable

Specifies the name of a global variable. The value of the variable is a list to be displayed inside the widget; if the variable value changes then the widget will automatically update itself to reflect the new value. Attempts to assign a variable with an invalid list value to -listvariable will cause an error. Attempts to unset a variable in use as a -listvariable will fail but will not generate an error.

Selectmode

Specifies one of several styles for manipulating the selection. The value of the option may be arbitrary, but the default bindings expect it to be either single, browse, multiple, or extended; the default value is browse.

Specifies one of two states for the listbox: normal or disabled. If the listbox is disabled then items may not be inserted or deleted, items are drawn in the -disabledforeground color, and selection cannot be modified and is not shown (though selection information is retained).

Specifies the desired width for the window in characters. If the font does not have a uniform width then the width of the character is used in translating from character units to screen units. If zero or less, then the desired width for the window is made just large enough to hold all the elements in the listbox.

func (*ListboxWidget) Get ¶ added in v0.60.0

func (w *ListboxWidget) Get(first any, last ...any) (r []string)

listbox — Create and manipulate 'listbox' item list widgets

Description ¶

If last is omitted, returns the contents of the listbox element indicated by first, or an empty string if first refers to a non-existent element. If last is specified, the command returns a list whose elements are all of the listbox elements between first and last, inclusive. Both first and last may have any of the standard forms for indices.

More information might be available at the Tcl/Tk listbox page.

func (*ListboxWidget) Insert ¶ added in v0.60.0

func (w *ListboxWidget) Insert(index any, elements ...any)

listbox — Create and manipulate 'listbox' item list widgets

Description ¶

Inserts zero or more new elements in the list just before the element given by index. If index is specified as end then the new elements are added to the end of the list.

More information might be available at the Tcl/Tk listbox page.

type MenuItem ¶ added in v0.47.0

type MenuItem struct {
	// contains filtered or unexported fields
}

MenuItem represents an entry on a menu.

func (*MenuItem) String ¶ added in v0.47.0

func (m *MenuItem) String() string

String implements fmt.Stringer.

type MenuWidget ¶ added in v0.11.0

type MenuWidget struct {
	*Window
}

MenuWidget represents the Tcl/Tk menu widget/window

func Menu(options ...Opt) *MenuWidget

Menu — Create and manipulate 'menu' widgets and menubars

Use Window.Menu to create a Menu with a particular parent.

More information might be available at the Tcl/Tk menu page.

Activebackground
Activeborderwidth
Activeforeground
Activerelief
Background
Borderwidth
Cursor
Disabledforeground
Foreground
Relief
Takefocus

Postcommand

If this option is specified then it provides a Tcl command to execute each time the menu is posted. The command is invoked by the post widget command before posting the menu. Note that in Tk 8.0 on Macintosh and Windows, all post-commands in a system of menus are executed before any of those menus are posted. This is due to the limitations in the individual platforms' menu managers.

Selectcolor

For menu entries that are check buttons or radio buttons, this option specifies the color to display in the indicator when the check button or radio button is selected.

Tearoff

This option must have a proper boolean value (default is false), which specifies whether or not the menu should include a tear-off entry at the top. If so, it will exist as entry 0 of the menu and the other entries will number starting at 1. The default menu bindings arrange for the menu to be torn off when the tear-off entry is invoked. This option is ignored under Aqua/MacOS, where menus cannot be torn off.

Tearoffcommand

If this option has a non-empty value, then it specifies a Tcl command to invoke whenever the menu is torn off. The actual command will consist of the value of this option, followed by a space, followed by the name of the menu window, followed by a space, followed by the name of the name of the torn off menu window. For example, if the option's value is and menu .x.y is torn off to create a new menu .x.tearoff1, then the command will be invoked. This option is ignored under Aqua/MacOS, where menus cannot be torn off.

Title

The string will be used to title the window created when this menu is torn off. If the title is NULL, then the window will have the title of the menubutton or the text of the cascade item from which this menu was invoked.

Type

This option can be one of menubar, tearoff, or normal, and is set when the menu is created. While the string returned by the configuration database will change if this option is changed, this does not affect the menu widget's behavior. This is used by the cloning mechanism and is not normally set outside of the Tk library.

func (*MenuWidget) AddCascade ¶ added in v0.15.0

func (w *MenuWidget) AddCascade(options ...Opt) *MenuItem

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

Add a new cascade entry to the end of the menu.

Additional information might be available at the Tcl/Tk menu page.

func (*MenuWidget) AddCheckbutton ¶ added in v0.41.0

func (w *MenuWidget) AddCheckbutton(options ...Opt) *MenuItem

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

Add a new checkbutton entry to the bottom of the menu.

Additional information might be available at the Tcl/Tk menu page.

func (*MenuWidget) AddCommand ¶ added in v0.15.0

func (w *MenuWidget) AddCommand(options ...Opt) *MenuItem

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

Add a new command entry to the bottom of the menu.

Additional information might be available at the Tcl/Tk menu page.

func (*MenuWidget) AddRadiobutton ¶ added in v0.41.0

func (w *MenuWidget) AddRadiobutton(options ...Opt) *MenuItem

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

Add a new radiobutton entry to the bottom of the menu.

Additional information might be available at the Tcl/Tk menu page.

func (*MenuWidget) AddSeparator ¶ added in v0.15.0

func (w *MenuWidget) AddSeparator(options ...Opt) *MenuItem

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

Add a new separator entry to the bottom of the menu.

Additional information might be available at the Tcl/Tk menu page.

func (*MenuWidget) EntryConfigure ¶ added in v0.47.0

func (w *MenuWidget) EntryConfigure(index uint, options ...Opt)

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

This command is similar to the configure command, except that it applies to the options for an individual entry, whereas configure applies to the options for the menu as a whole. Options may have any of the values described in the MENU ENTRY OPTIONS section below. If options are specified, options are modified as indicated in the command and the command returns an empty string. If no options are specified, returns a list describing the current options for entry index (see Tk_ConfigureInfo for information on the format of this list).

Additional information might be available at the Tcl/Tk menu page.

func (*MenuWidget) Invoke ¶ added in v0.15.0

func (w *MenuWidget) Invoke(index uint)

Menu — Create and manipulate 'menu' widgets and menubars

Description ¶

Invoke the action of the menu entry. See the sections on the individual entries above for details on what happens. If the menu entry is disabled then nothing happens. If the entry has a command associated with it then the result of that command is returned as the result of the invoke widget command. Otherwise the result is an empty string. Note: invoking a menu entry does not automatically unpost the menu; the default bindings normally take care of this before invoking the invoke widget command.

Additional information might be available at the Tcl/Tk menu page.

type MenubuttonWidget ¶ added in v0.11.0

type MenubuttonWidget struct {
	*Window
}

MenubuttonWidget represents the Tcl/Tk menubutton widget/window

func Menubutton ¶ added in v0.2.0

func Menubutton(options ...Opt) *MenubuttonWidget

Menubutton — Create and manipulate 'menubutton' pop-up menu indicator widgets

Use Window.Menubutton to create a Menubutton with a particular parent.

More information might be available at the Tcl/Tk menubutton page.

Standard options ¶

Widget specific options ¶

Direction

Specifies where the menu is going to be popup up. above tries to pop the menu above the menubutton. below tries to pop the menu below the menubutton. left tries to pop the menu to the left of the menubutton. right tries to pop the menu to the right of the menu button. flush pops the menu directly over the menubutton. In the case of above or below, the direction will be reversed if the menu would show offscreen.

Specifies a desired height for the menubutton. If an image or bitmap is being displayed in the menubutton then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in lines of text. If this option is not specified, the menubutton's desired height is computed from the size of the image or bitmap or text being displayed in it.

Indicatoron

The value must be a proper boolean value. If it is true then a small indicator rectangle will be displayed on the right side of the menubutton and the default menu bindings will treat this as an option menubutton. If false then no indicator will be displayed.

Mnu

Specifies the path name of the menu associated with this menubutton. The menu must be a child of the menubutton.

Specifies one of three states for the menubutton: normal, active, or disabled. In normal state the menubutton is displayed using the foreground and background options. The active state is typically used when the pointer is over the menubutton. In active state the menubutton is displayed using the -activeforeground and -activebackground options. Disabled state means that the menubutton should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. In this state the -disabledforeground and -background options determine how the button is displayed.

Specifies a desired width for the menubutton. If an image or bitmap is being displayed in the menubutton then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in characters. If this option is not specified, the menubutton's desired width is computed from the size of the image or bitmap or text being displayed in it.

type MessageWidget ¶ added in v0.11.0

type MessageWidget struct {
	*Window
}

MessageWidget represents the Tcl/Tk message widget/window

func Message ¶ added in v0.2.0

func Message(options ...Opt) *MessageWidget

Message — Create and manipulate 'message' non-interactive text widgets

Description ¶

The message command creates a new window (given by the pathName argument) and makes it into a message widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the message such as its colors, font, text, and initial relief. The message command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A message is a widget that displays a textual string. A message widget has three special features that differentiate it from a label widget. First, it breaks up its string into lines in order to produce a given aspect ratio for the window. The line breaks are chosen at word boundaries wherever possible (if not even a single word would fit on a line, then the word will be split across lines). Newline characters in the string will force line breaks; they can be used, for example, to leave blank lines in the display.

The second feature of a message widget is justification. The text may be displayed left-justified (each line starts at the left side of the window), centered on a line-by-line basis, or right-justified (each line ends at the right side of the window).

The third feature of a message widget is that it handles control characters and non-printing characters specially. Tab characters are replaced with enough blank space to line up on the next 8-character boundary. Newlines cause line breaks. Other control characters (ASCII code less than 0x20) and characters not defined in the font are displayed as a four-character sequence \exhh where hh is the two-digit hexadecimal number corresponding to the character. In the unusual case where the font does not contain all of the characters in 0123456789abcdef\ex then control characters and undefined characters are not displayed at all.

Use Window.Message to create a Message with a particular parent.

More information might be available at the Tcl/Tk message page.

Standard options ¶

Anchor
Background
Borderwidth
Cursor
Foreground
Highlightbackground
Highlightcolor
Highlightthickness
Padx
Pady
Relief
Takefocus
Textvariable
Txt

Widget specific options ¶

Aspect

Specifies a non-negative integer value indicating desired aspect ratio for the text. The aspect ratio is specified as 100*width/height. 100 means the text should be as wide as it is tall, 200 means the text should be twice as wide as it is tall, 50 means the text should be twice as tall as it is wide, and so on. Used to choose line length for text if -width option is not specified. Defaults to 150.

Justify

Specifies how to justify lines of text. Must be one of left, center, or right. Defaults to left. This option works together with the -anchor, -aspect, -padx, -pady, and -width options to provide a variety of arrangements of the text within the window. The -aspect and -width options determine the amount of screen space needed to display the text. The -anchor, -padx, and -pady options determine where this rectangular area is displayed within the widget's window, and the -justify option determines how each line is displayed within that rectangular region. For example, suppose -anchor is e and -justify is left, and that the message window is much larger than needed for the text. The text will be displayed so that the left edges of all the lines line up and the right edge of the longest line is -padx from the right side of the window; the entire text block will be centered in the vertical span of the window.

Specifies the length of lines in the window. The value may have any of the forms acceptable to Tk_GetPixels. If this option has a value greater than zero then the -aspect option is ignored and the -width option determines the line length. If this option value is negative or zero, then the -aspect option determines the line length.

type Modifier ¶ added in v0.62.1

type Modifier int

Modifier is a bit field representing 0 or more modifiers.

const (
	ModifierNone  Modifier = 0
	ModifierShift Modifier = 1 << (iota - 1)
	ModifierLock
	ModifierControl
	ModifierMod1
	ModifierMod2
	ModifierMod3
	ModifierMod4
	ModifierMod5
	ModifierButton1
	ModifierButton2
	ModifierButton3
	ModifierButton4
	ModifierButton5

	ModifierAlt     = ModifierMod1
	ModifierNumlock = ModifierMod2
	ModifierWindows = ModifierMod4
	ModifierSuper   = ModifierMod4
)

func (Modifier) String ¶ added in v0.62.1

func (mods Modifier) String() string

type Opt ¶ added in v0.2.0

type Opt interface {
	// contains filtered or unexported methods
}

Opt represents an optional argument.

func Accelerator ¶ added in v0.4.10

func Accelerator(val any) Opt

Accelerator option.

Known uses:

MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)

func Activebackground ¶ added in v0.2.0

func Activebackground(val any) Opt

Activebackground option.

Specifies background color to use when drawing active elements. An element (a widget or portion of a widget) is active if the mouse cursor is positioned over the element and pressing a mouse button will cause some action to occur. If strict Motif compliance has been requested by setting the tk_strictMotif variable, this option will normally be ignored; the normal background color will be used instead. For some elements on Windows and Macintosh systems, the active color will only be used while mouse button 1 is pressed over the element.

Known uses:

Button
Checkbutton
Label
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menu
Menubutton
Radiobutton
Scale
Scrollbar
Spinbox

func Activebitmap ¶ added in v0.4.12

func Activebitmap(bitmap any) Opt

Activebitmap option.

This option specify the bitmap to display in the item in its active state. Bitmap may have any of the forms accepted by Tk_GetBitmap.

Known uses:

CanvasWidget.CreateBitmap (widget specific)

func Activeborderwidth ¶ added in v0.2.0

func Activeborderwidth(val any) Opt

Activeborderwidth option.

Specifies a non-negative value indicating the width of the 3-D border drawn around active elements. See above for definition of active elements. The value may have any of the forms acceptable to Tk_GetPixels. This option is typically only available in widgets displaying more than one element at a time (e.g. menus but not buttons).

Known uses:

Menu

func Activedash ¶ added in v0.4.12

func Activedash(pattern ...int) Opt

Activedash option.

This option specifies the dash pattern for the active state of an item. If the dash option is omitted then the default is a solid outline.

Many items support the notion of a dash pattern for outlines. The syntax is a list of integers. Each element represents the number of pixels of a line segment. Only the odd segments are drawn using the “outline” color. The other segments are drawn transparent.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Activefill ¶ added in v0.4.12

func Activefill(color any) Opt

Activefill option.

This option specifies the color to be used to fill item's area in its active state. The even-odd fill rule is used. Color may have any of the forms accepted by Tk_GetColor. For the line item, it specifies the color of the line drawn. For the text item, it specifies the foreground color of the text. If color is an empty string (the default for all canvas items except line and text), then the item will not be filled.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Activeforeground ¶ added in v0.2.0

func Activeforeground(val any) Opt

Activeforeground option.

Specifies foreground color to use when drawing active elements. See above for definition of active elements.

Known uses:

Button
Checkbutton
Label
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menu
Menubutton
Radiobutton

func Activeimage ¶ added in v0.4.12

func Activeimage(val any) Opt

Activeimage option.

Specifies the name of the image to display in the item in its active state. This image must have been created previously with the image create command.

Known uses:

CanvasWidget.CreateImage (widget specific)

func Activeoutline ¶ added in v0.4.12

func Activeoutline(color any) Opt

Activeoutline option.

This option specifies the color that should be used to draw the outline of the item in its active state. Color may have any of the forms accepted by Tk_GetColor. If color is specified as an empty string then no outline is drawn for the item.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Activeoutlinestipple ¶ added in v0.4.12

func Activeoutlinestipple(bitmap any) Opt

Activeoutlinestipple option.

This option specifies the stipple pattern that should be used to draw the outline of the item in its active state. Indicates that the outline for the item should be drawn with a stipple pattern; bitmap specifies the stipple pattern to use, in any of the forms accepted by Tk_GetBitmap. If the -outline option has not been specified then this option has no effect. If bitmap is an empty string (the default), then the outline is drawn in a solid fashion. Note that stipples are not well supported on platforms that do not use X11 as their drawing API.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Activerelief ¶ added in v0.2.0

func Activerelief(val any) Opt

Activerelief option.

Specifies the 3-D effect desired for the active item of the widget. See the -relief option for details.

Known uses:

Menu
Scrollbar (widget specific)

func Activestipple ¶ added in v0.4.12

func Activestipple(bitmap any) Opt

Activestipple option.

This option specifies the stipple patterns that should be used to fill the item in its active state. bitmap specifies the stipple pattern to use, in any of the forms accepted by Tk_GetBitmap. If the -fill option has not been specified then this option has no effect. If bitmap is an empty string (the default), then filling is done in a solid fashion. For the text item, it affects the actual text. Note that stipples are not well supported on platforms that do not use X11 as their drawing API.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Activestyle ¶ added in v0.3.0

func Activestyle(val any) Opt

Activestyle option.

Known uses:

Listbox (widget specific)

func Activewidth ¶ added in v0.4.12

func Activewidth(outlineWidth any) Opt

Activewidth option.

This option specifies the width of the outline to be drawn around the item's region, in its active state. outlineWidth may be in any of the forms described in the COORDINATES section above. If the -outline option has been specified as an empty string then this option has no effect. This option defaults to 1.0. For arcs, wide outlines will be drawn centered on the edges of the arc's region.

Known uses:

CanvasWidget.CreateArc (widget specific)

func After ¶ added in v0.4.10

func After(val any) Opt

After option.

Known uses:

Pack (command specific)

func Align ¶ added in v0.4.10

func Align(val any) Opt

Align option.

Known uses:

Text (widget specific, applies to embedded images)

func Anchor ¶ added in v0.2.0

func Anchor(val any) Opt

Anchor option.

Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Must be one of the values n, ne, e, se, s, sw, w, nw, or center. For example, nw means display the information such that its top-left corner is at the top-left corner of the widget.

Known uses:

Button
Checkbutton
Label
Menubutton
Message
Pack (command specific)
Place (command specific)
Radiobutton
TLabel
TProgressbar

func Angle ¶ added in v0.4.10

func Angle(rotationDegrees any) Opt

Angle option.

RotationDegrees tells how many degrees to rotate the text anticlockwise about the positioning point for the text; it may have any floating-point value from 0.0 to 360.0. For example, if rotationDegrees is 90, then the text will be drawn vertically from bottom to top. This option defaults to 0.0.

Known uses:

CanvasWidget.CreateText (widget specific)

func Arrowcolor ¶ added in v0.25.1

func Arrowcolor(val any) Opt

Arrowcolor — Styling widgets

Arrowcolor is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Arrowshape ¶ added in v0.4.10

func Arrowshape(a, b, c any) Opt

Arrowshape option.

This option indicates how to draw arrowheads. The shape argument must be a list with three elements, each specifying a distance in any of the forms described in the COORDINATES section above. The first element of the list gives the distance along the line from the neck of the arrowhead to its tip. The second element gives the distance along the line from the trailing points of the arrowhead to the tip, and the third element gives the distance from the outside edge of the line to the trailing points. If this option is not specified then Tk picks a “reasonable” shape.

Known uses:

CanvasWidget.CreateLine (widget specific)

func Arrowsize ¶ added in v0.25.1

func Arrowsize(val any) Opt

Arrowsize — Styling widgets

Arrowsize is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Aspect ¶ added in v0.3.0

func Aspect(val any) Opt

Aspect option.

Known uses:

Message (widget specific)

func Autoseparators ¶ added in v0.3.0

func Autoseparators(val any) Opt

Autoseparators option.

Known uses:

Text (widget specific)

func Background ¶ added in v0.2.0

func Background(val any) Opt

Background option.

Specifies the normal background color to use when displaying the widget.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame (widget specific)
Label
Labelframe (widget specific)
Listbox
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menu
Menubutton
Message
NewBitmap (command specific)
Panedwindow
Radiobutton
Scale
Scrollbar
Spinbox
TLabel (widget specific)
TextWidget.TagConfigure (command specific)
Text
Toplevel (widget specific)

func Backgroundimage ¶ added in v0.3.0

func Backgroundimage(val any) Opt

Backgroundimage option.

Known uses:

Frame (widget specific)
Toplevel (widget specific)

func Backward ¶ added in v0.44.0

func Backward() Opt

Backward option.

Known uses:

Text (widget specific, applies to Search)

func Before ¶ added in v0.4.10

func Before(val any) Opt

Before option.

Known uses:

Pack (command specific)

func Bgstipple ¶ added in v0.4.10

func Bgstipple(val any) Opt

Bgstipple option.

Known uses:

TextWidget.TagConfigure (command specific)

func Bigincrement ¶ added in v0.3.0

func Bigincrement(val any) Opt

Bigincrement option.

Known uses:

Scale (widget specific)

func Bitmap ¶ added in v0.2.0

func Bitmap(val any) Opt

Bitmap option.

Specifies a bitmap to display in the widget, in any of the forms acceptable to Tk_GetBitmap. The exact way in which the bitmap is displayed may be affected by other options such as -anchor or -justify. Typically, if this option is specified then it overrides other options that specify a textual value to display in the widget but this is controlled by the -compound option; the -bitmap option may be reset to an empty string to re-enable a text display. In widgets that support both -bitmap and -image options, -image will usually override -bitmap.

Known uses:

Button
Checkbutton
Label
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton
Radiobutton

func Blockcursor ¶ added in v0.3.0

func Blockcursor(val any) Opt

Blockcursor option.

Known uses:

Text (widget specific)

func Border ¶ added in v0.4.10

func Border(val any) Opt

Border option.

Known uses:

StyleLayout

func Bordercolor ¶ added in v0.25.1

func Bordercolor(val any) Opt

Bordercolor — Styling widgets

Bordercolor is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Bordermode ¶ added in v0.4.10

func Bordermode(val any) Opt

Bordermode option.

Known uses:

Place (command specific)

func Borderwidth ¶ added in v0.2.0

func Borderwidth(val any) Opt

Borderwidth option.

Specifies a non-negative value indicating the width of the 3-D border to draw around the outside of the widget (if such a border is being drawn; the -relief option typically determines this). The value may also be used when drawing 3-D effects in the interior of the widget. The value may have any of the forms acceptable to Tk_GetPixels.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame
Label
Labelframe
Listbox
Menu
Menubutton
Message
Panedwindow
Radiobutton
Scale
Scrollbar
Spinbox
TFrame (widget specific)
TextWidget.TagConfigure (command specific)
Text
Toplevel

func Buttonbackground ¶ added in v0.3.0

func Buttonbackground(val any) Opt

Buttonbackground option.

Known uses:

Spinbox (widget specific)

func Buttoncursor ¶ added in v0.3.0

func Buttoncursor(val any) Opt

Buttoncursor option.

Known uses:

Spinbox (widget specific)

func Buttondownrelief ¶ added in v0.3.0

func Buttondownrelief(val any) Opt

Buttondownrelief option.

Known uses:

Spinbox (widget specific)

func Buttonuprelief ¶ added in v0.3.0

func Buttonuprelief(val any) Opt

Buttonuprelief option.

Known uses:

Spinbox (widget specific)

func Capstyle ¶ added in v0.4.10

func Capstyle(style any) Opt

Capstyle option.

Specifies the ways in which caps are to be drawn at the endpoints of the line. Style may have any of the forms accepted by Tk_GetCapStyle (butt, projecting, or round). If this option is not specified then it defaults to butt. Where arrowheads are drawn the cap style is ignored.

Known uses:

CanvasWidget.CreateLine (widget specific)

func Chars ¶ added in v0.48.0

func Chars() Opt

Chars option.

Known uses:

TextWidget (command specific)

func Children ¶ added in v0.4.10

func Children(list ...any) Opt

Children option.

Known uses:

StyleLayout

Children describes children of a style layout.

func Class ¶ added in v0.3.0

func Class(val any) Opt

Class option.

Specifies the window class. The class is used when querying the option database for the window's other options, to determine the default bindtags for the window, and to select the widget's default layout and style. This is a read-only option: it may only be specified when the window is created, and may not be changed with the configure widget command.

Known uses:

Frame (widget specific)
Labelframe (widget specific)
TButton
TCheckbutton
TCombobox
TEntry
TFrame
TLabel
TLabelframe
TMenubutton
TNotebook
TPanedwindow
TProgressbar
TRadiobutton
TScale
TScrollbar
TSeparator
TSizegrip
TSpinbox
TTreeview
Toplevel (widget specific)

func Closeenough ¶ added in v0.3.0

func Closeenough(val any) Opt

Closeenough option.

Known uses:

Canvas (widget specific)

func Colormap ¶ added in v0.3.0

func Colormap(val any) Opt

Colormap option.

Known uses:

Frame (widget specific)
Labelframe (widget specific)
Toplevel (widget specific)

func Column ¶ added in v0.4.10

func Column(val any) Opt

Column option.

Known uses:

Grid (command specific)

func Columnbreak ¶ added in v0.4.10

func Columnbreak(val any) Opt

Columnbreak option.

Known uses:

MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)

func Columns ¶ added in v0.3.0

func Columns(val any) Opt

Columns option.

Known uses:

TTreeview (widget specific)

func Columnseparatorwidth ¶ added in v0.25.1

func Columnseparatorwidth(val any) Opt

Columnseparatorwidth — Styling widgets

Columnseparatorwidth is a styling option of a ttk::treeview. More information might be available at the Tcl/Tk ttk_treeview page.

func Columnspan ¶ added in v0.4.10

func Columnspan(val any) Opt

Columnspan option.

Known uses:

Grid (command specific)

func Command ¶ added in v0.3.0

func Command(handler any) Opt

Command option.

See also Event handlers.

Known uses:

Button (widget specific)
Checkbutton (widget specific)
Fontchooser (command specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
MessageBox (command specific)
Radiobutton (widget specific)
Scale (widget specific)
Scrollbar (widget specific)
Spinbox (widget specific)
TButton (widget specific)
TCheckbutton (widget specific)
TRadiobutton (widget specific)
TScale (widget specific)
TScrollbar (widget specific)
TSpinbox (widget specific)

func Compound ¶ added in v0.2.0

func Compound(val any) Opt

Compound option.

Specifies if the widget should display text and bitmaps/images at the same time, and if so, where the bitmap/image should be placed relative to the text. Must be one of the values none, bottom, top, left, right, or center. For example, the (default) value none specifies that the bitmap or image should (if defined) be displayed instead of the text, the value left specifies that the bitmap or image should be displayed to the left of the text, and the value center specifies that the bitmap or image should be displayed on top of the text.

Known uses:

Button
Checkbutton
Label
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton
Radiobutton
TButton
TCheckbutton
TLabel
TMenubutton
TRadiobutton

func Confine ¶ added in v0.3.0

func Confine(val any) Opt

Confine option.

Known uses:

Canvas (widget specific)

func Confirmoverwrite ¶ added in v0.4.10

func Confirmoverwrite(val any) Opt

Confirmoverwrite option.

Known uses:

GetSaveFile (command specific)

func Container ¶ added in v0.3.0

func Container(val any) Opt

Container option.

Known uses:

Frame (widget specific)
Toplevel (widget specific)

func Cursor ¶ added in v0.2.0

func Cursor(val any) Opt

Cursor option.

Specifies the mouse cursor to be used for the widget. The value may have any of the forms acceptable to Tk_GetCursor. In addition, if an empty string is specified, it indicates that the widget should defer to its parent for cursor specification.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame
Label
Labelframe
Listbox
Menu
Menubutton
Message
Panedwindow
Radiobutton
Scale
Scrollbar
Spinbox
TButton
TCheckbutton
TCombobox
TEntry
TFrame
TLabel
TLabelframe
TMenubutton
TNotebook
TPanedwindow
TProgressbar
TRadiobutton
TScale
TScrollbar
TSeparator
TSizegrip
TSpinbox
TTreeview
Text
Toplevel
Window.Busy (command specific)

func Darkcolor ¶ added in v0.25.1

func Darkcolor(val any) Opt

Darkcolor — Styling widgets

Darkcolor is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Dash ¶ added in v0.4.12

func Dash(pattern ...int) Opt

Dash option.

This option specifies the dash pattern for the normal state of an item. If the dash option is omitted then the default is a solid outline.

Many items support the notion of a dash pattern for outlines. The syntax is a list of integers. Each element represents the number of pixels of a line segment. Only the odd segments are drawn using the “outline” color. The other segments are drawn transparent.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Dashoffset ¶ added in v0.4.10

func Dashoffset(offset any) Opt

Dashoffset option.

The starting offset in pixels into the pattern provided by the -dash option. -dashoffset is ignored if there is no -dash pattern.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Data ¶ added in v0.4.10

func Data(val any) Opt

Data option.

Known uses:

NewBitmap (command specific)
NewPhoto (command specific)

func Default ¶ added in v0.3.0

func Default(val any) Opt

Default option.

Known uses:

Button (widget specific)
MessageBox (command specific)
TButton (widget specific)

func DefaultIcon ¶ added in v0.56.1

func DefaultIcon(val ...any) Opt

DefaultIcon option.

Known uses:

[IconPhoto] (command specific)

func Defaultextension ¶ added in v0.4.10

func Defaultextension(val any) Opt

Defaultextension option.

Known uses:

GetOpenFile (command specific)
GetSaveFile (command specific)

func Detail ¶ added in v0.4.10

func Detail(val any) Opt

Detail option.

Known uses:

MessageBox (command specific)

func Digits ¶ added in v0.3.0

func Digits(val any) Opt

Digits option.

Known uses:

Scale (widget specific)

func Direction ¶ added in v0.3.0

func Direction(val any) Opt

Direction option.

Known uses:

Menubutton (widget specific)
TMenubutton (widget specific)

func Disabledbackground ¶ added in v0.3.0

func Disabledbackground(val any) Opt

Disabledbackground option.

Known uses:

Entry (widget specific)
Spinbox (widget specific)

func Disabledbitmap ¶ added in v0.4.10

func Disabledbitmap(bitmap any) Opt

Disabledbitmap option.

This option specify the bitmap to display in the item in its disabled state. Bitmap may have any of the forms accepted by Tk_GetBitmap.

Known uses:

CanvasWidget.CreateBitmap (widget specific)

func Disableddash ¶ added in v0.4.10

func Disableddash(pattern ...int) Opt

Disableddash option.

This option specifies the dash pattern for the disabled state of an item. If the dash option is omitted then the default is a solid outline.

Many items support the notion of a dash pattern for outlines. The syntax is a list of integers. Each element represents the number of pixels of a line segment. Only the odd segments are drawn using the “outline” color. The other segments are drawn transparent.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Disabledfill ¶ added in v0.4.10

func Disabledfill(color any) Opt

Disabledfill option.

This option specifies the color to be used to fill item's area in its disabled state. The even-odd fill rule is used. Color may have any of the forms accepted by Tk_GetColor. For the line item, it specifies the color of the line drawn. For the text item, it specifies the foreground color of the text. If color is an empty string (the default for all canvas items except line and text), then the item will not be filled.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Disabledforeground ¶ added in v0.2.0

func Disabledforeground(val any) Opt

Disabledforeground option.

Specifies foreground color to use when drawing a disabled element. If the option is specified as an empty string (which is typically the case on monochrome displays), disabled elements are drawn with the normal foreground color but they are dimmed by drawing them with a stippled fill pattern.

Known uses:

Button
Checkbutton
Entry (widget specific)
Label
Listbox
Menu
Menubutton
Radiobutton
Spinbox (widget specific)

func Disabledimage ¶ added in v0.4.10

func Disabledimage(val any) Opt

Disabledimage option.

Specifies the name of the image to display in the item in its disabled state. This image must have been created previously with the image create command.

Known uses:

CanvasWidget.CreateImage (widget specific)

func Disabledoutline ¶ added in v0.4.10

func Disabledoutline(color any) Opt

Disabledline option.

This option specifies the color that should be used to draw the outline of the item in its disabled state. Color may have any of the forms accepted by Tk_GetColor. If color is specified as an empty string then no outline is drawn for the item.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Disabledoutlinestipple ¶ added in v0.4.10

func Disabledoutlinestipple(bitmap any) Opt

Disabledoutlinestipple option.

This option specifies the stipple pattern that should be used to draw the outline of the item in its disabled state. Indicates that the outline for the item should be drawn with a stipple pattern; bitmap specifies the stipple pattern to use, in any of the forms accepted by Tk_GetBitmap. If the -outline option has not been specified then this option has no effect. If bitmap is an empty string (the default), then the outline is drawn in a solid fashion. Note that stipples are not well supported on platforms that do not use X11 as their drawing API.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Disabledstipple ¶ added in v0.4.10

func Disabledstipple(bitmap any) Opt

Disabledstipple option.

This option specifies the stipple patterns that should be used to fill the item in its disabled state. bitmap specifies the stipple pattern to use, in any of the forms accepted by Tk_GetBitmap. If the -fill option has not been specified then this option has no effect. If bitmap is an empty string (the default), then filling is done in a solid fashion. For the text item, it affects the actual text. Note that stipples are not well supported on platforms that do not use X11 as their drawing API.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Disabledwidth ¶ added in v0.4.10

func Disabledwidth(outlineWidth any) Opt

Disabledwidth option.

This option specifies the width of the outline to be drawn around the item's region, in its disabled state. outlineWidth may be in any of the forms described in the COORDINATES section above. If the -outline option has been specified as an empty string then this option has no effect. This option defaults to 1.0. For arcs, wide outlines will be drawn centered on the edges of the arc's region.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Displaychars ¶ added in v0.48.0

func Displaychars() Opt

Displaychars option.

Known uses:

TextWidget (command specific)

func Displaycolumns ¶ added in v0.3.0

func Displaycolumns(val any) Opt

Displaycolumns option.

Known uses:

TTreeview (widget specific)

func Displayindices ¶ added in v0.48.0

func Displayindices() Opt

Displayindices option.

Known uses:

TextWidget (command specific)

func Displaylines ¶ added in v0.48.0

func Displaylines() Opt

Displaylines option.

Known uses:

TextWidget (command specific)

func Displayof ¶ added in v0.4.8

func Displayof(val any) Opt

Displayof option.

Known uses:

Bell (command specific)
ClipboardAppend (command specific)
ClipboardClear (command specific)
ClipboardGet (command specific)
Focus (command specific)
FontFamilies (command specific)

func Elementborderwidth ¶ added in v0.3.0

func Elementborderwidth(val any) Opt

Elementborderwidth option.

Known uses:

Scrollbar (widget specific)

func Elide ¶ added in v0.4.10

func Elide(val any) Opt

Elide option.

Known uses:

TextWidget.TagConfigure (command specific)

func Endline ¶ added in v0.3.0

func Endline(val any) Opt

Endline option.

Known uses:

Text (widget specific)

func ExitHandler ¶ added in v0.5.18

func ExitHandler() Opt

ExitHandler returns a canned Command that destroys the App.

func Expand ¶ added in v0.4.10

func Expand(val any) Opt

Expand option.

Known uses:

Pack (command specific)

func Exportselection ¶ added in v0.2.0

func Exportselection(val any) Opt

Exportselection option.

Specifies whether or not a selection in the widget should also be the X selection. The value may have any of the forms accepted by Tcl_GetBoolean, such as true, false, 0, 1, yes, or no. If the selection is exported, then selecting in the widget deselects the current X selection, selecting outside the widget deselects any widget selection, and the widget will respond to selection retrieval requests when it has a selection. The default is usually for widgets to export selections.

Known uses:

Entry
Listbox
Spinbox
TCombobox (widget specific)
TEntry (widget specific)
Text

func Extent ¶ added in v0.4.10

func Extent(degrees any) Opt

Extent option.

Specifies the size of the angular range occupied by the arc. The arc's range extends for degrees degrees counter-clockwise from the starting angle given by the -start option. Degrees may be negative. If it is greater than 360 or less than -360, then degrees modulo 360 is used as the extent.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Family ¶ added in v0.4.10

func Family(val any) Opt

Family option.

Known uses:

NewFont (command specific)

func Fgstipple ¶ added in v0.4.10

func Fgstipple(val any) Opt

Fgstipple option.

Known uses:

TextWidget.TagConfigure (command specific)

func Fieldbackground ¶ added in v0.25.1

func Fieldbackground(val any) Opt

Fieldbackground — Styling widgets

Fieldbackground is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func File ¶ added in v0.4.10

func File(val any) Opt

File option.

Known uses:

NewBitmap (command specific)
NewPhoto (command specific)

func Filetypes ¶ added in v0.4.10

func Filetypes(val any) Opt

Filetypes option.

Known uses:

GetOpenFile (command specific)
GetSaveFile (command specific)

func Fill ¶ added in v0.4.10

func Fill(val any) Opt

Fill option.

Known uses:

Pack (command specific)

func Focuscolor ¶ added in v0.29.0

func Focuscolor(val any) Opt

Focuscolor option.

Known uses:

StyleConfigure

func Focusfill ¶ added in v0.25.1

func Focusfill(val any) Opt

Focusfill — Styling widgets

Focusfill is a styling option of a ttk::combobox. More information might be available at the Tcl/Tk ttk_combobox page.

func Focussolid ¶ added in v0.29.0

func Focussolid(val any) Opt

Focussolid option.

Known uses:

StyleConfigure

func Focusthickness ¶ added in v0.29.0

func Focusthickness(val any) Opt

Focusthickness option.

Known uses:

StyleConfigure

func Font ¶ added in v0.2.0

func Font(list ...any) Opt

Font option.

Specifies the font to use when drawing text inside the widget. The value may have any of the forms described in the font manual page under FONT DESCRIPTION.

Known uses:

Button
Checkbutton
Entry
Fontchooser (command specific)
Label
Labelframe
Listbox
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menu
Menubutton
Message
Radiobutton
Scale
Spinbox
TEntry
TLabel
TProgressbar
TextWidget.TagConfigure (command specific)
Text

func Force ¶ added in v0.5.18

func Force(val any) Opt

Force option.

Known uses:

Focus (command specific)

func Foreground ¶ added in v0.2.0

func Foreground(val any) Opt

Foreground option.

Specifies the normal foreground color to use when displaying the widget.

Known uses:

Button
Checkbutton
Entry
Label
Labelframe
Listbox
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menu
Menubutton
Message
NewBitmap (command specific)
Radiobutton
Scale
Spinbox
TEntry
TLabel
TProgressbar
TextWidget.TagConfigure (command specific)
Text

func Format ¶ added in v0.3.0

func Format(val any) Opt

Format option.

Known uses:

ClipboardAppend (command specific)
NewPhoto (command specific)
Spinbox (widget specific)
TSpinbox (widget specific)

func Forward ¶ added in v0.44.0

func Forward() Opt

Forward option.

Known uses:

Text (widget specific, applies to Search)

func From ¶ added in v0.3.0

func From(val ...any) Opt

From option.

Known uses:

Img.Copy
Scale (widget specific)
Spinbox (widget specific)
TScale (widget specific)
TSpinbox (widget specific)

func Gamma ¶ added in v0.4.10

func Gamma(val any) Opt

Gamma option.

Known uses:

NewPhoto (command specific)

func Global ¶ added in v0.56.1

func Global() Opt

Global option.

Known uses:

Grab (command specific)
GrabSet (command specific)

func Gripsize ¶ added in v0.25.1

func Gripsize(val any) Opt

Gripsize — Styling widgets

Gripsize is a styling option of a ttk::panedwindow and ttk::scrollbar. More information might be available at the Tcl/Tk ttk_panedwindow or Tcl/Tk ttk_scrollbar page.

func Groovewidth ¶ added in v0.25.1

func Groovewidth(val any) Opt

Groovewidth — Styling widgets

Groovewidth is a styling option of a ttk::scale. More information might be available at the Tcl/Tk ttk_scale page.

func Handlepad ¶ added in v0.3.0

func Handlepad(val any) Opt

Handlepad option.

Known uses:

Panedwindow (widget specific)

func Handlesize ¶ added in v0.3.0

func Handlesize(val any) Opt

Handlesize option.

Known uses:

Panedwindow (widget specific)

func Heading ¶ added in v0.49.0

func Heading(columnId string) Opt

Heading option.

Known uses:

Tooltip (command specific)

func Height ¶ added in v0.3.0

func Height(val any) Opt

Height option.

Known uses:

Button (widget specific)
Canvas (widget specific)
Checkbutton (widget specific)
Frame (widget specific)
Label (widget specific)
Labelframe (widget specific)
Listbox (widget specific)
Menubutton (widget specific)
NewPhoto (command specific)
Panedwindow (widget specific)
Place (command specific)
Radiobutton (widget specific)
TCombobox (widget specific)
TFrame (widget specific)
TLabelframe (widget specific)
TNotebook (widget specific)
TPanedwindow (widget specific)
TTreeview (widget specific)
Text (widget specific)
Toplevel (widget specific)

func Hidemargin ¶ added in v0.4.10

func Hidemargin(val any) Opt

Hidemargin option.

Known uses:

MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)

func Highlightbackground ¶ added in v0.2.0

func Highlightbackground(val any) Opt

Highlightbackground option.

Specifies the color to display in the traversal highlight region when the widget does not have the input focus.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame
Label
Labelframe
Listbox
Menubutton
Message
Radiobutton
Scale
Scrollbar
Spinbox
Text
Toplevel

func Highlightcolor ¶ added in v0.2.0

func Highlightcolor(val any) Opt

Highlightcolor option.

Specifies the color to use for the traversal highlight rectangle that is drawn around the widget when it has the input focus.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame
Label
Labelframe
Listbox
Menubutton
Message
Radiobutton
Scale
Scrollbar
Spinbox
Text
Toplevel

func Highlightthickness ¶ added in v0.2.0

func Highlightthickness(val any) Opt

Highlightthickness option.

Specifies a non-negative value indicating the width of the highlight rectangle to draw around the outside of the widget when it has the input focus. The value may have any of the forms acceptable to Tk_GetPixels. If the value is zero, no focus highlight is drawn around the widget.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame
Label
Labelframe
Listbox
Menubutton
Message
Radiobutton
Scale
Scrollbar
Spinbox
Text
Toplevel

func Icon ¶ added in v0.4.10

func Icon(val any) Opt

Icon option.

Known uses:

MessageBox (command specific)

func Id ¶ added in v0.4.10

func Id(val any) Opt

Id option.

Known uses:

TTreeviewWidget (command specific)

More information might be available at the Tcl/Tk treeview page.

func Image ¶ added in v0.2.0

func Image(val any) Opt

Image option.

Specifies an image to display in the widget, which must have been created with the image create command. Typically, if the -image option is specified then it overrides other options that specify a bitmap or textual value to display in the widget, though this is controlled by the -compound option; the -image option may be reset to an empty string to re-enable a bitmap or text display.

Known uses:

Button
Checkbutton
Label
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton
Radiobutton
TButton
TCheckbutton
TLabel
TMenubutton
TRadiobutton

func In ¶ added in v0.4.10

func In(val any) Opt

In option.

Known uses:

Grid (command specific)
Pack (command specific)
Place (command specific)

func Inactiveselectbackground ¶ added in v0.3.0

func Inactiveselectbackground(val any) Opt

Inactiveselectbackground option.

Known uses:

Text (widget specific)

func Increment ¶ added in v0.3.0

func Increment(val any) Opt

Increment option.

Known uses:

Spinbox (widget specific)
TSpinbox (widget specific)

func Indent ¶ added in v0.25.1

func Indent(val any) Opt

Indent — Styling widgets

Indent is a styling option of a ttk::treeview. More information might be available at the Tcl/Tk ttk_treeview page.

func Index ¶ added in v0.49.0

func Index(index any) Opt

Index option.

Known uses:

Tooltip (command specific)

func Indicatorbackground ¶ added in v0.25.1

func Indicatorbackground(val any) Opt

Indicatorbackground — Styling widgets

Indicatorbackground is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Indicatorcolor ¶ added in v0.25.1

func Indicatorcolor(val any) Opt

Indicatorcolor — Styling widgets

Indicatorcolor is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Indicatormargin ¶ added in v0.25.1

func Indicatormargin(val any) Opt

Indicatormargin — Styling widgets

Indicatormargin is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Indicatormargins ¶ added in v0.25.1

func Indicatormargins(val any) Opt

Indicatormargins — Styling widgets

Indicatormargins is a styling option of a ttk::treeview. More information might be available at the Tcl/Tk ttk_treeview page.

func Indicatoron ¶ added in v0.3.0

func Indicatoron(val any) Opt

Indicatoron option.

Known uses:

Checkbutton (widget specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton (widget specific)
Radiobutton (widget specific)

func Indicatorrelief ¶ added in v0.25.1

func Indicatorrelief(val any) Opt

Indicatorrelief — Styling widgets

Indicatorrelief is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Indicatorsize ¶ added in v0.25.1

func Indicatorsize(val any) Opt

Indicatorsize — Styling widgets

Indicatorsize is a styling option of a ttk::treeview. More information might be available at the Tcl/Tk ttk_treeview page.

func Indices ¶ added in v0.48.0

func Indices() Opt

Indices option.

Known uses:

TextWidget (command specific)

func Info ¶ added in v0.49.0

func Info(info string) Opt

Info option.

Known uses:

Tooltip (command specific)

func Initialcolor ¶ added in v0.4.10

func Initialcolor(val any) Opt

Initialcolor option.

Known uses:

ChooseColor (command specific)

func Initialdir ¶ added in v0.4.10

func Initialdir(val any) Opt

Initialdir option.

Known uses:

ChooseDirectory (command specific)
GetOpenFile (command specific)
GetSaveFile (command specific)

func Initialfile ¶ added in v0.4.10

func Initialfile(val any) Opt

Initialfile option.

Known uses:

GetOpenFile (command specific)
GetSaveFile (command specific)

func Insertbackground ¶ added in v0.2.0

func Insertbackground(val any) Opt

Insertbackground option.

Specifies the color to use as background in the area covered by the insertion cursor. This color will normally override either the normal background for the widget (or the selection background if the insertion cursor happens to fall in the selection).

Known uses:

Canvas
Entry
Spinbox
Text

func Insertborderwidth ¶ added in v0.2.0

func Insertborderwidth(val any) Opt

Insertborderwidth option.

Specifies a non-negative value indicating the width of the 3-D border to draw around the insertion cursor. The value may have any of the forms acceptable to Tk_GetPixels.

Known uses:

Canvas
Entry
Spinbox
Text

func Insertcolor ¶ added in v0.25.1

func Insertcolor(val any) Opt

Insertcolor — Styling widgets

Insertcolor is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Insertofftime ¶ added in v0.2.0

func Insertofftime(val any) Opt

Insertofftime option.

Specifies a non-negative integer value indicating the number of milliseconds the insertion cursor should remain in each blink cycle. If this option is zero then the cursor does not blink: it is on all the time.

Known uses:

Canvas
Entry
Spinbox
Text

func Insertontime ¶ added in v0.2.0

func Insertontime(val any) Opt

Insertontime option.

Specifies a non-negative integer value indicating the number of milliseconds the insertion cursor should remain in each blink cycle.

Known uses:

Canvas
Entry
Spinbox
Text

func Insertunfocussed ¶ added in v0.3.0

func Insertunfocussed(val any) Opt

Insertunfocussed option.

Known uses:

Text (widget specific)

func Insertwidth ¶ added in v0.2.0

func Insertwidth(val any) Opt

Insertwidth option.

Specifies a non-negative value indicating the total width of the insertion cursor. The value may have any of the forms acceptable to Tk_GetPixels. If a border has been specified for the insertion cursor (using the -insertborderwidth option), the border will be drawn inside the width specified by the -insertwidth option.

Known uses:

Canvas
Entry
Spinbox
Text

func Invalidcommand ¶ added in v0.3.0

func Invalidcommand(handler any) Opt

Invalidcommand option.

See also Event handlers.

Known uses:

Entry (widget specific)
Spinbox (widget specific)
TEntry (widget specific)

func Ipadx ¶ added in v0.4.10

func Ipadx(val any) Opt

Ipadx option.

Known uses:

Grid (command specific)
Pack (command specific)

func Ipady ¶ added in v0.4.10

func Ipady(val any) Opt

Ipady option.

Known uses:

Grid (command specific)
Pack (command specific)

func ItemWindow ¶ added in v0.62.0

func ItemWindow(w *Window) Opt

ItemWindow option.

Specifies the window to associate with this item. The window specified by pathName must either be a child of the canvas widget or a child of some ancestor of the canvas widget. PathName may not refer to a top-level window.

Known uses:

CanvasWidget.CreateWindow (widget specific)

func Items ¶ added in v0.49.0

func Items(items ...any) Opt

Items option.

Known uses:

Tooltip (command specific)

func Joinstyle ¶ added in v0.4.10

func Joinstyle(style any) Opt

Joinstyle option.

Specifies the ways in which joints are to be drawn at the vertices of the line. Style may have any of the forms accepted by Tk_GetJoinStyle (bevel, miter, or round). If this option is not specified then it defaults to round. If the line only contains two points then this option is irrelevant.

Known uses:

CanvasWidget.CreateLine (widget specific)

func Jump ¶ added in v0.2.0

func Jump(val any) Opt

Jump option.

For widgets with a slider that can be dragged to adjust a value, such as scrollbars, this option determines when notifications are made about changes in the value. The option's value must be a boolean of the form accepted by Tcl_GetBoolean. If the value is false, updates are made continuously as the slider is dragged. If the value is true, updates are delayed until the mouse button is released to end the drag; at that point a single notification is made (the value rather than changing smoothly).

Known uses:

Scrollbar

func Justify ¶ added in v0.2.0

func Justify(val any) Opt

Justify option.

When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. Must be one of left, center, or right. Left means that the lines' left edges all line up, center means that the lines' centers are aligned, and right means that the lines' right edges line up.

Known uses:

Button
Checkbutton
Entry
Label
Listbox
Menubutton
Message (widget specific)
Radiobutton
Spinbox
TButton
TCombobox (widget specific)
TEntry (widget specific)
TLabel
TProgressbar
TextWidget.TagConfigure (command specific)

func Labelanchor ¶ added in v0.3.0

func Labelanchor(val any) Opt

Labelanchor option.

Known uses:

Labelframe (widget specific)
TLabelframe (widget specific)

func Labelmargins ¶ added in v0.25.1

func Labelmargins(val any) Opt

Labelmargins — Styling widgets

Labelmargins is a styling option of a ttk::labelframe. More information might be available at the Tcl/Tk ttk_labelframe page.

func Labeloutside ¶ added in v0.25.1

func Labeloutside(val any) Opt

Labeloutside — Styling widgets

Labeloutside is a styling option of a ttk::labelframe. More information might be available at the Tcl/Tk ttk_labelframe page.

func Labelwidget ¶ added in v0.3.0

func Labelwidget(val any) Opt

Labelwidget option.

Known uses:

Labelframe (widget specific)
TLabelframe (widget specific)

func Lastfor ¶ added in v0.5.18

func Lastfor(val any) Opt

Lastfor option.

Known uses:

Focus (command specific)

func Lbl ¶ added in v0.3.0

func Lbl(val any) Opt

Lbl option.

Known uses:

MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Scale (widget specific)

func Length ¶ added in v0.3.0

func Length(val any) Opt

Length option.

Known uses:

Scale (widget specific)
TProgressbar (widget specific)
TScale (widget specific)

func Lightcolor ¶ added in v0.25.1

func Lightcolor(val any) Opt

Lightcolor — Styling widgets

Lightcolor is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Linearrow ¶ added in v0.62.0

func Linearrow(where any) Opt

Linearrow option.

Indicates whether or not arrowheads are to be drawn at one or both ends of the line. Where must have one of the values none (for no arrowheads), first (for an arrowhead at the first point of the line), last (for an arrowhead at the last point of the line), or both (for arrowheads at both ends). This option defaults to none. When requested to draw an arrowhead, Tk internally adjusts the corresponding line end point so that the rendered line ends at the neck of the arrowhead rather than at its tip so that the line doesn't extend past the edge of the arrowhead. This may trigger a Leave event if the mouse is hovering this line end. Conversely, when removing an arrowhead Tk adjusts the corresponding line point the other way round, which may trigger an Enter event.

Known uses:

CanvasWidget.CreateLine (widget specific)

func Lines ¶ added in v0.48.0

func Lines() Opt

Lines option.

Known uses:

TextWidget (command specific)

func Listvariable ¶ added in v0.3.0

func Listvariable(val any) Opt

Listvariable option.

Known uses:

Listbox (widget specific)

func Lmargin1 ¶ added in v0.4.10

func Lmargin1(val any) Opt

Lmargin1 option.

Known uses:

TextWidget.TagConfigure (command specific)

func Lmargin2 ¶ added in v0.4.10

func Lmargin2(val any) Opt

Lmargin2 option.

Known uses:

TextWidget.TagConfigure (command specific)

func Lmargincolor ¶ added in v0.4.10

func Lmargincolor(val any) Opt

Lmargincolor option.

Known uses:

TextWidget.TagConfigure (command specific)

func Maskdata ¶ added in v0.4.10

func Maskdata(val any) Opt

Maskdata option.

Known uses:

NewBitmap (command specific)

func Maskfile ¶ added in v0.4.10

func Maskfile(val any) Opt

Maskfile option.

Known uses:

NewBitmap (command specific)

func Maximum ¶ added in v0.3.0

func Maximum(val any) Opt

Maximum option.

Known uses:

TProgressbar (widget specific)

func Maxphase ¶ added in v0.25.1

func Maxphase(val any) Opt

Maxphase — Styling widgets

Maxphase is a styling option of a ttk::progressbar. More information might be available at the Tcl/Tk ttk_progressbar page.

func Maxundo ¶ added in v0.3.0

func Maxundo(val any) Opt

Maxundo option.

Known uses:

Text (widget specific)

func Metadata ¶ added in v0.4.10

func Metadata(val any) Opt

Metadata option.

Known uses:

NewPhoto (command specific)

func Minsize ¶ added in v0.4.10

func Minsize(val ...any) Opt

Minsize option.

Known uses:

GridColumnConfigure
GridRowConfigure

func Mnu ¶ added in v0.3.0

func Mnu(val any) Opt

Mnu option.

Known uses:

MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton (widget specific)
TMenubutton (widget specific)
Toplevel (widget specific)

func Mode ¶ added in v0.3.0

func Mode(val any) Opt

Mode option.

Known uses:

TProgressbar (widget specific)

func Msg ¶ added in v0.4.10

func Msg(val any) Opt

Msg option.

Known uses:

ChooseDirectory (command specific)
MessageBox (command specific)

func Multiple ¶ added in v0.4.10

func Multiple(val any) Opt

Multiple option.

Known uses:

GetOpenFile (command specific)

func Mustexist ¶ added in v0.4.10

func Mustexist(val any) Opt

Mustexist option.

Known uses:

ChooseDirectory (command specific)

func Nice ¶ added in v0.4.8

func Nice(val any) Opt

Nice option.

Known uses:

Bell (command specific)

func Nocase ¶ added in v0.4.10

func Nocase() Opt

Nocase option.

Known uses:

Text (widget specific, applies to Search)

func Offrelief ¶ added in v0.3.0

func Offrelief(val any) Opt

Offrelief option.

Known uses:

Checkbutton (widget specific)
Radiobutton (widget specific)

func Offset ¶ added in v0.4.10

func Offset(val any) Opt

Offset option.

Known uses:

TextWidget.TagConfigure (command specific)

func Offvalue ¶ added in v0.3.0

func Offvalue(val any) Opt

Offvalue option.

Known uses:

Checkbutton (widget specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
TCheckbutton (widget specific)

func Onvalue ¶ added in v0.3.0

func Onvalue(val any) Opt

Onvalue option.

Known uses:

Checkbutton (widget specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
TCheckbutton (widget specific)

func Opaqueresize ¶ added in v0.3.0

func Opaqueresize(val any) Opt

Opaqueresize option.

Known uses:

Panedwindow (widget specific)

func Open ¶ added in v0.53.0

func Open(val bool) Opt

Open option.

Known uses:

TTreeviewWidget (command specific)

More information might be available at the Tcl/Tk treeview page.

func Orient ¶ added in v0.2.0

func Orient(val any) Opt

Orient option.

For widgets that can lay themselves out with either a horizontal or vertical orientation, such as scrollbars, this option specifies which orientation should be used. Must be either horizontal or vertical or an abbreviation of one of these.

Known uses:

Panedwindow
Scale
Scrollbar
TPanedwindow (widget specific)
TProgressbar (widget specific)
TScale (widget specific)
TScrollbar (widget specific)
TSeparator (widget specific)

func Outline ¶ added in v0.4.12

func Outline(color any) Opt

Outline option.

This option specifies the color that should be used to draw the outline of the item in its normal state. Color may have any of the forms accepted by Tk_GetColor. If color is specified as an empty string then no outline is drawn for the item.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Outlineoffset ¶ added in v0.4.10

func Outlineoffset(offset any) Opt

Outlineoffset option.

Specifies the offset of the stipple pattern used for outlines, in the same way that the -outline option controls fill stipples. (See the -outline option for a description of the syntax of offset.)

Known uses:

CanvasWidget.CreateArc (widget specific)

func Outlinestipple ¶ added in v0.4.12

func Outlinestipple(bitmap any) Opt

Outlinestipple option.

This option specifies the stipple pattern that should be used to draw the outline of the item in its normal state. Indicates that the outline for the item should be drawn with a stipple pattern; bitmap specifies the stipple pattern to use, in any of the forms accepted by Tk_GetBitmap. If the -outline option has not been specified then this option has no effect. If bitmap is an empty string (the default), then the outline is drawn in a solid fashion. Note that stipples are not well supported on platforms that do not use X11 as their drawing API.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Overrelief ¶ added in v0.3.0

func Overrelief(val any) Opt

Overrelief option.

Known uses:

Button (widget specific)
Checkbutton (widget specific)
Radiobutton (widget specific)

func Overstrike ¶ added in v0.4.10

func Overstrike(val any) Opt

Overstrike option.

Known uses:

NewFont (command specific)
TextWidget.TagConfigure (command specific)

func Overstrikefg ¶ added in v0.4.10

func Overstrikefg(val any) Opt

Overstrikefg option.

Known uses:

TextWidget.TagConfigure (command specific)

func Pad ¶ added in v0.56.0

func Pad(val any) Opt

Pad option.

The -pad option specifies the number of screen units that will be added to the largest window contained completely in that column/row when the grid geometry manager requests a size from the containing window.

Known uses:

GridColumnConfigure (command specific)
GridRowConfigure (command specific)

func Padding ¶ added in v0.3.0

func Padding(val any) Opt

Padding option.

Specifies the internal padding for the widget. The padding is a list of up to four length specifications left top right bottom. If fewer than four elements are specified, bottom defaults to top, right defaults to left, and top defaults to left. In other words, a list of three numbers specify the left, vertical, and right padding; a list of two numbers specify the horizontal and the vertical padding; a single number specifies the same padding all the way around the widget.

Known uses:

TFrame
TLabel
TLabelframe
TNotebook (widget specific)
TTreeview

func Padx ¶ added in v0.2.0

func Padx(val any) Opt

Padx option.

Specifies a non-negative value indicating how much extra space to request for the widget in the X-direction. The value may have any of the forms acceptable to Tk_GetPixels. When computing how large a window it needs, the widget will add this amount to the width it would normally need (as determined by the width of the things displayed in the widget); if the geometry manager can satisfy this request, the widget will end up with extra internal space to the left and/or right of what it displays inside. Most widgets only use this option for padding text: if they are displaying a bitmap or image, then they usually ignore padding options.

Known uses:

Button
Checkbutton
Frame
Grid (command specific)
Label
Labelframe
Menubutton
Message
Pack (command specific)
Radiobutton
Text
Toplevel

func Pady ¶ added in v0.2.0

func Pady(val any) Opt

Pady option.

Specifies a non-negative value indicating how much extra space to request for the widget in the Y-direction. The value may have any of the forms acceptable to Tk_GetPixels. When computing how large a window it needs, the widget will add this amount to the height it would normally need (as determined by the height of the things displayed in the widget); if the geometry manager can satisfy this request, the widget will end up with extra internal space above and/or below what it displays inside. Most widgets only use this option for padding text: if they are displaying a bitmap or image, then they usually ignore padding options.

Known uses:

Button
Checkbutton
Frame
Grid (command specific)
Label
Labelframe
Menubutton
Message
Pack (command specific)
Radiobutton
Text
Toplevel

func Palette ¶ added in v0.4.10

func Palette(val any) Opt

Palette option.

Known uses:

NewPhoto (command specific)

func Parent ¶ added in v0.4.10

func Parent(val any) Opt

Parent option.

Known uses:

ChooseColor (command specific)
ChooseDirectory (command specific)
Fontchooser (command specific)
GetOpenFile (command specific)
GetSaveFile (command specific)
MessageBox (command specific)

func Period ¶ added in v0.25.1

func Period(val any) Opt

Period — Styling widgets

Period is a styling option of a ttk::progressbar. More information might be available at the Tcl/Tk ttk_progressbar page.

func Phase ¶ added in v0.3.0

func Phase(val any) Opt

Phase option.

Known uses:

TProgressbar (widget specific)

func Placeholder ¶ added in v0.2.0

func Placeholder(val any) Opt

Placeholder option.

Specifies a help text string to display if no text is otherwise displayed, that is when the widget is empty. The placeholder text is displayed using the values of the -font and -justify options.

Known uses:

Entry
Spinbox
TCombobox
TEntry
TSpinbox

func Placeholderforeground ¶ added in v0.2.0

func Placeholderforeground(val any) Opt

Placeholderforeground option.

Specifies the foreground color to use when the placeholder text is displayed. The default color is platform-specific.

Known uses:

Entry
Spinbox
TCombobox
TEntry
TSpinbox

func Postcommand ¶ added in v0.3.0

func Postcommand(handler any) Opt

Postcommand option.

See also Event handlers.

Known uses:

Menu (widget specific)
TCombobox (widget specific)

func Postoffset ¶ added in v0.25.1

func Postoffset(val any) Opt

Postoffset — Styling widgets

Postoffset is a styling option of a ttk::combobox. More information might be available at the Tcl/Tk ttk_combobox page.

func Proxybackground ¶ added in v0.3.0

func Proxybackground(val any) Opt

Proxybackground option.

Known uses:

Panedwindow (widget specific)

func Proxyborderwidth ¶ added in v0.3.0

func Proxyborderwidth(val any) Opt

Proxyborderwidth option.

Known uses:

Panedwindow (widget specific)

func Proxyrelief ¶ added in v0.3.0

func Proxyrelief(val any) Opt

Proxyrelief option.

Known uses:

Panedwindow (widget specific)

func Readonlybackground ¶ added in v0.3.0

func Readonlybackground(val any) Opt

Readonlybackground option.

Known uses:

Entry (widget specific)
Spinbox (widget specific)

func Regexp ¶ added in v0.4.10

func Regexp() Opt

Regexp option.

Known uses:

Text (widget specific, applies to Search)

func Relheight ¶ added in v0.4.10

func Relheight(val any) Opt

Relheight option.

Known uses:

Place (command specific)

func Relief ¶ added in v0.2.0

func Relief(val any) Opt

Relief option.

Specifies the 3-D effect desired for the widget. Acceptable values are raised, sunken, flat, ridge, solid, and groove. The value indicates how the interior of the widget should appear relative to its exterior; for example, raised means the interior of the widget should appear to protrude from the screen, relative to the exterior of the widget.

Known uses:

Button
Canvas
Checkbutton
Entry
Frame
Label
Labelframe
Listbox
Menu
Menubutton
Message
Panedwindow
Radiobutton
Scale
Scrollbar
Spinbox
TFrame (widget specific)
TLabel (widget specific)
TextWidget.TagConfigure (command specific)
Text
Toplevel

func Relwidth ¶ added in v0.4.10

func Relwidth(val any) Opt

Relwidth option.

Known uses:

Place (command specific)

func Relx ¶ added in v0.4.10

func Relx(val any) Opt

Relx option.

Known uses:

Place (command specific)

func Rely ¶ added in v0.4.10

func Rely(val any) Opt

Rely option.

Known uses:

Place (command specific)

func Repeatdelay ¶ added in v0.2.0

func Repeatdelay(val any) Opt

Repeatdelay option.

Specifies the number of milliseconds a button or key must be held down before it begins to auto-repeat. Used, for example, on the up- and down-arrows in scrollbars.

Known uses:

Button
Scale
Scrollbar
Spinbox

func Repeatinterval ¶ added in v0.2.0

func Repeatinterval(val any) Opt

Repeatinterval option.

Used in conjunction with -repeatdelay: once auto-repeat begins, this option determines the number of milliseconds between auto-repeats.

Known uses:

Button
Scale
Scrollbar
Spinbox

func Resolution ¶ added in v0.3.0

func Resolution(val any) Opt

Resolution option.

Known uses:

Scale (widget specific)

func Rmargin ¶ added in v0.4.10

func Rmargin(val any) Opt

Rmargin option.

Known uses:

TextWidget.TagConfigure (command specific)

func Rmargincolor ¶ added in v0.4.10

func Rmargincolor(val any) Opt

Rmargincolor option.

Known uses:

TextWidget.TagConfigure (command specific)

func Row ¶ added in v0.4.10

func Row(val any) Opt

Row option.

Known uses:

Grid (command specific)

func Rowheight ¶ added in v0.25.1

func Rowheight(val any) Opt

Rowheight — Styling widgets

Rowheight is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Rowspan ¶ added in v0.4.10

func Rowspan(val any) Opt

Rowspan option.

Known uses:

Grid (command specific)

func Sashcursor ¶ added in v0.3.0

func Sashcursor(val any) Opt

Sashcursor option.

Known uses:

Panedwindow (widget specific)

func Sashpad ¶ added in v0.3.0

func Sashpad(val any) Opt

Sashpad option.

Known uses:

Panedwindow (widget specific)

func Sashrelief ¶ added in v0.3.0

func Sashrelief(val any) Opt

Sashrelief option.

Known uses:

Panedwindow (widget specific)

func Sashthickness ¶ added in v0.25.1

func Sashthickness(val any) Opt

Sashthickness — Styling widgets

Sashthickness is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Sashwidth ¶ added in v0.3.0

func Sashwidth(val any) Opt

Sashwidth option.

Known uses:

Panedwindow (widget specific)

func Screen ¶ added in v0.3.0

func Screen(val any) Opt

Screen option.

Known uses:

Toplevel (widget specific)

func Scrollregion ¶ added in v0.3.0

func Scrollregion(val any) Opt

Scrollregion option.

Known uses:

Canvas (widget specific)

func Selectbackground ¶ added in v0.2.0

func Selectbackground(val any) Opt

Selectbackground option.

Specifies the background color to use when displaying selected items.

Known uses:

Canvas
Entry
Listbox
Spinbox
TextWidget.TagConfigure (command specific)
Text

func Selectborderwidth ¶ added in v0.2.0

func Selectborderwidth(val any) Opt

Selectborderwidth option.

Specifies a non-negative value indicating the width of the 3-D border to draw around selected items. The value may have any of the forms acceptable to Tk_GetPixels.

Known uses:

Canvas
Entry
Listbox
Spinbox
Text

func Selectcolor ¶ added in v0.3.0

func Selectcolor(val any) Opt

Selectcolor option.

Known uses:

Checkbutton (widget specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menu (widget specific)
Radiobutton (widget specific)

func Selectforeground ¶ added in v0.2.0

func Selectforeground(val any) Opt

Selectforeground option.

Specifies the foreground color to use when displaying selected items.

Known uses:

Canvas
Entry
Listbox
Spinbox
TextWidget.TagConfigure (command specific)
Text

func Selectimage ¶ added in v0.3.0

func Selectimage(val any) Opt

Selectimage option.

Known uses:

Checkbutton (widget specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Radiobutton (widget specific)

func Selectmode ¶ added in v0.3.0

func Selectmode(val any) Opt

Selectmode option.

Known uses:

Listbox (widget specific)
TTreeview (widget specific)

func Selecttype ¶ added in v0.3.0

func Selecttype(val any) Opt

Selecttype option.

Known uses:

TTreeview (widget specific)

func Setgrid ¶ added in v0.2.0

func Setgrid(val any) Opt

Setgrid option.

Specifies a boolean value that determines whether this widget controls the resizing grid for its top-level window. This option is typically used in text widgets, where the information in the widget has a natural size (the size of a character) and it makes sense for the window's dimensions to be integral numbers of these units. These natural window sizes form a grid. If the -setgrid option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window size will be constrained to integral numbers of grid units. See the section GRIDDED GEOMETRY MANAGEMENT in the wm manual entry for more details.

Known uses:

Listbox
Text

func Shiftrelief ¶ added in v0.25.1

func Shiftrelief(val any) Opt

TButton — Widget that issues a command when pressed

Description ¶

Shiftrelief specifies how far the button contents are shifted down and right in the pressed state. This action provides additional skeuomorphic feedback.

func Show ¶ added in v0.3.0

func Show(val any) Opt

Show option.

Known uses:

Entry (widget specific)
TEntry (widget specific)
TTreeview (widget specific)

func Showhandle ¶ added in v0.3.0

func Showhandle(val any) Opt

Showhandle option.

Known uses:

Panedwindow (widget specific)

func Showvalue ¶ added in v0.3.0

func Showvalue(val any) Opt

Showvalue option.

Known uses:

Scale (widget specific)

func Side ¶ added in v0.4.10

func Side(val any) Opt

Side option.

Known uses:

Pack (command specific)

func Size ¶ added in v0.4.10

func Size(val any) Opt

Size option.

Known uses:

NewFont (command specific)

func Slant ¶ added in v0.4.10

func Slant(val any) Opt

Slant option.

Known uses:

NewFont (command specific)

func Sliderlength ¶ added in v0.3.0

func Sliderlength(val any) Opt

Sliderlength option.

Known uses:

Scale (widget specific)

func Sliderrelief ¶ added in v0.3.0

func Sliderrelief(val any) Opt

Sliderrelief option.

Known uses:

Scale (widget specific)

func Sliderwidth ¶ added in v0.25.1

func Sliderwidth(val any) Opt

Sliderwidth — Styling widgets

Sliderwidth is a styling option of a ttk::scale. More information might be available at the Tcl/Tk ttk_scale page.

func Smooth ¶ added in v0.4.10

func Smooth(smoothMethod any) Opt

Smooth option.

smoothMethod must have one of the forms accepted by Tcl_GetBoolean or a line smoothing method. Only true and raw are supported in the core (with bezier being an alias for true), but more can be added at runtime. If a boolean false value or empty string is given, no smoothing is applied. A boolean truth value assumes true smoothing. If the smoothing method is true, this indicates that the line should be drawn as a curve, rendered as a set of quadratic splines: one spline is drawn for the first and second line segments, one for the second and third, and so on. Straight-line segments can be generated within a curve by duplicating the end-points of the desired line segment. If the smoothing method is raw, this indicates that the line should also be drawn as a curve but where the list of coordinates is such that the first coordinate pair (and every third coordinate pair thereafter) is a knot point on a cubic Bezier curve, and the other coordinates are control points on the cubic Bezier curve. Straight line segments can be generated within a curve by making control points equal to their neighbouring knot points. If the last point is a control point and not a knot point, the point is repeated (one or two times) so that it also becomes a knot point.

Known uses:

CanvasWidget.CreateLine (widget specific)

func Spacing1 ¶ added in v0.3.0

func Spacing1(val any) Opt

Spacing1 option.

Known uses:

TextWidget.TagConfigure (command specific)
Text (widget specific)

func Spacing2 ¶ added in v0.3.0

func Spacing2(val any) Opt

Spacing2 option.

Known uses:

TextWidget.TagConfigure (command specific)
Text (widget specific)

func Spacing3 ¶ added in v0.3.0

func Spacing3(val any) Opt

Spacing3 option.

Known uses:

TextWidget.TagConfigure (command specific)
Text (widget specific)

func Splinesteps ¶ added in v0.4.10

func Splinesteps(number any) Opt

Splinesteps option.

Specifies the degree of smoothness desired for curves: each spline will be approximated with number line segments. This option is ignored unless the -smooth option is true or raw.

Known uses:

CanvasWidget.CreateLine (widget specific)

func Start ¶ added in v0.4.10

func Start(degrees any) Opt

Start option.

Specifies the beginning of the angular range occupied by the arc. Degrees is given in units of degrees measured counter-clockwise from the 3-o'clock position; it may be either positive or negative.

Known uses:

CanvasWidget.CreateArc (widget specific)

func Startline ¶ added in v0.3.0

func Startline(val any) Opt

Startline option.

Known uses:

Text (widget specific)

func State ¶ added in v0.3.0

func State(val any) Opt

State option.

May be set to normal or disabled to control the disabled state bit. This is a write-only option: setting it changes the widget state, but the state widget command does not affect the -state option.

Known uses:

Button (widget specific)
Canvas (widget specific)
Checkbutton (widget specific)
Entry (widget specific)
Label (widget specific)
Listbox (widget specific)
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton (widget specific)
Radiobutton (widget specific)
Scale (widget specific)
Spinbox (widget specific)
TButton
TCheckbutton
TCombobox (widget specific)
TEntry (widget specific)
TLabel
TMenubutton
TRadiobutton
TSpinbox
Text (widget specific)

func Sticky ¶ added in v0.3.0

func Sticky(val any) Opt

Sticky option.

Known uses:

Grid (command specific)

func Stipple ¶ added in v0.4.12

func Stipple(bitmap any) Opt

Stipple option.

This option specifies the stipple patterns that should be used to fill the item in its normal state. bitmap specifies the stipple pattern to use, in any of the forms accepted by Tk_GetBitmap. If the -fill option has not been specified then this option has no effect. If bitmap is an empty string (the default), then filling is done in a solid fashion. For the text item, it affects the actual text. Note that stipples are not well supported on platforms that do not use X11 as their drawing API.

Known uses:

CanvasWidget.CreateArc (widget specific)
CanvasWidget.CreateBitmap (widget specific)

func Stretch ¶ added in v0.4.10

func Stretch(when string) Opt

Stretch option.

Description ¶

Controls how extra space is allocated to each of the panes. When is one of always, first, last, middle, and never. The panedwindow will calculate the required size of all its panes. Any remaining (or deficit) space will be distributed to those panes marked for stretching. The space will be distributed based on each panes current ratio of the whole. The when values have the following definition:

always: This pane will always stretch.
first: Only if this pane is the first pane (left-most or top-most) will it stretch.
last: Only if this pane is the last pane (right-most or bottom-most) will it stretch. This is the default value.
middle: Only if this pane is not the first or last pane will it stretch.
never: This pane will never stretch.

Known uses:

PanedwindowWidget (command specific)

func Striped ¶ added in v0.3.0

func Striped(val any) Opt

Striped option.

Known uses:

TTreeview (widget specific)

func Stripedbackground ¶ added in v0.25.1

func Stripedbackground(val any) Opt

Stripedbackground — Styling widgets

Stripedbackground is a styling option of a ttk::treeview. More information might be available at the Tcl/Tk ttk_treeview page.

func Style ¶ added in v0.4.10

func Style(val any) Opt

Style option.

May be used to specify a custom widget style.

Known uses:

TButton
TCheckbutton
TCombobox
TEntry
TFrame
TLabel
TLabelframe
TMenubutton
TNotebook
TPanedwindow
TProgressbar
TRadiobutton
TScale
TScrollbar
TSeparator
TSizegrip
TSpinbox
TTreeview

func Tab ¶ added in v0.49.0

func Tab(tabId any) Opt

Tab option.

Known uses:

Tooltip (command specific)

func Tabmargins ¶ added in v0.25.1

func Tabmargins(val any) Opt

Tabmargins — Styling widgets

Tabmargins is a styling option of a ttk::notebook. More information might be available at the Tcl/Tk ttk_notebook page.

func Tabposition ¶ added in v0.25.1

func Tabposition(val any) Opt

Tabposition — Styling widgets

Tabposition is a styling option of a ttk::notebook.

More information might be available at the Tcl/Tk ttk_notebook page.

func Tabs ¶ added in v0.3.0

func Tabs(val any) Opt

Tabs option.

Known uses:

TextWidget.TagConfigure (command specific)
Text (widget specific)

func Tabstyle ¶ added in v0.3.0

func Tabstyle(val any) Opt

Tabstyle option.

Known uses:

TextWidget.TagConfigure (command specific)
Text (widget specific)

func Tag ¶ added in v0.4.10

func Tag(name string) Opt

Tag option.

Known uses:

Tooltip (command specific)

func Tags ¶ added in v0.4.10

func Tags(tagList ...string) Opt

Tags option.

Specifies a set of tags to apply to the item. TagList consists of a list of tag names, which replace any existing tags for the item. TagList may be an empty list.

Known uses:

CanvasWidget.CreateArc (widget specific)
CanvasWidget.CreateBitmap (widget specific)

func Takefocus ¶ added in v0.2.0

func Takefocus(val any) Opt

Takefocus option.

Determines whether the window accepts the focus during keyboard traversal (e.g., Tab and Shift-Tab). Before setting the focus to a window, the traversal scripts consult the value of the -takefocus option. A value of 0 means that the window should be skipped entirely during keyboard traversal. 1 means that the window should receive the input focus as long as it is viewable (it and all of its ancestors are mapped). An empty value for the option means that the traversal scripts make the decision about whether or not to focus on the window: the current algorithm is to skip the window if it is disabled, if it has no key bindings, or if it is not viewable. If the value has any other form, then the traversal scripts take the value, append the name of the window to it (with a separator space), and evaluate the resulting string as a Tcl script. The script must return 0, 1, or an empty string: a 0 or 1 value specifies whether the window will receive the input focus, and an empty string results in the default decision described above. Note that this interpretation of the option is defined entirely by the Tcl scripts that implement traversal: the widget implementations ignore the option entirely, so you can change its meaning if you redefine the keyboard traversal scripts.

Known uses:

func Tearoff ¶ added in v0.3.0

func Tearoff(val any) Opt

Tearoff option.

Known uses:

Menu (widget specific)

func Tearoffcommand ¶ added in v0.3.0

func Tearoffcommand(handler any) Opt

Tearoffcommand option.

See also Event handlers.

Known uses:

Menu (widget specific)

func Textvariable ¶ added in v0.2.0

func Textvariable(s string) Opt

Textvariable option.

Specifies the value to be displayed inside the widget. The way in which the string is displayed in the widget depends on the particular widget and may be determined by other options, such as -anchor or -justify.

Known uses:

Button
Checkbutton
Entry
Label
Menubutton
Message
Radiobutton
Spinbox
TButton
TCheckbutton
TCombobox (widget specific)
TEntry (widget specific)
TLabel
TMenubutton
TRadiobutton

func Tickinterval ¶ added in v0.3.0

func Tickinterval(val any) Opt

Tickinterval option.

Known uses:

Scale (widget specific)

func Tile ¶ added in v0.3.0

func Tile(val any) Opt

Tile option.

Known uses:

Frame (widget specific)
Toplevel (widget specific)

func Title ¶ added in v0.3.0

func Title(val any) Opt

Title option.

Known uses:

ChooseColor (command specific)
ChooseDirectory (command specific)
Fontchooser (command specific)
GetOpenFile (command specific)
GetSaveFile (command specific)
Menu (widget specific)
MessageBox (command specific)

func Titlecolumns ¶ added in v0.3.0

func Titlecolumns(val any) Opt

Titlecolumns option.

Known uses:

TTreeview (widget specific)

func Titleitems ¶ added in v0.3.0

func Titleitems(val any) Opt

Titleitems option.

Known uses:

TTreeview (widget specific)

func To ¶ added in v0.3.0

func To(val ...any) Opt

To option.

Known uses:

Img.Copy
Scale (widget specific)
Spinbox (widget specific)
TScale (widget specific)
TSpinbox (widget specific)

func Topmost ¶ added in v0.4.10

func Topmost(v bool) Opt

Topmost option.

Known uses:

WmAttributes (command specific)

func Tristateimage ¶ added in v0.3.0

func Tristateimage(val any) Opt

Tristateimage option.

Known uses:

Checkbutton (widget specific)
Radiobutton (widget specific)

func Tristatevalue ¶ added in v0.3.0

func Tristatevalue(val any) Opt

Tristatevalue option.

Known uses:

Checkbutton (widget specific)
Radiobutton (widget specific)

func Troughcolor ¶ added in v0.2.0

func Troughcolor(val any) Opt

Troughcolor option.

Specifies the color to use for the rectangular trough areas in widgets such as scrollbars and scales. This option is ignored for scrollbars on Windows (native widget does not recognize this option).

Known uses:

Scale
Scrollbar

func Troughrelief ¶ added in v0.25.1

func Troughrelief(val any) Opt

Troughrelief — Styling widgets

Troughrelief is a styling option of one or more widgets. Please see Changing Widget Colors for details.

func Txt ¶ added in v0.2.0

func Txt(val any) Opt

Txt option.

Specifies a string to be displayed inside the widget. The way in which the string is displayed depends on the particular widget and may be determined by other options, such as -anchor or -justify.

Known uses:

Button
Checkbutton
Label
Labelframe
Menubutton
Message
Radiobutton
TButton
TCheckbutton
TLabel
TLabelframe (widget specific)
TMenubutton
TProgressbar
TRadiobutton

func Type ¶ added in v0.3.0

func Type(val any) Opt

Type option.

Known uses:

ClipboardAppend (command specific)
ClipboardGet (command specific)
Menu (widget specific)
MessageBox (command specific)
WmAttributes (command specific)

func Underline ¶ added in v0.2.0

func Underline(val any) Opt

Underline option.

Specifies the integer index of a character to underline in the widget. This option is used by the default bindings to implement keyboard traversal for menu buttons and menu entries. 0 corresponds to the first character of the text displayed in the widget, 1 to the next character, and so on. end corresponds to the last character, end-1 to the before last character, and so on.

Known uses:

Button
Checkbutton
Label
MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Menubutton
NewFont (command specific)
Radiobutton
TButton
TCheckbutton
TLabel
TLabelframe (widget specific)
TMenubutton
TRadiobutton
TextWidget.TagConfigure (command specific)

func Underlinefg ¶ added in v0.4.10

func Underlinefg(val any) Opt

Underlinefg option.

Known uses:

TextWidget.TagConfigure (command specific)

func Undo ¶ added in v0.3.0

func Undo(val any) Opt

Undo option.

Known uses:

Text (widget specific)

func Use ¶ added in v0.3.0

func Use(val any) Opt

Use option.

Known uses:

Toplevel (widget specific)

func Validate ¶ added in v0.3.0

func Validate(val any) Opt

Validate option.

Known uses:

Entry (widget specific)
Spinbox (widget specific)
TEntry (widget specific)
TSpinbox

func Validatecommand ¶ added in v0.3.0

func Validatecommand(handler any) Opt

Validatecommand option.

See also Event handlers.

Known uses:

Entry (widget specific)
Spinbox (widget specific)
TEntry (widget specific)
TSpinbox

func Value ¶ added in v0.3.0

func Value(val any) Opt

Value option.

Known uses:

MenuWidget.AddCascade (command specific)
MenuWidget.AddCommand (command specific)
MenuWidget.AddSeparator (command specific)
Radiobutton (widget specific)
TProgressbar (widget specific)
TRadiobutton (widget specific)
TScale (widget specific)

func Values ¶ added in v0.3.0

func Values(val any) Opt

Values option.

Known uses:

Spinbox (widget specific)
TCombobox (widget specific)
TSpinbox (widget specific)

func Visual ¶ added in v0.3.0

func Visual(val any) Opt

Visual option.

Known uses:

Frame (widget specific)
Labelframe (widget specific)
Toplevel (widget specific)

func Weight ¶ added in v0.3.0

func Weight(val any) Opt

Weight option.

Known uses:

NewFont (command specific)

func Width ¶ added in v0.3.0

func Width(val any) Opt

Width option.

If greater than zero, specifies how much space, in character widths, to allocate for the text label. If less than zero, specifies a minimum width. If zero or unspecified, the natural width of the text label is used. Note that some themes may specify a non-zero -width in the style.

Known uses:

Button (widget specific)
Canvas (widget specific)
Checkbutton (widget specific)
Entry (widget specific)
Frame (widget specific)
Label (widget specific)
Labelframe (widget specific)
Listbox (widget specific)
Menubutton (widget specific)
Message (widget specific)
NewPhoto (command specific)
Panedwindow (widget specific)
Place (command specific)
Radiobutton (widget specific)
Scale (widget specific)
Scrollbar (widget specific)
Spinbox (widget specific)
TButton
TCheckbutton
TCombobox (widget specific)
TEntry (widget specific)
TFrame (widget specific)
TLabel
TLabelframe (widget specific)
TMenubutton
TNotebook (widget specific)
TPanedwindow (widget specific)
TRadiobutton
Text (widget specific)
Toplevel (widget specific)

func Win ¶ added in v0.36.0

func Win(val any) Opt

Win option.

Known uses:

Text (widget specific, applies to embedded windows)

func Wrap ¶ added in v0.3.0

func Wrap(val any) Opt

Wrap option.

Known uses:

Spinbox (widget specific)
TSpinbox (widget specific)
TextWidget.TagConfigure (command specific)
Text (widget specific)

func Wraplength ¶ added in v0.2.0

func Wraplength(val any) Opt

Wraplength option.

For widgets that can perform word-wrapping, this option specifies the maximum line length. Lines that would exceed this length are wrapped onto the next line, so that no line is longer than the specified length. The value may be specified in any of the standard forms for screen distances. If this value is negative or zero then no wrapping is done: lines will break only at newline characters in the text.

Known uses:

Button
Checkbutton
Label
Menubutton
Radiobutton
TLabel
TLabel (widget specific)
TProgressbar

func X ¶ added in v0.4.10

func X(val any) Opt

X option.

Known uses:

Place (command specific)

func Xpixels ¶ added in v0.48.0

func Xpixels() Opt

Xpixels option.

Known uses:

TextWidget (command specific)

func Xscrollcommand ¶ added in v0.2.0

func Xscrollcommand(handler any) Opt

Xscrollcommand option.

See also Event handlers.

Specifies the prefix for a command used to communicate with horizontal scrollbars. When the view in the widget's window changes (or whenever anything else occurs that could change the display in a scrollbar, such as a change in the total size of the widget's contents), the widget will generate a Tcl command by concatenating the scroll command and two numbers. Each of the numbers is a fraction between 0 and 1, which indicates a position in the document. 0 indicates the beginning of the document, 1 indicates the end, .333 indicates a position one third the way through the document, and so on. The first fraction indicates the first information in the document that is visible in the window, and the second fraction indicates the information just after the last portion that is visible. The command is then passed to the Tcl interpreter for execution. Typically the -xscrollcommand option consists of the path name of a scrollbar widget followed by e.g. this will cause the scrollbar to be updated whenever the view in the window changes. If this option is not specified, then no command will be executed.

Known uses:

Canvas
Entry
Listbox
Spinbox
TEntry
TSpinbox
TTreeview
Text

func Xscrollincrement ¶ added in v0.3.0

func Xscrollincrement(val any) Opt

Xscrollincrement option.

Known uses:

Canvas (widget specific)

func Y ¶ added in v0.4.10

func Y(val any) Opt

Y option.

Known uses:

Place (command specific)

func Ypixels ¶ added in v0.48.0

func Ypixels() Opt

Ypixels option.

Known uses:

TextWidget (command specific)

func Yscrollcommand ¶ added in v0.2.0

func Yscrollcommand(handler any) Opt

Yscrollcommand option.

See also Event handlers.

Specifies the prefix for a command used to communicate with vertical scrollbars. This option is treated in the same way as the -xscrollcommand option, except that it is used for vertical scrollbars and is provided by widgets that support vertical scrolling. See the description of -xscrollcommand for details on how this option is used.

Known uses:

Canvas
Listbox
TTreeview
Text

func Yscrollincrement ¶ added in v0.3.0

func Yscrollincrement(val any) Opt

Yscrollincrement option.

Known uses:

Canvas (widget specific)

type OptionMenuWidget ¶ added in v0.53.0

type OptionMenuWidget struct {
	*Window
	// contains filtered or unexported fields
}

OptionMenuWidget represents the Tcl/Tk option menu.

More information might be available at the Tcl/Tk option menu page.

func OptionMenu ¶ added in v0.2.0

func OptionMenu(varName *VariableOpt, options ...any) (r *OptionMenuWidget)

tk_optionMenu — Create an option menubutton and its menu

Description ¶

This procedure creates an option menubutton whose name is pathName, plus an associated menu. Together they allow the user to select one of the values given by the value arguments. The current value will be stored in the global variable whose name is given by varName and it will also be displayed as the label in the option menubutton. The user can click on the menubutton to display a menu containing all of the values and thereby select a new value. Once a new value is selected, it will be stored in the variable and appear in the option menubutton. The current value can also be changed by setting the variable.

The return value from tk_optionMenu is the name of the menu associated with pathName, so that the caller can change its configuration options or manipulate it in other ways.

More information might be available at the Tcl/Tk option menu page.

func (*OptionMenuWidget) Name ¶ added in v0.53.0

func (w *OptionMenuWidget) Name() string

Name returns the menu name of 'w'.

type Opts ¶ added in v0.5.18

type Opts []Opt

Opts is a list of options. It implements Opt.

type PanedwindowWidget ¶ added in v0.11.0

type PanedwindowWidget struct {
	*Window
}

PanedwindowWidget represents the Tcl/Tk panedwindow widget/window

func Panedwindow ¶ added in v0.2.0

func Panedwindow(options ...Opt) *PanedwindowWidget

Panedwindow — Create and manipulate 'panedwindow' split container widgets

Description ¶

The panedwindow command creates a new window (given by the pathName argument) and makes it into a panedwindow widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the panedwindow such as its default background color and relief. The panedwindow command returns the path name of the new window.

A panedwindow widget contains any number of panes, arranged horizontally or vertically, according to the value of the panes is separated by a moveable (via mouse movements) sash. Moving a sash causes the widgets on either side of the sash to be resized.

Use Window.Panedwindow to create a Panedwindow with a particular parent.

More information might be available at the Tcl/Tk panedwindow page.

Standard options ¶

Background
Borderwidth
Cursor
Orient
Relief

Widget specific options ¶

Handlepad

When sash handles are drawn, specifies the distance from the top or left end of the sash (depending on the orientation of the widget) at which to draw the handle. May be any value accepted by Tk_GetPixels.

Handlesize

Specifies the side length of a sash handle. Handles are always drawn as squares. May be any value accepted by Tk_GetPixels.

Specifies a desired height for the overall panedwindow widget. May be any value accepted by Tk_GetPixels. If an empty string, the widget will be made high enough to allow all contained widgets to have their natural height.

Opaqueresize

Specifies whether panes should be resized as a sash is moved (true), or if resizing should be deferred until the sash is placed (false). In the latter case, a version of the sash is displayed during the resizing to show where the panes will be resized to when releasing the mouse button. This version of the sash is the proxy. It's rendering can be configured using the -proxybackground, -proxyborderwidth and -proxyrelief options.

Proxybackground

Background color to use when drawing the proxy. If an empty string, the value of the -background option will be used.

Proxyborderwidth

Specifies the borderwidth of the proxy. May be any value accepted by Tk_GetPixels.

Proxyrelief

Relief to use when drawing the proxy. May be any of the standard Tk relief values. If an empty string, the value of the -sashrelief option will be used.

Sashcursor

Mouse cursor to use when over a sash. If null, sb_h_double_arrow will be used for horizontal panedwindows, and sb_v_double_arrow will be used for vertical panedwindows.

Sashpad

Specifies the amount of padding to leave of each side of a sash. May be any value accepted by Tk_GetPixels.

Sashrelief

Relief to use when drawing a sash. May be any of the standard Tk relief values.

Sashwidth

Specifies the width of each sash. May be any value accepted by Tk_GetPixels.

Showhandle

Specifies whether sash handles should be shown. May be any valid Tcl boolean value.

Specifies a desired width for the overall panedwindow widget. May be any value accepted by Tk_GetPixels. If an empty string, the widget will be made wide enough to allow all contained widgets to have their natural width.

func (*PanedwindowWidget) Add ¶ added in v0.41.0

func (w *PanedwindowWidget) Add(subwindow *Window, options ...Opt)

panedwindow — Create and manipulate 'panedwindow' split container widgets

Description ¶

Add one or more windows to the panedwindow, each in a separate pane. The arguments consist of the names of one or more windows followed by pairs of arguments that specify how to manage the windows. Option may have any of the values accepted by the configure subcommand.

More information might be available at the Tcl/Tk panedwindow page.

func (*PanedwindowWidget) Panecget ¶ added in v0.41.0

func (w *PanedwindowWidget) Panecget(subwindow *Window, opt any) string

panedwindow — Create and manipulate 'panedwindow' split container widgets

Description ¶

Query a management option for window. Option may be any value allowed by the paneconfigure subcommand.

More information might be available at the Tcl/Tk panedwindow page.

func (*PanedwindowWidget) Paneconfigure ¶ added in v0.41.0

func (w *PanedwindowWidget) Paneconfigure(subwindow *Window, options ...Opt) string

panedwindow — Create and manipulate 'panedwindow' split container widgets

Description ¶

Query or modify the management options for window. If no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list). 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.

More information might be available at the Tcl/Tk panedwindow page.

type RadiobuttonWidget ¶ added in v0.11.0

type RadiobuttonWidget struct {
	*Window
}

RadiobuttonWidget represents the Tcl/Tk radiobutton widget/window

func Radiobutton ¶ added in v0.2.0

func Radiobutton(options ...Opt) *RadiobuttonWidget

Radiobutton — Create and manipulate 'radiobutton' pick-one widgets

Description ¶

The radiobutton command creates a new window (given by the pathName argument) and makes it into a radiobutton widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the radiobutton such as its colors, font, text, and initial relief. The radiobutton command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A radiobutton is a widget that displays a textual string, bitmap or image and a diamond or circle called an indicator. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines or if wrapping occurs because of the -wraplength option) and one of the characters may optionally be underlined using the all of the behavior of a simple button: it can display itself in either of three different ways, according to the -state option; it can be made to appear raised, sunken, or flat; it can be made to flash; and it invokes a Tcl command whenever mouse button 1 is clicked over the check button.

In addition, radiobuttons can be selected. If a radiobutton is selected, the indicator is normally drawn with a selected appearance, and a Tcl variable associated with the radiobutton is set to a particular value (normally 1). Under Unix, the indicator is drawn with a sunken relief and a special color. Under Windows, the indicator is drawn with a round mark inside. If the radiobutton is not selected, then the indicator is drawn with a deselected appearance, and the associated variable is set to a different value (typically 0). The indicator is drawn without a round mark inside. Typically, several radiobuttons share a single variable and the value of the variable indicates which radiobutton is to be selected. When a radiobutton is selected it sets the value of the variable to indicate that fact; each radiobutton also monitors the value of the variable and automatically selects and deselects itself when the variable's value changes. If the variable's value matches the -tristatevalue, then the radiobutton is drawn using the tri-state mode. This mode is used to indicate mixed or multiple values. (This is used when the radiobutton represents the state of multiple items.) By default the variable selectedButton is used; its contents give the name of the button that is selected, or the empty string if no button associated with that variable is selected. The name of the variable for a radiobutton, plus the variable to be stored into it, may be modified with options on the command line or in the option database. Configuration options may also be used to modify the way the indicator is displayed (or whether it is displayed at all). By default a radiobutton is configured to select itself on button clicks.

Use Window.Radiobutton to create a Radiobutton with a particular parent.

More information might be available at the Tcl/Tk radiobutton page.

Standard options ¶

Widget specific options ¶

Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1 is released over the button window. The button's global variable (-variable option) will be updated before the command is invoked.

Specifies a desired height for the button. If an image or bitmap is being displayed in the button then the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in lines of text. If this option is not specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it.

Indicatoron

Specifies whether or not the indicator should be drawn. Must be a proper boolean value. If false, the -relief option is ignored and the widget's relief is always sunken if the widget is selected and raised otherwise.

Offrelief

Specifies the relief for the checkbutton when the indicator is not drawn and the checkbutton is off. The default value is By setting this option to and setting -indicatoron to false and -overrelief to the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a word-processor, for example.

Overrelief

Specifies an alternative relief for the radiobutton, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring -relief flat -overrelief raised. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the radiobutton. The empty string is the default value.

Selectcolor

Specifies a background color to use when the button is selected. If indicatorOn is true then the color is used as the background for the indicator regardless of the select state. If -indicatoron is false, this color is used as the background for the entire widget, in place of -background or -activeBackground, whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected.

Selectimage

Specifies an image to display (in place of the -image option) when the radiobutton is selected. This option is ignored unless the -image option has been specified.

Specifies one of three states for the radiobutton: normal, active, or disabled. In normal state the radiobutton is displayed using the -foreground and -background options. The active state is typically used when the pointer is over the radiobutton. In active state the radiobutton is displayed using the -activeforeground and -activebackground options. Disabled state means that the radiobutton should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. In this state the -disabledforeground and -background options determine how the radiobutton is displayed.

Tristateimage

Specifies an image to display (in place of the -image option) when the radiobutton is selected. This option is ignored unless the -image option has been specified.

Tristatevalue

Specifies the value that causes the radiobutton to display the multi-value selection, also known as the tri-state mode. Defaults to

Specifies value to store in the button's associated variable whenever this button is selected.

Specifies the name of a global variable to set whenever this button is selected. Changes in this variable also cause the button to select or deselect itself. Defaults to the value selectedButton.

Specifies a desired width for the button. If an image or bitmap is being displayed in the button, the value is in screen units (i.e. any of the forms acceptable to Tk_GetPixels); for text it is in characters. If this option is not specified, the button's desired width is computed from the size of the image or bitmap or text being displayed in it.

type ScaleWidget ¶ added in v0.11.0

type ScaleWidget struct {
	*Window
}

ScaleWidget represents the Tcl/Tk scale widget/window

func Scale ¶ added in v0.2.0

func Scale(options ...Opt) *ScaleWidget

Scale — Create and manipulate 'scale' value-controlled slider widgets

Description ¶

The scale command creates a new window (given by the pathName argument) and makes it into a scale widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the scale such as its colors, orientation, and relief. The scale command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A scale is a widget that displays a rectangular trough and a small slider. The trough corresponds to a range of real values (determined by the -from, -to, and and the position of the slider selects a particular real value. The slider's position (and hence the scale's value) may be adjusted with the mouse or keyboard as described in the BINDINGS section below. Whenever the scale's value is changed, a Tcl command is invoked (using the -command option) to notify other interested widgets of the change. In addition, the value of the scale can be linked to a Tcl variable (using the -variable option), so that changes in either are reflected in the other.

Three annotations may be displayed in a scale widget: a label appearing at the top right of the widget (top left for horizontal scales), a number displayed just to the left of the slider (just above the slider for horizontal scales), and a collection of numerical tick marks just to the left of the current value (just below the trough for horizontal scales). Each of these three annotations may be enabled or disabled using the configuration options.

Use Window.Scale to create a Scale with a particular parent.

More information might be available at the Tcl/Tk scale page.

Standard options ¶

Activebackground
Background
Borderwidth
Cursor
Foreground
Highlightbackground
Highlightcolor
Highlightthickness
Orient
Relief
Repeatdelay
Repeatinterval
Takefocus
Troughcolor

Widget specific options ¶

Bigincrement

Some interactions with the scale cause its value to change by increments; this option specifies the size of the large increments. If specified as 0, the large increments default to 1/10 the range of the scale.

Specifies the prefix of a Tcl command to invoke whenever the scale's value is changed via a widget command. The actual command consists of this option followed by a space and a real number indicating the new value of the scale.

Digits

An integer specifying how many significant digits should be retained when converting the value of the scale to a string. If the number is negative or zero, then the scale picks the smallest value that guarantees that every possible slider position prints as a different string.

A real value corresponding to the left or top end of the scale.

Lbl

A string to display as a label for the scale. For vertical scales the label is displayed just to the right of the top end of the scale. For horizontal scales the label is displayed just above the left end of the scale. If the option is specified as an empty string, no label is displayed.

Length

Specifies the desired long dimension of the scale in screen units (i.e. any of the forms acceptable to Tk_GetPixels). For vertical scales this is the scale's height; for horizontal scales it is the scale's width.

Resolution

A real value specifying the resolution for the scale. If this value is greater than zero then the scale's value will always be rounded to an even multiple of this value, as will the endpoints of the scale. If the value is negative then no rounding occurs. Defaults to 1 (i.e., the value will be integral).

Showvalue

Specifies a boolean value indicating whether or not the current value of the scale is to be displayed.

Sliderlength

Specifies the size of the slider, measured in screen units along the slider's long dimension. The value may be specified in any of the forms acceptable to Tk_GetPixels.

Sliderrelief

Specifies the relief to use when drawing the slider, such as raised or sunken.

Specifies one of three states for the scale: normal, active, or disabled. If the scale is disabled then the value may not be changed and the scale will not activate. If the scale is active, the slider is displayed using the color specified by the -activebackground option.

Tickinterval

Must be a real value. Determines the spacing between numerical tick marks displayed below or to the left of the slider. The values will all be displayed with the same number of decimal places, which will be enough to ensure they are all accurate to within 20% of a tick interval. If 0, no tick marks will be displayed.

Specifies a real value corresponding to the right or bottom end of the scale. This value may be either less than or greater than the -from option.

Specifies the name of a global variable to link to the scale. Whenever the value of the variable changes, the scale will update to reflect this value. Whenever the scale is manipulated interactively, the variable will be modified to reflect the scale's new value.

Specifies the desired narrow dimension of the scale in screen units (i.e. any of the forms acceptable to Tk_GetPixels). For vertical scales this is the scale's width; for horizontal scales this is the scale's height.

type ScrollbarWidget ¶ added in v0.11.0

type ScrollbarWidget struct {
	*Window
}

ScrollbarWidget represents the Tcl/Tk scrollbar widget/window

func Scrollbar ¶ added in v0.2.0

func Scrollbar(options ...Opt) *ScrollbarWidget

Scrollbar — Create and manipulate 'scrollbar' scrolling control and indicator widgets

Description ¶

The scrollbar command creates a new window (given by the pathName argument) and makes it into a scrollbar widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the scrollbar such as its colors, orientation, and relief. The scrollbar command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A scrollbar is a widget that displays two arrows, one at each end of the scrollbar, and a slider in the middle portion of the scrollbar. It provides information about what is visible in an associated window that displays a document of some sort (such as a file being edited or a drawing). The position and size of the slider indicate which portion of the document is visible in the associated window. For example, if the slider in a vertical scrollbar covers the top third of the area between the two arrows, it means that the associated window displays the top third of its document.

Scrollbars can be used to adjust the view in the associated window by clicking or dragging with the mouse. See the BINDINGS section below for details.

Use Window.Scrollbar to create a Scrollbar with a particular parent.

More information might be available at the Tcl/Tk scrollbar page.

Standard options ¶

Activebackground
Background
Borderwidth
Cursor
Highlightbackground
Highlightcolor
Highlightthickness
Jump
Orient
Relief
Repeatdelay
Repeatinterval
Takefocus
Troughcolor

Widget specific options ¶

Activerelief

Specifies the relief to use when displaying the element that is active, if any. Elements other than the active element are always displayed with a raised relief.

Specifies the prefix of a Tcl command to invoke to change the view in the widget associated with the scrollbar. When a user requests a view change by manipulating the scrollbar, a Tcl command is invoked. The actual command consists of this option followed by additional information as described later. This option almost always has a value such as .t xview or .t yview, consisting of the name of a widget and either xview (if the scrollbar is for horizontal scrolling) or yview (for vertical scrolling). All scrollable widgets have xview and yview commands that take exactly the additional arguments appended by the scrollbar as described in SCROLLING COMMANDS below.

Elementborderwidth

Specifies the width of borders drawn around the internal elements of the scrollbar (the two arrows and the slider). The value may have any of the forms acceptable to Tk_GetPixels. If this value is the empty string (the default), the value of the -borderwidth option is used in its place.

Specifies the desired narrow dimension of the scrollbar window, not including 3-D border, if any. For vertical scrollbars this will be the width and for horizontal scrollbars this will be the height. The value may have any of the forms acceptable to Tk_GetPixels.

type SpinboxWidget ¶ added in v0.11.0

type SpinboxWidget struct {
	*Window
}

SpinboxWidget represents the Tcl/Tk spinbox widget/window

func Spinbox ¶ added in v0.2.0

func Spinbox(options ...Opt) *SpinboxWidget

Spinbox — Create and manipulate 'spinbox' value spinner widgets

Description ¶

The spinbox command creates a new window (given by the pathName argument) and makes it into a spinbox widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the spinbox such as its colors, font, and relief. The spinbox command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.

A spinbox is an extended entry widget that allows he user to move, or spin, through a fixed set of ascending or descending values such as times or dates in addition to editing the value as in an entry. When first created, a spinbox's string is empty. A portion of the spinbox may be selected as described below. If a spinbox is exporting its selection (see the -exportselection option), then it will observe the standard protocols for handling the selection; spinbox selections are available as type STRING. Spinboxes also observe the standard Tk rules for dealing with the input focus. When a spinbox has the input focus it displays an insertion cursor to indicate where new characters will be inserted.

Spinboxes are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below may be used to change the view in the window. Spinboxes use the standard -xscrollcommand mechanism for interacting with scrollbars (see the description of the -xscrollcommand option for details). They also support scanning, as described below.

Use Window.Spinbox to create a Spinbox with a particular parent.

More information might be available at the Tcl/Tk spinbox page.

Standard options ¶

Widget specific options ¶

Buttonbackground

The background color to be used for the spin buttons.

Buttoncursor

The cursor to be used when over the spin buttons. If this is empty (the default), a default cursor will be used.

Buttondownrelief

The relief to be used for the upper spin button.

Buttonuprelief

The relief to be used for the lower spin button.

Specifies a Tcl command to invoke whenever a spinbutton is invoked. The command recognizes several percent substitutions: %W for the widget path, %s for the current value of the widget, and %d for the direction of the button pressed (up or down).

Disabledbackground

Specifies the background color to use when the spinbox is disabled. If this option is the empty string, the normal background color is used.

Disabledforeground

Specifies the foreground color to use when the spinbox is disabled. If this option is the empty string, the normal foreground color is used.

Format

Specifies an alternate format to use when setting the string value when using the -from and -to range. This must be a format specifier of the form %<pad>.<pad>f, as it will format a floating-point number.

A floating-point value corresponding to the lowest value for a spinbox, to be used in conjunction with -to and -increment. When all are specified correctly, the spinbox will use these values to control its contents. If this value is greater than the -to option, then -from and -to values are automatically swapped. If -values is specified, it supersedes this option.

Invalidcommand

Specifies a script to eval when -validatecommand returns 0. Setting it to an empty string disables this feature (the default). The best use of this option is to set it to bell. See VALIDATION below for more information.

Increment

A floating-point value specifying the increment. When used with -from and -to, the value in the widget will be adjusted by -increment when a spin button is pressed (up adds the value, down subtracts the value).

Readonlybackground

Specifies the background color to use when the spinbox is readonly. If this option is the empty string, the normal background color is used.

Specifies one of three states for the spinbox: normal, disabled, or readonly. If the spinbox is readonly, then the value may not be changed using widget commands and no insertion cursor will be displayed, even if the input focus is in the widget; the contents of the widget may still be selected. If the spinbox is disabled, the value may not be changed, no insertion cursor will be displayed, the contents will not be selectable, and the spinbox may be displayed in a different color, depending on the values of the -disabledforeground and -disabledbackground options.

A floating-point value corresponding to the highest value for the spinbox, to be used in conjunction with -from and -increment. When all are specified correctly, the spinbox will use these values to control its contents. If this value is less than the -from option, then -from and -to values are automatically swapped. If -values is specified, it supersedes this option.

Validate

Specifies the mode in which validation should operate: none, focus, focusin, focusout, key, or all. It defaults to none. When you want validation, you must explicitly state which mode you wish to use. See VALIDATION below for more.

Validatecommand

Specifies a script to evaluate when you want to validate the input in the widget. Setting it to an empty string disables this feature (the default). Validation occurs according to the value of -validate. This command must return a valid Tcl boolean value. If it returns 0 (or the valid Tcl boolean equivalent) then the value of the widget will not change and the -invalidcommand will be evaluated if it is set. If it returns 1, then value will be changed. See VALIDATION below for more information.

Values

Must be a proper list value. If specified, the spinbox will use these values as to control its contents, starting with the first value. This option has precedence over the -from and -to range.

Specifies an integer value indicating the desired width of the spinbox window, in average-size characters of the widget's font. If the value is negative or zero, the widget picks a size just large enough to hold its current text.

Wrap

Must be a proper boolean value. If on, the spinbox will wrap around the values of data in the widget.

type TButtonWidget ¶ added in v0.11.0

type TButtonWidget struct {
	*Window
}

TButtonWidget represents the Tcl/Tk ttk_button widget/window

func TButton ¶ added in v0.2.0

func TButton(options ...Opt) *TButtonWidget

TButton — Widget that issues a command when pressed

Description ¶

A ttk::button widget displays a textual label and/or image, and evaluates a command when pressed.

Use Window.TButton to create a TButton with a particular parent.

More information might be available at the Tcl/Tk ttk_button page.

Standard options ¶

Class
Compound
Cursor
Image
Justify
State
Style
Takefocus
Textvariable
Txt
Underline
Width

Widget specific options ¶

A script to evaluate when the widget is invoked.

Default

May be set to one of normal, active, or disabled. In a dialog box, one button may be designated the button (meaning, roughly, active indicates that this is currently the default button; normal means that it may become the default button, and disabled means that it is not defaultable. The default is normal.

Standard styles ¶

Ttk::button widgets support the Toolbutton style in all standard themes, which is useful for creating widgets for toolbars.

In the Aqua theme there are several other styles which can be used to produce replicas of many of the different button types that are discussed in Apple's Human Interface Guidelines. These include DisclosureButton, DisclosureTriangle, HelpButton, ImageButton, InlineButton, GradientButton, RoundedRectButton, and RecessedButton.

Styling options ¶

The class name for a ttk::button is TButton.

Dynamic states: active, disabled, pressed, readonly.

TButton styling options configurable with ttk::style are:

Anchor anchor
Background color
Bordercolor color
Compound compound
Darkcolor color
Foreground color
Font font
Highlightcolor color
Highlightthickness amount
Lightcolor color
Padding padding
Relief relief
Shiftrelief amount
Width amount

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func TExit ¶ added in v0.5.18

func TExit(options ...Opt) *TButtonWidget

TExit provides a canned TButton with default Txt "Exit", bound to the ExitHandler.

Use Window.TExit to create a TExit with a particular parent.

func (*TButtonWidget) Invoke ¶ added in v0.44.0

func (w *TButtonWidget) Invoke() string

TButton — Widget that issues a command when pressed

Description ¶

Invokes the command associated with the button.

Additional information might be available at the Tcl/Tk ttk::button page.

type TCheckbuttonWidget ¶ added in v0.11.0

type TCheckbuttonWidget struct {
	*Window
}

TCheckbuttonWidget represents the Tcl/Tk ttk_checkbutton widget/window

func TCheckbutton ¶ added in v0.2.0

func TCheckbutton(options ...Opt) *TCheckbuttonWidget

TCheckbutton — On/off widget

Description ¶

A ttk::checkbutton widget is used to show or change a setting. It has two states, selected and deselected. The state of the checkbutton may be linked to a Tcl variable.

Use Window.TCheckbutton to create a TCheckbutton with a particular parent.

More information might be available at the Tcl/Tk ttk_checkbutton page.

Standard options ¶

Class
Compound
Cursor
Image
State
Style
Takefocus
Textvariable
Txt
Underline
Width

Widget specific options ¶

A Tcl script to execute whenever the widget is invoked.

Offvalue

The value to store in the associated -variable when the widget is deselected. Defaults to 0.

Onvalue

The value to store in the associated -variable when the widget is selected. Defaults to 1.

The name of a global variable whose value is linked to the widget. Defaults to the widget pathname if not specified.

Standard styles ¶

Ttk::checkbutton widgets support the Toolbutton style in all standard themes, which is useful for creating widgets for toolbars.

Styling options ¶

The class name for a ttk::checkbutton is TCheckbutton.

Dynamic states: active, alternate, disabled, pressed, selected, readonly.

TCheckbutton styling options configurable with ttk::style are:

Background color
Compound compound
Foreground color
Indicatorbackground color
Indicatorcolor color
Indicatormargin padding
Indicatorrelief relief
Padding padding

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TCheckbuttonWidget) Invoke ¶ added in v0.32.0

func (w *TCheckbuttonWidget) Invoke() string

ttk::checkbutton — On/off widget

Description ¶

Toggles between the selected and deselected states and evaluates the associated -command. If the widget is currently selected, sets the -variable to the -offvalue and deselects the widget; otherwise, sets the -variable to the -onvalue. Returns the result of the -command.

More information might be available at the Tcl/Tk TCheckbutton page.

type TComboboxWidget ¶ added in v0.11.0

type TComboboxWidget struct {
	*Window
}

TComboboxWidget represents the Tcl/Tk ttk_combobox widget/window

func TCombobox ¶ added in v0.2.0

func TCombobox(options ...Opt) *TComboboxWidget

TCombobox — Text field with popdown selection list

Description ¶

A ttk::combobox combines a text field with a pop-down list of values; the user may select the value of the text field from among the values in the list.

Use Window.TCombobox to create a TCombobox with a particular parent.

More information might be available at the Tcl/Tk ttk_combobox page.

Standard options ¶

Class
Cursor
Placeholder
Placeholderforeground
Style
Takefocus

Widget specific options ¶

Exportselection

Boolean value. If set, the widget selection is linked to the X selection.

Justify

Specifies how the text is aligned within the widget. Must be one of left, center, or right.

Specifies the height of the pop-down listbox, in rows.

Postcommand

A Tcl script to evaluate immediately before displaying the listbox. The -postcommand script may specify the -values to display.

One of normal, readonly, or disabled. In the readonly state, the value may not be edited directly, and the user can only select one of the -values from the dropdown list. In the normal state, the text field is directly editable. In the disabled state, no interaction is possible.

Textvariable

Specifies the name of a global variable whose value is linked to the widget value. Whenever the variable changes value the widget value is updated, and vice versa.

Values

Specifies the list of values to display in the drop-down listbox.

Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font.

Styling options ¶

The class name for a ttk::combobox is TCombobox. The ttk::combobox uses the entry and listbox widgets internally. The listbox frame has a class name of ComboboxPopdownFrame.

Dynamic states: disabled, focus, pressed, readonly.

TCombobox styling options configurable with ttk::style are:

Arrowcolor color
Arrowsize amount
Background color
Bordercolor color
Darkcolor color
Focusfill color
Foreground color
Fieldbackground color
Insertcolor color
Insertwidth amount
Lightcolor color
Padding padding
Placeholderforeground color
Postoffset padding
Selectbackground color
Selectforeground color

The ttk::combobox popdown listbox cannot be configured using ttk::style nor via the widget configure command. The listbox can be configured using the option database.

option add *TCombobox*Listbox.background color option add *TCombobox*Listbox.font font option add *TCombobox*Listbox.foreground color option add *TCombobox*Listbox.selectBackground color option add *TCombobox*Listbox.selectForeground color

To configure a specific listbox (subject to future change):

ComboboxPopdownFrame styling options configurable with ttk::style are:

Borderwidth amount
Relief relief

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TComboboxWidget) Current ¶ added in v0.53.0

func (w *TComboboxWidget) Current(newIndex any) (r string)

ttk::combobox — text field with popdown selection list

Description ¶

If newIndex is supplied, sets the combobox value to the element at position newIndex in the list of -values (in addition to integers, the end index is supported and indicates the last element of the list, moreover the same simple interpretation as for the command string index is supported, with simple integer index arithmetic and indexing relative to end). Otherwise, returns the index of the current value in the list of -values or {} if the current value does not appear in the list.

More information might be available at the Tcl/Tk combobox page.

type TEntryWidget ¶ added in v0.11.0

type TEntryWidget struct {
	*Window
}

TEntryWidget represents the Tcl/Tk ttk_entry widget/window

func TEntry ¶ added in v0.2.0

func TEntry(options ...Opt) *TEntryWidget

TEntry — Editable text field widget

Description ¶

An ttk::entry widget displays a one-line text string and allows that string to be edited by the user. The value of the string may be linked to a Tcl variable with the -textvariable option. Entry widgets support horizontal scrolling with the standard -xscrollcommand option and xview widget command.

Use Window.TEntry to create a TEntry with a particular parent.

More information might be available at the Tcl/Tk ttk_entry page.

Standard options ¶

Class
Cursor
Foreground
Placeholder
Placeholderforeground
Style
Takefocus
Xscrollcommand

Widget specific options ¶

Exportselection

A boolean value specifying whether or not a selection in the widget should be linked to the X selection. If the selection is exported, then selecting in the widget deselects the current X selection, selecting outside the widget deselects any widget selection, and the widget will respond to selection retrieval requests when it has a selection.

Invalidcommand

A script template to evaluate whenever the -validatecommand returns 0. See VALIDATION below for more information.

Justify

Specifies how the text is aligned within the entry widget. One of left, center, or right.

Show

If this option is specified, then the true contents of the entry are not displayed in the window. Instead, each character in the entry's value will be displayed as the first character in the value of this option, such as or a bullet. This is useful, for example, if the entry is to be used to enter a password. If characters in the entry are selected and copied elsewhere, the information copied will be what is displayed, not the true contents of the entry.

Compatibility option; see ttk::widget(n) for details. Specifies one of three states for the entry, normal, disabled, or readonly. See WIDGET STATES, below.

Textvariable

Specifies the name of a global variable whose value is linked to the entry widget's contents. Whenever the variable changes value, the widget's contents are updated, and vice versa.

Validate

Specifies the mode in which validation should operate: none, focus, focusin, focusout, key, or all. Default is none, meaning that validation is disabled. See VALIDATION below.

Validatecommand

A script template to evaluate whenever validation is triggered. If set to the empty string (the default), validation is disabled. The script must return a boolean value. See VALIDATION below.

Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font.

Styling options ¶

The class name for a ttk::entry is TEntry.

Dynamic states: disabled, focus, readonly.

TEntry styling options configurable with ttk::style are:

Background color
Bordercolor color
Darkcolor color
Fieldbackground color
Foreground color
Insertcolor color
Insertwidth amount
Lightcolor color
Padding padding
Placeholderforeground color
Relief relief
Selectbackground color
Selectborderwidth amount
Selectforeground color

See the ttk::style manual page for information on how to configure ttk styles.

func (*TEntryWidget) Icursor ¶ added in v0.58.0

func (w *TEntryWidget) Icursor(index any) (r string)

TEntry — Editable text field widget

Description ¶

Arrange for the insertion cursor to be displayed just before the character given by index. Returns an empty string.

More information might be available at the Tcl/Tk ttk_entry page.

type TFrameWidget ¶ added in v0.11.0

type TFrameWidget struct {
	*Window
}

TFrameWidget represents the Tcl/Tk ttk_frame widget/window

func TFrame ¶ added in v0.2.0

func TFrame(options ...Opt) *TFrameWidget

TFrame — Simple container widget

Description ¶

A ttk::frame widget is a container, used to group other widgets together.

Use Window.TFrame to create a TFrame with a particular parent.

More information might be available at the Tcl/Tk ttk_frame page.

Standard options ¶

Class
Cursor
Padding
Style
Takefocus

Widget specific options ¶

Borderwidth

The desired width of the widget border. Defaults to 0. May be ignored depending on the theme used.

Relief

One of the standard Tk border styles: flat, groove, raised, ridge, solid, or sunken. Defaults to flat.

If specified, the widget's requested width in pixels.

If specified, the widget's requested height in pixels.

Styling options ¶

The class name for a ttk::frame is TFrame.

TFrame styling options configurable with ttk::style are:

Background color
Relief relief

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TLabelWidget ¶ added in v0.11.0

type TLabelWidget struct {
	*Window
}

TLabelWidget represents the Tcl/Tk ttk_label widget/window

func TLabel ¶ added in v0.2.0

func TLabel(options ...Opt) *TLabelWidget

TLabel — Display a text string and/or image

Description ¶

A ttk::label widget displays a textual label and/or image. The label may be linked to a Tcl variable to automatically change the displayed text.

Use Window.TLabel to create a TLabel with a particular parent.

More information might be available at the Tcl/Tk ttk_label page.

Standard options ¶

Anchor
Class
Compound
Cursor
Foreground
Image
Justify
Padding
State
Style
Takefocus
Textvariable
Txt
Underline
Width
Wraplength

Widget specific options ¶

The widget's background color. If unspecified, the theme default is used.

Relief

Specifies the 3-D effect desired for the widget border. Valid values are flat, groove, raised, ridge, solid, and sunken.

Wraplength

Specifies the maximum line length (in pixels). If this option is negative or zero, then automatic wrapping is not performed; otherwise the text is split into lines such that no line is longer than the specified value.

Styling options ¶

The class name for a ttk::label is TLabel.

Dynamic states: disabled, readonly.

TLabel styling options configurable with ttk::style are:

Background color
Compound compound
Foreground color
Font font

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TLabelframeWidget ¶ added in v0.11.0

type TLabelframeWidget struct {
	*Window
}

TLabelframeWidget represents the Tcl/Tk ttk_labelframe widget/window

func TLabelframe ¶ added in v0.2.0

func TLabelframe(options ...Opt) *TLabelframeWidget

TLabelframe — Container widget with optional label

Description ¶

A ttk::labelframe widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget.

Use Window.TLabelframe to create a TLabelframe with a particular parent.

More information might be available at the Tcl/Tk ttk_labelframe page.

Standard options ¶

Class
Cursor
Padding
Style
Takefocus

Widget specific options ¶

If specified, the widget's requested height in pixels. (See ttk::frame(n) for further notes on -width and -height).

Labelanchor

Specifies where to place the label. Allowed values are (clockwise from the top upper left corner): nw, n, ne, en, e, es, se, s,sw, ws, w and wn. The default value is theme-dependent.

Labelwidget

The name of a widget to use for the label. If set, overrides the -text option. The -labelwidget must be a child of the labelframe widget or one of the labelframe's ancestors, and must belong to the same top-level widget as the labelframe.

Txt

Specifies the text of the label.

Underline

If set, specifies the integer index (0-based) of a character to underline in the text string. The underlined character is used for mnemonic activation. Mnemonic activation for a ttk::labelframe sets the keyboard focus to the first child of the ttk::labelframe widget.

If specified, the widget's requested width in pixels.

Styling options ¶

The class name for a ttk::labelframe is TLabelframe. The text label has a class of TLabelframe.Label.

Dynamic states: disabled, readonly.

TLabelframe styling options configurable with ttk::style are:

Background color
Bordercolor color
Borderwidth amount
Darkcolor color
Labelmargins amount
Labeloutside boolean
Lightcolor color
Relief relief

TLabelframe.Label styling options configurable with ttk::style are:

Background color
Font font
Foreground color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TMenubuttonWidget ¶ added in v0.11.0

type TMenubuttonWidget struct {
	*Window
}

TMenubuttonWidget represents the Tcl/Tk ttk_menubutton widget/window

func TMenubutton ¶ added in v0.2.0

func TMenubutton(options ...Opt) *TMenubuttonWidget

TMenubutton — Widget that pops down a menu when pressed

Description ¶

A ttk::menubutton widget displays a textual label and/or image, and displays a menu when pressed.

Use Window.TMenubutton to create a TMenubutton with a particular parent.

More information might be available at the Tcl/Tk ttk_menubutton page.

Standard options ¶

Class
Compound
Cursor
Image
State
Style
Takefocus
Textvariable
Txt
Underline
Width

Widget specific options ¶

Direction

Specifies where the menu is to be popped up relative to the menubutton. One of: above, below, left, right, or flush. The default is below. flush pops the menu up directly over the menubutton.

Mnu

Specifies the path name of the menu associated with the menubutton. To be on the safe side, the menu ought to be a direct child of the menubutton.

Standard styles ¶

Ttk::menubutton widgets support the Toolbutton style in all standard themes, which is useful for creating widgets for toolbars.

Styling options ¶

The class name for a ttk::menubutton is TMenubutton.

Dynamic states: active, disabled, readonly.

TMenubutton styling options configurable with ttk::style are:

Arrowsize amount
Background color
Compound compound
Foreground color
Font font
Padding padding
Relief relief
Width amount

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TNotebookWidget ¶ added in v0.11.0

type TNotebookWidget struct {
	*Window
}

TNotebookWidget represents the Tcl/Tk ttk_notebook widget/window

func TNotebook ¶ added in v0.2.0

func TNotebook(options ...Opt) *TNotebookWidget

TNotebook — Multi-paned container widget

Description ¶

A ttk::notebook widget manages a collection of windows and displays a single one at a time. Each content window is associated with a tab, which the user may select to change the currently-displayed window.

Use Window.TNotebook to create a TNotebook with a particular parent.

More information might be available at the Tcl/Tk ttk_notebook page.

Standard options ¶

Class
Cursor
Style
Takefocus

Widget specific options ¶

If present and greater than zero, specifies the desired height of the pane area (not including internal padding or tabs). Otherwise, the maximum height of all panes is used.

Padding

Specifies the amount of extra space to add around the outside of the notebook. The padding is a list of up to four length specifications left top right bottom. If fewer than four elements are specified, bottom defaults to top, right defaults to left, and top defaults to left. In other words, a list of three numbers specify the left, vertical, and right padding; a list of two numbers specify the horizontal and the vertical padding; a single number specifies the same padding all the way around the widget.

If present and greater than zero, specifies the desired width of the pane area (not including internal padding). Otherwise, the maximum width of all panes is used.

Styling options ¶

The class name for a ttk::notebook is TNotebook. The tab has a class name of TNotebook.Tab

Dynamic states: active, disabled, selected.

TNotebook styling options configurable with ttk::style are:

Background color
Bordercolor color
Darkcolor color
Foreground color
Lightcolor color
Padding padding
Tabmargins padding
Tabposition position

TNotebook.Tab styling options configurable with ttk::style are:

Background color
Bordercolor color
Compound compound
Expand padding
Font font
Foreground color
Padding padding

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TNotebookWidget) Add ¶ added in v0.30.0

func (w *TNotebookWidget) Add(options ...Opt)

ttk::notebook — Multi-paned container widget

Description ¶

Adds a new tab to the notebook. See TAB OPTIONS for the list of available options. If window is currently managed by the notebook but hidden, it is restored to its previous position.

More information might be available at the Tcl/Tk TNotebook page.

func (*TNotebookWidget) Select ¶ added in v0.31.0

func (w *TNotebookWidget) Select(tabid any) string

TNotebook — Multi-paned container widget

Description ¶

Selects the specified tab. The associated content window will be displayed, and the previously-selected window (if different) is unmapped. If tabid is omitted, returns the widget name of the currently selected pane.

More information might be available at the Tcl/Tk TNotebook page.

func (*TNotebookWidget) Tabs ¶ added in v0.32.0

func (w *TNotebookWidget) Tabs() (r []*Window)

TNotebook — Multi-paned container widget

Description ¶

Returns the list of windows managed by the notebook, in the index order of their associated tabs.

More information might be available at the Tcl/Tk TNotebook page.

type TPanedwindowWidget ¶ added in v0.11.0

type TPanedwindowWidget struct {
	*Window
}

TPanedwindowWidget represents the Tcl/Tk ttk_panedwindow widget/window

func TPanedwindow ¶ added in v0.2.0

func TPanedwindow(options ...Opt) *TPanedwindowWidget

TPanedwindow — Multi-pane container window

Description ¶

A ttk::panedwindow widget displays a number of subwindows, stacked either vertically or horizontally. The user may adjust the relative sizes of the subwindows by dragging the sash between panes.

Use Window.TPanedwindow to create a TPanedwindow with a particular parent.

More information might be available at the Tcl/Tk ttk_panedwindow page.

Standard options ¶

Class
Cursor
Style
Takefocus

Widget specific options ¶

Specifies the orientation of the window. If vertical, subpanes are stacked top-to-bottom; if horizontal, subpanes are stacked left-to-right.

If present and greater than zero, specifies the desired width of the widget in pixels. Otherwise, the requested width is determined by the width of the managed windows.

If present and greater than zero, specifies the desired height of the widget in pixels. Otherwise, the requested height is determined by the height of the managed windows.

Styling options ¶

The class name for a ttk::panedwindow is TPanedwindow. The sash has a class name of Sash.

TPanedwindow styling options configurable with ttk::style are:

Background color

Sash styling options configurable with ttk::style are:

Background color
Bordercolor color
Gripsize size (number of screen units)
Handlepad amount
Handlesize amount
Lightcolor color
Sashpad amount
Sashrelief relief
Sashthickness amount

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TPanedwindowWidget) Add ¶ added in v0.41.0

func (w *TPanedwindowWidget) Add(subwindow *Window, options ...Opt)

ttk::panedwindow — Multi-pane container window

Description ¶

Adds a new pane to the window. See PANE OPTIONS for the list of available options.

More information might be available at the Tcl/Tk ttk_panedwindow page.

type TProgressbarWidget ¶ added in v0.11.0

type TProgressbarWidget struct {
	*Window
}

TProgressbarWidget represents the Tcl/Tk ttk_progressbar widget/window

func TProgressbar ¶ added in v0.2.0

func TProgressbar(options ...Opt) *TProgressbarWidget

TProgressbar — Provide progress feedback

Description ¶

A ttk::progressbar widget shows the status of a long-running operation. They can operate in two modes: determinate mode shows the amount completed relative to the total amount of work to be done, and indeterminate mode provides an animated display to let the user know that something is happening.

If the value of -orient is horizontal a text string can be displayed inside the progressbar. This string can be configured using the -anchor, -font, -foreground, -justify, is vertical then these options are ignored.

Use Window.TProgressbar to create a TProgressbar with a particular parent.

More information might be available at the Tcl/Tk ttk_progressbar page.

Standard options ¶

Anchor
Class
Cursor
Foreground
Justify
Style
Takefocus
Txt
Wraplength

Widget specific options ¶

Length

Specifies the length of the long axis of the progress bar (width if horizontal, height if vertical). The value may have any of the forms acceptable to Tk_GetPixels.

Maximum

A floating point number specifying the maximum -value. Defaults to 100.

Mode

One of determinate or indeterminate.

One of horizontal or vertical. Specifies the orientation of the progress bar.

Phase

Read-only option. The widget periodically increments the value of this option whenever the -value is greater than 0 and, in determinate mode, less than -maximum. This option may be used by the current theme to provide additional animation effects.

The current value of the progress bar. In determinate mode, this represents the amount of work completed. In indeterminate mode, it is interpreted modulo -maximum; that is, the progress bar completes one when the -value increases by -maximum. If -variable is set to an existing variable, specifying -value has no effect (the variable value takes precedence).

The name of a global Tcl variable which is linked to the -value. If specified to an existing variable, the -value of the progress bar is automatically set to the value of the variable whenever the latter is modified.

Styling options ¶

The class name for a ttk::progressbar is TProgressbar.

TProgressbar styling options configurable with ttk::style are:

Background color
Bordercolor color
Darkcolor color
Lightcolor color
Maxphase
Period
Troughcolor color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TProgressbarWidget) Start ¶ added in v0.61.0

func (w *TProgressbarWidget) Start(interval ...time.Duration)

ttk::progressbar — Provide progress feedback

Description ¶

Begin autoincrement mode: schedules a recurring timer event that calls step every interval milliseconds. If omitted, interval defaults to 50 milliseconds (20 steps/second).

More information might be available at the Tcl/Tk progressbar page.

func (*TProgressbarWidget) Step ¶ added in v0.61.0

func (w *TProgressbarWidget) Step(amount ...float64)

ttk::progressbar — Provide progress feedback

Description ¶

Increments the -value by amount. amount defaults to 1.0 if omitted.

More information might be available at the Tcl/Tk progressbar page.

func (*TProgressbarWidget) Stop ¶ added in v0.61.0

func (w *TProgressbarWidget) Stop()

ttk::progressbar — Provide progress feedback

Description ¶

Stop autoincrement mode: cancels any recurring timer event initiated by pathName start.

More information might be available at the Tcl/Tk progressbar page.

type TRadiobuttonWidget ¶ added in v0.11.0

type TRadiobuttonWidget struct {
	*Window
}

TRadiobuttonWidget represents the Tcl/Tk ttk_radiobutton widget/window

func TRadiobutton ¶ added in v0.2.0

func TRadiobutton(options ...Opt) *TRadiobuttonWidget

TRadiobutton — Mutually exclusive option widget

Description ¶

ttk::radiobutton widgets are used in groups to show or change a set of mutually-exclusive options. Radiobuttons are linked to a Tcl variable, and have an associated value; when a radiobutton is clicked, it sets the variable to its associated value.

Use Window.TRadiobutton to create a TRadiobutton with a particular parent.

More information might be available at the Tcl/Tk ttk_radiobutton page.

Standard options ¶

Class
Compound
Cursor
Image
State
Style
Takefocus
Textvariable
Txt
Underline
Width

Widget specific options ¶

A Tcl script to evaluate whenever the widget is invoked.

The value to store in the associated -variable when the widget is selected.

The name of a global variable whose value is linked to the widget. Default value is ::selectedButton.

Standard styles ¶

Ttk::radiobutton widgets support the Toolbutton style in all standard themes, which is useful for creating widgets for toolbars.

Styling options ¶

The class name for a ttk::radiobutton is TRadiobutton.

Dynamic states: active, alternate, disabled, pressed, readonly, selected.

TRadiobutton styling options configurable with ttk::style are:

Background color
Compound compound
Foreground color
Indicatorbackground color
Indicatorcolor color
Indicatormargin padding
Indicatorrelief relief
Padding padding

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TScaleWidget ¶ added in v0.11.0

type TScaleWidget struct {
	*Window
}

TScaleWidget represents the Tcl/Tk ttk_scale widget/window

func TScale ¶ added in v0.2.0

func TScale(options ...Opt) *TScaleWidget

TScale — Create and manipulate a scale widget

Description ¶

A ttk::scale widget is typically used to control the numeric value of a linked variable that varies uniformly over some range. A scale displays a slider that can be moved along over a trough, with the relative position of the slider over the trough indicating the value of the variable.

Use Window.TScale to create a TScale with a particular parent.

More information might be available at the Tcl/Tk ttk_scale page.

Standard options ¶

Class
Cursor
Style
Takefocus

Widget specific options ¶

Specifies the prefix of a Tcl command to invoke whenever the scale's value is changed via a widget command. The actual command consists of this option followed by a space and a real number indicating the new value of the scale.

A real value corresponding to the left or top end of the scale.

Length

Specifies the desired long dimension of the scale in screen units (i.e. any of the forms acceptable to Tk_GetPixels). For vertical scales this is the scale's height; for horizontal scales it is the scale's width.

Specifies which orientation whether the widget should be laid out horizontally or vertically. Must be either horizontal or vertical or an abbreviation of one of these.

Specifies a real value corresponding to the right or bottom end of the scale. This value may be either less than or greater than the -from option.

Specifies the current floating-point value of the variable. If -variable is set to an existing variable, specifying -value has no effect (the variable value takes precedence).

Specifies the name of a global variable to link to the scale. Whenever the value of the variable changes, the scale will update to reflect this value. Whenever the scale is manipulated interactively, the variable will be modified to reflect the scale's new value.

Styling options ¶

The class name for a ttk::scale is TScale.

Dynamic states: active.

TScale styling options configurable with ttk::style are:

Background color
Borderwidth amount
Darkcolor color
Groovewidth amount
Lightcolor color
Sliderwidth amount
Troughcolor color
Troughrelief relief

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TScaleWidget) Get ¶ added in v0.53.0

func (w *TScaleWidget) Get(xy ...any) (r string)

ttk::scale — Create and manipulate a scale widget

Description ¶

Get the current value of the -value option, or the value corresponding to the coordinates x,y if they are specified. X and y are pixel coordinates relative to the scale widget origin.

More information might be available at the Tcl/Tk scale page.

type TScrollbarWidget ¶ added in v0.11.0

type TScrollbarWidget struct {
	*Window
}

TScrollbarWidget represents the Tcl/Tk ttk_scrollbar widget/window

func TScrollbar ¶ added in v0.2.0

func TScrollbar(options ...Opt) *TScrollbarWidget

TScrollbar — Control the viewport of a scrollable widget

Description ¶

ttk::scrollbar widgets are typically linked to an associated window that displays a document of some sort, such as a file being edited or a drawing. A scrollbar displays a thumb in the middle portion of the scrollbar, whose position and size provides information about the portion of the document visible in the associated window. The thumb may be dragged by the user to control the visible region. Depending on the theme, two or more arrow buttons may also be present; these are used to scroll the visible region in discrete units.

Use Window.TScrollbar to create a TScrollbar with a particular parent.

More information might be available at the Tcl/Tk ttk_scrollbar page.

Standard options ¶

Class
Cursor
Style
Takefocus

Widget specific options ¶

A Tcl script prefix to evaluate to change the view in the widget associated with the scrollbar. Additional arguments are appended to the value of this option, as described in SCROLLING COMMANDS below, whenever the user requests a view change by manipulating the scrollbar.

One of horizontal or vertical. Specifies the orientation of the scrollbar.

Styling options ¶

The class name for a ttk::scrollbar is TScrollbar.

Dynamic states: active, disabled.

TScrollbar (or more specifically Vertical.TScrollbar and Horizontal.TScrollbar) styling options that are configurable with ttk::style are:

Arrowcolor color
Arrowsize amount
Background color
Bordercolor color
Darkcolor color (color of the dark part of the 3D relief)
Foreground color
Gripsize size (number of screen units)
Lightcolor color (color of the light part of the 3D relief)
Troughcolor color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TScrollbarWidget) Set ¶ added in v0.16.2

func (w *TScrollbarWidget) Set(firstLast string)

TScrollbar — Control the viewport of a scrollable widget

Description ¶

This command is normally invoked by the scrollbar's associated widget from an -xscrollcommand or -yscrollcommand callback. Specifies the visible range to be displayed. first and last are real fractions between 0 and 1.

More information might be available at the Tcl/Tk ttk_scrollbar page.

type TSeparatorWidget ¶ added in v0.11.0

type TSeparatorWidget struct {
	*Window
}

TSeparatorWidget represents the Tcl/Tk ttk_separator widget/window

func TSeparator ¶ added in v0.2.0

func TSeparator(options ...Opt) *TSeparatorWidget

TSeparator — Separator bar

Description ¶

A ttk::separator widget displays a horizontal or vertical separator bar.

Use Window.TSeparator to create a TSeparator with a particular parent.

More information might be available at the Tcl/Tk ttk_separator page.

Standard options ¶

Class
Cursor
Style
Takefocus

Widget specific options ¶

One of horizontal or vertical. Specifies the orientation of the separator.

Styling options ¶

The class name for a ttk::separator is TSeparator.

TSeparator styling options configurable with ttk::style are:

Background color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TSizegripWidget ¶ added in v0.11.0

type TSizegripWidget struct {
	*Window
}

TSizegripWidget represents the Tcl/Tk ttk_sizegrip widget/window

func TSizegrip ¶ added in v0.2.0

func TSizegrip(options ...Opt) *TSizegripWidget

TSizegrip — Bottom-right corner resize widget

Description ¶

A ttk::sizegrip widget (also known as a grow box) allows the user to resize the containing toplevel window by pressing and dragging the grip.

Use Window.TSizegrip to create a TSizegrip with a particular parent.

More information might be available at the Tcl/Tk ttk_sizegrip page.

Standard options ¶

Class
Cursor
Style
Takefocus

Styling options ¶

The class name for a ttk::sizegrip is TSizegrip.

TSizegrip styling options configurable with ttk::style are:

Background color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TSpinboxWidget ¶ added in v0.11.0

type TSpinboxWidget struct {
	*Window
}

TSpinboxWidget represents the Tcl/Tk ttk_spinbox widget/window

func TSpinbox ¶ added in v0.2.0

func TSpinbox(options ...Opt) *TSpinboxWidget

TSpinbox — Selecting text field widget

Description ¶

A ttk::spinbox widget is a ttk::entry widget with built-in up and down buttons that are used to either modify a numeric value or to select among a set of values. The widget implements all the features of the ttk::entry widget including support of the to a Tcl variable.

Use Window.TSpinbox to create a TSpinbox with a particular parent.

More information might be available at the Tcl/Tk ttk_spinbox page.

Standard options ¶

Class
Cursor
Placeholder
Placeholderforeground
State
Style
Takefocus
Validate
Validatecommand
Xscrollcommand

Widget specific options ¶

Specifies a Tcl command to be invoked whenever a spinbutton is invoked.

Format

Specifies an alternate format to use when setting the string value when using the -from and -to range. This must be a format specifier of the form %<pad>.<pad>f, as it will format a floating-point number.

A floating-point value specifying the lowest value for the spinbox. This is used in conjunction with -to and -increment to set a numerical range.

Increment

A floating-point value specifying the change in value to be applied each time one of the widget spin buttons is pressed. The up button applies a positive increment, the down button applies a negative increment.

A floating-point value specifying the highest permissible value for the widget. See also -from and -increment. range.

Values

This must be a Tcl list of values. If this option is set then this will override any range set using the -from, -to and -increment options. The widget will instead use the values specified beginning with the first value.

Wrap

Must be a proper boolean value. If on, the spinbox will wrap around the values of data in the widget.

Styling options ¶

The class name for a ttk::spinbox is TSpinbox.

Dynamic states: active, disabled, focus, readonly.

TSpinbox styling options configurable with ttk::style are:

Arrowcolor color
Arrowsize amount
Background color
Bordercolor color
Darkcolor color
Fieldbackground color
Foreground color
Insertcolor color
Insertwidth amount
Lightcolor color
Padding padding
Placeholderforeground color
Selectbackground color
Selectforeground color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

type TTreeviewWidget ¶ added in v0.11.0

type TTreeviewWidget struct {
	*Window
}

TTreeviewWidget represents the Tcl/Tk ttk_treeview widget/window

func TTreeview ¶ added in v0.2.0

func TTreeview(options ...Opt) *TTreeviewWidget

TTreeview — Hierarchical multicolumn data display widget

Description ¶

The ttk::treeview widget displays a hierarchical collection of items. Each item has a textual label, an optional image, and an optional list of data values. The data values are displayed in successive columns after the tree label.

The order in which data values are displayed may be controlled by setting the -displaycolumns widget option. The tree widget can also display column headings. Columns may be accessed by number or by symbolic names listed in the -columns widget option; see COLUMN IDENTIFIERS.

Each item is identified by a unique name. The widget will generate item IDs if they are not supplied by the caller. There is a distinguished root item, named {}. The root item itself is not displayed; its children appear at the top level of the hierarchy.

Each item also has a list of tags, which can be used to associate event bindings with individual items and control the appearance of the item.

Treeview widgets support horizontal and vertical scrolling with the standard -[xy]scrollcommand options and [xy]view widget commands.

Use Window.TTreeview to create a TTreeview with a particular parent.

More information might be available at the Tcl/Tk ttk_treeview page.

Standard options ¶

Class
Cursor
Padding
Style
Takefocus
Xscrollcommand
Yscrollcommand

Widget specific options ¶

Columns

A list of column identifiers, specifying the number of columns and their names.

Displaycolumns

A list of column identifiers (either symbolic names or integer indices) specifying which data columns are displayed and the order in which they appear, or the string #all. If set to #all (the default), all columns are shown in the order given.

Specifies the number of rows which should be visible. Note that the requested width is determined from the sum of the column widths.

Selectmode

Controls how the built-in class bindings manage the selection. One of extended, browse, or none.

Selecttype

Controls how the built-in class bindings manage the selection. One of item or cell.

Show

A list containing zero or more of the following values, specifying which elements of the tree to display.

Striped

Boolean specifying zebra striped item coloring. Note that striped items uses the -stripedbackground option if set by the theme or a tag. If not supported by the current theme, it will not show.

Titlecolumns

Number of display columns at the left that should not be scrolled. The tree column counts, even if -show tree is not specified. Thus for value N of this option, column #N is the first one that is scrollable. Default is 0.

Titleitems

Number of items at the top that should not be vertically scrolled. Default is 0.

Styling options ¶

The class name for a ttk::treeview is Treeview. The treeview header class name is Heading. The treeview item class name is Item. The treeview cell class name is Cell.

Dynamic states: disabled, selected.

Treeview styling options configurable with ttk::style are:

Background color
Fieldbackground color
Font font
Foreground color
Indent amount
Columnseparatorwidth amount
Rowheight amount
Stripedbackground color

Heading styling options configurable with ttk::style are:

Background color
Font font
Relief relief

Item styling options configurable with ttk::style are:

Foreground color
Indicatormargins padding
Indicatorsize amount
Padding padding

Cell styling options configurable with ttk::style are:

Padding padding

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

func (*TTreeviewWidget) Children ¶ added in v0.58.0

func (w *TTreeviewWidget) Children(item any, newChildren ...any) (r []string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

If newchildren is not specified, returns the list of children belonging to item.

If newchildren is specified, replaces item's child list with newchildren. Items in the old child list not present in the new child list are detached from the tree. None of the items in newchildren may be an ancestor of item.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Column ¶ added in v0.53.0

func (w *TTreeviewWidget) Column(column any, options ...Opt) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Query or modify the options for the specified column. If no -option is specified, returns a dictionary of option/value pairs. If a single -option is specified, returns the value of that option. Otherwise, the options are updated with the specified values. The following options may be set on each column:

id name: The column name. This is a read-only option. For example, [$pathname column #n -id] returns the data column associated with display column n. The tree column has -id #0.
anchor anchor: Specifies how the text in this column should be aligned with respect to the cell. Anchor is one of n, ne, e, se, s, sw, w, nw, or center.
minwidth minwidth: The minimum width of the column in pixels. The treeview widget will not make the column any smaller than -minwidth when the widget is resized or the user drags a heading column separator. Default is 20 pixels.
separator boolean: Specifies whether or not a column separator should be drawn to the right of the column. Default is false.
stretch boolean: Specifies whether or not the column width should be adjusted when the widget is resized or the user drags a heading column separator. Boolean may have any of the forms accepted by Tcl_GetBoolean. By default columns are stretchable. -width width: The width of the column in pixels. Default is 200 pixels. The specified column width may be changed by Tk in order to honor -stretch and/or -minwidth, or when the widget is resized or the user drags a heading column separator.

Use pathname "#0" to configure the tree column.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Delete ¶ added in v0.57.0

func (w *TTreeviewWidget) Delete(itemList ...any)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Deletes each of the items in itemList and all of their descendants. The root item may not be deleted. See also: detach.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Focus ¶ added in v0.59.0

func (w *TTreeviewWidget) Focus(item ...any) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

If item is specified, sets the focus item to item. Otherwise, returns the current focus item, or {} if there is none.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Heading ¶ added in v0.53.0

func (w *TTreeviewWidget) Heading(column any, options ...Opt) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Query or modify the heading options for the specified column. Valid options are:

text text: The text to display in the column heading.
image imageName: Specifies an image to display to the right of the column heading.
anchor anchor: Specifies how the heading text should be aligned. One of the standard Tk anchor values.
command script: A script to evaluate when the heading label is pressed.

Use pathname heading "#0" to configure the tree column heading.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) IdentifyCell ¶ added in v0.57.0

func (w *TTreeviewWidget) IdentifyCell(x, y int) (r []string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns the cell identifier of the cell at position x, y. A cell identifier is a list of item ID and column ID.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) IdentifyColumn ¶ added in v0.57.0

func (w *TTreeviewWidget) IdentifyColumn(x, y int) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns the display column identifier of the cell at position x. The tree column has ID #0.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) IdentifyElement ¶ added in v0.57.0

func (w *TTreeviewWidget) IdentifyElement(x, y int) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns the element at position x, y.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) IdentifyItem ¶ added in v0.57.0

func (w *TTreeviewWidget) IdentifyItem(x, y int) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns the item ID of the item at position x y.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) IdentifyRegion ¶ added in v0.57.0

func (w *TTreeviewWidget) IdentifyRegion(x, y int) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns one of:

heading
Tree heading area; use [pathname identify column x y] to determine the heading number.
separator
Space between two column headings; [pathname identify column x y] will return the display column identifier of the heading to left of the separator.
tree
The tree area.
cell
A data cell.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Index ¶ added in v0.57.0

func (w *TTreeviewWidget) Index(item any) (r int)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns the integer index of item within its parent's list of children or -1 otherwise.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Insert ¶ added in v0.53.0

func (w *TTreeviewWidget) Insert(parent, index any, options ...Opt) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Creates a new item. parent is the item ID of the parent item, or the empty string {} to create a new top-level item. index is an integer, or the value end, specifying where in the list of parent's children to insert the new item. If index is negative or zero, the new node is inserted at the beginning; if index is greater than or equal to the current number of children, it is inserted at the end. If -id is specified, it is used as the item identifier; id must not already exist in the tree. Otherwise, a new unique identifier is generated.

Insert returns the item identifier of the newly created item. See ITEM OPTIONS for the list of available options.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Item ¶ added in v0.53.0

func (w *TTreeviewWidget) Item(item any, options ...any) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Query or modify the options for the specified item. If no -option is specified, returns a dictionary of option/value pairs. If a single -option is specified, returns the value of that option. Otherwise, the item's options are updated with the specified values. See ITEM OPTIONS for the list of available options. pathname move item parent index

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Parent ¶ added in v0.57.0

func (w *TTreeviewWidget) Parent(item any) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Returns the ID of the parent of item, or "" if item is at the top level of the hierarchy.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) See ¶ added in v0.53.0

func (w *TTreeviewWidget) See(item any)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Ensure that item is visible: sets all of item's ancestors to -open true, and scrolls the widget if necessary so that item is within the visible portion of the tree.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) Selection ¶ added in v0.53.0

func (w *TTreeviewWidget) Selection(selop string, itemList ...any) (r []string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Manages item selection. Item selection is independent from cell selection handled by the cellselection command. If selop is not specified, returns the list of selected items. Otherwise, selop is one of the following:

set itemList: itemList becomes the new selection.
add itemList: Add itemList to the selection.
remove itemList: Remove itemList from the selection.
toggle itemList: Toggle the selection state of each item in itemList.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) TagAdd ¶ added in v0.59.0

func (w *TTreeviewWidget) TagAdd(tag string, items ...any)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Adds the specified tag to each of the listed items. If tag is already present for a particular item, then the -tags for that item are unchanged.

More information might be available at the Tcl/Tk treeview page.

func (*TTreeviewWidget) TagConfigure ¶ added in v0.59.0

func (w *TTreeviewWidget) TagConfigure(tag string, options ...any) (r string)

ttk::treeview — hierarchical multicolumn data display widget

Description ¶

Query or modify the options for the specified tagName. If one or more option/value pairs are specified, sets the value of those options for the specified tag. If a single option is specified, returns the value of that option (or the empty string if the option has not been specified for tagName). With no additional arguments, returns a dictionary of the option settings for tagName. See TAG OPTIONS for the list of available options.

More information might be available at the Tcl/Tk treeview page.

type TextWidget ¶ added in v0.11.0

type TextWidget struct {
	*Window
}

TextWidget represents the Tcl/Tk text widget/window

func Text ¶ added in v0.2.0

func Text(options ...Opt) *TextWidget

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

The text command creates a new window (given by the pathName argument) and makes it into a text widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the text such as its default background color and relief. The text command returns the path name of the new window.

A text widget displays one or more lines of text and allows that text to be edited. Text widgets support four different kinds of annotations on the text, called tags, marks, embedded windows or embedded images. Tags allow different portions of the text to be displayed with different fonts and colors. In addition, Tcl commands can be associated with tags so that scripts are invoked when particular actions such as keystrokes and mouse button presses occur in particular ranges of the text. See TAGS below for more details.

The second form of annotation consists of floating markers in the text called marks . Marks are used to keep track of various interesting positions in the text as it is edited. See MARKS below for more details.

The third form of annotation allows arbitrary windows to be embedded in a text widget. See EMBEDDED WINDOWS below for more details.

The fourth form of annotation allows Tk images to be embedded in a text widget. See EMBEDDED IMAGES below for more details.

The text widget also has a built-in undo/redo mechanism. See THE UNDO MECHANISM below for more details.

The text widget allows for the creation of peer widgets. These are other text widgets which share the same underlying data (text, marks, tags, images, etc). See PEER WIDGETS below for more details.

Use Window.Text to create a Text with a particular parent.

More information might be available at the Tcl/Tk text page.

Standard options ¶

Widget specific options ¶

Autoseparators

Specifies a boolean that says whether separators are automatically inserted in the undo stack. Only meaningful when the -undo option is true.

Blockcursor

Specifies a boolean that says whether the blinking insertion cursor should be drawn as a character-sized rectangular block. If false (the default) a thin vertical line is used for the insertion cursor.

Endline

Specifies an integer line index representing the line of the underlying textual data store that should be just after the last line contained in the widget. This allows a text widget to reflect only a portion of a larger piece of text. Instead of an integer, the empty string can be provided to this configuration option, which will configure the widget to end at the very last line in the textual data store.

Specifies the desired height for the window, in units of characters in the font given by the -font option. Must be at least one.

Inactiveselectbackground

Specifies the colour to use for the selection (the sel tag) when the window does not have the input focus. If empty, {}, then no selection is shown when the window does not have the focus.

Insertunfocussed

Specifies how to display the insertion cursor when the widget does not have the focus. Must be none (the default) which means to not display the cursor, hollow which means to display a hollow box, or solid which means to display a solid box. Note that hollow and solid will appear very similar when the -blockcursor option is false.

Maxundo

Specifies the maximum number of compound undo actions on the undo stack. A zero or a negative value imply an unlimited undo stack.

Spacing1

Requests additional space above each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the first line on the display. This option may be overridden with -spacing1 options in tags.

Spacing2

For lines that wrap (so that they cover more than one line on the display) this option specifies additional space to provide between the display lines that represent a single line of text. The value may have any of the standard forms for screen distances. This option may be overridden with -spacing2 options in tags.

Spacing3

Requests additional space below each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the last line on the display. This option may be overridden with -spacing3 options in tags.

Startline

Specifies an integer line index representing the first line of the underlying textual data store that should be contained in the widget. This allows a text widget to reflect only a portion of a larger piece of text. Instead of an integer, the empty string can be provided to this configuration option, which will configure the widget to start at the very first line in the textual data store.

Specifies one of two states for the text: normal or disabled. If the text is disabled then characters may not be inserted or deleted and no insertion cursor will be displayed, even if the input focus is in the widget.

Tabs

Specifies a set of tab stops for the window. The option's value consists of a list of screen distances giving the positions of the tab stops, each of which is a distance relative to the left edge of the widget (excluding borders, padding, etc). Each position may optionally be followed in the next list element by one of the keywords left, right, center, or numeric, which specifies how to justify text relative to the tab stop. Left is the default; it causes the text following the tab character to be positioned with its left edge at the tab position. Right means that the right edge of the text following the tab character is positioned at the tab position, and center means that the text is centered at the tab position. Numeric means that the decimal point in the text is positioned at the tab position; if there is no decimal point then the least significant digit of the number is positioned just to the left of the tab position; if there is no number in the text then the text is right-justified at the tab position. For example, creates three tab stops at two-centimeter intervals; the first two use left justification and the third uses center justification.

Tabstyle

Specifies how to interpret the relationship between tab stops on a line and tabs in the text of that line. The value must be tabular (the default) or wordprocessor. Note that tabs are interpreted as they are encountered in the text. If the tab style is tabular then the n'th tab character in the line's text will be associated with the n'th tab stop defined for that line. If the tab character's x coordinate falls to the right of the n'th tab stop, then a gap of a single space will be inserted as a fallback. If the tab style is wordprocessor then any tab character being laid out will use (and be defined by) the first tab stop to the right of the preceding characters already laid out on that line. The value of the -tabstyle option may be overridden by -tabstyle options in tags.

Undo

Specifies a boolean that says whether the undo mechanism is active or not.

Specifies the desired width for the window in units of characters in the font given by the -font option. If the font does not have a uniform width then the width of the character is used in translating from character units to screen units.

Wrap

Specifies how to handle lines in the text that are too long to be displayed in a single line of the text's window. The value must be none or char or word. A wrap mode of none means that each line of text appears as exactly one line on the screen; extra characters that do not fit on the screen are not displayed. In the other modes each line of text will be broken up into several screen lines if necessary to keep all the characters visible. In char mode a screen line break may occur after any character; in word mode a line break will only be made at word boundaries.

func (*TextWidget) Clear ¶ added in v0.38.0

func (w *TextWidget) Clear()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Clear makes 'w' empty.

func (*TextWidget) Copy ¶ added in v0.32.0

func (w *TextWidget) Copy()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Copies the selection in the widget to the clipboard, if there is a selection.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Count ¶ added in v0.48.0

func (w *TextWidget) Count(options ...any) []string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

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 depend on the options given. 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. The default value, if no option is specified, is -indices. There is an additional possible option -update which is a modifier. If given (and if the text widget is managed by a geometry manager), then all subsequent options ensure that any possible out of date information is recalculated. This currently only has any effect for the -ypixels count (which, if -update is not given, will use the text widget's current cached value for each line). This -update option is obsoleted by pathName sync, pathName pendingsync and <<WidgetViewSync>>. The count options are interpreted as follows:

Chars Count all characters, whether elided or not. Do not count embedded windows or images.
Displaychars Count all non-elided characters.
Displayindices Count all non-elided characters, windows and images.
Displaylines Count all display lines (i.e. counting one for each time a line wraps) from the line of the first index up to, but not including the display line of the second index. Therefore if they are both on the same display line, zero will be returned. By definition displaylines are visible and therefore this only counts portions of actual visible lines.
Indices Count all characters and embedded windows or images (i.e. everything which counts in text-widget index space), whether they are elided or not.
Lines Count all logical lines (irrespective of wrapping) from the line of the first index up to, but not including the line of the second index. Therefore if they are both on the same line, zero will be returned. Logical lines are counted whether they are currently visible (non-elided) or not.
Xpixels Count the number of horizontal pixels from the first pixel of the first index to (but not including) the first pixel of the second index. To count the total desired width of the text widget (assuming wrapping is not enabled), first find the longest line and then use “.text count -xpixels "${line}.0" "${line}.0 lineend"”.
Ypixels Count the number of vertical pixels from the first pixel of the first index to (but not including) the first pixel of the second index. If both indices are on the same display line, zero will be returned. To count the total number of vertical pixels in the text widget, use “.text count -ypixels 1.0 end”, and to ensure this is up to date, use “.text count -update -ypixels 1.0 end”.

The command returns a positive or negative integer corresponding to the number of items counted between the two indices. One such integer is returned for each counting option given, so a list is returned if more than one option was supplied. For example “.text count -xpixels -ypixels 1.3 4.5” is perfectly valid and will return a list of two elements.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Cut ¶ added in v0.32.0

func (w *TextWidget) Cut()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Copies the selection in the widget to the clipboard and deletes the selection. If there is no selection in the widget then these keys have no effect.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Delete ¶ added in v0.37.0

func (w *TextWidget) Delete(options ...any)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Delete a range of characters from the text. If both index1 and index2 are specified, then delete all the characters starting with the one given by index1 and stopping just before index2 (i.e. the character at index2 is not deleted). If index2 does not specify a position later in the text than index1 then no characters are deleted. If index2 is not specified then the single character at index1 is deleted. Attempts to delete characters in a way that would leave the text without a newline as the last character will be tweaked by the text widget to avoid this. In particular, deletion of complete lines of text up to the end of the text will also delete the newline character just before the deleted block so that it is replaced by the new final newline of the text widget. The command returns an empty string. If more indices are given, multiple ranges of text will be deleted. All indices are first checked for validity before any deletions are made. They are sorted and the text is removed from the last range to the first range so deleted text does not cause an undesired index shifting side-effects. If multiple ranges with the same start index are given, then the longest range is used. If overlapping ranges are given, then they will be merged into spans that do not cause deletion of text outside the given ranges due to text shifted during deletion.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) EditReset ¶ added in v0.47.0

func (w *TextWidget) EditReset()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Clears the undo and redo stacks.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Get ¶ added in v0.30.3

func (w *TextWidget) Get(options ...any) (r []string)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Return a range of characters from the text. The return value will be all the characters in the text starting with the one whose index is index1 and ending just before the one whose index is index2 (the character at index2 will not be returned). If index2 is omitted then the single character at index1 is returned. If there are no characters in the specified range (e.g. index1 is past the end of the file or index2 is less than or equal to index1) then an empty string is returned. If the specified range contains embedded windows, no information about them is included in the returned string. If multiple index pairs are given, multiple ranges of text will be returned in a list. Invalid ranges will not be represented with empty strings in the list. The ranges are returned in the order passed to pathName get. If the -displaychars option is given, then, within each range, only those characters which are not elided will be returned. This may have the effect that some of the returned ranges are empty strings.

BUG(jnml) TextWidget.Get currently supports only one range.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) ImageCreate ¶ added in v0.36.0

func (w *TextWidget) ImageCreate(index any, options ...Opt)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

This command creates a new image annotation, which will appear in the text at the position given by index. Any number of option-value pairs may be specified to configure the annotation. Returns a unique identifier that may be used as an index to refer to this image. See EMBEDDED IMAGES for information on the options that are supported, and a description of the identifier returned.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Index ¶ added in v0.43.0

func (w *TextWidget) Index(index any) (r string)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Returns the position corresponding to index in the form line.char where line is the line number and char is the character number. Index may have any of the forms described under INDICES above.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Insert ¶ added in v0.11.0

func (w *TextWidget) Insert(index any, chars string, options ...string) any

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Inserts all of the chars arguments just before the character at index. If index refers to the end of the text (the character after the last newline) then the new text is inserted just before the last newline instead. If there is a single chars argument and no tagList, then the new text will receive any tags that are present on both the character before and the character after the insertion point; if a tag is present on only one of these characters then it will not be applied to the new text. If tagList is specified then it consists of a list of tag names; the new characters will receive all of the tags in this list and no others, regardless of the tags present around the insertion point. If multiple chars-tagList argument pairs are present, they produce the same effect as if a separate pathName insert widget command had been issued for each pair, in order. The last tagList argument may be omitted.

The value that is passed to Tcl/Tk for the 'index' argument is obtained by fmt.Sprint(index), enabling any custom index encoding via implementing fmt.Stringer.

Indices ¶

Many of the widget commands for texts take one or more indices as arguments. An index is a string used to indicate a particular place within a text, such as a place to insert characters or one endpoint of a range of characters to delete. Indices have the syntax

base modifier modifier modifier ...

Where base gives a starting point and the modifiers adjust the index from the starting point (e.g. move forward or backward one character). Every index must contain a base, but the modifiers are optional. Most modifiers (as documented below) allow an optional submodifier. Valid submodifiers are any and display. If the submodifier is abbreviated, then it must be followed by whitespace, but otherwise there need be no space between the submodifier and the following modifier. Typically the display submodifier adjusts the meaning of the following modifier to make it refer to visual or non-elided units rather than logical units, but this is explained for each relevant case below. Lastly, where count is used as part of a modifier, it can be positive or negative, so “base - -3 lines” is perfectly valid (and equivalent to “base +3lines”).

The base for an index must have one of the following forms:

"line.char"

Indicates char'th character on line line. Lines are numbered from 1 for consistency with other UNIX programs that use this numbering scheme. Within a line, characters are numbered from 0. If char is end then it refers to the newline character that ends the line.

This form of index can be passed as LC{line, char}.

"@x,y"

Indicates the character that covers the pixel whose x and y coordinates within the text's window are x and y.

"end"

Indicates the end of the text (the character just after the last newline).

"mark"

Indicates the character just after the mark whose name is mark (see MARKS for details).

"tag.first"

Indicates the first character in the text that has been tagged with tag. This form generates an error if no characters are currently tagged with tag.

"tag.last"

Indicates the character just after the last one in the text that has been tagged with tag. This form generates an error if no characters are currently tagged with tag.

"pathName"

Indicates the position of the embedded window whose name is pathName. This form generates an error if there is no embedded window by the given name.

"imageName"

Indicates the position of the embedded image whose name is imageName. This form generates an error if there is no embedded image by the given name.

If the base could match more than one of the above forms, such as a mark and imageName both having the same value, then the form earlier in the above list takes precedence. If modifiers follow the base index, each one of them must have one of the forms listed below. Keywords such as chars and wordend may be abbreviated as long as the abbreviation is unambiguous.

"+ count ?submodifier? chars"

Adjust the index forward by count characters, moving to later lines in the text if necessary. If there are fewer than count characters in the text after the current index, then set the index to the last index in the text. Spaces on either side of count are optional. If the display submodifier is given, elided characters are skipped over without being counted. If any is given, then all characters are counted. For historical reasons, if neither modifier is given then the count actually takes place in units of index positions (see INDICES for details). This behaviour may be changed in a future major release, so if you need an index count, you are encouraged to use indices instead wherever possible.

"- count ?submodifier? chars"

Adjust the index backward by count characters, moving to earlier lines in the text if necessary. If there are fewer than count characters in the text before the current index, then set the index to the first index in the text (1.0). Spaces on either side of count are optional. If the display submodifier is given, elided characters are skipped over without being counted. If any is given, then all characters are counted. For historical reasons, if neither modifier is given then the count actually takes place in units of index positions (see INDICES for details). This behavior may be changed in a future major release, so if you need an index count, you are encouraged to use indices instead wherever possible.

"+ count ?submodifier? indices"

Adjust the index forward by count index positions, moving to later lines in the text if necessary. If there are fewer than count index positions in the text after the current index, then set the index to the last index position in the text. Spaces on either side of count are optional. Note that an index position is either a single character or a single embedded image or embedded window. If the display submodifier is given, elided indices are skipped over without being counted. If any is given, then all indices are counted; this is also the default behaviour if no modifier is given.

"- count ?submodifier? indices"

Adjust the index backward by count index positions, moving to earlier lines in the text if necessary. If there are fewer than count index positions in the text before the current index, then set the index to the first index position (1.0) in the text. Spaces on either side of count are optional. If the display submodifier is given, elided indices are skipped over without being counted. If any is given, then all indices are counted; this is also the default behaviour if no modifier is given.

"+ count ?submodifier? lines"

Adjust the index forward by count lines, retaining the same character position within the line. If there are fewer than count lines after the line containing the current index, then set the index to refer to the same character position on the last line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of count are optional. If the display submodifier is given, then each visual display line is counted separately. Otherwise, if any (or no modifier) is given, then each logical line (no matter how many times it is visually wrapped) counts just once. If the relevant lines are not wrapped, then these two methods of counting are equivalent.

"- count ?submodifier? lines"

Adjust the index backward by count logical lines, retaining the same character position within the line. If there are fewer than count lines before the line containing the current index, then set the index to refer to the same character position on the first line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of count are optional. If the display submodifier is given, then each visual display line is counted separately. Otherwise, if any (or no modifier) is given, then each logical line (no matter how many times it is visually wrapped) counts just once. If the relevant lines are not wrapped, then these two methods of counting are equivalent.

"?submodifier? linestart"

Adjust the index to refer to the first index on the line. If the display submodifier is given, this is the first index on the display line, otherwise on the logical line.

"?submodifier? lineend"

Adjust the index to refer to the last index on the line (the newline). If the display submodifier is given, this is the last index on the display line, otherwise on the logical line.

"?submodifier? wordstart"

Adjust the index to refer to the first character of the word containing the current index. A word consists of any number of adjacent characters that are letters, digits, or underscores, or a single character that is not one of these. If the display submodifier is given, this only examines non-elided characters, otherwise all characters (elided or not) are examined.

"?submodifier? wordend"

Adjust the index to refer to the character just after the last one of the word containing the current index. If the current index refers to the last character of the text then it is not modified. If the display submodifier is given, this only examines non-elided characters, otherwise all characters (elided or not) are examined.

If more than one modifier is present then they are applied in left-to-right order. For example, the index “end - 1 chars” refers to the next-to-last character in the text and “insert wordstart - 1 c” refers to the character just before the first one in the word containing the insertion cursor. Modifiers are applied one by one in this left to right order, and after each step the resulting index is constrained to be a valid index in the text widget. So, for example, the index “1.0 -1c +1c” refers to the index “2.0”.

Where modifiers result in index changes by display lines, display chars or display indices, and the base refers to an index inside an elided tag, that base index is considered to be equivalent to the first following non-elided index.

Insert returns its index argument.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) InsertML ¶ added in v0.17.0

func (w *TextWidget) InsertML(list ...any)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

InsertML inserts 'ml' at the end of 'w', interpreting it as a HTML-like markup language.

It recognizes and treats accordingly the <br> tag.

The <img> tag is reserved for embedded images. You can inline the image directly:

InsertML("Hello", NewPhoto(...), Align("top"), "world!")

The <embed> tag is reserved for embedded widgets. You can inline a widget directly:

InsertML("Hello", Button(Txt("Foo")), Align("center"), "world!")

The <pre> tag works similarly to HTML, ie. white space and line breaks are kept. To make the content of a <pre> rendered in monospace, configure the tag, for example:

t.TagConfigure("pre", Font(CourierFont(), 10)

Other ML-tags are used as names of configured 'w' tags, if configured, ignored otherwise.

Example usage in _examples/embed.go.

func (*TextWidget) MarkGravity ¶ added in v0.45.0

func (w *TextWidget) MarkGravity(markName, direction string)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

If direction is not specified, returns left or right to indicate which of its adjacent characters markName is attached to. If direction is specified, it must be left or right; the gravity of markName is set to the given value.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) MarkNames ¶ added in v0.45.0

func (w *TextWidget) MarkNames() []string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Returns a list whose elements are the names of all the marks that are currently set.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) MarkSet ¶ added in v0.44.0

func (w *TextWidget) MarkSet(markName string, index any)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Sets the mark named markName to a position just before the character at index. If markName already exists, it is moved from its old position; if it does not exist, a new mark is created. This command returns an empty string.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) MarkUnset ¶ added in v0.45.0

func (w *TextWidget) MarkUnset(markName ...string)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Remove the mark corresponding to each of the markName arguments. The removed marks will not be usable in indices and will not be returned by future calls to “pathName mark names”. This command returns an empty string.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Modified ¶ added in v0.41.0

func (w *TextWidget) Modified() bool

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

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.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Paste ¶ added in v0.32.0

func (w *TextWidget) Paste()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Inserts the contents of the clipboard at the position of the insertion cursor.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Redo ¶ added in v0.31.0

func (w *TextWidget) Redo()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

When the -undo option is true, reapplies the last undone edits provided no other edits were done since then, and returns a list of indices indicating what ranges were changed by the redo operation. Generates an error when the redo stack is empty. Does nothing when the -undo option is false.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Search ¶ added in v0.44.0

func (w *TextWidget) Search(options ...any) string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Searches the text in pathName starting at index for a range of characters that matches pattern. If a match is found, the index of the first character in the match is returned as result; otherwise an empty string is returned. One or more of the following switches (or abbreviations thereof) may be specified to control the search:

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) See ¶ added in v0.43.0

func (w *TextWidget) See(index any)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Adjusts the view in the window so that the character given by index is completely visible. If index is already visible then the command does nothing. If index is a short distance out of view, the command adjusts the view just enough to make index visible at the edge of the window. If index is far out of view, then the command centers index in the window.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) SelectAll ¶ added in v0.41.0

func (w *TextWidget) SelectAll()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Select all text in 'w'.

func (*TextWidget) SetModified ¶ added in v0.41.0

func (w *TextWidget) SetModified(v bool)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Sets the modified flag of the widget to 'v'.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagAdd ¶ added in v0.11.0

func (w *TextWidget) TagAdd(tagName string, indexes ...any) string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Associate the tag name with all of the characters starting with index1 and ending just before index2 (the character at index2 is not tagged). A single command may contain any number of index1-index2 pairs. If the last index2 is omitted then the single character at index1 is tagged. If there are no characters in the specified range (e.g. index1 is past the end of the file or index2 is less than or equal to index1) then the command has no effect.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagBind ¶ added in v0.40.0

func (w *TextWidget) TagBind(tag, sequence string, handler any) string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

This command associates a script with the tag given by tagName. Whenever the event sequence given by sequence occurs for a character that has been tagged with tagName, the script will be invoked. This widget command is similar to the bind command except that it operates on characters in a text rather than entire widgets. See the bind manual entry for complete details on the syntax of sequence and the substitutions performed on script before invoking it. A new binding is created, replacing any existing binding for the same sequence and tagName. The only events for which bindings may be specified are those related to the mouse and keyboard (such as Enter, Leave, Button, Motion, and Key) or virtual events. Mouse and keyboard event bindings for a text widget respectively use the current and insert marks described under MARKS above. An Enter event triggers for a tag when the tag first becomes present on the current character, and a Leave event triggers for a tag when it ceases to be present on the current character. Enter and Leave events can happen either because the current mark moved or because the character at that position changed. Note that these events are different than Enter and Leave events for windows. Mouse events are directed to the current character, while keyboard events are directed to the insert character. If a virtual event is used in a binding, that binding can trigger only if the virtual event is defined by an underlying mouse-related or keyboard-related event.

It is possible for the current character to have multiple tags, and for each of them to have a binding for a particular event sequence. When this occurs, one binding is invoked for each tag, in order from lowest-priority to highest priority. If there are multiple matching bindings for a single tag, then the most specific binding is chosen (see the manual entry for the bind command for details). continue and break commands within binding scripts are processed in the same way as for bindings created with the bind command.

If bindings are created for the widget as a whole using the bind command, then those bindings will supplement the tag bindings. The tag bindings will be invoked first, followed by bindings for the window as a whole.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagConfigure ¶ added in v0.11.0

func (w *TextWidget) TagConfigure(tagName string, options ...Opt)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

This command is similar to the pathName configure widget command except that it modifies options associated with the tag given by tagName instead of modifying options for the overall text widget. If no option is specified, the command returns a list describing all of the available options for tagName (see Tk_ConfigureInfo for information on the format of this list). 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 option(s) to have the given value(s) in tagName; in this case the command returns an empty string. See TAGS above for details on the options available for tags.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagDelete ¶ added in v0.38.0

func (w *TextWidget) TagDelete(tags ...string)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Deletes all tag information for each of the tagName arguments. The command removes the tags from all characters in the file and also deletes any other information associated with the tags, such as bindings and display information. The command returns an empty string.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagNames ¶ added in v0.38.0

func (w *TextWidget) TagNames(index string) []string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Returns a list whose elements are the names of all the tags that are active at the character position given by index. If index is omitted, then the return value will describe all of the tags that exist for the text (this includes all tags that have been named in a “pathName tag” widget command but have not been deleted by a “pathName tag delete” widget command, even if no characters are currently marked with the tag). The list will be sorted in order from lowest priority to highest priority.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagRanges ¶ added in v0.51.0

func (w *TextWidget) TagRanges(tagName string) (r []string)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Returns a list describing all of the ranges of text that have been tagged with tagName. The first two elements of the list describe the first tagged range in the text, the next two elements describe the second range, and so on. The first element of each pair contains the index of the first character of the range, and the second element of the pair contains the index of the character just after the last one in the range. If there are no characters tagged with tag then an empty string is returned.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) TagRemove ¶ added in v0.62.0

func (w *TextWidget) TagRemove(tagName string, indexes ...any) string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Remove the tag tagName from all of the characters starting at index1 and ending just before index2 (the character at index2 is not affected). A single command may contain any number of index1-index2 pairs. If the last index2 is omitted then the tag is removed from the single character at index1. If there are no characters in the specified range (e.g. index1 is past the end of the file or index2 is less than or equal to index1) then the command has no effect. This command returns an empty string.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Text ¶ added in v0.31.0

func (w *TextWidget) Text() string

Text is a shortcut for w.Get("1.0", "end-1c")[0].

func (*TextWidget) Undo ¶ added in v0.31.0

func (w *TextWidget) Undo()

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Undoes the last edit action when the -undo option is true, and returns a list of indices indicating what ranges were changed by the undo operation. 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.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) WindowCreate ¶ added in v0.36.0

func (w *TextWidget) WindowCreate(index any, options ...Opt)

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

This command creates a new window annotation, which will appear in the text at the position given by index. Any number of option-value pairs may be specified to configure the annotation. See EMBEDDED WINDOWS for information on the options that are supported. Returns an empty string.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Xview ¶ added in v0.17.0

func (w *TextWidget) Xview() string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Returns a list containing two elements, both of which are real fractions between 0 and 1. The first element gives the position of the first visible pixel of the first character (or image, etc) in the top line in the window, relative to the text as a whole (0.5 means it is halfway through the text, for example). The second element gives the position of the first pixel just after the last visible one in the bottom line of the window, relative to the text as a whole. These are the same values passed to scrollbars via the -xscrollcommand option.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Yview ¶ added in v0.16.2

func (w *TextWidget) Yview() string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Returns a list containing two elements, both of which are real fractions between 0 and 1. The first element gives the position of the first visible pixel of the first character (or image, etc) in the top line in the window, relative to the text as a whole (0.5 means it is halfway through the text, for example). The second element gives the position of the first pixel just after the last visible one in the bottom line of the window, relative to the text as a whole. These are the same values passed to scrollbars via the -yscrollcommand option.

Additional information might be available at the Tcl/Tk text page.

func (*TextWidget) Yviewmoveto ¶ added in v0.43.0

func (w *TextWidget) Yviewmoveto(fraction any) string

Text — Create and manipulate 'text' hypertext editing widgets

Description ¶

Adjusts the view in the window so that the pixel given by fraction appears at the top of the top line of the window. Fraction is a fraction between 0 and 1; 0 indicates the first pixel of the first character in the text, 0.33 indicates the pixel that is one-third the way through the text; and so on. Values close to 1 will indicate values close to the last pixel in the text (1 actually refers to one pixel beyond the last pixel), but in such cases the widget will never scroll beyond the last pixel, and so a value of 1 will effectively be rounded back to whatever fraction ensures the last pixel is at the bottom of the window, and some other pixel is at the top.

Additional information might be available at the Tcl/Tk text page.

type Theme ¶ added in v0.53.0

type Theme interface {
	// Activate makes the theme active/in use. The Activate method of themes in
	// Themes automatically call Initialize if it was not called before.
	Activate(context ThemeContext) error
	// Deactivate makes the theme not active. Deactivate cannot be called before
	// Activate().
	Deactivate(context ThemeContext) error
	// Finalize is called to perform any cleanup. After Finalize returns, the theme
	// cannot be used. The Finalize method of themes in Themes automatically remove
	// the theme from Themes after Finalize completes.
	Finalize(context ThemeContext) error
	// Initialize is called to perform any one-time initialization of a theme. The
	// Initialize method of themes in Themes can be called multiple times but only
	// the first successful call to Initialize will have any effect.
	Initialize(context ThemeContext) error
}

Theme provides handling of a Tk theme. When calling Theme methods registered in Theme, the context argument is ignored and an instance is created automatically.

func CurrentTheme ¶ added in v0.53.0

func CurrentTheme() Theme

CurrentTheme returns the currently activated theme, if any.

type ThemeContext ¶ added in v0.53.0

type ThemeContext interface {
	Eval(tcl string) (r string, err error)
}

ThemeContext provides context to Theme methods.

type ThemeKey ¶ added in v0.53.0

type ThemeKey struct {
	Type string
	Name string
}

ThemeKey indexes Themes

func RegisterTheme ¶ added in v0.53.0

func RegisterTheme(name string, t Theme) (r ThemeKey, err error)

RegisterTheme registers t.

type Ticker ¶ added in v0.30.2

type Ticker struct {
	// contains filtered or unexported fields
}

func NewTicker ¶ added in v0.30.2

func NewTicker(d time.Duration, handler func()) (r *Ticker, err error)

type ToplevelWidget ¶ added in v0.11.0

type ToplevelWidget struct {
	*Window
}

ToplevelWidget represents the Tcl/Tk toplevel widget/window

func Toplevel ¶ added in v0.2.0

func Toplevel(options ...Opt) *ToplevelWidget

Toplevel — Create and manipulate 'toplevel' main and popup window widgets

Description ¶

The toplevel command creates a new toplevel widget (given by the pathName argument). Additional options, described above, may be specified on the command line or in the option database to configure aspects of the toplevel such as its background color and relief. The toplevel command returns the path name of the new window.

A toplevel is similar to a frame except that it is created as a top-level window: its X parent is the root window of a screen rather than the logical parent from its Tk path name. The primary purpose of a toplevel is to serve as a container for dialog boxes and other collections of widgets. The only visible features of a toplevel are its background and an optional 3-D border to make the toplevel appear raised or sunken.

Use Window.Toplevel to create a Toplevel with a particular parent.

More information might be available at the Tcl/Tk toplevel page.

Standard options ¶

Borderwidth
Cursor
Highlightbackground
Highlightcolor
Highlightthickness
Padx
Pady
Relief
Takefocus

Widget specific options ¶

This option is the same as the standard -background option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background and border. An empty background will disable drawing the background image.

Backgroundimage

This specifies an image to display on the toplevel's background within the border of the toplevel (i.e., the image will be clipped by the toplevel's highlight ring and border, if either are present) on top of the background; subwidgets of the toplevel will be drawn on top. The image must have been created with the image create command. If specified as the empty string, no image will be displayed.

Class

Specifies a class for the window. This class will be used when querying the option database for the window's other options, and it will also be used later for other purposes such as bindings. Some window managers display the class name for windows in their dock while some others display the window title. The -class option may not be changed with the configure widget command.

Colormap

Specifies a colormap to use for the window. The value may be either new, in which case a new colormap is created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as pathName), in which case the new window will use the colormap from the specified window. If the -colormap option is not specified, the new window uses the default colormap of its screen. This option may not be changed with the configure widget command.

Container

The value must be a boolean. If true, it means that this window will be used as a container in which some other application will be embedded (for example, a Tk toplevel can be embedded using the -use option). The window will support the appropriate window manager protocols for things like geometry requests. The window should not have any children of its own in this application. This option may not be changed with the configure widget command.

Specifies the desired height for the window in any of the forms acceptable to Tk_GetPixels. If this option is negative or zero then the window will not request any size at all.

Mnu

Specifies a menu widget to be used as a menubar. On the Macintosh, the menubar will be displayed across the top of the main monitor. On Microsoft Windows and all UNIX platforms, the menu will appear across the toplevel window as part of the window dressing maintained by the window manager.

Screen

Specifies the screen on which to place the new window. Any valid screen name may be used, even one associated with a different display. Defaults to the same screen as its parent. This option is special in that it may not be specified via the option database, and it may not be modified with the configure widget command.

Tile

This specifies how to draw the background image (see -backgroundimage) on the toplevel. If true (according to Tcl_GetBoolean), the image will be tiled to fill the whole toplevel, with the origin of the first copy of the image being the top left of the interior of the toplevel. If false (the default), the image will be centered within the toplevel.

Use

This option is used for embedding. If the value is not an empty string, it must be the window identifier of a container window, specified as a hexadecimal string like the ones returned by the winfo id command. The toplevel widget will be created as a child of the given container instead of the root window for the screen. If the container window is in a Tk application, it must be a frame or toplevel widget for which the -container option was specified. This option may not be changed with the configure widget command.

Visual

Specifies visual information for the new window in any of the forms accepted by Tk_GetVisual. If this option is not specified, the new window will use the default visual for its screen. The -visual option may not be modified with the configure widget command.