Package xdp :: Module tkutil :: Class ScrolledText
[show private | hide private]
[frames | no frames]

Class ScrolledText

FrameLayoutMixin --+    
                   |    
       ScrolledMixin --+
                       |
    Misc --+           |
           |           |
  BaseWidget --+       |
               |       |
        Grid --+       |
               |       |
        Pack --+       |
               |       |
       Place --+       |
               |       |
          Widget --+   |
                   |   |
                Text --+
                       |
                      ScrolledText

Known Subclasses:
MessageText

A Tkinter 'Text' widget with scroll bars which appear as necessary.

*Note*: there is currently a bug which will result in the horizontal scrollbar appearing and disappearing continuously under certain conditions (very long, unwrappable lines at the top or bottom of the visible area).
Method Summary
  __init__(self, root, **kw)
Creates a new 'ScrolledText' widget.
    Inherited from Text
  bbox(self, *args)
Return a tuple of (x,y,width,height) which gives the bounding box of the visible part of the character at the index in ARGS.
  compare(self, index1, op, index2)
Return whether between index INDEX1 and index INDEX2 the relation OP is satisfied.
  debug(self, boolean)
Turn on the internal consistency checks of the B-Tree inside the text widget according to BOOLEAN.
  delete(self, index1, index2)
Delete the characters between INDEX1 and INDEX2 (not included).
  dlineinfo(self, index)
Return tuple (x,y,width,height,baseline) giving the bounding box and baseline position of the visible part of the line containing the character at INDEX.
  dump(self, index1, index2, command, **kw)
Return the contents of the widget between index1 and index2.
  edit(self, *args)
Internal method
  edit_modified(self, arg)
Get or Set the modified flag
  edit_redo(self)
Redo the last undone edit
  edit_reset(self)
Clears the undo and redo stacks
  edit_separator(self)
Inserts a separator (boundary) on the undo stack.
  edit_undo(self)
Undoes the last edit action
  get(self, index1, index2)
Return the text from INDEX1 to INDEX2 (not included).
  image_cget(self, index, option)
Return the value of OPTION of an embedded image at INDEX.
  image_configure(self, index, cnf, **kw)
Configure an embedded image at INDEX.
  image_create(self, index, cnf, **kw)
Create an embedded image at INDEX.
  image_names(self)
Return all names of embedded images in this widget.
  index(self, index)
Return the index in the form line.char for INDEX.
  insert(self, index, chars, *args)
Insert CHARS before the characters at INDEX.
  mark_gravity(self, markName, direction)
Change the gravity of a mark MARKNAME to DIRECTION (LEFT or RIGHT).
  mark_names(self)
Return all mark names.
  mark_next(self, index)
Return the name of the next mark after INDEX.
  mark_previous(self, index)
Return the name of the previous mark before INDEX.
  mark_set(self, markName, index)
Set mark MARKNAME before the character at INDEX.
  mark_unset(self, *markNames)
Delete all marks in MARKNAMES.
  scan_dragto(self, x, y)
Adjust the view of the text to 10 times the difference between X and Y and the coordinates given in scan_mark.
  scan_mark(self, x, y)
Remember the current X, Y coordinates.
  search(self, pattern, index, stopindex, forwards, backwards, exact, regexp, nocase, count)
Search PATTERN beginning from INDEX until STOPINDEX.
  see(self, index)
Scroll such that the character at INDEX is visible.
  tag_add(self, tagName, index1, *args)
Add tag TAGNAME to all characters between INDEX1 and index2 in ARGS.
  tag_bind(self, tagName, sequence, func, add)
Bind to all characters with TAGNAME at event SEQUENCE a call to function FUNC.
  tag_cget(self, tagName, option)
Return the value of OPTION for tag TAGNAME.
  tag_config(self, tagName, cnf, **kw)
Configure a tag TAGNAME.
  tag_configure(self, tagName, cnf, **kw)
Configure a tag TAGNAME.
  tag_delete(self, *tagNames)
