Module Tkinter :: Class PanedWindow
[hide private]
[frames] | no frames]

_ClassType PanedWindow

  Misc --+        
         |        
BaseWidget --+    
             |    
      Pack --+    
             |    
     Place --+    
             |    
      Grid --+    
             |    
  Tix.Form --+    
             |    
        Widget --+
                 |
                PanedWindow

panedwindow widget.

Nested Classes [hide private]

Inherited from Misc: getdouble, getint

Instance Methods [hide private]
 
__init__(self, master=None, cnf={}, **kw)
Construct a panedwindow widget with the parent MASTER.
 
add(self, child, **kw)
Add a child widget to the panedwindow in a new pane.
 
remove(self, child)
Remove the pane containing child from the panedwindow
 
forget(self, child)
Remove the pane containing child from the panedwindow
 
identify(self, x, y)
Identify the panedwindow component at point x, y
 
proxy(self, *args)
Internal function.
 
proxy_coord(self)
Return the x and y pair of the most recent proxy location
 
proxy_forget(self)
Remove the proxy from the display.
 
proxy_place(self, x, y)
Place the proxy at the given x and y coordinates.
 
sash(self, *args)
Internal function.
 
sash_coord(self, index)
Return the current x and y pair for the sash given by index.
 
sash_mark(self, index)
Records x and y for the sash given by index;
 
sash_place(self, index, x, y)
Place the sash given by index at the given coordinates
 
panecget(self, child, option)
Query a management option for window.
 
paneconfigure(self, tagOrId, cnf=None, **kw)
Query or modify the management options for window.
 
paneconfig(self, tagOrId, cnf=None, **kw)
Query or modify the management options for window.
 
panes(self)
Returns an ordered list of the child panes.

Inherited from BaseWidget: destroy

Inherited from BaseWidget (private): _do, _setup

Inherited from Misc: __getitem__, __setitem__, __str__, after, after_cancel, after_idle, bbox, bell, bind, bind_all, bind_class, bindtags, cget, clipboard_append, clipboard_clear, clipboard_get, colormodel, columnconfigure, config, configure, deletecommand, event_add, event_delete, event_generate, event_info, focus, focus_displayof, focus_force, focus_get, focus_lastfor, focus_set, getboolean, getvar, grab_current, grab_release, grab_set, grab_set_global, grab_status, grid_bbox, grid_columnconfigure, grid_location, grid_propagate, grid_rowconfigure, grid_size, grid_slaves, image_names, image_types, keys, lift, lower, mainloop, nametowidget, option_add, option_clear, option_get, option_readfile, pack_propagate, pack_slaves, place_slaves, propagate, quit, register, rowconfigure, selection_clear, selection_get, selection_handle, selection_own, selection_own_get, send, setvar, size, slaves, tk_bisque, tk_focusFollowsMouse, tk_focusNext, tk_focusPrev, tk_menuBar, tk_setPalette, tk_strictMotif, tkraise, unbind, unbind_all, unbind_class, update, update_idletasks, wait_variable, wait_visibility, wait_window, waitvar, winfo_atom, winfo_atomname, winfo_cells, winfo_children, winfo_class, winfo_colormapfull, winfo_containing, winfo_depth, winfo_exists, winfo_fpixels, winfo_geometry, winfo_height, winfo_id, winfo_interps, winfo_ismapped, winfo_manager, winfo_name, winfo_parent, winfo_pathname, winfo_pixels, winfo_pointerx, winfo_pointerxy, winfo_pointery, winfo_reqheight, winfo_reqwidth, winfo_rgb, winfo_rootx, winfo_rooty, winfo_screen, winfo_screencells, winfo_screendepth, winfo_screenheight, winfo_screenmmheight, winfo_screenmmwidth, winfo_screenvisual, winfo_screenwidth, winfo_server, winfo_toplevel, winfo_viewable, winfo_visual, winfo_visualid, winfo_visualsavailable, winfo_vrootheight, winfo_vrootwidth, winfo_vrootx, winfo_vrooty, winfo_width, winfo_x, winfo_y

Inherited from Pack: info, pack, pack_configure, pack_forget, pack_info

Inherited from Place: place, place_configure, place_forget, place_info

Inherited from Grid: grid, grid_configure, grid_forget, grid_info, grid_remove, location

Inherited from Tix.Form: check, form

Class Variables [hide private]

Inherited from Misc: _noarg_

Inherited from Misc (private): _subst_format, _subst_format_str, _tclCommands

Method Details [hide private]

__init__(self, master=None, cnf={}, **kw)
(Constructor)

 
Construct a panedwindow widget with the parent MASTER.

STANDARD OPTIONS

    background, borderwidth, cursor, height,
    orient, relief, width

WIDGET-SPECIFIC OPTIONS

    handlepad, handlesize, opaqueresize,
    sashcursor, sashpad, sashrelief,
    sashwidth, showhandle,

Overrides: BaseWidget.__init__

add(self, child, **kw)

 

Add a child widget to the panedwindow in a new pane.

The child argument is the name of the child widget followed by pairs of arguments that specify how to manage the windows. Options may have any of the values accepted by the configure subcommand.

remove(self, child)

 

Remove the pane containing child from the panedwindow

All geometry management options for child will be forgotten.

forget(self, child)

 

Remove the pane containing child from the panedwindow

All geometry management options for child will be forgotten.

