wxPython Application Development Cookbook: Over 80 step-by-step recipes to get you up to speed with building your own wxPython applications

Table of Contents

wxPython Application Development Cookbook

Credits

About the Author

About the Reviewers

www.PacktPub.com

Support files, eBooks, discount offers, and more

Why Subscribe?

Free Access for Packt account holders

Preface

What this book covers

What you need for this book

Who this book is for

Sections

Getting ready

How to do it…

How it works…

There's more…

See also

Conventions

Reader feedback

Customer support

Downloading the example code

Errata

Piracy

Questions

1. wxPython Starting Points

Introduction

Creating an application object

How to do it…

How it works…

There's more…

See also

Adding the main frame

How to do it…

How it works…

There's more…

Using bitmaps

How to do it…

How it works…

There's more…

Binding to events

How to do it…

How it works…

There's more…

See also

Understanding the hierarchy of the UI

How to do it…

How it works…

There's more…

See also

Controlling the propagation of events

How to do it…

How it works…

There's more…

Accessing the clipboard

How to do it…

How it works…

There's more…

See also

Supporting drag and drop

How to do it…

How it works…

There's more…

Handling AppleEvents

How to do it…

How it works…

There's more…

2. Common User Controls

Introduction

Starting with the easy button

How to do it…

How it works…

See also

Pushing all the buttons

How to do it…

How it works…

There's more…

Offering options with CheckBoxes

How to do it…

How it works…

Using TextCtrl

How to do it…

How it works…

There's more…

See also

Processing key events

How to do it…

How it works…

There's more…

Picking dates with DatePickerCtrl

How to do it…

How it works…

There's more…

Exploring menus and shortcuts

How to do it…

How it works…

There's more…

See also

Displaying a context menu

How to do it…

How it works…

See also

Working with ToolBars

Getting ready

How to do it…

How it works…

There's more…

See also

Managing UI states

Getting ready

How to do it…

How it works…

There's more…

3. UI Layout and Organization

Introduction

Laying out controls with Sizers

How to do it…

How it works…

See also

Controlling layout behavior

Getting ready

How to do it…

How it works…

There's more…

Grouping controls with a StaticBox control

How to do it…

How it works…

There's more…

Creating an automatic wrapping layout

How to do it…

How it works…

Using the standard dialog button sizer

How to do it…

How it works…

There's more…

Simplifying the panel layout

How to do it…

How it works…

There's more…

See also

Making dialog layout easy

Getting ready

How to do it…

How it works…

Building XML resource-based layouts

How to do it…

How it works…

There's more…

Extending XRC for custom controls

How to do it…

How it works…

There's more…

Advancing your UI with AuiManager

How to do it…

How it works…

There's more…

Additional AuiPaneInfo options

Saving and restoring a window's state

4. Containers and Advanced Controls

Introduction

Adding tabs with the Notebook control

How to do it…

How it works…

There's more…

See also

Enhancing ComboBox with bitmaps

How to do it…

How it works…

There's more…

See also

Configuring properties

How to do it…

How it works…

There's more…

Taking control with FlatNotebook

How to do it…

How it works…

There's more…

See also

Styling text in StyledTextCtrl

How to do it…

How it works…

There's more…

See also

Annotating StyledTextCtrl

Getting started

How to do it…

How it works…

There's more…

Displaying hierarchical data with TreeCtrl

How to do it…

How it works…

There's more…

Building a system tray application

Getting started

How to do it…

How it works…

There's more…

Surfing the Web in your app

How to do it…

How it works…

There's more…

5. Data Displays and Grids

Introduction

Displaying lists of data

How to do it…

How it works…

There's more…

See also

Editing data lists

Getting ready

How to do it…

How it works…

There's more…

Implementing a data source

How to do it…

How it works…

There's more…

See also

Getting started with the data grid

Getting ready

How to do it…

How it works…

There's more…

Custom Editors

Managing Attributes

See also

Displaying dynamic data

How to do it…

How it works…

There's more…

See also

Modeling your data

How to do it…

How it works…

There's more…

See also

Displaying your data model

Getting ready

How to do it…

How it works…

There's more…

6. Ways to Notify and Alert

Introduction

Showing MessageBox

How to do it…

How it works…

There's more…

Button flags

Icon flags

Using InfoBar

How to do it…

How it works…

There's more…

See also

Providing extra tips on usage

How to do it…

How it works…

Displaying transient notifications

How to do it…

How it works…

There's more…

See also

Making a splash at startup

How to do it…

How it works…

There's more…

