1tixNoteBook(n) Tix Built-In Commands tixNoteBook(n)
2
6 tixNoteBook - Create and manipulate tixNoteBook widgets
7
9 tixNoteBook pathName ?options?
10
12 The NoteBook widget supports all the standard options of a frame wid‐
13 get. See the options(n) manual entry for details on the standard
14 options.
15
17 [-dynamicgeometry dynamicGeometry] If set to false, the size of the
18 Notebook will match the size of the largest page. If set to true, the
19 size of the Notebook will match the size of the current page (there‐
20 fore, the size may change when the user selects different pages). The
21 default value is false. A setting of true is discouraged.
22 [-ipadx ipadX] The amount of internal horizontal paddings around the
23 sides of the page subwidgets. [-ipady ipadY] The amount of internal
24 vertical paddings around the sides of the page subwidgets.
25
27 Name: nbframe
28 Class: tixNoteBookFrame
29 The "note book frame" widget that displays ths tabs of the note‐
31 book. Most of the display options of the page tabs are con‐
32 trolled by this subwidget. For example, if you need to choose a
33 different font to display the tab names of the pages, the color
34 of the inactive tabs or the color behind the tabs, you can con‐
35 figure the options of the nbframe subwidget. See the manual
36 page of tixNoteBookFrame(n) for more details.
37 In addition, all the page subwidgets created as a result of the add
39 command can be accessed by the subwidget command. They are identified
40 by the pageName parameter to the add command.
41
43 The tixNoteBook command creates a new window (given by the pathName
44 argument) and makes it into a NoteBook widget. Additional options,
45 described above, may be specified on the command line or in the option
46 database to configure aspects of the NoteBook widget such as its cursor
47 and relief.
48 The NoteBook widget can be used to display many windows in a limited
50 space using a "notebook" metaphore. The notebook is divided into a
51 stack of pages (windows). At one time only one of these pages can be
52 shown. The user can navigate through these pages by choosing the visual
53 "tabs" at the top of the NoteBook widget.
54
56 The tixNoteBook command creates a new Tcl command whose name is the
57 same as the path name of the NoteBook widget's window. This command
58 may be used to invoke various operations on the widget. It has the fol‐
59 lowing general form:
60 pathName option ?arg arg ...?
61 PathName is the name of the command, which is the same as the NoteBook
62 widget's path name. Option and the args determine the exact behavior of
63 the command. The following commands are possible for NoteBook widgets:
64 pathName add pageName ?option value ...?
66 Adds a new notebook page subwidget into the NoteBook widget.
67 Additional parameters may be supplied to configure this page
68 subwidget. Possible options are:
69 -anchor
71 Specifies how the information in a tab (e.g. text or a
72 bitmap) is to be displayed in the widget. Must be one of
73 the values n, ne, e, se, s, sw, w, nw, or center. For
74 example, nw means display the information such that its
75 top-left corner is at the top-left corner of the widget.
76 -bitmap
78 Specifies a bitmap to display on the tab of this page.
79 The bitmap is displayed only if none of the -label or
80 -image options are specified.
81 -createcmd
83 Specifies a TCL command to be called the first time a
84 page is shown on the screen. This option can be used to
85 delay the creation of the contents of a page until neces‐
86 sary. Therefore, it can be used to speed up interface
87 creation process especially when there are a large number
88 of pages in a NoteBook widget.
89 -image Specifies an image to display on the tab of this page.
91 The image is displayed only if the -label options is not
92 specified.
93 -justify
95 When there are multiple lines of text displayed in a tab,
96 this option determines how the lines line up with each
97 other. Must be one of left, center, or right. Left means
98 that the lines' left edges all line up, center means that
99 the lines' centers are aligned, and right means that the
100 lines' right edges line up.
101 -label Specifies a text label string to display on the tab of
103 this page subwidget.
104 -raisecmd
106 Specifies a TCL command to be called whenever this page
107 is raised by the user.
108 -state Specifies whether this page can be raised by the user.
110 Must be either normal or disabled.
111 -underline
113 Specifies the integer index of a character to underline
114 in the tab. This option is used by the default bindings
115 to implement keyboard traversal for menu buttons and menu
116 entries. 0 corresponds to the first character of the
117 text displayed in the widget, 1 to the next character,
118 and so on.
119 -wraplength
121 This option specifies the maximum line length of the
122 label string on this tab. If the line length of the label
123 string exceeds this length, it is wrapped onto the next
124 line, so that no line is longer than the specified
125 length. The value may be specified in any of the standard
126 forms for screen distances. If this value is less than or
127 equal to 0 then no wrapping is done: lines will break
128 only at newline characters in the text.
129 pathName cget option
131 Returns the current value of the configuration option given by
132 option.Option may have any of the values accepted by the
133 tixNoteBook command.
134 pathName configure ?option? ?value option value ...?
136 Query or modify the configuration options of the widget. If no
137 option is specified, returns a list describing all of the avail‐
138 able options for pathName (see Tk_ConfigureInfo for information
139 on the format of this list). If option is specified with no
140 value, then the command returns a list describing the one named
141 option (this list will be identical to the corresponding sublist
142 of the value returned if no option is specified). If one or
143 more option-value pairs are specified, then the command modifies
144 the given widget option(s) to have the given value(s); in this
145 case the command returns an empty string. Option may have any
146 of the values accepted by the tixNoteBook command.
147 pathName delete pageName?
149 Deletes the page identified by pageName.
150 pathName pagecget pageName option
152 Returns the current value of the configuration option given by
153 option in the page given by pageName. Option may have any of the
154 values accepted by the add widget command.
155 pathName pageconfigure pageName ?option? ?value ...?
157 When no option is given, prints out the values of all options of
158 this page. If option is specified with no value, then the com‐
159 mand returns the current value of that option. If one or more
160 option-value pairs are specified, then the command modifies the
161 given page's option(s) to have the given value(s); in this case
162 the command returns an empty string. Option may be any of
163 options accepted by the add widget command.
164 pathName pages
166 Returns a list of the names of all the pages.
167 pathName raise pageName
169 Raise the page identified by pageName.
170 pathName raised
172 Returns the name of the currently raised page.
173 pathName subwidget name ?args?
175 When no options are given, this command returns the pathname of
176 the subwidget of the specified name.
177 When options are given, the widget command of the specified sub‐
179 widget will be called with these options.
180
182 [1] When the user pressed the left mouse button over a notebook tab,
183 the notebook page associated with that tab will be raised to the
184 top of the stack of pages.
185 [2] The pages can also be selected using the keyboard. The user can
187 type the <Tab> key to cycle among the set of pages. When the
188 focus appears on the desired page, the user can type <Return> or
189 <space> to select that page. Or, if the user wants to cancel the
190 selection, he/she can type the <Escape> key.
191
193 Tix(n)
194Tix 4.0 tixNoteBook(n)