/
tkListbox.c
3283 lines (3021 loc) · 97.6 KB
/
tkListbox.c
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* tkListbox.c --
*
* This module implements listbox widgets for the Tk
* toolkit. A listbox displays a collection of strings,
* one per line, and provides scrolling and selection.
*
* Copyright (c) 1990-1994 The Regents of the University of California.
* Copyright (c) 1994-1997 Sun Microsystems, Inc.
*
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
*
* RCS: @(#) $Id: tkListbox.c,v 1.16 2000/03/02 21:52:41 hobbs Exp $
*/
#include "tkPort.h"
#include "default.h"
#include "tkInt.h"
typedef struct {
Tk_OptionTable listboxOptionTable; /* Table defining configuration options
* available for the listbox */
Tk_OptionTable itemAttrOptionTable; /* Table definining configuration
* options available for listbox
* items */
} ListboxOptionTables;
/*
* A data structure of the following type is kept for each listbox
* widget managed by this file:
*/
typedef struct {
Tk_Window tkwin; /* Window that embodies the listbox. NULL
* means that the window has been destroyed
* but the data structures haven't yet been
* cleaned up.*/
Display *display; /* Display containing widget. Used, among
* other things, so that resources can be
* freed even after tkwin has gone away. */
Tcl_Interp *interp; /* Interpreter associated with listbox. */
Tcl_Command widgetCmd; /* Token for listbox's widget command. */
Tk_OptionTable optionTable; /* Table that defines configuration options
* available for this widget. */
Tk_OptionTable itemAttrOptionTable; /* Table that defines configuration
* options available for listbox
* items */
char *listVarName; /* List variable name */
Tcl_Obj *listObj; /* Pointer to the list object being used */
int nElements; /* Holds the current count of elements */
Tcl_HashTable *selection; /* Tracks selection */
Tcl_HashTable *itemAttrTable; /* Tracks item attributes */
/*
* Information used when displaying widget:
*/
Tk_3DBorder normalBorder; /* Used for drawing border around whole
* window, plus used for background. */
int borderWidth; /* Width of 3-D border around window. */
int relief; /* 3-D effect: TK_RELIEF_RAISED, etc. */
int highlightWidth; /* Width in pixels of highlight to draw
* around widget when it has the focus.
* <= 0 means don't draw a highlight. */
XColor *highlightBgColorPtr;
/* Color for drawing traversal highlight
* area when highlight is off. */
XColor *highlightColorPtr; /* Color for drawing traversal highlight. */
int inset; /* Total width of all borders, including
* traversal highlight and 3-D border.
* Indicates how much interior stuff must
* be offset from outside edges to leave
* room for borders. */
Tk_Font tkfont; /* Information about text font, or NULL. */
XColor *fgColorPtr; /* Text color in normal mode. */
GC textGC; /* For drawing normal text. */
Tk_3DBorder selBorder; /* Borders and backgrounds for selected
* elements. */
int selBorderWidth; /* Width of border around selection. */
XColor *selFgColorPtr; /* Foreground color for selected elements. */
GC selTextGC; /* For drawing selected text. */
int width; /* Desired width of window, in characters. */
int height; /* Desired height of window, in lines. */
int lineHeight; /* Number of pixels allocated for each line
* in display. */
int topIndex; /* Index of top-most element visible in
* window. */
int fullLines; /* Number of lines that fit are completely
* visible in window. There may be one
* additional line at the bottom that is
* partially visible. */
int partialLine; /* 0 means that the window holds exactly
* fullLines lines. 1 means that there is
* one additional line that is partially
* visble. */
int setGrid; /* Non-zero means pass gridding information
* to window manager. */
/*
* Information to support horizontal scrolling:
*/
int maxWidth; /* Width (in pixels) of widest string in
* listbox. */
int xScrollUnit; /* Number of pixels in one "unit" for
* horizontal scrolling (window scrolls
* horizontally in increments of this size).
* This is an average character size. */
int xOffset; /* The left edge of each string in the
* listbox is offset to the left by this
* many pixels (0 means no offset, positive
* means there is an offset). */
/*
* Information about what's selected or active, if any.
*/
Tk_Uid selectMode; /* Selection style: single, browse, multiple,
* or extended. This value isn't used in C
* code, but the Tcl bindings use it. */
int numSelected; /* Number of elements currently selected. */
int selectAnchor; /* Fixed end of selection (i.e. element
* at which selection was started.) */
int exportSelection; /* Non-zero means tie internal listbox
* to X selection. */
int active; /* Index of "active" element (the one that
* has been selected by keyboard traversal).
* -1 means none. */
/*
* Information for scanning:
*/
int scanMarkX; /* X-position at which scan started (e.g.
* button was pressed here). */
int scanMarkY; /* Y-position at which scan started (e.g.
* button was pressed here). */
int scanMarkXOffset; /* Value of "xOffset" field when scan
* started. */
int scanMarkYIndex; /* Index of line that was at top of window
* when scan started. */
/*
* Miscellaneous information:
*/
Tk_Cursor cursor; /* Current cursor for window, or None. */
char *takeFocus; /* Value of -takefocus option; not used in
* the C code, but used by keyboard traversal
* scripts. Malloc'ed, but may be NULL. */
char *yScrollCmd; /* Command prefix for communicating with
* vertical scrollbar. NULL means no command
* to issue. Malloc'ed. */
char *xScrollCmd; /* Command prefix for communicating with
* horizontal scrollbar. NULL means no command
* to issue. Malloc'ed. */
int flags; /* Various flag bits: see below for
* definitions. */
} Listbox;
/*
* ItemAttr structures are used to store item configuration information for
* the items in a listbox
*/
typedef struct {
Tk_3DBorder border; /* Used for drawing background around text */
Tk_3DBorder selBorder; /* Used for selected text */
XColor *fgColor; /* Text color in normal mode. */
XColor *selFgColor; /* Text color in selected mode. */
} ItemAttr;
/*
* Flag bits for listboxes:
*
* REDRAW_PENDING: Non-zero means a DoWhenIdle handler
* has already been queued to redraw
* this window.
* UPDATE_V_SCROLLBAR: Non-zero means vertical scrollbar needs
* to be updated.
* UPDATE_H_SCROLLBAR: Non-zero means horizontal scrollbar needs
* to be updated.
* GOT_FOCUS: Non-zero means this widget currently
* has the input focus.
* MAXWIDTH_IS_STALE: Stored maxWidth may be out-of-date
* LISTBOX_DELETED: This listbox has been effectively destroyed.
*/
#define REDRAW_PENDING 1
#define UPDATE_V_SCROLLBAR 2
#define UPDATE_H_SCROLLBAR 4
#define GOT_FOCUS 8
#define MAXWIDTH_IS_STALE 16
#define LISTBOX_DELETED 32
/*
* The optionSpecs table defines the valid configuration options for the
* listbox widget
*/
static Tk_OptionSpec optionSpecs[] = {
{TK_OPTION_BORDER, "-background", "background", "Background",
DEF_LISTBOX_BG_COLOR, -1, Tk_Offset(Listbox, normalBorder),
0, (ClientData) DEF_LISTBOX_BG_MONO, 0},
{TK_OPTION_SYNONYM, "-bd", (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-borderwidth", 0},
{TK_OPTION_SYNONYM, "-bg", (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-background", 0},
{TK_OPTION_PIXELS, "-borderwidth", "borderWidth", "BorderWidth",
DEF_LISTBOX_BORDER_WIDTH, -1, Tk_Offset(Listbox, borderWidth),
0, 0, 0},
{TK_OPTION_CURSOR, "-cursor", "cursor", "Cursor",
DEF_LISTBOX_CURSOR, -1, Tk_Offset(Listbox, cursor),
TK_OPTION_NULL_OK, 0, 0},
{TK_OPTION_BOOLEAN, "-exportselection", "exportSelection",
"ExportSelection", DEF_LISTBOX_EXPORT_SELECTION, -1,
Tk_Offset(Listbox, exportSelection), 0, 0, 0},
{TK_OPTION_SYNONYM, "-fg", "foreground", (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-foreground", 0},
{TK_OPTION_FONT, "-font", "font", "Font",
DEF_LISTBOX_FONT, -1, Tk_Offset(Listbox, tkfont), 0, 0, 0},
{TK_OPTION_COLOR, "-foreground", "foreground", "Foreground",
DEF_LISTBOX_FG, -1, Tk_Offset(Listbox, fgColorPtr), 0, 0, 0},
{TK_OPTION_INT, "-height", "height", "Height",
DEF_LISTBOX_HEIGHT, -1, Tk_Offset(Listbox, height), 0, 0, 0},
{TK_OPTION_COLOR, "-highlightbackground", "highlightBackground",
"HighlightBackground", DEF_LISTBOX_HIGHLIGHT_BG, -1,
Tk_Offset(Listbox, highlightBgColorPtr), 0, 0, 0},
{TK_OPTION_COLOR, "-highlightcolor", "highlightColor", "HighlightColor",
DEF_LISTBOX_HIGHLIGHT, -1, Tk_Offset(Listbox, highlightColorPtr),
0, 0, 0},
{TK_OPTION_PIXELS, "-highlightthickness", "highlightThickness",
"HighlightThickness", DEF_LISTBOX_HIGHLIGHT_WIDTH, -1,
Tk_Offset(Listbox, highlightWidth), 0, 0, 0},
{TK_OPTION_RELIEF, "-relief", "relief", "Relief",
DEF_LISTBOX_RELIEF, -1, Tk_Offset(Listbox, relief), 0, 0, 0},
{TK_OPTION_BORDER, "-selectbackground", "selectBackground", "Foreground",
DEF_LISTBOX_SELECT_COLOR, -1, Tk_Offset(Listbox, selBorder),
0, (ClientData) DEF_LISTBOX_SELECT_MONO, 0},
{TK_OPTION_PIXELS, "-selectborderwidth", "selectBorderWidth",
"BorderWidth", DEF_LISTBOX_SELECT_BD, -1,
Tk_Offset(Listbox, selBorderWidth), 0, 0, 0},
{TK_OPTION_COLOR, "-selectforeground", "selectForeground", "Background",
DEF_LISTBOX_SELECT_FG_COLOR, -1, Tk_Offset(Listbox, selFgColorPtr),
0, (ClientData) DEF_LISTBOX_SELECT_FG_MONO, 0},
{TK_OPTION_STRING, "-selectmode", "selectMode", "SelectMode",
DEF_LISTBOX_SELECT_MODE, -1, Tk_Offset(Listbox, selectMode),
TK_OPTION_NULL_OK, 0, 0},
{TK_OPTION_BOOLEAN, "-setgrid", "setGrid", "SetGrid",
DEF_LISTBOX_SET_GRID, -1, Tk_Offset(Listbox, setGrid), 0, 0, 0},
{TK_OPTION_STRING, "-takefocus", "takeFocus", "TakeFocus",
DEF_LISTBOX_TAKE_FOCUS, -1, Tk_Offset(Listbox, takeFocus),
TK_OPTION_NULL_OK, 0, 0},
{TK_OPTION_INT, "-width", "width", "Width",
DEF_LISTBOX_WIDTH, -1, Tk_Offset(Listbox, width), 0, 0, 0},
{TK_OPTION_STRING, "-xscrollcommand", "xScrollCommand", "ScrollCommand",
DEF_LISTBOX_SCROLL_COMMAND, -1, Tk_Offset(Listbox, xScrollCmd),
TK_OPTION_NULL_OK, 0, 0},
{TK_OPTION_STRING, "-yscrollcommand", "yScrollCommand", "ScrollCommand",
DEF_LISTBOX_SCROLL_COMMAND, -1, Tk_Offset(Listbox, yScrollCmd),
TK_OPTION_NULL_OK, 0, 0},
{TK_OPTION_STRING, "-listvariable", "listVariable", "Variable",
DEF_LISTBOX_LIST_VARIABLE, -1, Tk_Offset(Listbox, listVarName),
TK_OPTION_NULL_OK, 0, 0},
{TK_OPTION_END, (char *) NULL, (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, 0, 0}
};
/*
* The itemAttrOptionSpecs table defines the valid configuration options for
* listbox items
*/
static Tk_OptionSpec itemAttrOptionSpecs[] = {
{TK_OPTION_BORDER, "-background", "background", "Background",
(char *)NULL, -1, Tk_Offset(ItemAttr, border),
TK_OPTION_NULL_OK|TK_OPTION_DONT_SET_DEFAULT,
(ClientData) DEF_LISTBOX_BG_MONO, 0},
{TK_OPTION_SYNONYM, "-bg", (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-background", 0},
{TK_OPTION_SYNONYM, "-fg", "foreground", (char *) NULL,
(char *) NULL, 0, -1, 0, (ClientData) "-foreground", 0},
{TK_OPTION_COLOR, "-foreground", "foreground", "Foreground",
(char *) NULL, -1, Tk_Offset(ItemAttr, fgColor),
TK_OPTION_NULL_OK|TK_OPTION_DONT_SET_DEFAULT, 0, 0},
{TK_OPTION_BORDER, "-selectbackground", "selectBackground", "Foreground",
(char *) NULL, -1, Tk_Offset(ItemAttr, selBorder),
TK_OPTION_NULL_OK|TK_OPTION_DONT_SET_DEFAULT,
(ClientData) DEF_LISTBOX_SELECT_MONO, 0},
{TK_OPTION_COLOR, "-selectforeground", "selectForeground", "Background",
(char *) NULL, -1, Tk_Offset(ItemAttr, selFgColor),
TK_OPTION_NULL_OK|TK_OPTION_DONT_SET_DEFAULT,
(ClientData) DEF_LISTBOX_SELECT_FG_MONO, 0},
{TK_OPTION_END, (char *) NULL, (char *) NULL, (char *) NULL,
(char *) NULL, 0, -1, 0, 0, 0}
};
/*
* The following tables define the listbox widget commands (and sub-
* commands) and map the indexes into the string tables into
* enumerated types used to dispatch the listbox widget command.
*/
static char *commandNames[] = {
"activate", "bbox", "cget", "configure", "curselection", "delete", "get",
"index", "insert", "itemcget", "itemconfigure", "nearest", "scan",
"see", "selection", "size", "xview", "yview",
(char *) NULL
};
enum command {
COMMAND_ACTIVATE, COMMAND_BBOX, COMMAND_CGET, COMMAND_CONFIGURE,
COMMAND_CURSELECTION, COMMAND_DELETE, COMMAND_GET, COMMAND_INDEX,
COMMAND_INSERT, COMMAND_ITEMCGET, COMMAND_ITEMCONFIGURE,
COMMAND_NEAREST, COMMAND_SCAN, COMMAND_SEE, COMMAND_SELECTION,
COMMAND_SIZE, COMMAND_XVIEW, COMMAND_YVIEW
};
static char *selCommandNames[] = {
"anchor", "clear", "includes", "set", (char *) NULL
};
enum selcommand {
SELECTION_ANCHOR, SELECTION_CLEAR, SELECTION_INCLUDES, SELECTION_SET
};
static char *scanCommandNames[] = {
"mark", "dragto", (char *) NULL
};
enum scancommand {
SCAN_MARK, SCAN_DRAGTO
};
static char *indexNames[] = {
"active", "anchor", "end", (char *)NULL
};
enum indices {
INDEX_ACTIVE, INDEX_ANCHOR, INDEX_END
};
/* Declarations for procedures defined later in this file */
static void ChangeListboxOffset _ANSI_ARGS_((Listbox *listPtr,
int offset));
static void ChangeListboxView _ANSI_ARGS_((Listbox *listPtr,
int index));
static int ConfigureListbox _ANSI_ARGS_((Tcl_Interp *interp,
Listbox *listPtr, int objc, Tcl_Obj *CONST objv[],
int flags));
static int ConfigureListboxItem _ANSI_ARGS_ ((Tcl_Interp *interp,
Listbox *listPtr, ItemAttr *attrs, int objc,
Tcl_Obj *CONST objv[]));
static int ListboxDeleteSubCmd _ANSI_ARGS_((Listbox *listPtr,
int first, int last));
static void DestroyListbox _ANSI_ARGS_((char *memPtr));
static void DestroyListboxOptionTables _ANSI_ARGS_ (
(ClientData clientData, Tcl_Interp *interp));
static void DisplayListbox _ANSI_ARGS_((ClientData clientData));
static int GetListboxIndex _ANSI_ARGS_((Tcl_Interp *interp,
Listbox *listPtr, Tcl_Obj *index, int endIsSize,
int *indexPtr));
static int ListboxInsertSubCmd _ANSI_ARGS_((Listbox *listPtr,
int index, int objc, Tcl_Obj *CONST objv[]));
static void ListboxCmdDeletedProc _ANSI_ARGS_((
ClientData clientData));
static void ListboxComputeGeometry _ANSI_ARGS_((Listbox *listPtr,
int fontChanged, int maxIsStale, int updateGrid));
static void ListboxEventProc _ANSI_ARGS_((ClientData clientData,
XEvent *eventPtr));
static int ListboxFetchSelection _ANSI_ARGS_((
ClientData clientData, int offset, char *buffer,
int maxBytes));
static void ListboxLostSelection _ANSI_ARGS_((
ClientData clientData));
static void EventuallyRedrawRange _ANSI_ARGS_((Listbox *listPtr,
int first, int last));
static void ListboxScanTo _ANSI_ARGS_((Listbox *listPtr,
int x, int y));
static int ListboxSelect _ANSI_ARGS_((Listbox *listPtr,
int first, int last, int select));
static void ListboxUpdateHScrollbar _ANSI_ARGS_(
(Listbox *listPtr));
static void ListboxUpdateVScrollbar _ANSI_ARGS_(
(Listbox *listPtr));
static int ListboxWidgetObjCmd _ANSI_ARGS_((ClientData clientData,
Tcl_Interp *interp, int objc,
Tcl_Obj *CONST objv[]));
static int ListboxBboxSubCmd _ANSI_ARGS_ ((Tcl_Interp *interp,
Listbox *listPtr, int index));
static int ListboxSelectionSubCmd _ANSI_ARGS_ (
(Tcl_Interp *interp, Listbox *listPtr, int objc,
Tcl_Obj *CONST objv[]));
static int ListboxXviewSubCmd _ANSI_ARGS_ ((Tcl_Interp *interp,
Listbox *listPtr, int objc,
Tcl_Obj *CONST objv[]));
static int ListboxYviewSubCmd _ANSI_ARGS_ ((Tcl_Interp *interp,
Listbox *listPtr, int objc,
Tcl_Obj *CONST objv[]));
static ItemAttr * ListboxGetItemAttributes _ANSI_ARGS_ (
(Tcl_Interp *interp, Listbox *listPtr, int index));
static void ListboxWorldChanged _ANSI_ARGS_((
ClientData instanceData));
static int NearestListboxElement _ANSI_ARGS_((Listbox *listPtr,
int y));
static char * ListboxListVarProc _ANSI_ARGS_ ((ClientData clientData,
Tcl_Interp *interp, char *name1, char *name2,
int flags));
static void MigrateHashEntries _ANSI_ARGS_ ((Tcl_HashTable *table,
int first, int last, int offset));
/*
* The structure below defines button class behavior by means of procedures
* that can be invoked from generic window code.
*/
static TkClassProcs listboxClass = {
NULL, /* createProc. */
ListboxWorldChanged, /* geometryProc. */
NULL /* modalProc. */
};
/*
*--------------------------------------------------------------
*
* Tk_ListboxObjCmd --
*
* This procedure is invoked to process the "listbox" Tcl
* command. See the user documentation for details on what
* it does.
*
* Results:
* A standard Tcl result.
*
* Side effects:
* See the user documentation.
*
*--------------------------------------------------------------
*/
int
Tk_ListboxObjCmd(clientData, interp, objc, objv)
ClientData clientData; /* Either NULL or pointer to option table */
Tcl_Interp *interp; /* Current interpreter. */
int objc; /* Number of arguments. */
Tcl_Obj *CONST objv[]; /* Argument objects. */
{
register Listbox *listPtr;
Tk_Window tkwin;
ListboxOptionTables *optionTables;
optionTables = (ListboxOptionTables *)clientData;
if (optionTables == NULL) {
Tcl_CmdInfo info;
char *name;
/*
* We haven't created the option tables for this widget class yet.
* Do it now and save the a pointer to them as the ClientData for
* the command, so future invocations will have access to it.
*/
optionTables =
(ListboxOptionTables *) ckalloc(sizeof(ListboxOptionTables));
/* Set up an exit handler to free the optionTables struct */
Tcl_SetAssocData(interp, "ListboxOptionTables",
DestroyListboxOptionTables, (ClientData) optionTables);
/* Create the listbox option table and the listbox item option table */
optionTables->listboxOptionTable =
Tk_CreateOptionTable(interp, optionSpecs);
optionTables->itemAttrOptionTable =
Tk_CreateOptionTable(interp, itemAttrOptionSpecs);
/* Store a pointer to the tables as the ClientData for the command */
name = Tcl_GetString(objv[0]);
Tcl_GetCommandInfo(interp, name, &info);
info.objClientData = (ClientData) optionTables;
Tcl_SetCommandInfo(interp, name, &info);
}
if (objc < 2) {
Tcl_WrongNumArgs(interp, 1, objv, "pathName ?options?");
return TCL_ERROR;
}
tkwin = Tk_CreateWindowFromPath(interp, Tk_MainWindow(interp),
Tcl_GetString(objv[1]), (char *) NULL);
if (tkwin == NULL) {
return TCL_ERROR;
}
/*
* Initialize the fields of the structure that won't be initialized
* by ConfigureListbox, or that ConfigureListbox requires to be
* initialized already (e.g. resource pointers).
*/
listPtr = (Listbox *) ckalloc(sizeof(Listbox));
listPtr->tkwin = tkwin;
listPtr->display = Tk_Display(tkwin);
listPtr->interp = interp;
listPtr->widgetCmd = Tcl_CreateObjCommand(interp,
Tk_PathName(listPtr->tkwin), ListboxWidgetObjCmd,
(ClientData) listPtr, ListboxCmdDeletedProc);
listPtr->optionTable = optionTables->listboxOptionTable;
listPtr->itemAttrOptionTable = optionTables->itemAttrOptionTable;
listPtr->listVarName = NULL;
listPtr->listObj = NULL;
listPtr->selection =
(Tcl_HashTable *) ckalloc(sizeof(Tcl_HashTable));
Tcl_InitHashTable(listPtr->selection, TCL_ONE_WORD_KEYS);
listPtr->itemAttrTable =
(Tcl_HashTable *) ckalloc(sizeof(Tcl_HashTable));
Tcl_InitHashTable(listPtr->itemAttrTable, TCL_ONE_WORD_KEYS);
listPtr->nElements = 0;
listPtr->normalBorder = NULL;
listPtr->borderWidth = 0;
listPtr->relief = TK_RELIEF_RAISED;
listPtr->highlightWidth = 0;
listPtr->highlightBgColorPtr = NULL;
listPtr->highlightColorPtr = NULL;
listPtr->inset = 0;
listPtr->tkfont = NULL;
listPtr->fgColorPtr = NULL;
listPtr->textGC = None;
listPtr->selBorder = NULL;
listPtr->selBorderWidth = 0;
listPtr->selFgColorPtr = None;
listPtr->selTextGC = None;
listPtr->width = 0;
listPtr->height = 0;
listPtr->lineHeight = 0;
listPtr->topIndex = 0;
listPtr->fullLines = 1;
listPtr->partialLine = 0;
listPtr->setGrid = 0;
listPtr->maxWidth = 0;
listPtr->xScrollUnit = 1;
listPtr->xOffset = 0;
listPtr->selectMode = NULL;
listPtr->numSelected = 0;
listPtr->selectAnchor = 0;
listPtr->exportSelection = 1;
listPtr->active = 0;
listPtr->scanMarkX = 0;
listPtr->scanMarkY = 0;
listPtr->scanMarkXOffset = 0;
listPtr->scanMarkYIndex = 0;
listPtr->cursor = None;
listPtr->takeFocus = NULL;
listPtr->xScrollCmd = NULL;
listPtr->yScrollCmd = NULL;
listPtr->flags = 0;
Tk_SetClass(listPtr->tkwin, "Listbox");
TkSetClassProcs(listPtr->tkwin, &listboxClass, (ClientData) listPtr);
Tk_CreateEventHandler(listPtr->tkwin,
ExposureMask|StructureNotifyMask|FocusChangeMask,
ListboxEventProc, (ClientData) listPtr);
Tk_CreateSelHandler(listPtr->tkwin, XA_PRIMARY, XA_STRING,
ListboxFetchSelection, (ClientData) listPtr, XA_STRING);
if (Tk_InitOptions(interp, (char *)listPtr,
optionTables->listboxOptionTable, tkwin) != TCL_OK) {
Tk_DestroyWindow(listPtr->tkwin);
return TCL_ERROR;
}
if (ConfigureListbox(interp, listPtr, objc-2, objv+2, 0) != TCL_OK) {
Tk_DestroyWindow(listPtr->tkwin);
return TCL_ERROR;
}
Tcl_SetResult(interp, Tk_PathName(listPtr->tkwin), TCL_STATIC);
return TCL_OK;
}
/*
*----------------------------------------------------------------------
*
* ListboxWidgetObjCmd --
*
* This Tcl_Obj based procedure is invoked to process the Tcl command
* that corresponds to a widget managed by this module. See the user
* documentation for details on what it does.
*
* Results:
* A standard Tcl result.
*
* Side effects:
* See the user documentation.
*
*----------------------------------------------------------------------
*/
static int
ListboxWidgetObjCmd(clientData, interp, objc, objv)
ClientData clientData; /* Information about listbox widget. */
Tcl_Interp *interp; /* Current interpreter. */
int objc; /* Number of arguments. */
Tcl_Obj *CONST objv[]; /* Arguments as Tcl_Obj's. */
{
register Listbox *listPtr = (Listbox *) clientData;
int cmdIndex, index;
int result = TCL_OK;
if (objc < 2) {
Tcl_WrongNumArgs(interp, 1, objv, "option ?arg arg ...?");
return TCL_ERROR;
}
Tcl_Preserve((ClientData)listPtr);
/*
* Parse the command by looking up the second argument in the list
* of valid subcommand names
*/
result = Tcl_GetIndexFromObj(interp, objv[1], commandNames,
"option", 0, &cmdIndex);
if (result != TCL_OK) {
Tcl_Release((ClientData)listPtr);
return result;
}
/* The subcommand was valid, so continue processing */
switch (cmdIndex) {
case COMMAND_ACTIVATE: {
if (objc != 3) {
Tcl_WrongNumArgs(interp, 2, objv, "index");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &index);
if (result != TCL_OK) {
break;
}
if (index >= listPtr->nElements) {
index = listPtr->nElements-1;
}
if (index < 0) {
index = 0;
}
listPtr->active = index;
EventuallyRedrawRange(listPtr, listPtr->active, listPtr->active);
result = TCL_OK;
break;
}
case COMMAND_BBOX: {
if (objc != 3) {
Tcl_WrongNumArgs(interp, 2, objv, "index");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &index);
if (result != TCL_OK) {
break;
}
result = ListboxBboxSubCmd(interp, listPtr, index);
break;
}
case COMMAND_CGET: {
Tcl_Obj *objPtr;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 2, objv, "option");
result = TCL_ERROR;
break;
}
objPtr = Tk_GetOptionValue(interp, (char *)listPtr,
listPtr->optionTable, objv[2], listPtr->tkwin);
if (objPtr == NULL) {
result = TCL_ERROR;
break;
}
Tcl_SetObjResult(interp, objPtr);
result = TCL_OK;
break;
}
case COMMAND_CONFIGURE: {
Tcl_Obj *objPtr;
if (objc <= 3) {
objPtr = Tk_GetOptionInfo(interp, (char *) listPtr,
listPtr->optionTable,
(objc == 3) ? objv[2] : (Tcl_Obj *) NULL,
listPtr->tkwin);
if (objPtr == NULL) {
result = TCL_ERROR;
break;
} else {
Tcl_SetObjResult(interp, objPtr);
result = TCL_OK;
}
} else {
result = ConfigureListbox(interp, listPtr, objc-2, objv+2, 0);
}
break;
}
case COMMAND_CURSELECTION: {
char indexStringRep[TCL_INTEGER_SPACE];
int i;
if (objc != 2) {
Tcl_WrongNumArgs(interp, 2, objv, NULL);
result = TCL_ERROR;
break;
}
/*
* Of course, it would be more efficient to use the Tcl_HashTable
* search functions (Tcl_FirstHashEntry, Tcl_NextHashEntry), but
* then the result wouldn't be in sorted order. So instead we
* loop through the indices in order, adding them to the result
* if they are selected
*/
for (i = 0; i < listPtr->nElements; i++) {
if (Tcl_FindHashEntry(listPtr->selection, (char *)i) != NULL) {
sprintf(indexStringRep, "%d", i);
Tcl_AppendElement(interp, indexStringRep);
}
}
result = TCL_OK;
break;
}
case COMMAND_DELETE: {
int first, last;
if ((objc < 3) || (objc > 4)) {
Tcl_WrongNumArgs(interp, 2, objv,
"firstIndex ?lastIndex?");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &first);
if (result != TCL_OK) {
break;
}
if (first < listPtr->nElements) {
/*
* if a "last index" was given, get it now; otherwise, use the
* first index as the last index
*/
if (objc == 4) {
result = GetListboxIndex(interp, listPtr,
objv[3], 0, &last);
if (result != TCL_OK) {
break;
}
} else {
last = first;
}
if (last >= listPtr->nElements) {
last = listPtr->nElements - 1;
}
result = ListboxDeleteSubCmd(listPtr, first, last);
} else {
result = TCL_OK;
}
break;
}
case COMMAND_GET: {
int first, last;
Tcl_Obj **elemPtrs;
int listLen;
if (objc != 3 && objc != 4) {
Tcl_WrongNumArgs(interp, 2, objv, "firstIndex ?lastIndex?");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &first);
if (result != TCL_OK) {
break;
}
last = first;
if (objc == 4) {
result = GetListboxIndex(interp, listPtr, objv[3], 0, &last);
if (result != TCL_OK) {
break;
}
}
if (first >= listPtr->nElements) {
result = TCL_OK;
break;
}
if (last >= listPtr->nElements) {
last = listPtr->nElements - 1;
}
if (first < 0) {
first = 0;
}
if (first > last) {
result = TCL_OK;
break;
}
result = Tcl_ListObjGetElements(interp, listPtr->listObj, &listLen,
&elemPtrs);
if (result != TCL_OK) {
break;
}
if (objc == 3) {
/*
* One element request - we return a string
*/
Tcl_SetObjResult(interp, elemPtrs[first]);
} else {
Tcl_SetListObj(Tcl_GetObjResult(interp), (last - first + 1),
&(elemPtrs[first]));
}
result = TCL_OK;
break;
}
case COMMAND_INDEX:{
char buf[TCL_INTEGER_SPACE];
if (objc != 3) {
Tcl_WrongNumArgs(interp, 2, objv, "index");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 1, &index);
if (result != TCL_OK) {
break;
}
sprintf(buf, "%d", index);
Tcl_SetResult(interp, buf, TCL_VOLATILE);
result = TCL_OK;
break;
}
case COMMAND_INSERT: {
if (objc < 3) {
Tcl_WrongNumArgs(interp, 2, objv,
"index ?element element ...?");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 1, &index);
if (result != TCL_OK) {
break;
}
result = ListboxInsertSubCmd(listPtr, index, objc-3, objv+3);
break;
}
case COMMAND_ITEMCGET: {
Tcl_Obj *objPtr;
ItemAttr *attrPtr;
if (objc != 4) {
Tcl_WrongNumArgs(interp, 2, objv, "index option");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &index);
if (result != TCL_OK) {
break;
}
if (index < 0 || index >= listPtr->nElements) {
Tcl_AppendResult(interp, "item number \"",
Tcl_GetString(objv[2]), "\" out of range",
(char *)NULL);
result = TCL_ERROR;
break;
}
attrPtr = ListboxGetItemAttributes(interp, listPtr, index);
objPtr = Tk_GetOptionValue(interp, (char *)attrPtr,
listPtr->itemAttrOptionTable, objv[3], listPtr->tkwin);
if (objPtr == NULL) {
result = TCL_ERROR;
break;
}
Tcl_SetObjResult(interp, objPtr);
result = TCL_OK;
break;
}
case COMMAND_ITEMCONFIGURE: {
Tcl_Obj *objPtr;
ItemAttr *attrPtr;
if (objc < 3) {
Tcl_WrongNumArgs(interp, 2, objv,
"index ?option? ?value? ?option value ...?");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &index);
if (result != TCL_OK) {
break;
}
if (index < 0 || index >= listPtr->nElements) {
Tcl_AppendResult(interp, "item number \"",
Tcl_GetString(objv[2]), "\" out of range",
(char *)NULL);
result = TCL_ERROR;
break;
}
attrPtr = ListboxGetItemAttributes(interp, listPtr, index);
if (objc <= 4) {
objPtr = Tk_GetOptionInfo(interp, (char *)attrPtr,
listPtr->itemAttrOptionTable,
(objc == 4) ? objv[3] : (Tcl_Obj *) NULL,
listPtr->tkwin);
if (objPtr == NULL) {
result = TCL_ERROR;
break;
} else {
Tcl_SetObjResult(interp, objPtr);
result = TCL_OK;
}
} else {
result = ConfigureListboxItem(interp, listPtr, attrPtr,
objc-3, objv+3);
}
break;
}
case COMMAND_NEAREST: {
char buf[TCL_INTEGER_SPACE];
int y;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 2, objv, "y");
result = TCL_ERROR;
break;
}
result = Tcl_GetIntFromObj(interp, objv[2], &y);
if (result != TCL_OK) {
break;
}
index = NearestListboxElement(listPtr, y);
sprintf(buf, "%d", index);
Tcl_SetResult(interp, buf, TCL_VOLATILE);
result = TCL_OK;
break;
}
case COMMAND_SCAN: {
int x, y, scanCmdIndex;
if (objc != 5) {
Tcl_WrongNumArgs(interp, 2, objv, "mark|dragto x y");
result = TCL_ERROR;
break;
}
if (Tcl_GetIntFromObj(interp, objv[3], &x) != TCL_OK
|| Tcl_GetIntFromObj(interp, objv[4], &y) != TCL_OK) {
result = TCL_ERROR;
break;
}
result = Tcl_GetIndexFromObj(interp, objv[2], scanCommandNames,
"option", 0, &scanCmdIndex);
if (result != TCL_OK) {
break;
}
switch (scanCmdIndex) {
case SCAN_MARK: {
listPtr->scanMarkX = x;
listPtr->scanMarkY = y;
listPtr->scanMarkXOffset = listPtr->xOffset;
listPtr->scanMarkYIndex = listPtr->topIndex;
break;
}
case SCAN_DRAGTO: {
ListboxScanTo(listPtr, x, y);
break;
}
}
result = TCL_OK;
break;
}
case COMMAND_SEE: {
int diff;
if (objc != 3) {
Tcl_WrongNumArgs(interp, 2, objv, "index");
result = TCL_ERROR;
break;
}
result = GetListboxIndex(interp, listPtr, objv[2], 0, &index);
if (result != TCL_OK) {
break;
}
if (index >= listPtr->nElements) {
index = listPtr->nElements - 1;
}
if (index < 0) {
index = 0;
}
diff = listPtr->topIndex - index;
if (diff > 0) {
if (diff <= (listPtr->fullLines/3)) {
ChangeListboxView(listPtr, index);