TABLE OF CONTENTS


TklibAda/Tooltip [ Packages ]

[ Top ] [ TklibAda ] [ Packages ]

FUNCTION

 Provides code for manipulate Tklib tooltip package

SOURCE

package Tcl.Tklib.Ada.Tooltip with
   SPARK_Mode
is

Tooltip/Tooltip.Add [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Add the tooltip to selected Tk_Widget

SOURCE

   procedure Add
     (Widget: in Tk_Widget'Class; Message: in String;
      Options: in String := "") with
      Pre => Message /= "";

PARAMETERS

 Widget  - Tk_Widget to which the tooltip will be added
 Message - Text which will be show in the tooltip
 Options - Additional tooltip options

EXAMPLE

   -- Add tooltip with text my tooltip text to the My_Label widget
   Add(My_Label, "my tooltip text");

COMMANDS

 ::tooltip::tooltip Widget ?options? message

HISTORY

 8.6.1 - Added

Tooltip/Tooltip.Clear [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Prevent the selected widgets from showing tooltips

SOURCE

   procedure Clear
     (Pattern: in String; Interp: in Tcl_Interp := Get_Context) with
      Pre => Pattern /= "";

PARAMETERS

 Pattern - Tk glob pattern for widgets which should not showing
           tooltips
 Interp  - Tcl interpreter on which widgets will be set. Default value
           is current interpreter

EXAMPLE

      -- Prevent to show tooltip to all widgets which name starts from .mylabel on current interpreter
      Clear("^.mylabel");

COMMANDS

 :tooltip::tooltip clear pattern

HISTORY

 8.6.7 - Added

Tooltip/Tooltip.Disable [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Disable all tooptips on the selected Tcl interpreter

SOURCE

   procedure Disable(Interp: in Tcl_Interp := Get_Context);
   procedure Off(Interp: in Tcl_Interp := Get_Context) renames Disable;

PARAMETERS

 Interp - Tcl interpreter on which tooltips will be disabled. Default
          value is current interpreter

EXAMPLE

   -- Disable all tooltips on current Tcl interpreter
   Disable;

SEE ALSO

 Tooltip.Enable

COMMANDS

 :tooltip::tooltip disable
 :tooltip::tooltip off

HISTORY

 8.6.7 - Added

Tooltip/Tooltip.Enable [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Enable all tooptips on the selected Tcl interpreter

SOURCE

   procedure Enable(Interp: in Tcl_Interp := Get_Context);
   procedure On(Interp: in Tcl_Interp := Get_Context) renames Enable;

PARAMETERS

 Interp - Tcl interpreter on which tooltips will be enabled. Default
          value is current interpreter

EXAMPLE

   -- Enable all tooltips on current Tcl interpreter
   Enable;

SEE ALSO

 Tooltip.Enable

COMMANDS

 :tooltip::tooltip enable
 :tooltip::tooltip on

HISTORY

 8.6.7 - Added

Tooltip/Tooltip.Fade [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Enable of disable fading of tooltips

SOURCE

   procedure Fade(Enable: in String; Interp: in Tcl_Interp := Get_Context) with
      Pre => Enable in "true" | "false";

PARAMETERS

 Enable - If true, enable fading, if false disable it
 Interp - Tcl interpreter on which fading will be set

EXAMPLE

   -- Enable tooltips fading on current Tcl interpreter
   Fade("true");

COMMANDS

 :tooltip::tooltip fade ?enable?

Tooltip/Tooltip.Tooltip_Delay_(function) [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Get the delay between show tooltip and moment when the pointer enters
 a widget

SOURCE

   function Tooltip_Delay(Interp: in Tcl_Interp := Get_Context) return String;

PARAMETERS

 Interp    - Tcl interpreter on which tooltip delay will be get

RESULT

 The miliseconds difference between entering the pointer a widget and
 showing tooltip

EXAMPLE

      -- Get the tooltip delay on current Tcl interpreter
      T_Delay: constant String := Tooltip_Delay;

SEE ALSO

 Tooltip.Tooltip_Delay_(procedure)

COMMANDS

 :tooltip::tooltip delay

HISTORY

 8.6.7 - Added

Tooltip/Tooltip.Tooltip_Delay_(procedure) [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Set delay between show tooltip and moment when the pointer enters a
 widget

SOURCE

   procedure Tooltip_Delay
     (Milisecs: in String; Interp: in Tcl_Interp := Get_Context) with
      Pre => Milisecs /= "";

PARAMETERS

 Milisecs  - A new value for delay (in miliseconds)
 Interp    - Tcl interpreter on which tooltip delay will be set

EXAMPLE

      -- Set the tooltips delay to 2 seconds on current Tcl interpreter
      Tooltip_Delay("2000");

SEE ALSO

 Tooltip.Tooltip_Delay_(function)

COMMANDS

 :tooltip::tooltip delay milisecs

HISTORY

 8.6.7 - Added

Tooltip/Tooltip.Tooltip_Init [ Subprograms ]

[ Top ] [ Tooltip ] [ Subprograms ]

FUNCTION

 Load package Tooltip. Raise Program_Error if package can't be loaded

SOURCE

   procedure Tooltip_Init(Interp: in Tcl_Interp);

PARAMETERS

 Interp: Tcl interpreter to which tooltip package will be added

EXAMPLE

   -- Init tooltip package on My_Interp Tcl interpreter
   Tooltip_Init(My_Interp);

COMMANDS

 package require tooltip

HISTORY

 8.6.1 - Added