Delete all tags in TAGNAMES.
  tag_lower(self, tagName, belowThis)
Change the priority of tag TAGNAME such that it is lower than the priority of BELOWTHIS.
  tag_names(self, index)
Return a list of all tag names.
  tag_nextrange(self, tagName, index1, index2)
Return a list of start and end index for the first sequence of characters between INDEX1 and INDEX2 which all have tag TAGNAME.
  tag_prevrange(self, tagName, index1, index2)
Return a list of start and end index for the first sequence of characters between INDEX1 and INDEX2 which all have tag TAGNAME.
  tag_raise(self, tagName, aboveThis)
Change the priority of tag TAGNAME such that it is higher than the priority of ABOVETHIS.
  tag_ranges(self, tagName)
Return a list of ranges of text which have tag TAGNAME.
  tag_remove(self, tagName, index1, index2)
Remove tag TAGNAME from all characters between INDEX1 and INDEX2.
  tag_unbind(self, tagName, sequence, funcid)
Unbind for all characters with TAGNAME for event SEQUENCE the function identified with FUNCID.
  tk_textBackspace(self)
  tk_textIndexCloser(self, a, b, c)
  tk_textResetAnchor(self, index)
  tk_textSelectTo(self, index)
  window_cget(self, index, option)
Return the value of OPTION of an embedded window at INDEX.
  window_config(self, index, cnf, **kw)
Configure an embedded window at INDEX.
  window_configure(self, index, cnf, **kw)
Configure an embedded window at INDEX.
  window_create(self, index, cnf, **kw)
Create a window at INDEX.
  window_names(self)
Return all names of embedded windows in this widget.
  xview(self, *what)
Query and change horizontal position of the view.
  xview_moveto(self, fraction)
Adjusts the view in the window so that FRACTION of the total width of the canvas is off-screen to the left.
  xview_scroll(self, number, what)
Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT).
  yview(self, *what)
Query and change vertical position of the view.
  yview_moveto(self, fraction)
Adjusts the view in the window so that FRACTION of the total height of the canvas is off-screen to the top.
  yview_pickplace(self, *what)
Obsolete function, use see.
  yview_scroll(self, number, what)
Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT).
    Inherited from BaseWidget
  destroy(self)
Destroy this and all descendants widgets.
  _do(self, name, args)
  _setup(self, master, cnf)
Internal function.
    Inherited from Misc
  __getitem__(self, key)
Return the resource value for a KEY given as string.
  __setitem__(self, key, value)
  __str__(self)
Return the window path name of this widget.
  _nametowidget(self, name)
Return the Tkinter instance of a widget identified by its Tcl name NAME.
  after(self, ms, func, *args)
Call function once after given time.
  after_cancel(self, id)
Cancel scheduling of function identified with ID.
  after_idle(self, func, *args)
Call FUNC once if the Tcl main loop has no event to process.
  bell(self, displayof)
Ring a display's bell.
  bind(self, sequence, func, add)
Bind to this widget at event SEQUENCE a call to function FUNC.
  bind_all(self, sequence, func, add)
Bind to all widgets at an event SEQUENCE a call to function FUNC.
  bind_class(self, className, sequence, func, add)
Bind to widgets with bindtag CLASSNAME at event SEQUENCE a call of function FUNC.
  bindtags(self, tagList)
Set or get the list of bindtags for this widget.
  cget(self, key)
Return the resource value for a KEY given as string.
  clipboard_append(self, string, **kw)
Append STRING to the Tk clipboard.
  clipboard_clear(self, **kw)
Clear the data in the Tk clipboard.
  colormodel(self, value)
Useless.
  columnconfigure(self, index, cnf, **kw)
Configure column INDEX of a grid.
  config(self, cnf, **kw)
Configure resources of a widget.
  configure(self, cnf, **kw)
Configure resources of a widget.
  deletecommand(self, name)
Internal function.
  event_add(self, virtual, *sequences)
