[ Tklib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

ntextIndent(n) 1.0 tklib "ntext Indentation for the Text Widget"


ntextIndent - ntext Indentation for the Text Widget

Table Of Contents



The ntext package provides a binding tag named Ntext for use by text widgets in place of the default Text binding tag.

Tk's text widget may be configured to wrap lines of text that are longer than the width of the text area, a feature that is familiar from text editors and word processors. A complete line of text (delimited by newlines, or by the beginning or end of the document) is called a "logical line". When a logical line is wrapped onto more than one line of the display area, these fragments of the logical line are called "display lines".

If a logical line begins with whitespace, then wrapped display lines begin further to the left than the first display line, which can make the text layout untidy and difficult to read. The Ntext binding tag provides facilities so that a text widget in -wrap word mode will automatically indent display lines (other than the first) to match the initial whitespace of the first display line.

This indentation is available to text widgets only in -wrap word mode.


::ntext::new_textCopy pathName

Replacement for ::tk_textCopy.

::ntext::new_textCut pathName

Replacement for ::tk_textCut that also maintains Ntext indentation.

::ntext::new_textPaste pathName

Replacement for ::tk_textPaste that also maintains Ntext indentation.

::ntext::syncIndentColor pathName

Command to apply the current value of the variable ::ntext::indentColor to existing lines in a text widget. This command is useful if a text widget has been created, text has been inserted in the widget, and then the value of ::ntext::indentColor is changed.


The behavior of Ntext may be configured application-wide by setting the values of a number of namespace variables:



Advanced Use



To use Ntext 's display line indentation:

  1. Set the variable ::ntext::classicWrap to 0 (default value is 1). This enables bindings that will preserve indentation whenever the user modifies the widget contents using the keyboard and mouse. If the widget already holds text, call ::ntext::wrapIndent to initialise indentation.

    Further instructions apply if the program changes the widget's contents, wrap configuration, or indent configuration.

  2. The program can change the text contents, e.g. by the .text insert command. Such a change does not trigger a window binding, so the program should explicitly call function ::ntext::wrapIndent after inserting text.

  3. Auto-indentation occurs only if the widget is in -wrap word mode. If the program changes to or from -wrap word when the widget is not empty, it should call ::ntext::wrapIndent to format the widget's text.

  4. If indentation is used, and then switched off by setting ::ntext::classicWrap to 1, call ::ntext::wrapIndent to remove indentation.


::ntext::wrapIndent textWidget ?index1? ?index2?

::ntext::wrapIndent textWidget

::ntext::wrapIndent textWidget index1

::ntext::wrapIndent textWidget index1 index2



This version of ntext is intended to be compatible with all releases of Tk 8.5 and 8.6, and with the branches core-8-5-branch, core-8-6-branch, and trunk in the source code repository for Tk. Any incompatibility with any of these versions, for any Tk windowing system, should be reported as a bug. Please report such in the category ntext of the Tklib Trackers.


To switch on Ntext 's indentation and use it in widget .t, using the default indent color #d9d9d9:

package require ntext
set ::ntext::classicWrap 0
text .t -wrap word
bindtags .t {.t Ntext . all}

To switch on Ntext 's indentation and use it in widget .t, without colored indents:

package require ntext
set ::ntext::classicWrap 0
set ::ntext::indentColor {}
text .t -wrap word
bindtags .t {.t Ntext . all}

To switch on Ntext 's indentation and use it in widget .t, coloring the indents black:

package require ntext
set ::ntext::classicWrap 0
set ::ntext::indentColor black
text .t -wrap word
bindtags .t {.t Ntext . all}

To decide later to switch off Ntext 's indentation:

set ::ntext::classicWrap 1
::ntext::wrapIndent .t

To decide later to switch Ntext 's indentation back on:

set ::ntext::classicWrap 0
::ntext::wrapIndent .t 1.0 end

To inject some text into the widget:

set foo [.t index end]
.t insert end {This line was added by the script, not the keyboard!}
::ntext::wrapIndent .t $foo end

To change the indentation color when a widget .t already holds text:

set ::ntext::indentColor black
::ntext::syncIndentColor .t

To switch to -wrap char mode:

.t configure -wrap char
::ntext::wrapIndent .t

See Also

bindtags, ntext, re_syntax, regexp, text


bindtags, re_syntax, regexp, text