1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin ipentry n 0.3]
[moddesc {An IP address entry widget}]
[titledesc {An IP address entry widget}]
[require Tcl 8.4]
[require Tk 8.4]
[require ipentry [opt 0.3]]
[description]
This package provides a widget for the entering of a IP address.
[para]
[list_begin definitions]
[call [cmd ::ipentry::ipentry] [arg pathName] [opt "[arg option] [arg value]..."]]
Creates a new IPv4 ipentry widget and configures it with the given options and
their values.
[call [cmd ::ipentry::ipentry6] [arg pathName] [opt "[arg option] [arg value]..."]]
Creates a new ipentry widget for the entry of an IPv6 address. All options
are the same as the IPv4 widget.
[list_end]
Each widget created with the command above supports the following methods:
[list_begin definitions]
[call [arg pathName] [method complete]]
Returns a boolean value. True indicates that the entry contains a
complete IP address, meaning all fields have a value. In some cases
IPv6 address are valid when fields are missing. You will need to do your
own validation to detect this.
[call [arg pathName] [method get]]
Returns the contents of the entry as a list consisting of 4 or 8 elements.
[call [arg pathName] [method insert] [arg iplist]]
IPv4
Takes a list of 4 elements and inserts one into each quad of the entry, in order.
All values in the list must be empty or integers. Values outside the range 0 to 255
are modified to be within the range.
IPv6
Takes a list of 8 elements and inserts one into each quad of the entry, in order.
All values in the list must be empty or 1 to 4 hex digits.
[call [arg pathName] [method icursor] [arg index]]
Sets the position of the widgets insertion cursor. Only integer values between
0 and 15 are valid for ipentry and 0 to 31 for ipentry6.
Setting the icursor will only have an effect if the widget
already has the input focus.
[call [arg pathName] [method configure] [arg option] [arg value]...]
Modifies the configuration of the widget. For options and
their meaning see the widget options section.
[call [arg pathName] [method cget] [arg option]]
Returns information about the current configuration of the widget, for
the specified option. For options and their meaning see the widget
options section.
[list_end]
[section {Widget options}]
[list_begin tkoption]
[tkoption_def -textvariable textvariable Variable]
The name of a variable which holds the value of the IP address.
The value must be a string of the form NNN.NNN.NNN.NNN for IPv4 or
HHHH:HHHH:HHHH:HHHH:HHHH:HHHH:HHHH:HHHH for IPv6 where H is a hex digit.
The variable will be modified to represent a valid IP address if it is not
already.
[tkoption_def -state state State]
Specifies one of three states for the entry: [const normal],
[const disabled], or [const readonly].
[tkoption_def -font font Font]
[tkoption_def -bd borderWidth BorderWidth]
[tkoption_def -fg foreground Foreground]
[tkoption_def -bg background Background]
[tkoption_def -relief relief Relief]
[tkoption_def -highlightthickness highlightThickness HighlightThickness]
[tkoption_def -highlightcolor highlightColor HighlightColor]
[tkoption_def -highlightbackground highlightBackground HighlightBackground]
[tkoption_def -selectbackground selectBackground Background]
[tkoption_def -selectforeground selectForeground Foreground]
[tkoption_def -selectborderwidth selectBorderWidth BorderWidth]
[tkoption_def -disabledbackground disabledBackground DisabledBackground]
[tkoption_def -disabledforeground disabledForeground DisabledForeground]
[tkoption_def -readonlybackground readonlyBackground ReadonlyBackground]
[tkoption_def -insertbackground insertBackground Background]
Standard widget options. See [cmd options] for a description of their
meanings and values.
[list_end]
[keywords entry {ip address}]
[manpage_end]
|