TABLE OF CONTENTS

Widgets/PanedWindow [ Packages ]

[ Top ] [ Widgets ] [ Packages ]

FUNCTION

 Provides code for manipulate Tk widget PanedWindow

SOURCE

package Tcl.Tk.Ada.Widgets.PanedWindow with
   SPARK_Mode
is
   pragma Elaborate_Body;

PanedWindow/PanedWindow.Tk_Paned_Window [ Types ]

[ Top ] [ PanedWindow ] [ Types ]

FUNCTION

 This is a non-abstract type derived directly from Tk_Widget.
 Each of the derived widgets redefines the Create subprogram
 in order to create the correct type of widget.

SOURCE

   type Tk_PanedWindow is new Tk_Widget with private;

PanedWindow/PanedWindow.Add [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Adds the Tk_Widget to the Tk_PanedWindow.

SOURCE

   procedure Add
     (Paned: in Tk_PanedWindow; SubWindow: in Tk_Widget'Class;
      Options: in String := "");

PARAMETERS

 Paned     - Tk_PanedWindow to which SubWindow will be added
 SubWindow - Tk_Widget which will be added to the Tk_PanedWindow
 Options   - Tk options which will be passed to the command. Default
             value is empty.

EXAMPLE

     -- Add My_Frame to My_Paned panedwindow
     Add(My_Paned, My_Frame);

COMMANDS

 Paned SubWindow ?Options?

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Create_(function) [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Creates a new Tk_PanedWindow in the specified interpreter.

SOURCE

   overriding function Create
     (pathName: in String; options: in String := "";
      Interp: in Tcl_Interp := Null_Interp) return Tk_PanedWindow with
      Global => null;

PARAMETERS

 pathName - Tk path (starts with dot) for the widget
 options  - Options which will be passed to the widget. Default value is
            empty
 Interp   - Tcl interpreter to which the widget will be created. If null,
            the widget will be created in the "contextual" interpreter.
            Default value is null.

RESULT

 Newly created Tk_PanedWindow

EXAMPLE

   -- Create a new panedwindow with pathname .mypaned and relief solid
   My_Paned: constant Tk_PanedWindow := Create(".mypaned", "-relief solid");

SEE ALSO

 PanedWindow.Create_(procedure)

COMMANDS

 panedwindow pathName ?options?

HISTORY

 8.6.1 - Added

PanedWindow/PanedWindow.Create_(procedure) [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Creates a new Tk_PanedWindow in the specified interpreter.

SOURCE

   overriding procedure Create
     (Widgt: out Tk_PanedWindow; pathName: in String; options: in String := "";
      Interp: in Tcl_Interp := Null_Interp) with
      Global => null;

PARAMETERS

 Widgt    - Tk_PanedWindow which will be created
 pathName - Tk path (starts with dot) for the widget
 options  - Options which will be passed to the widget. Default value is
            empty
 Interp   - Tcl interpreter to which the widget will be created. If null,
            the widget will be created in the "contextual" interpreter.
            Default value is null.

OUTPUT

 Newly created Tk_PanedWindow as parameter Widgt

EXAMPLE

     -- Create panedwindow My_Paned with pathname .mypaned and black background on the current Tcl interpreter
     declare
        My_Paned: Tk_PanedWindow;
     begin
        Create(My_Paned, ".mypaned", "-background black");
     end;

SEE ALSO

 PanedWindow.Create_(function)

COMMANDS

 panedwindow pathName ?options?

HISTORY

 8.6.1 - Added

PanedWindow/PanedWindow.Forget [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Remove the Tk_Widget from the Tk_PanedWindow

SOURCE

   procedure Forget(Paned: in Tk_PanedWindow; SubWindow: in Tk_Widget'Class);

PARAMETERS

 Paned     - Tk_PanedWindow from which SubWindow will be removed
 SubWindow - Tk_Widget which will be removed from the Tk_PanedWindow

EXAMPLE

   -- Remove My_Frame widget from My_Paned panedwindow
   Forget(My_Paned, My_Frame);

COMMANDS

 Paned forget window

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Get_Widget [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Get the existing Tk_PanedWindow widget

SOURCE

   overriding function Get_Widget
     (pathName: in String; Interp: in Tcl_Interp := Get_Context)
      return Tk_PanedWindow with
      Global => null;

PARAMETERS

 pathName - Tk path (starts with dot) for the widget
 Interp   - Tcl interpreter on which the widget exists. Can be empty.
            Default value is current Tcl interpreter

RESULT

 Existing Tk_PanedWindow widget

EXAMPLE

     -- Get panedwindow widget with name .mypaned on the current Tcl interpreter
     My_Paned: constant Tk_PanedWindow := Get_Widget(".mypaned");

HISTORY

 8.6.9 - Added

PanedWindow/PanedWindow.Identify [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Identify Tk_PanedWindow component at the selected point in window
 coordinates

SOURCE

   function Identify
     (Paned: in Tk_PanedWindow; X, Y: in String) return String with
      Pre'Class => X /= "" and Y /= "";

PARAMETERS

 Paned - Tk_PanedWindow which will be queried
 X     - X coordinate to check
 Y     - Y coordinate to check

RESULT

 If point is over sash or sash handle return two values: 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 window, return {}

EXAMPLE

   -- Identify the My_Paned paned element at point (24, 56)
   Element: constant String := Identify(My_Paned, "24", "56");

COMMANDS

 Paned identify x y

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Pane_Cget [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Get value of the selected option of the selected window in the
 selected Tk_PanedWindow

SOURCE

   function Pane_Cget
     (Paned: in Tk_PanedWindow; Window, Option: in String) return String with
      Pre'Class => Window /= "" and Option /= "";

PARAMETERS

 Paned  - Tk_PanedWindow in which option will be queried
 Window - Name of the window inside Paned which option will be queried
 Option - Option to query

RESULT

 Current value of the selected Option for the selected Window

EXAMPLE

      -- Get the visibility of the .mypaned.myframe widget in My_Paned panedwindow
      Visibility: constant String := Pane_Cget(My_Paned, ".mypaned.myframe", "-hide");

SEE ALSO

 PanedWindow.Pane_Configure_(function)

COMMANDS

 Paned panecget window option

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Pane_Configure_(function) [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Modify or query the selected options of the selected window in the
 selected Tk_PanedWindow

SOURCE

   function Pane_Configure
     (Paned: in Tk_PanedWindow; Window: in String; Options: in String := "")
      return String with
      Pre'Class => Window /= "";

PARAMETERS

 Paned   - Tk_PanedWindow in which options will be modified or
           queried
 Window  - Name of the window inside Paned which options will be
           modified or queried
 Options - Options names with new values for them. Can be empty.
           Default value is empty

RESULT

 List of options with current values for them. If used to modify the
 selected Options returns {}

EXAMPLE

      -- Get the height of the .mypaned.myframe widget in My_Paned panedwindow
      Height: constant String := Pane_Configure(My_Paned, ".mypaned.myframe", "-height");

SEE ALSO

 PanedWindow.Pane_Configure_(procedure), PanedWindow.Pane_Cget

COMMANDS

 Paned paneconfigure window ?options?

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Pane_Configure_(procedure) [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Modify the selected options of the selected window in the selected
 Tk_PanedWindow

SOURCE

   procedure Pane_Configure
     (Paned: in Tk_PanedWindow; Window, Options: in String) with
      Pre'Class => Window /= "" and Options /= "";

PARAMETERS

 Paned   - Tk_PanedWindow in which options will be modified
 Window  - Name of the window inside Paned which options will be
           modified
 Options - Options names with new values for them

EXAMPLE

      -- Set the widget .mypaned.myframe sticky option to north in My_Paned panedwindow
      Pane_Configure(My_Paned, ".mypaned.myframe", "-sticky n");

SEE ALSO

 PanedWindow.Pane_Configure_(function)

COMMANDS

 Paned paneconfigure window options

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Panes [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Get list of names of all widgets managed by the Tk_PanedWindow

SOURCE

   function Panes(Paned: in Tk_PanedWindow) return String;

PARAMETERS

 Paned - Tk_PanedWindow which will be queried for widgets

RESULT

 List of widgets inside of Tk_PanedWindow

EXAMPLE

      -- Get the names of all widget in the My_Paned panedwindow
      Children: constant String := Panes(My_Paned);

COMMANDS

 Paned panes

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Proxy_Coord [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Get coordinates of current positon of sash proxy

SOURCE

   function Proxy_Coord(Paned: in Tk_PanedWindow) return String;

PARAMETERS

 Paned - Tk_PanedWindow which will be queried for coordinates

RESULT

 List of coordinates (X and Y) of the most recent proxy location

EXAMPLE

   -- Get the coordinates of sash proxy in My_Paned panedwindow
   Coords: constant String := Proxy_Coord(My_Paned);

COMMANDS

 Paned proxy coord

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Proxy_Forget [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Remove the proxy from the display

SOURCE

   procedure Proxy_Forget(Paned: in Tk_PanedWindow);

PARAMETERS

 Paned - Tk_PanedWindow which the proxy will be removed

EXAMPLE

   -- Remove the proxy from the My_Paned panedwindow
   Proxy_Forget(My_Paned);

COMMANDS

 Paned proxy forget

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Proxy_Place [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Place the proxy at the given x and y coordinates

SOURCE

   procedure Proxy_Place(Paned: in Tk_PanedWindow; X, Y: in String) with
      Pre'Class => X /= "" and Y /= "";

PARAMETERS

 Paned - Tk_PanedWindow in which the proxy will be placed
 X     - X coordinate of new point for the proxy
 Y     - Y coordinate of new point for the proxy

EXAMPLE

   -- Place the My_Paned panedwindow proxy at (24, 57)
   Proxy_Place(My_Paned, "24", "57");

COMMANDS

 Paned proxy place x y

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Sash_Coord [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Get coordinates of the selected sash in the selected Tk_PanedWindow

SOURCE

   function Sash_Coord
     (Paned: in Tk_PanedWindow; Index: in String) return String with
      Pre'Class => Index /= "";

PARAMETERS

 Paned - Tk_PanedWindow which will be queried for sash coordinates
 Index - Index of the sash which coordinates will be queried

RESULT

 Coordinates X and Y of top left corner of the selected sash

EXAMPLE

      -- Get coordinates of the first sash in the My_Paned panedwindow
      Coords: constant String := Sash_Coord(My_Paned, "0");

COMMANDS

 Paned sash coord index

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Sash_DragTo [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Move the selected sash by difference between given coordinates and
 last Sash_Mark procedure call

SOURCE

   procedure Sash_DragTo(Paned: in Tk_PanedWindow; Index, X, Y: in String) with
      Pre'Class => Index /= "" and X /= "" and Y /= "";

PARAMETERS

 Paned - Tk_PanedWindow in which the selected sash will be moved
 Index - Index of the sash to move
 X     - X coordinate for compute a new position for the sash
 Y     - Y coordinate for compute a new position for the sash

EXAMPLE

      -- Move second sash in the My_Paned panedwindow by difference (22, 54) and Sash_Mark call
      Sash_DragTo(My_Paned, "1", "22", "54");

SEE ALSO

 PanedWindow.Sash_Mark

COMMANDS

 Paned sash dragto index x y

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Sash_Mark [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Set position which will be later used to move sash with procedure
 Sash_DragTo

SOURCE

   procedure Sash_Mark(Paned: in Tk_PanedWindow; Index, X, Y: in String) with
      Pre'Class => Index /= "" and X /= "" and Y /= "";

PARAMETERS

 Paned - Tk_PanedWindow in which the selected sash coordinates will be
         marked
 Index - Index of the sash to mark
 X     - X coordinate a new position to mark
 Y     - Y coordinate a new position to mark

EXAMPLE

      -- Set the sash mark for second sash in My_Paned panewindow to (89, 34)
      Sash_Mark(My_Paned, "1", "89", "34");

SEE ALSO

 PanedWindow.Sash_DragTo

COMMANDS

 Paned sash mark index x y

HISTORY

 8.6.4 - Added

PanedWindow/PanedWindow.Sash_Place [ Subprograms ]

[ Top ] [ PanedWindow ] [ Subprograms ]

FUNCTION

 Place the selected sash at the selected coordinates

SOURCE

   procedure Sash_Place(Paned: in Tk_PanedWindow; Index, X, Y: in String) with
      Pre'Class => Index /= "" and X /= "" and Y /= "";

PARAMETERS

 Paned - Tk_PanedWindow in which sash will be moved
 Index - Index of the sash to move
 X     - X coordinate where the sash will be placed
 Y     - Y coordinate where the sash will be placed

EXAMPLE

      -- Place the first sash in My_Paned panedwindow at position (56, 32)
      Sash_Place(My_Paned, "0", "56", "32");

COMMANDS

 Paned sash place index x y

HISTORY

 8.6.4 - Added