./src/tklib/tcl-tklib-ada-getstring.ads

1. TklibAda/GetString

1.1. GetString/GetString.GetString_Init
1.2. GetString/GetString.Tk_Get_String

TklibAda/GetString [ Packages ]

FUNCTION

 Provides code for manipulate Tklib getstring package

SOURCE

package Tcl.Tklib.Ada.GetString with
   SPARK_Mode
is

GetString/GetString.GetString_Init [ Subprograms ]

[ Top ] [ GetString ] [ Subprograms ]

FUNCTION

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

SOURCE

   procedure GetString_Init(Interp: in Tcl_Interp);

PARAMETERS

 Interp: Tcl interpreter to which getstring package will be added

EXAMPLE

   -- Init getstring package on My_Interp Tcl interpreter
   GetString_Init(My_Interp);

COMMANDS

 package require getstring

HISTORY

 8.6.7 - Added

GetString/GetString.Tk_Get_String [ Subprograms ]

[ Top ] [ GetString ] [ Subprograms ]

FUNCTION

 Create a dialog which prompts the user with text to input a text string.

SOURCE

   function Tk_Get_String
     (Interp: in Tcl_Interp; DialogName, Variable, Text: in String;
      Options: in String := "") return String with
      Pre => DialogName /= "" and Variable /= "" and Text /= "";

PARAMETERS

 Interp     - Tcl interpreter on which the dialog will be created
 DialogName - The name of the dialog to create
 Variable   - The name of Tcl variable which will store value entered by
              the user
 Text       - Additional text to show to the user
 Options    - Additional options for the dialog. Can be empty. Default
              value is empty

RESULT

 1 if the user pressed Ok button, otherwise 0

EXAMPLE

   -- Create dialog .mygs with text Enter text and and store entered text in mytext Tcl variable on My_Interp interpreter
   if Tk_Get_String(My_Interp, ".mygs", "mytext", "{Enter text}") = "1" then
      Ada.Text_IO.Put_Line("Entered text: " & Tcl_GetVar(My_Interp, "mytext"));
   end if;

COMMANDS

 ::getstring::tk_getString pathName variable text ?options?

HISTORY

 8.6.7 - Added

TABLE OF CONTENTS

TklibAda/GetString [ Packages ]

GetString/GetString.GetString_Init [ Subprograms ]

GetString/GetString.Tk_Get_String [ Subprograms ]