Bind a virtual event VIRTUAL (of the form <<Name>>) to an event SEQUENCE such that the virtual event is triggered whenever SEQUENCE occurs.
  event_delete(self, virtual, *sequences)
Unbind a virtual event VIRTUAL from SEQUENCE.
  event_generate(self, sequence, **kw)
Generate an event SEQUENCE.
  event_info(self, virtual)
Return a list of all virtual events or the information about the SEQUENCE bound to the virtual event VIRTUAL.
  focus(self)
Direct input focus to this widget.
  focus_displayof(self)
Return the widget which has currently the focus on the display where this widget is located.
  focus_force(self)
Direct input focus to this widget even if the application does not have the focus.
  focus_get(self)
Return the widget which has currently the focus in the application.
  focus_lastfor(self)
Return the widget which would have the focus if top level for this widget gets the focus from the window manager.
  focus_set(self)
Direct input focus to this widget.
  getboolean(self, s)
Return a boolean value for Tcl boolean values true and false given as parameter.
  getvar(self, name)
Return value of Tcl variable NAME.
  grab_current(self)
Return widget which has currently the grab in this application or None.
  grab_release(self)
Release grab for this widget if currently set.
  grab_set(self)
Set grab for this widget.
  grab_set_global(self)
Set global grab for this widget.
  grab_status(self)
Return None, "local" or "global" if this widget has no, a local or a global grab.
  grid_bbox(self, column, row, col2, row2)
Return a tuple of integer coordinates for the bounding box of this widget controlled by the geometry manager grid.
  grid_columnconfigure(self, index, cnf, **kw)
Configure column INDEX of a grid.
  grid_location(self, x, y)
Return a tuple of column and row which identify the cell at which the pixel at position X and Y inside the master widget is located.
  grid_propagate(self, flag)
Set or get the status for propagation of geometry information.
  grid_rowconfigure(self, index, cnf, **kw)
Configure row INDEX of a grid.
  grid_size(self)
Return a tuple of the number of column and rows in the grid.
  grid_slaves(self, row, column)
Return a list of all slaves of this widget in its packing order.
  image_types(self)
