Teek::UI::TextContent Class

add_marker(name, at:)

A marker is a named, floating position in the text that moves with edits around it - a bookmark, not a range.

Parameters

• name Symbol, String
• at String, Symbol — where to place it

Returns void

View source ▼

def add_marker(name, at:)
  @app.command(@path, :mark, :set, name, resolve_index(at))
end

apply_format(name, from, to)

Applies a previously-#formatted name to a range.

Parameters

• name Symbol, String
• from String, Symbol
• to String, Symbol

Returns void

View source ▼

def apply_format(name, from, to)
  @app.command(@path, :tag, :add, name, resolve_index(from), resolve_index(to))
end

clear

Empties the whole buffer.

Returns void

View source ▼

def clear
  mutate { @app.command(@path, :delete, '1.0', 'end') }
end

clear_format(name, from, to)

Removes name from a range - the format definition itself is untouched, still applyable elsewhere; see #delete_format to remove the definition entirely.

Parameters

• name Symbol, String
• from String, Symbol
• to String, Symbol

Returns void

View source ▼

def clear_format(name, from, to)
  @app.command(@path, :tag, :remove, name, resolve_index(from), resolve_index(to))
end

cursor

Returns String — the text cursor's current position (the insert mark), as "line.char"

View source ▼

def cursor
  index('insert')
end

cursor=(spec)

Moves the text cursor.

Parameters

• spec String, Symbol

Returns void

View source ▼

def cursor=(spec)
  add_marker('insert', at: spec)
end

delete(start, end_ nil)

Parameters

• start String, Symbol
• end_ String, Symbol, nil — a single character at start if omitted, the range [start, end_) otherwise

Returns void

View source ▼

def delete(start, end_ = nil)
  mutate { @app.command(@path, :delete, resolve_index(start), *(end_ ? [resolve_index(end_)] : [])) }
end

delete_format(name)

Deletes a format’s definition entirely, and with it every range it was applied to.

Parameters

• name Symbol, String

Returns void

View source ▼

def delete_format(name)
  @app.command(@path, :tag, :delete, name)
end

format(name, **opts)

Defines (or redefines) a named format - a reusable set of display properties, applied to text ranges via #apply_format.

Parameters

• name Symbol, String
• opts Hash — Tk text-tag options, e.g. foreground:/font:/underline:

Returns void

View source ▼

def format(name, **opts)
  @app.command(@path, :tag, :configure, name, **opts)
end

format_ranges(name)

Parameters

• name Symbol, String

Returns Array<String> — a flat list of index pairs - [start1, end1, start2, end2, ...], one pair per contiguous applied range

View source ▼

def format_ranges(name)
  @app.split_list(@app.command(@path, :tag, :ranges, name))
end

get(start '1.0', end_ 'end')

Parameters

• start String, Symbol
• end_ String, Symbol, nil — a single character at start if omitted, the range [start, end_) otherwise

Returns String

View source ▼

def get(start = '1.0', end_ = 'end')
  @app.command(@path, :get, resolve_index(start), resolve_index(end_))
end

index(spec)

Resolves any index expression to its canonical "line.char" form.

Parameters

• spec String, Symbol

Returns String

View source ▼

def index(spec)
  @app.command(@path, :index, resolve_index(spec))
end

initialize(app, path)

Returns TextContent — a new instance of TextContent

@api private

View source ▼

def initialize(app, path)
  @app = app
  @path = path
end

insert(index, text, *tags)

Parameters

• index String, Symbol
• text String
• tags Array<String, Symbol> — format name(s) to apply to the inserted text, same as Tk's own trailing tagList

Returns void

View source ▼

def insert(index, text, *tags)
  mutate { @app.command(@path, :insert, resolve_index(index), text, *tags) }
end

insert_image(index, image:)

Embeds an image inline in the text flow at index.

Parameters

• index String, Symbol
• image Image, Teek::Photo — anything whose #to_s is a Tcl image name - a DSL Image or a raw Teek::Photo both work

Returns void

View source ▼

