Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ttk_panedwindow (1t)

Name

ttk_panedwindow - pane container window

Synopsis

ttk::panedwindow pathname ?options?
pathname add window ?options...?
pathname insert index window ?options...?

Description

ttk::panedwindow(1t)           Tk Themed Widget           ttk::panedwindow(1t)



______________________________________________________________________________

NAME
       ttk::panedwindow - Multi-pane container window

SYNOPSIS
       ttk::panedwindow pathname ?options?
       pathname add window ?options...?
       pathname insert index window ?options...?
______________________________________________________________________________

DESCRIPTION
       A  ttk::panedwindow  widget  displays  a  number of subwindows, stacked
       either vertically or horizontally.  The user may  adjust  the  relative
       sizes of the subwindows by dragging the sash between panes.

STANDARD OPTIONS
       -class                -cursor              -takefocus
       -style

       See the ttk_widget manual entry for details on the standard options.

WIDGET-SPECIFIC OPTIONS
       Command-Line Name:-orient
       Database Name:  orient
       Database Class: Orient

              Specifies  the orientation of the window.  If vertical, subpanes
              are stacked top-to-bottom; if horizontal, subpanes  are  stacked
              left-to-right.

       Command-Line Name:-width
       Database Name:  width
       Database Class: Width

              If present and greater than zero, specifies the desired width of
              the widget in pixels.  Otherwise, the requested width is  deter-
              mined by the width of the managed windows.

       Command-Line Name:-height
       Database Name:  height
       Database Class: Height

              If  present  and greater than zero, specifies the desired height
              of the widget in pixels.  Otherwise,  the  requested  height  is
              determined by the height of the managed windows.

PANE OPTIONS
       The following options may be specified for each pane:

       Command-Line Name:-weight
       Database Name:  weight
       Database Class: Weight

              An  integer  specifying the relative stretchability of the pane.
              When the paned window is resized, the extra space  is  added  or
              subtracted to each pane proportionally to its -weight.

WIDGET COMMAND
       Supports the standard configure, cget, state, and instate commands; see
       ttk::widget(n) for details.  Additional commands:

       pathname add subwindow options...
              Adds a new pane to the window.  See PANE OPTIONS for the list of
              available options.

       pathname forget pane
              Removes  the  specified subpane from the widget.  pane is either
              an integer index or the name of a managed subwindow.

       pathname identify component x y
              Returns the name of the element under the point given by  x  and
              y,  or the empty string if no component is present at that loca-
              tion.  If component is omitted, it defaults to sash.   The  fol-
              lowing subcommands are supported:

              pathname identify element x y
                     Returns  the  name  of the element at the specified loca-
                     tion.

              pathname identify sash x y
                     Returns the index of the sash at the specified location.

       pathname insert pos subwindow options...
              Inserts a pane at the specified position.   pos  is  either  the
              string  end,  an integer index, or the name of a managed subwin-
              dow.  If subwindow is already managed by the paned window, moves
              it  to the specified position.  See PANE OPTIONS for the list of
              available options.

       pathname pane pane -option ?value ?-option value...
              Query or modify the options of the specified pane, where pane is
              either  an integer index or the name of a managed subwindow.  If
              no -option is specified, returns a dictionary of the pane option
              values.   If one -option is specified, returns the value of that
              option.  Otherwise, sets the -options to the corresponding  val-
              ues.

       pathname panes
              Returns  the  list  of all windows managed by the widget, in the
              index order of their associated panes.

       pathname sashpos index ?newpos?
              If newpos is specified, sets the position of sash number  index.
              May adjust the positions of adjacent sashes to ensure that posi-
              tions are monotonically increasing.  Sash positions are  further
              constrained  to  be  between 0 and the total size of the widget.
              Returns the new position of sash number index.

VIRTUAL EVENTS
       The panedwindow widget generates an <<EnteredChild>> virtual  event  on
       LeaveNotify/NotifyInferior  events, because Tk does not execute binding
       scripts for <Leave> events when the pointer crosses from a parent to  a
       child. The panedwindow widget needs to know when that happens.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       ttk::widget(n), ttk::notebook(n), panedwindow(n)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                    8.5                 ttk::panedwindow(1t)