Overrides: Tix.Form.forget

identify(self, x, y)

 

Identify the panedwindow component at point x, y

If the point is over a sash or a sash handle, the result is a two element list containing the index of the sash or handle, and a word indicating whether it is over a sash or a handle, such as {0 sash} or {2 handle}. If the point is over any other part of the panedwindow, the result is an empty list.

sash_coord(self, index)

 

Return the current x and y pair for the sash given by index.

Index must be an integer between 0 and 1 less than the number of panes in the panedwindow. The coordinates given are those of the top left corner of the region containing the sash. pathName sash dragto index x y This command computes the difference between the given coordinates and the coordinates given to the last sash coord command for the given sash. It then moves that sash the computed difference. The return value is the empty string.

sash_mark(self, index)

 

Records x and y for the sash given by index;

Used in conjunction with later dragto commands to move the sash.

panecget(self, child, option)

 

Query a management option for window.

Option may be any value allowed by the paneconfigure subcommand

paneconfigure(self, tagOrId, cnf=None, **kw)

 
Query or modify the management options for window.

If no option is specified, returns a list describing all
of the available options for pathName.  If option is
specified with no value, then the command returns a list
describing the one named option (this list will be identical
to the corresponding sublist of the value returned if no
option is specified). If one or more option-value pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. The following options
are supported:

after window
    Insert the window after the window specified. window
    should be the name of a window already managed by pathName.
before window
    Insert the window before the window specified. window
    should be the name of a window already managed by pathName.
height size
    Specify a height for the window. The height will be the
    outer dimension of the window including its border, if
    any. If size is an empty string, or if -height is not
    specified, then the height requested internally by the
    window will be used initially; the height may later be
    adjusted by the movement of sashes in the panedwindow.
    Size may be any value accepted by Tk_GetPixels.
minsize n
    Specifies that the size of the window cannot be made
    less than n. This constraint only affects the size of
    the widget in the paned dimension -- the x dimension
    for horizontal panedwindows, the y dimension for
    vertical panedwindows. May be any value accepted by
    Tk_GetPixels.
padx n
    Specifies a non-negative value indicating how much
    extra space to leave on each side of the window in
    the X-direction. The value may have any of the forms
    accepted by Tk_GetPixels.
pady n
    Specifies a non-negative value indicating how much
    extra space to leave on each side of the window in
    the Y-direction. The value may have any of the forms
    accepted by Tk_GetPixels.
sticky style
    If a window's pane is larger than the requested
    dimensions of the window, this option may be used
    to position (or stretch) the window within its pane.
    Style is a string that contains zero or more of the
    characters n, s, e or w. The string can optionally
    contains spaces or commas, but they are ignored. Each
    letter refers to a side (north, south, east, or west)
    that the window will "stick" to. If both n and s
    (or e and w) are specified, the window will be
    stretched to fill the entire height (or width) of
    its cavity.
width size
    Specify a width for the window. The width will be
    the outer dimension of the window including its
    border, if any. If size is an empty string, or
    if -width is not specified, then the width requested
    internally by the window will be used initially; the
    width may later be adjusted by the movement of sashes
    in the panedwindow. Size may be any value accepted by
    Tk_GetPixels.

paneconfig(self, tagOrId, cnf=None, **kw)

 
Query or modify the management options for window.

If no option is specified, returns a list describing all
of the available options for pathName.  If option is
specified with no value, then the command returns a list
describing the one named option (this list will be identical
to the corresponding sublist of the value returned if no
option is specified). If one or more option-value pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. The following options
are supported:

after window
    Insert the window after the window specified. window
    should be the name of a window already managed by pathName.
before window
    Insert the window before the window specified. window
    should be the name of a window already managed by pathName.
height size
    Specify a height for the window. The height will be the
    outer dimension of the window including its border, if
    any. If size is an empty string, or if -height is not
    specified, then the height requested internally by the
    window will be used initially; the height may later be
    adjusted by the movement of sashes in the panedwindow.
    Size may be any value accepted by Tk_GetPixels.
minsize n
    Specifies that the size of the window cannot be made
    less than n. This constraint only affects the size of
    the widget in the paned dimension -- the x dimension
    for horizontal panedwindows, the y dimension for
    vertical panedwindows. May be any value accepted by
    Tk_GetPixels.
padx n
    Specifies a non-negative value indicating how much
    extra space to leave on each side of the window in
    the X-direction. The value may have any of the forms
    accepted by Tk_GetPixels.
pady n
    Specifies a non-negative value indicating how much
    extra space to leave on each side of the window in
    the Y-direction. The value may have any of the forms
    accepted by Tk_GetPixels.
sticky style
    If a window's pane is larger than the requested
    dimensions of the window, this option may be used
    to position (or stretch) the window within its pane.
    Style is a string that contains zero or more of the
    characters n, s, e or w. The string can optionally
    contains spaces or commas, but they are ignored. Each
    letter refers to a side (north, south, east, or west)
    that the window will "stick" to. If both n and s
    (or e and w) are specified, the window will be
    stretched to fill the entire height (or width) of
    its cavity.
width size
    Specify a width for the window. The width will be
    the outer dimension of the window including its
    border, if any. If size is an empty string, or
    if -width is not specified, then the width requested
    internally by the window will be used initially; the
    width may later be adjusted by the movement of sashes
    in the panedwindow. Size may be any value accepted by
    Tk_GetPixels.