See also

Giving busy feedback

How to do it…

How it works…

Showing information about your app

How to do it…

How it works…

There's more…

See also

7. Requesting and Retrieving Information

Introduction

Selecting files with FileDialog

Getting ready

How to do it…

How it works…

See also

Searching text with FindReplaceDialog

Getting ready

How to do it…

How it works…

There's more…

Filtering through choices

How to do it…

How it works…

There's more…

See also

Retrieving multiple selections

How to do it…

How it works…

There's more…

See also

Using Print dialogs

How to do it…

How it works…

There's more…

See also

Guiding selections with Wizard

How to do it…

How it works…

There's more…

8. User Interface Primitives

Introduction

Painting in your UI

How to do it…

How it works…

See also

Drawing basic shapes

How to do it…

How it works…

There's more…

Customizing grid labels

Getting ready

How to do it…

How it works…

There's more…

See also

Drawing gradients with GraphicsContext

How to do it…

How it works…

There's more…

Recreating native controls with RendererNative

How to do it…

How it works…

There's more…

9. Creating and Customizing Components

Introduction

Making your own dialog

How to do it…

How it works…

There's more…

See also

Validating user input

How to do it…

How it works…

There's more…

Interacting with StatusBar

How to do it…

How it works…

There's more…

Providing your own information window

How to do it…

How it works…

See also

Creating a managed layout

How to do it…

How it works…

Drawing your own list control

How to do it…

How it works…

There's more…

Implementing highlighting in StyledTextCtrl

Getting ready

How to do it…

How it works…

See also

Creating a composite control

How to do it…

How it works…

See also

Designing an owner-drawn control

Getting ready

How to do it…

How it works

See also

10. Getting Your Application Ready for Release

Introduction

Storing your configuration with StandardPaths

How to do it…

How it works...

There's more...

Saving the application's state

How to do it…

How it works...

See also

Supporting internationalization

How to do it…

How it works…

There's more…

See also

Optimizing for OS X

How to do it…

How it works…

There's more…

ToolBars

See also

Handling errors gracefully

How to do it…

How it works…

Embedding your resources

How to do it…

How it works…

There's more…

See also

Distributing an application

Getting ready

How to do it…

How it works…

There's more…

See also

Updating your software

Getting ready

How to do it…

How it works…

There's more…

See also

Index

wxPython Application Development Cookbook

wxPython Application Development Cookbook

Copyright © 2015 Packt Publishing

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.

Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.

First published: December 2015

Production reference: 1171215

Published by Packt Publishing Ltd.

Livery Place

35 Livery Street

Birmingham B3 2PB, UK.

ISBN 978-1-78528-773-2

www.packtpub.com

Credits

Author

Cody Precord

Reviewers

Joran Beasley

Jens Göpfert

Acquisition Editor

Usha Iyer

Content Development Editor

Neeshma Ramakrishnan

Deepti Thore

Technical Editor

Vijin Boricha

Copy Editor

Shruti Iyer

Project Coordinator

Shweta H Birwatkar

Proofreader

Safis Editing

Indexer

Mariammal Chettiyar

Production Coordinator

Nilesh Mohite

Cover Work

Nilesh Mohite

About the Author

Cody Precord is a software engineer based in Minneapolis, MN, USA. He designs and writes systems and application software for Windows, AIX, Linux, and Macintosh OS X using primarily C++, C#, C, Perl, Bash, and Python. The constant need for working on multiple platforms naturally led Cody to the wxPython toolkit, which he has used for several years. He is the author of wxPython 2.8 Application Development Cookbook, Packt Publishing and has also contributed to the development of the wxPython library. Cody is interested in promoting cross platform development practices and improving usability in software.

About the Reviewers

Joran Beasley received his degree in computer science from the University of Idaho. He has programmed desktop applications in wxPython professionally to monitor large-scale sensor networks that can be used in agriculture for the last 7 years. Joran currently lives in Moscow, Idaho, and works for Decagon Devices, Inc. as a software engineer.

I would like to thank my wife, Nicole, for putting up with my long hours hunched over a keyboard and her constant support and help in raising our two wonderful children.

Jens Göpfert started developing applications with wxPyton in 2003, as a student assistant first and later on during his professional career. He is known and considered by peers as a wxPython expert. Jens has developed applications for engineers in the automotive domain, where he further gained invaluable experience in working with complex and easily operable user interfaces. With this knowledge, he started using wxPython for various projects in his spare time as well. Also, as a user of the underlying C++ implementation, Jens applies his analytical skills to better understand the wxPython functionality and address problems or make enhancements.

