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
|
.. _the-view-and-its-building-blocks:
================================
The View and Its Building Blocks
================================
A simple way to edit (or simply observe) the attribute values of a
:term:`HasTraits` object in a GUI window is to call the object's
configure_traits() [3]_ method. This method constructs and displays a window
containing editable fields for each of the object's :term:`trait attribute`\ s.
For example, the following sample code [4]_ defines the SimpleEmployee class,
creates an object of that class, and constructs and displays a GUI for the
object:
.. index::
pair: examples; configure_traits()
.. _example-1-using-configure-traits:
.. rubric:: Example 1: Using configure_traits()
::
# configure_traits.py -- Sample code to demonstrate
# configure_traits()
from traits.api import HasTraits, Str, Int
import traitsui
class SimpleEmployee(HasTraits):
first_name = Str
last_name = Str
department = Str
employee_number = Str
salary = Int
sam = SimpleEmployee()
sam.configure_traits()
Unfortunately, the resulting form simply displays the attributes of the object
**sam** in alphabetical order with little formatting, which is seldom what is
wanted:
.. figure:: images/ui_for_ex1.jpg
:alt: Dialog box showing all attributes of SimpleEmployee in alphabetical order
Figure 1: User interface for Example 1
.. index::
object: View
.. _the-view-object:
The View Object
---------------
In order to control the layout of the interface, it is necessary to define a
View object. A View object is a template for a GUI window or panel. In other
words, a View specifies the content and appearance of a TraitsUI window or
panel display.
For example, suppose you want to construct a GUI window that shows only the
first three attributes of a SimpleEmployee (e.g., because salary is confidential
and the employee number should not be edited). Furthermore, you would like to
specify the order in which those fields appear. You can do this by defining a
View object and passing it to the configure_traits() method:
.. index:: configure_traits(); view parameter, examples; View object
.. _example-2-using-configure-traits-with-a-view-object:
.. rubric:: Example 2: Using configure_traits() with a View object
::
# configure_traits_view.py -- Sample code to demonstrate
# configure_traits()
from traits.api import HasTraits, Str, Int
from traitsui.api import View, Item
import traitsui
class SimpleEmployee(HasTraits):
first_name = Str
last_name = Str
department = Str
employee_number = Str
salary = Int
view1 = View(Item(name = 'first_name'),
Item(name = 'last_name'),
Item(name = 'department'))
sam = SimpleEmployee()
sam.configure_traits(view=view1)
The resulting window has the desired appearance:
.. figure:: images/ui_for_ex2.jpg
:alt: User interface showing only First name, Last name, and Department
Figure 2: User interface for Example 2
A View object can have a variety of attributes, which are set in the View
definition, following any Group or Item objects.
The sections on :ref:`contents-of-a-view` through :ref:`advanced-view-concepts`
explore the contents and capabilities of Views. Refer to
the *Traits API Reference* for details of the View class.
Except as noted, all example code uses the configure_traits() method; a detailed
description of this and other techniques for creating GUI displays from Views
can be found in :ref:`displaying-a-view`.
.. index:: View; contents
object: View
.. _contents-of-a-view:
Contents of a View
------------------
The contents of a View are specified primarily in terms of two basic building
blocks: Item objects (which, as suggested by Example 2, correspond roughly to
individual trait attributes), and Group objects. A given View definition can
contain one or more objects of either of these types, which are specified as
arguments to the View constructor, as in the case of the three Items in Example
2.
The remainder of this chapter describes the Item and Group classes.
.. index:: widget, control
object: Item
.. _the-item-object:
The Item Object
```````````````
The simplest building block of a View is the :term:`Item` object. An Item
specifies a single interface :term:`widget`, usually the display for a single
trait attribute of a HasTraits object. The content, appearance, and behavior of
the widget are controlled by means of the Item object's attributes, which are
usually specified as keyword arguments to the Item constructor, as in the case
of *name* in Example 2.
The remainder of this section describes the attributes of the Item object,
grouped by categories of functionality. It is not necessary to understand all of
these attributes in order to create useful Items; many of them can usually be
left unspecified, as their default values are adequate for most purposes.
Indeed, as demonstrated by earlier examples, simply specifying the name of the
trait attribute to be displayed is often enough to produce a usable result.
The following table lists the attributes of the Item class, organized by
functional categories. Refer to the *Traits API Reference* for details on the
Item class.
.. index:: attributes; Item, Item; attributes
.. index:: name attribute, dock attribute; Item, emphasized attribute
.. index:: export attribute; Item, height attribute; Item, image attribute; Item
.. index:: item_theme attribute; Item, label attribute; Item
.. index:: label_theme attribute; Item, padding attribute; Item
.. index:: resizable attribute, show_label attribute, springy attribute; Item
.. index:: width attribute; Item, format_str attribute, format_func attribute
.. index:: editor attribute, style attribute; Item, enabled_when attribute; Item
.. index:: visible_when attribute; Item, defined_when attribute; Item
.. index:: has_focus attribute, tooltip attribute, help attribute; Item
.. index:: help_id attribute; Item, id attribute; Item
.. _attributes-of-item-by-category-table:
.. rubric:: Attributes of Item, by category
+----------+---------------------+---------------------------------------------+
|Category |Attributes |Description |
+==========+=====================+=============================================+
|Content | * **name** |These attributes specify the actual data to |
| | |be displayed by an item. Because an Item is |
| | |essentially a template for displaying a |
| | |single trait, its **name** attribute is |
| | |nearly always specified. |
+----------+---------------------+---------------------------------------------+
|Display |* **dock** |In addition to specifying which trait |
|format |* **emphasized** |attributes are to be displayed, you might |
| |* **export** |need to adjust the format of one or more of |
| |* **height** |the resulting widgets. |
| |* **image** | |
| |* **item_theme** |If an Item's **label** attribute is specified|
| |* **label** |but not its name, the value of **label** is |
| |* **label_theme** |displayed as a simple, non-editable string. |
| |* **padding** |(This feature can be useful for displaying |
| |* **resizable** |comments or instructions in a TraitsUI |
| |* **show_label** |window.) |
| |* **springy** | |
| |* **width** | |
+----------+---------------------+---------------------------------------------+
|Content |* **format_str** |In some cases it can be desirable to apply |
|format |* **format_func** |special formatting to a widget's contents |
| | |rather than to the widget itself. Examples of|
| | |such formatting might include rounding a |
| | |floating-point value to two decimal places, |
| | |or capitalizing all letter characters in a |
| | |license plate number. |
+----------+---------------------+---------------------------------------------+
|Widget |* **editor** |These attributes override the widget that is |
|override |* **style** |automatically selected by TraitsUI. These |
| | |options are discussed in |
| | |:ref:`introduction-to-trait-editor-factories`|
| | |and |
| | |:ref:`the-predefined-trait-editor-factories`.|
+----------+---------------------+---------------------------------------------+
|Visibility|* **enabled_when** |Use these attributes to create a simple form |
|and status|* **visible_when** |of a dynamic GUI, which alters the display |
| |* **defined_when** |in response to changes in the data it |
| |* **has_focus** |contains. More sophisticated dynamic behavior|
| | |can be implemented using a custom |
| |.. TODO: Add examples|:term:`Handler` see |
| | here |:ref:`controlling-the-interface-the-handler` |
| | |). |
+----------+---------------------+---------------------------------------------+
|User help |* **tooltip** |These attributes provide guidance to the user|
| |* **help** |in using the user interface. If the **help** |
| |* **help_id** |attribute is not defined for an Item, a |
| | |system-generated message is used instead. The|
| |.. TODO: Add sample |**help_id** attribute is ignored by the |
| | help screen |default help handler, but can be used by a |
| | |custom help handler. |
+----------+---------------------+---------------------------------------------+
|Unique |* **id** |The **id** attribute is used as a key for |
|identifier| |saving user preferences about the widget. If |
| | |**id** is not specified, the value of the |
| | |**name** attribute is used. |
+----------+---------------------+---------------------------------------------+
.. index:: Label class, Heading class, Spring class
pair: Item; subclasses
.. _subclasses-of-item:
Subclasses of Item
``````````````````
The TraitsUI package defines the following subclasses of Item:
* Label
* Heading
* Spring
These classes are intended to help with the layout of a TraitsUI View, and need
not have a trait attribute associated with them. See the *Traits API Reference*
for details.
.. index:
object: Group
.. _the-group-object:
The Group Object
````````````````
The preceding sections have shown how to construct windows that display a simple
vertical sequence of widgets using instances of the View and Item classes. For
more sophisticated interfaces, though, it is often desirable to treat a group of
data elements as a unit for reasons that might be visual (e.g., placing the
widgets within a labeled border) or logical (activating or deactivating the
widgets in response to a single condition, defining group-level help text). In
TraitsUI, such grouping is accomplished by means of the :term:`Group` object.
Consider the following enhancement to Example 2:
pair: configure_traits(); examples
triple: View; Group; examples
.. _example-3-using-configure-traits-with-a-view-and-a-group-object:
.. rubric:: Example 3: Using configure_traits() with a View and a Group object
::
# configure_traits_view_group.py -- Sample code to demonstrate
# configure_traits()
from traits.api import HasTraits, Str, Int
from traitsui.api import View, Item, Group
import traitsui
class SimpleEmployee(HasTraits):
first_name = Str
last_name = Str
department = Str
employee_number = Str
salary = Int
view1 = View(Group(Item(name = 'first_name'),
Item(name = 'last_name'),
Item(name = 'department'),
label = 'Personnel profile',
show_border = True))
sam = SimpleEmployee()
sam.configure_traits(view=view1)
The resulting window shows the same widgets as before, but they are now enclosed
in a visible border with a text label:
.. figure:: images/ui_for_ex3.jpg
:alt: User interface showing three fields enclosed in a border
Figure 3: User interface for Example 3
.. indexx:
pair: contents; Group
.. _content-of-a-group:
Content of a Group
::::::::::::::::::
The content of a Group object is specified exactly like that of a View object.
In other words, one or more Item or Group objects are given as arguments to the
Group constructor, e.g., the three Items in Example 3. [5]_ The objects
contained in a Group are called the *elements* of that Group. Groups can be
nested to any level.
.. index::
pair: attributes; Group
.. _group-attributes:
Group Attributes
::::::::::::::::
The following table lists the attributes of the Group class, organized by
functional categories. As with Item attributes, many of these attributes can
be left unspecified for any given Group, as the default values usually lead to
acceptable displays and behavior.
See the *Traits API Reference* for details of the Group class.
.. index:: object attribute; Group, content attribute; Group
.. index:: label attribute; Group, show_border attribute, show_labels attribute
.. index:: show_left attribute, padding attribute; Group, layout attribute
.. index:: selected attribute, orientation attribute, style attribute; Group
.. index:: columns attribute, dock attribute; Group, dock_theme attribute
.. index:: group_theme attribute, item_theme attribute; Group
.. index:: label_theme attribute; Group, image attribute; Group
.. index:: export attribute; Group, springy attribute; Group
.. _attributes-of-group-by-category-table:
.. rubric:: Attributes of Group, by category
+----------+---------------------+---------------------------------------------+
|Category |Attributes |Description |
+==========+=====================+=============================================+
|Content |* **object** |The **object** attribute references the |
| |* **content** |object whose traits are being edited by |
| | |members of the group; by default this is |
| | |'object', but could be another object in the |
| | |current context. The **content** attribute is|
| | |a list of elements in the group. |
+----------+---------------------+---------------------------------------------+
|Display |* **columns** |These attributes define display options for |
|format |* **dock** |the group as a whole. |
| |* **dock_theme** | |
| |* **export** | |
| |* **group_theme** |.. index:: enabled_when attribute; Group |
| |* **image** |.. index:: visible_when attribute; Group |
| |* **item_theme** |.. index:: defined_when attribute; Group |
| |* **label** |.. index:: help attribute; Group |
| |* **label_theme** |.. index:: help_id attribute; Group |
| |* **layout** |.. index:: id attribute; Group |
| |* **orientation** | |
| |* **padding** | |
| |* **selected** | |
| |* **show_border** | |
| |* **show_labels** | |
| |* **show_left** | |
| |* **springy** | |
| |* **style** | |
+----------+---------------------+---------------------------------------------+
|Visibility|* **enabled_when** |These attributes work similarly to the |
|and status|* **visible_when** |attributes of the same names on the Item |
| |* **defined_when** |class. |
| | | |
| | |.. TODO: Does Item-level or Group-level take |
| | | precedence? Find out and document. |
+----------+---------------------+---------------------------------------------+
|User help |* **help** |The help text is used by the default help |
| |* **help_id** |handler only if the group is the only |
| | |top-level group for the current View. For |
| | |example, suppose help text is defined for a |
| | |Group called **group1**. The following View |
| | |shows this text in its help window:: |
| | | |
| | | View(group1) |
| | | |
| | |The following two do not:: |
| | | |
| | | View(group1, group2) |
| | | View(Group(group1)) |
| | | |
| | |The **help_id** attribute is ignored by the |
| | |default help handler, but can be used by a |
| | |custom help handler. |
| | | |
| | |.. TODO: The document needs to include |
| | | material on organizing Views via Groups, |
| | | including the implied top-level group of |
| | | every View. If we do this earlier in the |
| | | document, it will probably simplify this. |
+----------+---------------------+---------------------------------------------+
|Unique |* **id** |The **id** attribute is used as a key for |
|identifier| |saving user preferences about the widget. If |
| | |**id** is not specified, the **id** values |
| | |of the elements of the group are concatenated|
| | |and used as the group identifier. |
+----------+---------------------+---------------------------------------------+
.. index::
pair: subclasses; Group
.. _subclasses-of-group:
Subclasses of Group
```````````````````
The TraitsUI package defines the following subclasses of Group, which are
helpful shorthands for defining certain types of groups. Refer to the *Traits
API Reference* for details.
.. index:: HGroup, HFlow, HSplit, Tabbed, VGroup, VFlow, VGrid, VFold, VSplit
.. _subclasses-of-group_table:
.. rubric:: Subclasses of Group
+-----------+------------------------------+-----------------------------------------+
|Subclass |Description |Equivalent To |
+===========+==============================+=========================================+
|HGroup |A group whose items are laid |:samp:`Group(orientation='horizontal')` |
| |out horizontally. | |
+-----------+------------------------------+-----------------------------------------+
|HFlow |A horizontal group whose items|:samp:`Group(orientation='horizontal', |
| |"wrap" when they exceed the |layout='flow', show_labels=False)` |
| |available horizontal space. | |
+-----------+------------------------------+-----------------------------------------+
|HSplit |A horizontal group with |:samp:`Group(orientation='horizontal', |
| |splitter bars to separate it |layout='split')` |
| |from other groups. | |
+-----------+------------------------------+-----------------------------------------+
|Tabbed |A group that is shown as a tab|:samp:`Group(orientation='horizontal' |
| |in a notebook. |layout='tabbed', springy=True)` |
+-----------+------------------------------+-----------------------------------------+
|VGroup |A group whose items are laid |:samp:`Group(orientation='vertical')` |
| |out vertically. | |
+-----------+------------------------------+-----------------------------------------+
|VFlow |A vertical group whose items |:samp:`Group(orientation='vertical', |
| |"wrap" when they exceed the |layout='flow', show_labels=False)` |
| |available vertical space. | |
+-----------+------------------------------+-----------------------------------------+
|VFold |A vertical group in which |:samp:`Group(orientation='vertical', |
| |items can be collapsed (i.e., |layout='fold', show_labels=False)` |
| |folded) by clicking their | |
| |titles. | |
+-----------+------------------------------+-----------------------------------------+
|VGrid |A vertical group whose items |:samp:`Group(orientation='vertical', |
| |are laid out in two columns. |columns=2)` |
+-----------+------------------------------+-----------------------------------------+
|VSplit |A vertical group with splitter|:samp:`Group(orientation='vertical', |
| |bars to separate it from other|layout='split')` |
| |groups. | |
+-----------+------------------------------+-----------------------------------------+
.. rubric:: Footnotes
.. [3] If the code is being run from a program that already has a GUI defined,
then use edit_traits() instead of configure_traits(). These methods are
discussed in more detail in :ref:`displaying-a-view`.
.. [4] All code examples in this guide that include a file name are also
available as examples in the :file:`tutorials/doc_examples/examples`
subdirectory of the Traits docs directory. You can run them individually,
or view them in a tutorial program by running:
:program:`python` :file:`{Traits_dir}/tutorials/tutor.py` :file:`{Traits_dir}/docs/tutorials/doc_examples`
.. [5] As with Views, it is possible for a Group to contain objects of more than
one type, but it is not recommended.
|