TABLE OF CONTENTS

Widgets/TtkPanedWindow [ Packages ]

[ Top ] [ Widgets ] [ Packages ]

FUNCTION

 Provides code for manipulate Tk widget Ttk::PanedWindow

SOURCE

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

TtkPanedWindow/TtkPanedWindow.Ttk_PanedWindow [ Types ]

[ Top ] [ TtkPanedWindow ] [ 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 Ttk_PanedWindow is new Tk_Widget with private;

TtkPanedWindow/Panes [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Get list of names of all widgets managed by the Ttk_PanedWindow

SOURCE

   function Panes(Paned: in Ttk_PanedWindow) return String;

PARAMETERS

 Paned - Ttk_PanedWindow which will be queried for widgets

RESULT

 List of widgets inside of Ttk_PanedWindow

EXAMPLE

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

COMMANDS

 Paned panes

HISTORY

 8.6.1 - Added

TtkPanedWindow/TtkPanedWindow.Add [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Adds the Tk_Widget to the Ttk_PanedWindow.

SOURCE

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

PARAMETERS

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

EXAMPLE

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

COMMANDS

 Paned add subwindow ?options?

HISTORY

 8.6.1 - Added

TtkPanedWindow/TtkPanedWindow.Create_(function) [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Creates a new Ttk_PanedWindow in the specified interpreter.

SOURCE

   overriding function Create
     (pathName: in String; options: in String := "";
      Interp: in Tcl_Interp := Null_Interp) return Ttk_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 Ttk_PanedWindow

EXAMPLE

   -- Create a new panedwindow with pathname .mypaned
   My_Paned: constant Ttk_PanedWindow := Create(".mypaned");

SEE ALSO

 TtkPanedWindow.Create_(procedure)

COMMANDS

 ttk::panedwindow pathName ?options?

HISTORY

 8.6.1 - Added

TtkPanedWindow/TtkPanedWindow.Create_(procedure) [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Creates a new Ttk_PanedWindow in the specified interpreter.

SOURCE

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

PARAMETERS

 Widgt    - Ttk_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 Ttk_PanedWindow as parameter Widgt

EXAMPLE

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

SEE ALSO

 TtkPanedWindow.Create_(function)

COMMANDS

 ttk::panedwindow pathName ?options?

HISTORY

 8.6.1 - Added

TtkPanedWindow/TtkPanedWindow.Forget [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Remove the Tk_Widget from the Ttk_PanedWindow

SOURCE

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

PARAMETERS

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

EXAMPLE

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

COMMANDS

 Paned forget subwindow

HISTORY

 8.6.1 - Added

TtkPanedWindow/TtkPanedWindow.Get_Widget [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Get the existing Ttk_PanedWindow widget

SOURCE

   overriding function Get_Widget
     (pathName: in String; Interp: in Tcl_Interp := Get_Context)
      return Ttk_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 Ttk_PanedWindow widget

EXAMPLE

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

HISTORY

 8.6.9 - Added

TtkPanedWindow/TtkPanedWindow.Identify_Element [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Get the name of the paned element at the selected point

SOURCE

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

PARAMETERS

 Paned - Ttk_PanedWindow which will be queried for elements
 X     - X coordinate of the point to check
 Y     - Y coordinate of the point to check

RESULT

 Name of the element at the selected point of {} if no element or point
 is outside Paned

EXAMPLE

   -- Get the name of the element at point (56, 32) in My_Paned panedwindow
   Element_Name: constant String := Identify_Element(My_Paned, "56", "32");

COMMANDS

 Paned identify element x y

HISTORY

 8.6.6 - Added

TtkPanedWindow/TtkPanedWindow.Identify_Sash [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Get the index of the paned sash at the selected point

SOURCE

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

PARAMETERS

 Paned - Ttk_PanedWindow which will be queried for sash
 X     - X coordinate of the point to check
 Y     - Y coordinate of the point to check

RESULT

 Index of the sash at the selected point of {} if no sash or point
 is outside Paned

EXAMPLE

      -- Identify sash at point (43, 86) in My_Paned panedwindow
      Sash_Index: constant String := Identify_Sash(My_Paned, "43", "86");

COMMANDS

 Paned identify sash x y

HISTORY

 8.6.6 - Added

TtkPanedWindow/TtkPanedWindow.Insert [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Insert the selected Tk_Widget in the selected Ttk_PanedWindow on the
 selected position

SOURCE

   procedure Insert
     (Paned: in Ttk_PanedWindow; Position: in String;
      SubWindow: in Tk_Widget'Class; Options: in String := "") with
      Pre'Class => Position /= "";

PARAMETERS

 Paned     - Ttk_PanedWindow in which SubWindow will be inserted
 Position  - Position on which SubWindow will be inserted
 SubWindow - Tk_Widget to insert to the Ttk_PanedWindow
 Options   - Tk options which will be passed to the command. Default
             value is empty.

EXAMPLE

      -- Insert My_Frame at the end of the My_Paned panedwindow
      Insert(My_Paned, "end", My_Frame);

COMMANDS

 Paned insert pos subwindow ?options?

HISTORY

 8.6.3 - Added

TtkPanedWindow/TtkPanedWindow.Pane_(function) [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Get the selected options values of the selected widget in the
 selected Ttk_PanedWindow

SOURCE

   function Pane
     (Paned: in Ttk_PanedWindow; Index: in String; Option: in String := "")
      return String with
      Pre'Class => Index /= "";

PARAMETERS

 Paned  - Ttk_PanedWindow in which widget's options will be queried
 Index  - Numeric index or name of widget which options will be get
 Option - Name of the option to get. Can be empty. Default value is
          empty

RESULT

 If Option is specified, then return value of the selected option.
 Otherwise, return list of all options with their values.

EXAMPLE

      -- Get all available options for first subwindow in My_Paned panedwindow
      Options: constant String := Pane(My_Paned, "0");

SEE ALSO

 TtkPanedWindow.Pane_(procedure)

COMMANDS

 Paned pane pane ?option?

HISTORY

 8.6.6 - Added

TtkPanedWindow/TtkPanedWindow.Pane_(procedure) [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Set the selected options of the selected widget in the selected
 Ttk_PanedWindow

SOURCE

   procedure Pane(Paned: in Ttk_PanedWindow; Index, Options: in String) with
      Pre'Class => Index /= "" and Options /= "";

PARAMETERS

 Paned   - Ttk_PanedWindow in which widget's options will be set
 Index   - Numeric index or name of widget which options will be set
 Options - Options and new values for the selected widget

EXAMPLE

      -- Set the weight of first subwindow in My_Paned panedwindow to 2
      Pane(My_Paned, "0", "-weight 2");

SEE ALSO

 TtkPanedWindow.Pane_(function)

COMMANDS

 Paned pane index ?options?

HISTORY

 8.6.6 - Added

TtkPanedWindow/TtkPanedWindow.SashPos_(function) [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Get the current position of the selected sash in the selected
 Ttk_PanedWindow

SOURCE

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

PARAMETERS

 Paned  - Ttk_PanedWindow in which the position of the sash will be
          taken
 Index  - Index of the sash to query for position

RESULT

 The current position of the selected sash.

EXAMPLE

      -- Get the current position of the second sash in My_Paned panedwindow
      Position: constant String := SashPos(My_Paned, "1");

SEE ALSO

 TtkPanedWindow.SashPos_(procedure)

COMMANDS

 Paned sashpos index

HISTORY

 8.6.6 - Added

TtkPanedWindow/TtkPanedWindow.SashPos_(procedure) [ Subprograms ]

[ Top ] [ TtkPanedWindow ] [ Subprograms ]

FUNCTION

 Set position of the selected sash in the selected Ttk_PanedWindow to new
 position

SOURCE

   procedure SashPos(Paned: in Ttk_PanedWindow; Index, NewPos: in String) with
      Pre'Class => Index /= "" and NewPos /= "";

PARAMETERS

 Paned  - Ttk_PanedWindow in which the selected sash will be moved
 Index  - Index of the sash to move
 NewPos - New position (in pixels) of the selected sash

EXAMPLE

   -- Set the position of the first sash in My_Paned panedwindow to 35 pixels from start
   SashPos(My_Paned, "0", "35");

SEE ALSO

 TtkPanedWindow.SashPos_(function)

COMMANDS

 Paned sashpos index newpos

HISTORY

 8.6.6 - Added