Special thanks go to my wife, Marlene, and my two children, Melinda and Julius, for supporting me and my passion for developing while I spent a lot of time working on the computer.

www.PacktPub.com

Support files, eBooks, discount offers, and more

For support files and downloads related to your book, please visit www.PacktPub.com.

Did you know that Packt offers eBook versions of every book published, with PDF and ePub files available? You can upgrade to the eBook version at www.PacktPub.com and as a print book customer, you are entitled to a discount on the eBook copy. Get in touch with us at for more details.

At www.PacktPub.com, you can also read a collection of free technical articles, sign up for a range of free newsletters and receive exclusive discounts and offers on Packt books and eBooks.

https://www2.packtpub.com/books/subscription/packtlib

Do you need instant solutions to your IT questions? PacktLib is Packt's online digital book library. Here, you can search, access, and read Packt's entire library of books.

Why Subscribe?

Fully searchable across every book published by Packt

Copy and paste, print, and bookmark content

On demand and accessible via a web browser

Free Access for Packt account holders

If you have an account with Packt at www.PacktPub.com, you can use this to access PacktLib today and view 9 entirely free books. Simply use your login credentials for immediate access.

Preface

In today's world of desktop applications, there is a great amount of incentive in being able to develop applications that can run in more than one environment. Currently, there are a handful of options available for cross platform frameworks to develop desktop applications in Python; wxPython is one such cross platform GUI toolkit for the Python programming language. It allows Python programmers to simply and easily create programs with a complete, highly functional graphical user interface. The wxPython code style has changed quite a bit over the years and has become much more Pythonic. The examples that you will find in this book are fully up to date and reflect this change in style. This cookbook provides you with the latest recipes to quickly create robust, reliable, and reusable wxPython applications. These recipes will guide you right from writing simple, basic wxPython scripts all the way through complex concepts and also feature various design approaches and techniques in wxPython.

This book starts off by covering a variety of topics, from the most basic requirements of a wxPython application to some of the more in-depth details of the inner workings of the framework, thus laying a foundation for any wxPython application. It then explains event handling, basic and advanced user interface controls, interface design and layout, creating dialogs, components, extending functionality, and so on. We will conclude by learning how to build and manage applications for distribution.

For each of the recipes, there is first an introductory and then more advanced examples along with plenty of example code that shows you how to develop and manage user-friendly applications. For more experienced developers, most recipes also include an additional discussion of the solution, allowing you to further customize and enhance the component.

What this book covers

Chapter 1, wxPython Starting Points, teaches the basics of getting started with building applications with wxPython.

Chapter 2, Common User Controls, introduces you to the commonly used UI components and how use them in wxPython.

Chapter 3, UI Layout and Organization, shows you how to lay out and present user controls on screen using Sizers.

Chapter 4, Containers and Advanced Controls, introduces you to various container-type and specialized controls, such as web browsers.

Chapter 5, Data Displays and Grids, shows you how to display and work with data using the Grids, Lists, and DataView controls.

Chapter 6, Ways to Notify and Alert, teaches you the techniques of alerting and notifying users with information.

Chapter 7, Requesting and Retrieving Information, shows you how to prompt users for information and input.

Chapter 8, User Interface Primitives, shows you how to use DeviceContexts to draw and customize your own UI components.

Chapter 9, Creating and Customizing Components, teaches you the techniques of designing and creating your own custom controls.

Chapter 10, Getting Your Application Ready for Release, shows you how to manage application configuration and build packages for release.

What you need for this book

All the recipes in this book were written using the following software:

wxPython 3.0.2.0

Python 2.7.9

A small selection of recipes requires some additional external Python packages, which are described in the recipe.

In addition to these tools, you will just need a good text editor that can work with Python files.

Who this book is for

This book is written for Python programmers wanting to develop user interfaces for their applications. An understanding of the Python language and basic object-oriented programming concepts is required to get the most out of this book.

Sections

