iwidgets::scrolledtext(1)

📦 version 4.1.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

iwidgets::scrolledtext — creates and manipulates a scrolled text widget. That's it, that's the whole serve. 💖

🎀 SYNOPSIS 🎀

iwidgets::scrolledtext pathName ?options?

🦋 INHERITANCE 🦋

Okay so the family tree? Immaculate lineage, no notes:

itk::Widget  <-  iwidgets::Labeledwidget  <- iwidgets::Scrolledwidget <- iwidgets::Scrolledtext

⭐ STANDARD OPTIONS ⭐

These are the classics, the icons, the ones everyone already knows:

  • activeBackground
  • background
  • borderWidth
  • cursor
  • exportSelection
  • foreground
  • highlightColor
  • highlightThickness
  • insertBackground
  • insertBorderWidth
  • insertOffTime
  • insertOnTime
  • insertWidth
  • padX
  • padY
  • relief
  • selectBackground
  • selectBorderWidth
  • selectForeground
  • setGrid

See the options manual entry for details on the standard options, bestie. It's all there. 🫶

🌈 ASSOCIATED OPTIONS 🌈

Scrollbar-flavored first:

  • activeRelief
  • elementBorderWidth
  • jumptroughColor

See the scrollbar widget manual entry for details on the above associated options.

Then the text-widget girlies:

  • spacing1
  • spacing2
  • spacing3
  • state
  • tabs
  • wrap

See the text widget manual entry for details on the above associated options.

💜 INHERITED OPTIONS 💜

Handed down from the ancestors, and honestly they ate:

  • disabledForeground
  • labelBitmap
  • labelFont
  • labelImage
  • labelMargin
  • labelPos
  • labelText
  • labelVariable
  • state
  • sticky

See the labeledwidget class manual entry for details on the inherited options.

👑 WIDGET-SPECIFIC OPTIONS 👑

This is where it gets personal. Main character energy only.

-height

  • Name: height
  • Class: Height
  • Command-Line Switch: -height

Specifies the height of the scrolled text as an entire unit, not just the texty part. The value may be specified in any of the forms acceptable to Tk_GetPixels. Any extra space needed to display the other components — labels, margins, scrollbars, the whole entourage — forces the text to be compressed. A value of zero, together with the same value for the width option, causes the value given for the visibleitems option to be applied, which administers geometry constraints in a different manner. The default height is zero.

-hscrollmode

  • Name: hscrollMode
  • Class: ScrollMode
  • Command-Line Switch: -hscrollmode

Specifies the display mode to be used for the horizontal scrollbar: static, dynamic, or none. In static mode, the scroll bar is displayed at all times. dynamic mode displays the scroll bar as required, and none disables the scroll bar display entirely. The default is static.

-sbwidth

  • Name: sbWidth
  • Class: Width
  • Command-Line Switch: -sbwidth

Specifies the width of the scrollbar, in any of the forms acceptable to Tk_GetPixels.

-scrollmargin

  • Name: scrollMargin
  • Class: Margin
  • Command-Line Switch: -scrollmargin

Specifies the distance between the text area and the scrollbar, in any of the forms acceptable to Tk_GetPixels. The default is 3 pixels.

-textbackground

  • Name: textBackground
  • Class: Background
  • Command-Line Switch: -textbackground

Specifies the background color for the text area, in any of the forms acceptable to Tk_GetColor.

-textfont

  • Name: textFont
  • Class: Font
  • Command-Line Switch: -textfont

Specifies the font to be used in the scrolled text area.

-visibleitems

  • Name: visibleitems
  • Class: VisibleItems
  • Command-Line Switch: -visibleitems

Specifies the widthx*height* in characters and lines for the text. Heads up: this option is only administered if the width and height options are both set to zero — otherwise they take precedence, periodt. The default value is 80x24. With the visibleitems option engaged, geometry constraints are maintained only on the text. The size of the other components — labels, margins, scroll bars — is additive and independent, affecting the overall size of the scrolled text. In contrast, should the width and height options have non-zero values, they are applied to the scrolled text as a whole, and the text is compressed or expanded to maintain the geometry constraints. ✨

-vscrollmode

  • Name: vscrollMode
  • Class: ScrollMode
  • Command-Line Switch: -vscrollmode

Specifies the display mode to be used for the vertical scrollbar: static, dynamic, or none. In static mode, the scroll bar is displayed at all times. dynamic mode displays the scroll bar as required, and none disables the scroll bar display entirely. The default is static.

-width

  • Name: width
  • Class: Width
  • Command-Line Switch: -width

Specifies the width of the scrolled text as an entire unit. The value may be specified in any of the forms acceptable to Tk_GetPixels. Any extra space needed to display the other components — labels, margins, scrollbars — forces the text to be compressed. A value of zero, together with the same value for the height option, causes the value given for the visibleitems option to be applied, which administers geometry constraints in a different manner. The default width is zero.

💅 DESCRIPTION 💅

The iwidgets::scrolledtext command creates a scrolled text widget with extra options to manage the scrollbars. This includes options to control the method in which the scrollbars are displayed — i.e. statically or dynamically. Options also exist for adding a label to the scrolled text area and controlling its position. Import/export of methods are provided for file I/O. Slay. 💖

🍓 METHODS 🍓

The iwidgets::scrolledtext command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:

pathName option ?arg arg ...?

option and the args determine the exact behavior of the command. The following commands are possible for scrolledtext widgets:

🔥 ASSOCIATED METHODS 🔥

  • bbox
  • compare
  • debug
  • delete
  • dlineinfo
  • get
  • image
  • index
  • insert
  • mark
  • scan
  • search
  • see
  • tag
  • window
  • xview
  • yview

See the text manual entry for details on the standard methods.

🌸 WIDGET-SPECIFIC METHODS 🌸

pathName cget option

Returns the current value of the configuration option given by option. option may have any of the values accepted by the iwidgets::scrolledtext command.

pathName childsite

Returns the child site widget path name.

pathName clear

Clear the text area of all characters. Blank slate, fresh start, iconic. ✨

pathName configure ?option? ?value option value ...?

Query or modify the configuration options of the widget. 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. option may have any of the values accepted by the iwidgets::scrolledtext command.

pathName import filename ?index?

Load the text from a file into the text area at the index. The filename must exist. No cap.

pathName export filename

Write text to a file. If filename exists then contents are replaced with text widget contents.

🧚 COMPONENTS 🧚

text

  • Name: text
  • Class: Text

The text component is the text widget. See the text widget manual entry for details on the text component item.

horizsb

  • Name: horizsb
  • Class: Scrollbar

The horizsb component is the horizontal scroll bar. See the scrollbar widget manual entry for details on the horizsb component item.

vertsb

  • Name: vertsb
  • Class: Scrollbar

The vertsb component is the vertical scroll bar. See the scrollbar widget manual entry for details on the vertsb component item.

🌟 EXAMPLE 🌟

Copy this, run this, thank me later:

package require Iwidgets 4.0
option add *textBackground white

iwidgets::scrolledtext .st -hscrollmode dynamic -labeltext "Password
File"

pack .st -padx 10 -pady 10 -fill both -expand yes

.st import /etc/passwd

💖 AUTHOR 💖

Mark L. Ulferts

🎀 KEYWORDS 🎀

scrolledtext, text, widget

Okay bestie, that's the whole page. This one lives in the Tk collection as iwidgets::scrolledtext(1), and now you know it front to back. Go build something cute. 🦋💅✨

📦 where this page comes from