TraitsUI 8.0.0 User Manual

Authors:

Lyn Pierce, Janet Swisher, and Enthought Developers

Version:

Document Version 4

Copyright:

2005-2023 Enthought, Inc. All Rights Reserved.

Contents

• Introduction
  • The Model-View-Controller (MVC) Design Pattern
    • The Model: HasTraits Subclasses and Objects
    • The View: View Objects
    • The Controller: Handler Subclasses and Objects
  • Toolkit Selection
    • The “qt4” Toolkit
  • Structure of this Manual
• The View and Its Building Blocks
  • The View Object
  • Contents of a View
    • The Item Object
    • Subclasses of Item
    • The Group Object
    • Subclasses of Group
• Customizing a View
  • Specifying Window Type: the kind Attribute
    • Stand-alone Windows
    • Wizards
    • Panels and Subpanels
  • Command Buttons: the buttons Attribute
  • Other View Attributes
• Advanced View Concepts
  • Internal Views
    • Defining a Default View
    • Defining Multiple Views Within the Model
  • Separating Model and View: External Views
  • Displaying a View
    • configure_traits()
    • edit_traits()
    • ui()
  • The View Context
    • Multi-Object Views
  • Include Objects
• Controlling the Interface: the Handler
  • Backstage: Introducing the UIInfo Object
  • Backstage: The UI Object
  • Assigning Handlers to Views
    • Binding a Singleton Handler to a View
    • Linking Handler and View at Edit Time
    • Creating a Default View Within a Handler
  • Handler Subclasses
    • ModelView
    • Controller
    • Controller Class
    • ModelView Class
  • Writing Handler Methods
    • Overriding Standard Methods
    • Reacting to Trait Changes
    • Implementing Custom Window Commands
  • Undo and Redo
• Introduction to Trait Editor Factories
  • Specifying an Alternate Trait Editor Factory
    • Initializing Editors
  • Specifying an Editor Style
    • The ‘simple’ Style
    • The ‘custom’ Style
    • The ‘text’ Style
    • The ‘readonly’ style
    • Using Editor Styles
• The Predefined Trait Editor Factories
  • Basic Trait Editor Factories
    • ArrayEditor()
    • BooleanEditor()
    • ButtonEditor()
    • CheckListEditor()
    • CodeEditor()
    • ColorEditor()
    • CompoundEditor()
    • CSVListEditor()
    • DateEditor()
    • DatetimeEditor()
    • DirectoryEditor()
    • EnumEditor()
    • FileEditor()
    • FontEditor()
    • HistoryEditor()
    • HTMLEditor()
    • ImageEditor()
    • ImageEnumEditor()
    • InstanceEditor()
    • ListEditor()
    • LEDEditor()
    • ListStrEditor()
    • NullEditor()
    • RangeEditor()
    • RGBColorEditor()
    • SetEditor()
    • ShellEditor()
    • TextEditor()
    • TimeEditor()
    • TitleEditor()
    • TupleEditor()
    • ValueEditor()
• Advanced Trait Editors
  • CustomEditor()
  • DropEditor()
  • DNDEditor()
  • KeyBindingEditor()
  • TableEditor()
    • Specifying Columns
    • Managing Items
    • Editing the Table
    • Defining the Layout
    • Defining the Format
    • Other User Interactions
  • TabularEditor()
    • Advantages
    • Disadvantages
    • TabularAdapter
    • The Tabular Editor User Interface
  • TreeEditor()
    • Defining Nodes
    • Defining Operations on Nodes
    • Defining the Format
  • ArrayViewEditor()
  • DataFrameEditor()
  • DefaultOverride()
  • VideoEditor()
• “Extra” Trait Editor Factories
  • AnimatedGIFEditor()
• Advanced Editor Adapters
  • The TreeEditor and TreeNodes
    • Specializing TreeNode Behaviour
    • ITreeNodes and ITreeNodeAdapters
    • ObjectTreeNodes and TreeNodeObjects
    • Custom Renderers
    • Examples
  • The TabularAdapter Class
    • The TabularAdapter columns Trait
    • The Core TabularAdapter Interface
    • Creating a Custom TabularAdapter
    • Examples
  • The ListStrAdapter Class
• Testing TraitsUI Applications
  • Get started
    • First simple test
    • Testing with nested objects
  • How-to guides
    • Add support for performing actions or inspecting states
    • Add support for locating a nested GUI element
  • Discussions
    • Limitations on automated GUI testing
    • Debugging GUI tests at runtime
    • Compatibility with Pyface test utilities
    • GUI event processing and exception handling
    • Understanding Target, Interaction and Location
    • How extension works
  • Technical Reference
    • Examples
    • API Reference
• Tips, Tricks and Gotchas
  • Getting and Setting Model View Elements
    • trait_views()
    • trait_view()
• Appendix I: Glossary of Terms
• Appendix II: Editor Factories for Predefined Traits

License

Redistribution and use of this document in source and derived forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source or derived format (for example, Portable Document Format or Hypertext Markup Language) must retain the above copyright notice, this list of conditions and the following disclaimer.

• Neither the name of Enthought, Inc., nor the names of contributors may be used to endorse or promote products derived from this document without specific prior written permission.

THIS DOCUMENT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

All trademarks and registered trademarks are the property of their respective owners.

Enthought, Inc.

200 W Cesar Chavez, Suite 202

Austin, TX 78701

United States

1.512.536.1057 (voice)

http://www.enthought.com

info@enthought.com