def insert_image(index, image:)
  mutate { @app.command(@path, :image, :create, resolve_index(index), image: image) }
end

mark_gravity(name, direction nil)

Which way name drifts when text is inserted exactly at it - an advanced, rarely-needed Tk concept, so this stays under its Tk name only (no friendlier alias).

Parameters

• name Symbol, String
• direction String, Symbol, nil — :left/:right to set; omit to just read the current gravity

Returns String — "left" or "right"

View source ▼

def mark_gravity(name, direction = nil)
  if direction
    @app.command(@path, :mark, :gravity, name, direction)
  else
    @app.command(@path, :mark, :gravity, name)
  end
end

markers

Returns Array<String> — every marker currently defined, including the built-in insert/current ones

View source ▼

def markers
  @app.split_list(@app.command(@path, :mark, :names))
end

on_format(name, event, &block)

#on_format_click, for an arbitrary Tk event pattern instead of the common left-click case.

Parameters

• name Symbol, String
• event String — a Tk bind event pattern, e.g. "Double-Button-1"

Returns void

@yield called with no arguments

View source ▼

def on_format(name, event, &block)
  bind_format_event(name, resolve_event(event), block)
end

on_format_click(name, &block)

Fires on a left click anywhere text carrying name is displayed. Wired through tag bind (not a raw tcl_eval), so the existing leak-safe reconcile (teek core’s TagBindInterceptor, already registered for the text widget) releases the callback if name stops being applied anywhere - the same leak-safety every other DSL event binding already gets.

Parameters

• name Symbol, String

Returns void

@yield called with no arguments

View source ▼

def on_format_click(name, &block)
  bind_format_event(name, '<Button-1>', block)
end

read_only

Returns Boolean — whether this widget currently rejects direct typing/edits (its Tk -state is disabled) - #insert/ #delete/etc still work regardless, temporarily lifting this for their own duration (see the class docs)

View source ▼

def read_only
  @app.command(@path, :cget, '-state') == 'disabled'
end

read_only=(value)

Parameters

• value Boolean

Returns void

View source ▼

def read_only=(value)
  @app.command(@path, :configure, state: value ? :disabled : :normal)
end

remove_marker(name)

Parameters

• name Symbol, String

Returns void

View source ▼

def remove_marker(name)
  @app.command(@path, :mark, :unset, name)
end

replace(start, end_, text)

Atomic delete-then-insert over [start, end_).

Parameters

• start String, Symbol
• end_ String, Symbol
• text String

Returns void

View source ▼

def replace(start, end_, text)
  mutate { @app.command(@path, :replace, resolve_index(start), resolve_index(end_), text) }
end

scroll_to(index)

Scrolls the view so index is visible.

Parameters

• index String, Symbol

Returns void

View source ▼

def scroll_to(index)
  @app.command(@path, :see, resolve_index(index))
end

search(pattern, from: 'insert', to: 'end', backwards: false, regexp: false, nocase: false)

Parameters

• pattern String
• from String, Symbol — where to start searching
• to String, Symbol — the search boundary - with backwards: true this is the earliest index the search may reach, same as plain Tk search
• backwards Boolean
• regexp Boolean — treat pattern as a regular expression
• nocase Boolean

Returns String, nil — the matching index, or nil if not found

View source ▼

def search(pattern, from: 'insert', to: 'end', backwards: false, regexp: false, nocase: false)
  args = []
  args << '-backward' if backwards
  args << '-regexp' if regexp
  args << '-nocase' if nocase
  args << '--'
  result = @app.command(@path, :search, *args, pattern, resolve_index(from), resolve_index(to))
  result.empty? ? nil : result
end

value

Returns String — the whole buffer's text, without the synthetic trailing newline Tk always keeps at end

View source ▼

def value
  get('1.0', 'end-1c')
end

value=(text)

Replaces the whole buffer’s content outright.

Parameters

• text String

Returns void

View source ▼

def value=(text)
  mutate {
    @app.command(@path, :delete, '1.0', 'end')
    @app.command(@path, :insert, '1.0', text)
  }
end