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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
|
<manpage cat="cmd" id="combobox" title="combobox" version="0.4">
<!-- This file was automatically generated. DO NOT EDIT (yet)! -->
<!--
Copyright (c) 2004 Joe English
-->
<?TROFF.TH title="combobox" section="n" date="0.4" source="tile" manual="Tile Widget Set" ?>
<namesection>
<name>ttk::combobox</name>
<desc>text field with popdown selection list</desc>
</namesection>
<synopsis>
<syntax>
<b>ttk::combobox</b> <m>pathName</m> ?<m>options</m>?
</syntax>
</synopsis>
<section>
<title>STANDARD OPTIONS</title>
<sl cat="stdopt" cols="4">
<li>-class</li>
<li>-cursor</li>
<li>-style</li>
<li>-takefocus</li>
</sl>
</section>
<section>
<title>OPTIONS</title>
<optionlist>
<optiondef>
<name>-exportselection</name>
<dbname>exportSelection</dbname>
<dbclass>ExportSelection</dbclass>
<desc>Boolean value.
If set, the widget selection is linked to the X selection.
</desc>
</optiondef>
<optiondef>
<name>-justify</name>
<dbname>justify</dbname>
<dbclass>Justify</dbclass>
<desc>Specifies how the text is aligned within the widget.
One of <b>left</b>, <b>center</b>, or <b>right</b>.
</desc>
</optiondef>
<optiondef>
<name>-height</name>
<dbname>height</dbname>
<dbclass>Height</dbclass>
<desc>Specifies the height of the pop-down listbox, in rows.
</desc>
</optiondef>
<optiondef>
<name>-postcommand</name>
<dbname>postCommand</dbname>
<dbclass>PostCommand</dbclass>
<desc>A Tcl script to evaluate immediately before displaying the listbox.
The <b>-postcommand</b> script may specify the <b>-values</b> to display.
</desc>
</optiondef>
<optiondef>
<name>-state</name>
<dbname>state</dbname>
<dbclass>State</dbclass>
<desc>One of <b>normal</b>, <b>readonly</b>, or <b>disabled</b>.
In the <b>readonly</b> state,
the value may not be edited directly, and
the user can only select one of the <b>-values</b> from the
dropdown list.
In the <b>normal</b> state,
the text field is directly editable.
In the <b>disabled</b> state, no interaction is possible.
</desc>
</optiondef>
<optiondef>
<name>-textvariable</name>
<dbname>textVariable</dbname>
<dbclass>TextVariable</dbclass>
<desc>Specifies the name of a variable whose value is linked
to the widget value.
Whenever the variable changes value the widget value is updated,
and vice versa.
</desc>
</optiondef>
<optiondef>
<name>-values</name>
<dbname>values</dbname>
<dbclass>Values</dbclass>
<desc>Specifies the list of values to display in the drop-down listbox.
</desc>
</optiondef>
<optiondef>
<name>-width</name>
<dbname>width</dbname>
<dbclass>Width</dbclass>
<desc>Specifies an integer value indicating the desired width of the entry window,
in average-size characters of the widget's font.
</desc>
</optiondef>
</optionlist>
</section>
<section>
<title>DESCRIPTION</title>
<p>A combobox combines a text field with a pop-down list of values;
the user may select the value of the text field from among the
values in the list.
</p>
</section>
<section>
<title>WIDGET COMMAND</title>
<dl>
<dle>
<dt><m>pathName</m> <b>cget</b> <m>option</m></dt>
<dd>Returns the current value of the specified <i>option</i>.
See <i>widget(n)</i>.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>configure</b> ?<m>option</m>? ?<m>value option value ...</m>?</dt>
<dd>Modify or query widget options.
See <i>widget(n)</i>.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>current</b> ?<m>newIndex</m>?</dt>
<dd>If <i>newIndex</i> is supplied, sets the combobox value
to the element at position <i>newIndex</i> in the list of <b>-values</b>.
Otherwise, returns the index of the current value in the list of <b>-values</b>
or <b>-1</b> if the current value does not appear in the list.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>get</b></dt>
<dd>Returns the current value of the combobox.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>identify</b> <m>x y</m></dt>
<dd>Returns the name of the element at position <i>x</i>, <i>y</i>,
or the empty string if the coordinates are outside the window.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>instate</b> <m>statespec</m> ?<m>script</m>?</dt>
<dd>Test the widget state.
See <i>widget(n)</i>.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>set</b> <m>value</m></dt>
<dd>Sets the value of the combobox to <i>value</i>.
</dd>
</dle>
<dle>
<dt><m>pathName</m> <b>state</b> ?<m>stateSpec</m>?</dt>
<dd>Modify or query the widget state.
See <i>widget(n)</i>.
</dd>
</dle>
</dl>
<p>The combobox widget also supports the following <i>entry</i>
widget commands (see <i>entry(n)</i> for details):
</p>
<?TABSTOPS 5.5c 11c?>
<sl cols="3">
<li>bbox</li>
<li>delete</li>
<li>icursor</li>
<li>index</li>
<li>insert</li>
<li>selection</li>
<li>xview</li>
</sl>
</section>
<section>
<title>VIRTUAL EVENTS</title>
<p>The combobox widget generates a <b><<ComboboxSelected>></b> virtual event
when the user selects an element from the list of values.
This event is generated after the listbox is unposted.
</p>
</section>
<seealso>
<ref>widget(n)</ref>
<ref>entry(n)</ref>
</seealso>
</manpage>
|