Return a list of all available image types (e.g.
  keys(self)
Return a list of all resource names of this widget.
  lift(self, aboveThis)
Raise this widget in the stacking order.
  location(self, x, y)
Return a tuple of column and row which identify the cell at which the pixel at position X and Y inside the master widget is located.
  lower(self, belowThis)
Lower this widget in the stacking order.
  mainloop(self, n)
Call the mainloop of Tk.
  nametowidget(self, name)
Return the Tkinter instance of a widget identified by its Tcl name NAME.
  option_add(self, pattern, value, priority)
Set a VALUE (second parameter) for an option PATTERN (first parameter).
  option_clear(self)
Clear the option database.
  option_get(self, name, className)
Return the value for an option NAME for this widget with CLASSNAME.
  option_readfile(self, fileName, priority)
Read file FILENAME into the option database.
  pack_propagate(self, flag)
Set or get the status for propagation of geometry information.
  pack_slaves(self)
Return a list of all slaves of this widget in its packing order.
  place_slaves(self)
Return a list of all slaves of this widget in its packing order.
  propagate(self, flag)
Set or get the status for propagation of geometry information.
  quit(self)
Quit the Tcl interpreter.
  rowconfigure(self, index, cnf, **kw)
Configure row INDEX of a grid.
  selection_clear(self, **kw)
Clear the current X selection.
  selection_get(self, **kw)
Return the contents of the current X selection.
  selection_handle(self, command, **kw)
Specify a function COMMAND to call if the X selection owned by this widget is queried by another application.
  selection_own(self, **kw)
Become owner of X selection.
  selection_own_get(self, **kw)
Return owner of X selection.
  send(self, interp, cmd, *args)
Send Tcl command CMD to different interpreter INTERP to be executed.
  setvar(self, name, value)
Set Tcl variable NAME to VALUE.
  size(self)
Return a tuple of the number of column and rows in the grid.
  slaves(self)
Return a list of all slaves of this widget in its packing order.
  tk_bisque(self)
Change the color scheme to light brown as used in Tk 3.6 and before.
  tk_focusFollowsMouse(self)
The widget under mouse will get automatically focus.
  tk_focusNext(self)
Return the next widget in the focus order which follows widget which has currently the focus.
  tk_focusPrev(self)
Return previous widget in the focus order.
  tk_menuBar(self, *args)
Do not use.
  tk_setPalette(self, *args, **kw)
Set a new color scheme for all widget elements.
  tk_strictMotif(self, boolean)
Set Tcl internal variable, whether the look and feel should adhere to Motif.
  tkraise(self, aboveThis)
Raise this widget in the stacking order.
  unbind(self, sequence, funcid)
Unbind for this widget for event SEQUENCE the function identified with FUNCID.
  unbind_all(self, sequence)
Unbind for all widgets for event SEQUENCE all functions.
  unbind_class(self, className, sequence)
Unbind for a all widgets with bindtag CLASSNAME for event SEQUENCE all functions.
  update(self)
Enter event loop until all pending events have been processed by Tcl.
  update_idletasks(self)
Enter event loop until all idle callbacks have been called.
  wait_variable(self, name)
Wait until the variable is modified.
  wait_visibility(self, window)
Wait until the visibility of a WIDGET changes (e.g.
  wait_window(self, window)
Wait until a WIDGET is destroyed.
  waitvar(self, name)
Wait until the variable is modified.
  winfo_atom(self, name, displayof)
Return integer which represents atom NAME.
  winfo_atomname(self, id, displayof)
Return name of atom with identifier ID.
  winfo_cells(self)
Return number of cells in the colormap for this widget.
  winfo_children(self)
Return a list of all widgets which are children of this widget.
  winfo_class(self)
Return window class name of this widget.
  winfo_colormapfull(self)
Return true if at the last color request the colormap was full.
  winfo_containing(self, rootX, rootY, displayof)
Return the widget which is at the root coordinates ROOTX, ROOTY.
  winfo_depth(self)
Return the number of bits per pixel.
  winfo_exists(self)
Return true if this widget exists.
  winfo_fpixels(self, number)
Return the number of pixels for the given distance NUMBER (e.g.
  winfo_geometry(self)
Return geometry string for this widget in the form "widthxheight+X+Y".
  winfo_height(self)
Return height of this widget.
  winfo_id(self)
Return identifier ID for this widget.
  winfo_interps(self, displayof)
Return the name of all Tcl interpreters for this display.
  winfo_ismapped(self)
Return true if this widget is mapped.
  winfo_manager(self)
Return the window mananger name for this widget.
  winfo_name(self)
Return the name of this widget.
  winfo_parent(self)
Return the name of the parent of this widget.
  winfo_pathname(self, id, displayof)
Return the pathname of the widget given by ID.
  winfo_pixels(self, number)
Rounded integer value of winfo_fpixels.
  winfo_pointerx(self)
Return the x coordinate of the pointer on the root window.
  winfo_pointerxy(self)
Return a tuple of x and y coordinates of the pointer on the root window.
  winfo_pointery(self)
Return the y coordinate of the pointer on the root window.
  winfo_reqheight(self)
Return requested height of this widget.
  winfo_reqwidth(self)
Return requested width of this widget.
  winfo_rgb(self, color)
Return tuple of decimal values for red, green, blue for COLOR in this widget.
  winfo_rootx(self)
Return x coordinate of upper left corner of this widget on the root window.
  winfo_rooty(self)
Return y coordinate of upper left corner of this widget on the root window.
  winfo_screen(self)
Return the screen name of this widget.
  winfo_screencells(self)
Return the number of the cells in the colormap of the screen of this widget.
  winfo_screendepth(self)
Return the number of bits per pixel of the root window of the screen of this widget.
  winfo_screenheight(self)
Return the number of pixels of the height of the screen of this widget in pixel.
  winfo_screenmmheight(self)
Return the number of pixels of the height of the screen of this widget in mm.
  winfo_screenmmwidth(self)
Return the number of pixels of the width of the screen of this widget in mm.
  winfo_screenvisual(self)
Return one of the strings directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor for the default colormodel of this screen.
  winfo_screenwidth(self)
Return the number of pixels of the width of the screen of this widget in pixel.
  winfo_server(self)
Return information of the X-Server of the screen of this widget in the form "XmajorRminor vendor vendorVersion".
  winfo_toplevel(self)
Return the toplevel widget of this widget.
  winfo_viewable(self)
Return true if the widget and all its higher ancestors are mapped.
  winfo_visual(self)
Return one of the strings directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor for the colormodel of this widget.
  winfo_visualid(self)
Return the X identifier for the visual for this widget.
  winfo_visualsavailable(self, includeids)
Return a list of all visuals available for the screen of this widget.
  winfo_vrootheight(self)
Return the height of the virtual root window associated with this widget in pixels.
  winfo_vrootwidth(self)
Return the width of the virtual root window associated with this widget in pixel.
  winfo_vrootx(self)
Return the x offset of the virtual root relative to the root window of the screen of this widget.
  winfo_vrooty(self)
Return the y offset of the virtual root relative to the root window of the screen of this widget.
  winfo_width(self)
Return the width of this widget.
  winfo_x(self)
Return the x coordinate of the upper left corner of this widget in the parent.
  winfo_y(self)
Return the y coordinate of the upper left corner of this widget in the parent.
  _bind(self, what, sequence, func, add, needcleanup)
Internal function.
  _configure(self, cmd, cnf, kw)
Internal function.
  _displayof(self, displayof)
Internal function.
  _getboolean(self, string)
Internal function.
  _getdoubles(self, string)
Internal function.
  _getints(self, string)
Internal function.
  _grid_configure(self, command, index, cnf, kw)
Internal function.
  _options(self, cnf, kw)
Internal function.
  _register(self, func, subst, needcleanup)
Return a newly created Tcl function.
  _report_exception(self)
Internal function.
  _root(self)
Internal function.
  _substitute(self, *args)
Internal function.
  register(self, func, subst, needcleanup)
Return a newly created Tcl function.
    Inherited from Pack
  forget(self)
Unmap this widget and do not use it for the packing order.
  info(self)
Return information about the packing options for this widget.
  pack(self, cnf, **kw)
Pack a widget in the parent widget.
  pack_configure(self, cnf, **kw)
Pack a widget in the parent widget.
  pack_forget(self)
Unmap this widget and do not use it for the packing order.
  pack_info(self)
Return information about the packing options for this widget.
    Inherited from Place
  place(self, cnf, **kw)
Place a widget in the parent widget.
  place_configure(self, cnf, **kw)
Place a widget in the parent widget.
  place_forget(self)
Unmap this widget.
  place_info(self)
Return information about the placing options for this widget.
    Inherited from Grid
  grid(self, cnf, **kw)
Position a widget in the parent widget in a grid.
  grid_configure(self, cnf, **kw)
Position a widget in the parent widget in a grid.
  grid_forget(self)
Unmap this widget.
  grid_info(self)
Return information about the options for positioning this widget in a grid.
  grid_remove(self)
Unmap this widget but remember the grid options.

Class Variable Summary
    Inherited from Misc
list _noarg_ = ['_noarg_']
tuple _subst_format = ('%#', '%b', '%f', '%h', '%k', '%s', '%t...
str _subst_format_str = '%# %b %f %h %k %s %t %w %x %y %A %E...
NoneType _tclCommands = None                                                                  

Method Details

__init__(self, root, **kw)
(Constructor)

Creates a new 'ScrolledText' widget.

'root' is the Tkinter parent widget. Any keyword arguments are passed to the 'Text' widget's constructor.
Overrides:
Tkinter.Text.__init__

Generated by Epydoc 2.1 on Wed Jul 20 11:51:05 2005 http://epydoc.sf.net