www.delorie.com/gnu/docs/gcl/gcl-tk_123.html   search  
 
Buy GNU books!


Untitled Document

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

A Entry Widget's Arguments

The entry command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:

 
pathName option ?arg arg ...?

Option and the args determine the exact behavior of the command.

Many of the widget commands for entries take one or more indices as arguments. An index specifies a particular character in the entry's string, in any of the following ways:

number
Specifies the character as a numerical index, where 0 corresponds to the first character in the string.
end
Indicates the character just after the last one in the entry's string. This is equivalent to specifying a numerical index equal to the length of the entry's string.
insert
Indicates the character adjacent to and immediately following the insertion cursor.
sel.first
Indicates the first character in the selection. It is an error to use this form if the selection isn't in the entry window.
sel.last
Indicates the last character in the selection. It is an error to use this form if the selection isn't in the entry window.
@number
In this form, number is treated as an x-coordinate in the entry's window; the character spanning that x-coordinate is used. For example, "@0" indicates the left-most character in the window.

Abbreviations may be used for any of the forms above, e.g. "e" or "sel.f". In general, out-of-range indices are automatically rounded to the nearest legal value.

The following commands are possible for entry widgets:

pathName :configure ?option? ?value option value ...?
Query or modify the configuration options of the widget. If no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list). If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more option:value pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. Option may have any of the values accepted by the entry command.
pathName :delete first ?last?
Delete one or more elements of the entry. First and last are indices of of the first and last characters in the range to be deleted. If last isn't specified it defaults to first, i.e. a single character is deleted. This command returns an empty string.
pathName :get
Returns the entry's string.
pathName :icursor index
Arrange for the insertion cursor to be displayed just before the character given by index. Returns an empty string.
pathName :index index
Returns the numerical index corresponding to index.
pathName :insert index string
Insert the characters of string just before the character indicated by index. Returns an empty string.
pathName :scan option args
This command is used to implement scanning on entries. It has two forms, depending on option:
pathName :scan :mark x
Records x and the current view in the entry window; used in conjunction with later scan dragto commands. Typically this command is associated with a mouse button press in the widget. It returns an empty string.
pathName :scan :dragto x
This command computes the difference between its x argument and the x argument to the last scan mark command for the widget. It then adjusts the view left or right by 10 times the difference in x-coordinates. This command is typically associated with mouse motion events in the widget, to produce the effect of dragging the entry at high speed through the window. The return value is an empty string.
pathName :select option arg
This command is used to adjust the selection within an entry. It has several forms, depending on option:
pathName :select :adjust index
Locate the end of the selection nearest to the character given by index, and adjust that end of the selection to be at index (i.e including but not going beyond index). The other end of the selection is made the anchor point for future select to commands. If the selection isn't currently in the entry, then a new selection is created to include the characters between index and the most recent selection anchor point, inclusive. Returns an empty string.
pathName :select :clear
Clear the selection if it is currently in this widget. If the selection isn't in this widget then the command has no effect. Returns an empty string.
pathName :select :from index
Set the selection anchor point to just before the character given by index. Doesn't change the selection. Returns an empty string.
pathName :select :to index
Set the selection to consist of the elements from the anchor point to element index, inclusive. The anchor point is determined by the most recent select from or select adjust command in this widget. If the selection isn't in this widget then a new selection is created using the most recent anchor point specified for the widget. Returns an empty string.
pathName :view index
Adjust the view in the entry so that element index is at the left edge of the window. Returns an empty string.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

  webmaster     delorie software   privacy  
  Copyright 2003   by The Free Software Foundation     Updated Jun 2003