In this book, you will find several headings that appear frequently (Getting ready, How to do it, How it works, There's more, and See also).

To give clear instructions on how to complete a recipe, we use these sections as follows:

Getting ready

This section tells you what to expect in the recipe, and describes how to set up any software or any preliminary settings required for the recipe.

How to do it…

This section contains the steps required to follow the recipe.

How it works…

This section usually consists of a detailed explanation of what happened in the previous section.

There's more…

This section consists of additional information about the recipe in order to make the reader more knowledgeable about the recipe.

See also

This section provides helpful links to other useful information for the recipe.

Conventions

In this book, you will find a number of text styles that distinguish between different kinds of information. Here are some examples of these styles and an explanation of their meaning.

Code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles are shown as follows: To make the control visible to the user we call the Show method.

A block of code is set as follows:

class MyPanel(sized.SizedScrolledPanel):

    def __init__(self, parent):

        super(MyPanel, self).__init__(parent)

        self.SetSizerType(form)

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

class MyPanel(sized.SizedScrolledPanel):

    def __init__(self, parent):

        super(MyPanel, self).__init__(parent)

self.SetSizerType(form)

Any command-line input or output is written as follows:

python main.py

New terms and important words are shown in bold. Words that you see on the screen, for example, in menus or dialog boxes, appear in the text like this: So now, it's time to add this method in to build up a simple File and Edit menu.

Note

Warnings or important notes appear in a box like this.

Tip

Tips and tricks appear like this.

Reader feedback

Feedback from our readers is always welcome. Let us know what you think about this book—what you liked or disliked. Reader feedback is important for us as it helps us develop titles that you will really get the most out of.

To send us general feedback, simply e-mail <[email protected]>, and mention the book's title in the subject of your message.

If there is a topic that you have expertise in and you are interested in either writing or contributing to a book, see our author guide at www.packtpub.com/authors.

Customer support

Now that you are the proud owner of a Packt book, we have a number of things to help you to get the most from your purchase.

Downloading the example code

You can download the example code files from your account at http://www.packtpub.com for all the Packt Publishing books you have purchased. If you purchased this book elsewhere, you can visit http://www.packtpub.com/support and register to have the files e-mailed directly to you.

Errata

Although we have taken every care to ensure the accuracy of our content, mistakes do happen. If you find a mistake in one of our books—maybe a mistake in the text or the code—we would be grateful if you could report this to us. By doing so, you can save other readers from frustration and help us improve subsequent versions of this book. If you find any errata, please report them by visiting http://www.packtpub.com/submit-errata, selecting your book, clicking on the Errata Submission Form link, and entering the details of your errata. Once your errata are verified, your submission will be accepted and the errata will be uploaded to our website or added to any list of existing errata under the Errata section of that title.

To view the previously submitted errata, go to https://www.packtpub.com/books/content/support and enter the name of the book in the search field. The required information will appear under the Errata section.

Piracy

Piracy of copyrighted material on the Internet is an ongoing problem across all media. At Packt, we take the protection of our copyright and licenses very seriously. If you come across any illegal copies of our works in any form on the Internet, please provide us with the location address or website name immediately so that we can pursue a remedy.

Please contact us at <[email protected]> with a link to the suspected pirated material.

We appreciate your help in protecting our authors and our ability to bring you valuable content.

Questions

If you have a problem with any aspect of this book, you can contact us at <[email protected]>, and we will do our best to address the problem.

Chapter 1. wxPython Starting Points

In this chapter, we will cover:

Creating an application object

Adding the main frame

Using bitmaps

Binding to events

Understanding the hierarchy of the UI

Controlling the propagation of events

Accessing the clipboard

Supporting drag and drop

Handling AppleEvents

Introduction

In this chapter, we will take a quick overview on getting started with wxPython, including how to get an app started as well as handling events and supporting basic integration with various operating system features for the environments that the application may be operated in. These concepts are used throughout the recipes in this book as well as in any wxPython application you may develop. The recipes throughout this book target wxPython 3.0 running on Python 2.7. Many features exist and work in earlier versions of wxPython as well, but your mileage may vary with the recipes in this book when using a version earlier than 3.0.

Creating an application object

The App object is an object that all wxPython applications must create before any other GUI object. This object creates the application and provides its main event loop, which is used to dispatch events and connect actions in the UI with the actions in your programs.

This recipe will introduce how to create a minimal wxPython application, which will be used as foundation for every other recipe in this book.

How to do it…

Perform the following steps:

Make the script as follows:

import wx

class MyApp(wx.App):

    def OnInit(self):

        wx.MessageBox(Hello wxPython, wxApp)

        return True

if __name__ == __main__:

    app = MyApp(False)

    app.MainLoop()

Run the script and take a look at the result:

How it works…

There are three things to take note of in this simple application: the first, we created a subclass of the wx.App object; the second, we overrode the OnInit method; and the third, we called the MainLoop method of the application object. These simple steps set up the base for any application.

The OnInit method is called by the application's MainLoop method when it is started and provides an entry point to start up the main logic and user interface of your application. In