Embedded Images
- Preface
- Introduction
- Tutorial
- Implementation
- Commands
- bitmap
- eval-wish
- get-tk-var
- photo
- set-tk-var!
- tk
- tk-id->widget
- tk-var
- tk/after
- tk/appname
- tk/bind
- tk/bindtags
- tk/caret
- tk/choosecolor
- tk/choosedirectory
- tk/clipboard
- tk/console
- tk/destroy
- tk/dialog
- tk/event
- tk/focus
- tk/getopenfile
- tk/getsavefile
- tk/grab
- tk/grid
- tk/image
- tk/lower
- tk/messagebox
- tk/option
- tk/pack
- tk/place
- tk/popup
- tk/raise
- tk/scaling
- tk/update
- tk/useinputmethods
- tk/wait
- tk/windowingsystem
- tk/winfo
- tk/wm
- Options
- Extensions
- Changes
The final form of annotation in text widgets is an embedded image. Each embedded image annotation causes an image to be displayed at a particular point in the text. There may be any number of embedded images in a text widget, and a particular image may be embedded in multiple places in the same text widget. The embedded image's position on the screen will be updated as the text is modified or scrolled. Each embedded image occupies one character's worth of index space in the text widget, and it may be referred to either by its position in the widget's index space, or the name it is assigned when the image is inserted into the text widget widh image create. If the range of text containing the embedded image is deleted then that copy of the image is removed from the screen.
When an embedded image is added to a text widget with the image create widget command, a name unique to this instance of the image is returned. This name may then be used to refer to this image instance. The name is taken to be the value of the #:name option (described below). If the #:name option is not provided, the #:image name is used instead. If the imageName is already in use in the text widget, then #nn is added to the end of the imageName, where nn is an arbitrary integer. This insures the imageName is unique. Once this name is assigned to this instance of the image, it does not change, even though the #:image or #:name values can be changed with image configure.
When an embedded image is added to a text widget with the image create widget command, several configuration options may be associated with it. These options may be modified later with the image configure widget command. The following options are currently supported:
- #:align where
- If the image is not as tall as the line in which it is displayed, this option determines where the image is displayed in the line. Where must have one of the values top (align the top of the image with the top of the line), center (center the image within the range of the line), bottom (align the bottom of the image with the bottom of the line's area), or baseline (align the bottom of the image with the baseline of the line).
- #:image image
- Specifies the name of the Tk image to display in the annotation. If image is not a valid Tk image, then an error is returned.
- #:name ImageName
- Specifies the name by which this image instance may be referenced in the text widget. If ImageName is not supplied, then the name of the Tk image is used instead. If the imageName is already in use, #nn is appended to the end of the name as described above.
- #:padx pixels
- Pixels specifies the amount of extra space to leave on each side of the embedded image. It may have any of the usual forms defined for a screen distance.
- #:pady pixels
- Pixels specifies the amount of extra space to leave on the top and on the bottom of the embedded image. It may have any of the usual forms defined for a screen distance.