1tixListNoteBook(n)           Tix Built-In Commands          tixListNoteBook(n)
2
3
4

NAME

6       tixListNoteBook - Create and manipulate tixListNoteBook widgets
7

SYNOPSIS

9       tixListNoteBook pathName ?options?
10

STANDARD OPTIONS

12       The  ListNoteBook  widget  supports all the standard options of a frame
13       widget.  See the options(n) manual entry for details  on  the  standard
14       options.
15

WIDGET-SPECIFIC OPTIONS

17       [-dynamicgeometry dynamicGeometry]  If  set  to  false, the size of the
18       ListNotebook will match the size of the largest page. If set  to  true,
19       the  size  of  the ListNotebook will match the size of the current page
20       (therefore, the size may change when the user selects different pages).
21       The  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

SUBWIDGETS

27       Name:          hlist
28       Class:         TixHList
29
30              The HList widget that displays the names of the pages.
31
32       In addition, all the page subwidgets created as a  result  of  the  add
33       command  can  be accessed by the subwidget command. They are identified
34       by the pageName parameter to the add command.
35

DESCRIPTION

37       The tixListNoteBook command creates a new window (given by the pathName
38       argument) and makes it into a ListNoteBook widget.  Additional options,
39       described above, may be specified on the command line or in the  option
40       database  to  configure  aspects of the ListNoteBook widget such as its
41       cursor and relief.
42
43       The ListNoteBook widget is very similar to the TixNoteBook  widget:  it
44       can  be  used to display many windows in a limited space using a "note‐
45       book" metaphore. The notebook is divided into a stack  of  pages  (win‐
46       dows).  At  one time only one of these pages can be shown. The user can
47       navigate through these pages by choosing the name of the  desired  page
48       in the hlist subwidget.
49

WIDGET COMMANDS

51       The tixListNoteBook command creates a new Tcl command whose name is the
52       same as the path name of the ListNoteBook widget's window.   This  com‐
53       mand may be used to invoke various operations on the widget. It has the
54       following general form:
55              pathName option ?arg arg ...?
56       PathName is the name of the command, which is the same as the ListNote‐
57       Book widget's path name. Option and the args determine the exact behav‐
58       ior of the command. The following commands are possible  for  ListNote‐
59       Book widgets:
60
61       pathName add pageName ?option value ...?
62              Adds  a  new  ListNotebook  page subwidget into the ListNoteBook
63              widget.  pageName must be the name of an existing entry  of  the
64              hlist  subwidget.  You  must create the entry before calling the
65              add command. Please refer to the tixHList(n)  manual  entry  for
66              adding entries in an HList widget.  Additional parameters may be
67              supplied to configure this page subwidget. Possible options are:
68
69              -createcmd
70                     Specifies a TCL command to be called  the  first  time  a
71                     page  is  shown on the screen. This option can be used to
72                     delay the creation of the contents of a page until neces‐
73                     sary.  Therefore,  it  can  be used to speed up interface
74                     creation process especially when there are a large number
75                     of pages in a ListNoteBook widget.
76
77              -raisecmd
78                     Specifies  a  TCL command to be called whenever this page
79                     is raised by the user.
80       When successful, this command returns the pathname of the newly created
81       page.
82
83       pathName cget option
84              Returns  the  current value of the configuration option given by
85              option.Option may  have  any  of  the  values  accepted  by  the
86              tixListNoteBook command.
87
88       pathName configure ?option? ?value option value ...?
89              Query  or modify the configuration options of the widget.  If no
90              option is specified, returns a list describing all of the avail‐
91              able  options for pathName (see Tk_ConfigureInfo for information
92              on the format of this list). If  option  is  specified  with  no
93              value,  then the command returns a list describing the one named
94              option (this list will be identical to the corresponding sublist
95              of  the  value  returned  if no option is specified).  If one or
96              more option-value pairs are specified, then the command modifies
97              the  given  widget option(s) to have the given value(s); in this
98              case the command returns an empty string.  Option may  have  any
99              of the values accepted by the tixListNoteBook command.
100
101       pathName delete pageName?
102              Deletes the page identified by pageName.
103
104       pathName pagecget pageName option
105              Returns  the  current value of the configuration option given by
106              option in the page given by pageName. Option may have any of the
107              values accepted by the add widget command.
108
109       pathName pageconfigure pageName ?option? ?value ...?
110              When no option is given, prints out the values of all options of
111              this page. If option is specified with no value, then  the  com‐
112              mand  returns  the  current value of that option. If one or more
113              option-value pairs are specified, then the command modifies  the
114              given  page's option(s) to have the given value(s); in this case
115              the command returns an  empty  string.  Option  may  be  any  of
116              options accepted by the add widget command.
117
118       pathName pages
119              Returns a list of the names of all the pages.
120
121       pathName raise pageName
122              Raise the page identified by pageName.
123
124       pathName raised
125              Returns the name of the currently raised page.
126
127       pathName subwidget  name ?args?
128              When  no options are given, this command returns the pathname of
129              the subwidget of the specified name.
130
131              When options are given, the widget command of the specified sub‐
132              widget will be called with these options.
133

EXAMPLE

135       set  n [tixListNoteBook .n]; pack $n $n subwidget hlist add page1 -text
136       "Page 1" $n subwidget hlist add page2 -text "Page 2"
137
138       set page1 [$n add page1] set page2 [$n add page2]
139
140       button $page1.b -text "On page1" button $page2.b -text "On page2"
141
142       pack $page1.b pack $page2.b
143
144       $n raise page2
145

BINDINGS

147       When the user activates an entry in the hlist subwidget, the page asso‐
148       ciated  with  that entry will be raised to the front.  This can be done
149       by using the mouse or keyboard. The hlist subwidget operates  with  its
150       -selectmode  option  set to single. See the event bindings of the HList
151       widget for more details.
152

KEYWORDS

154       Tix(n), tixHList(n)
155
156
157
158
159
160
161Tix                                   4.0                   tixListNoteBook(n)
Impressum