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

Class ScrolledCanvas

    Misc --+            
           |            
  BaseWidget --+        
               |        
        Grid --+        
               |        
        Pack --+        
               |        
       Place --+        
               |        
          Widget --+    
                   |    
              Canvas --+
                       |
FrameLayoutMixin --+   |
                   |   |
       ScrolledMixin --+
                       |
                      ScrolledCanvas


A Tkinter 'Canvas' widget with scroll bars which appear as necessary.
Method Summary
  __init__(self, root, **kw)
Creates a new 'ScrolledCanvas' widget.
  create_arc(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_bitmap(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_image(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_line(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_oval(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_polygon(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_rectangle(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_text(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  create_window(self, *args, **kw)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  dchars(self, *args)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  delete(self, *args)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  insert(self, *args)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  move(self, *args)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  scale(self, *args)
Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
  __scroll(self, event)
Private method to update the canvas's 'scrollregion' attribute.
    Inherited from Canvas
  addtag(self, *args)
Internal function.
  addtag_above(self, newtag, tagOrId)
Add tag NEWTAG to all items above TAGORID.
  addtag_all(self, newtag)
Add tag NEWTAG to all items.
  addtag_below(self, newtag, tagOrId)
Add tag NEWTAG to all items below TAGORID.
  addtag_closest(self, newtag, x, y, halo, start)
Add tag NEWTAG to item which is closest to pixel at X, Y.
  addtag_enclosed(self, newtag, x1, y1, x2, y2)
Add tag NEWTAG to all items in the rectangle defined by X1,Y1,X2,Y2.
  addtag_overlapping(self, newtag, x1, y1, x2, y2)
Add tag NEWTAG to all items which overlap the rectangle defined by X1,Y1,X2,Y2.
  addtag_withtag(self, newtag, tagOrId)
Add tag NEWTAG to all items with TAGORID.
  bbox(self, *args)
Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle which encloses all items with tags specified as arguments.
  canvasx(self, screenx, gridspacing)
Return the canvas x coordinate of pixel position SCREENX rounded to nearest multiple of GRIDSPACING units.
  canvasy(self, screeny, gridspacing)
Return the canvas y coordinate of pixel position SCREENY rounded to nearest multiple of GRIDSPACING units.
  coords(self, *args)
Return a list of coordinates for the item given in ARGS.
  dtag(self, *args)
Delete tag or id given as last arguments in ARGS from items identified by first argument in ARGS.
  find(self, *args)
Internal function.
  find_above(self, tagOrId)
Return items above TAGORID.
  find_all(self)
Return all items.
  find_below(self, tagOrId)
Return all items below TAGORID.
  find_closest(self, x, y, halo, start)
Return item which is closest to pixel at X, Y.
  find_enclosed(self, x1, y1, x2, y2)
Return all items in rectangle defined by X1,Y1,X2,Y2.
  find_overlapping(self, x1, y1, x2, y2)
Return all items which overlap the rectangle defined by X1,Y1,X2,Y2.
  find_withtag(self, tagOrId)
Return all items with TAGORID.
  focus(self, *args)
Set focus to the first item specified in ARGS.
  gettags(self, *args)
Return tags associated with the first item specified in ARGS.
  icursor(self, *args)
Set cursor at position POS in the item identified by TAGORID.
  index(self, *args)
Return position of cursor as integer in item specified in ARGS.
  itemcget(self, tagOrId, option)
Return the resource value for an OPTION for item TAGORID.
  itemconfig(self, tagOrId, cnf, **kw)
Configure resources of an item TAGORID.
  itemconfigure(self, tagOrId, cnf, **kw)
Configure resources of an item TAGORID.
  lift(self, *args)
Raise an item TAGORID given in ARGS (optional above another item).
  lower(self, *args)
Lower an item TAGORID given in ARGS (optional below another item).
  postscript(self, cnf, **kw)
Print the contents of the canvas to a postscript file.
  scan_dragto(self, x, y, gain)
Adjust the view of the canvas to GAIN 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.
  select_adjust(self, tagOrId, index)
Adjust the end of the selection near the cursor of an item TAGORID to index.
  select_clear(self)
Clear the selection if it is in this widget.
  select_from(self, tagOrId, index)
Set the fixed end of a selection in item TAGORID to INDEX.
  select_item(self)
Return the item which has the selection.
  select_to(self, tagOrId, index)
Set the variable end of a selection in item TAGORID to INDEX.
  tag_bind(self, tagOrId, sequence, func, add)
Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.
  tag_lower(self, *args)
Lower an item TAGORID given in ARGS (optional below another item).
  tag_raise(self, *args)
Raise an item TAGORID given in ARGS (optional above another item).
  tag_unbind(self, tagOrId, sequence, funcid)
Unbind for all items with TAGORID for event SEQUENCE the function identified with FUNCID.
  tkraise(self, *args)
Raise an item TAGORID given in ARGS (optional above another item).
  type(self, tagOrId)
Return the type of the item TAGORID.
  xview(self, *args)
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, *args)
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_scroll(self, number, what)
Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT).
  _create(self, itemType, args, kw)
Internal function.
    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_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_names(self)
Return a list of all existing image names.
  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.
  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.
  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.
  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 'ScrolledCanvas' widget.

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

create_arc(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_arc

create_bitmap(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_bitmap

create_image(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_image

create_line(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_line

create_oval(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_oval

create_polygon(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_polygon

create_rectangle(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_rectangle

create_text(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_text

create_window(self, *args, **kw)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.create_window

dchars(self, *args)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.dchars

delete(self, *args)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.delete

insert(self, *args)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.insert

move(self, *args)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.move

scale(self, *args)

Invokes the 'Canvas' widget method of the same name with the supplied arguments and keyword arguments, then updates the canvas's 'scrollregion' attribute.
Overrides:
Tkinter.Canvas.scale

__scroll(self, event=None)

Private method to update the canvas's 'scrollregion' attribute.

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