Differences between revisions 1 and 49 (spanning 48 versions)
⇤ ← Revision 1 as of 2001-11-01 18:42:18 →
Size: 3175
Editor: anonymous
Comment: missing edit-log entry for this revision
← Revision 49 as of 2008-07-25 21:29:32 → ⇥
Size: 3805
Editor: cpc3-warw6-0-0-cust905
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
How to learn wxPython. = Learning wxPython by Example. =
Line 3: Line 3:
We have had a lot of questions on the newsgroup asking how to go about
learning wxPython. this page gives some pointers on how to do just that.		 The following code shows an example of a wxPython application with a frame containing a menu bar, status bar and panel. The panel contains a label and a button that is bound to an exit function. The menu bar has a Help->About action that is bound to a dialog box. The dialog box shows how to display an HTML message and bring up a link in the user's default browser. You might find this example useful as a starting point that you can adapt. In a larger program it would be best to put the about box code into a separate file so that the main program file does not become too large.
Line 6: Line 5:
First of all, if you are new to Python, and especially if you are new
to programming in general, it makes the most sense to learn Python
itself first, without any GUI stuff. This can be frustrating if your
goal is to write GUI programs, and particularly if you have experience
with an environment like Visual Basic in which GUI programming is
integrated into the environment. It is worth it, however, to take some
time to learn about Python. Python is a very powerful language capable
of doing many things both with and without GUIs.		 {{{
#!/usr/bin/python
# -*- coding: <<encoding>> -*-
#-------------------------------------------------------------------------------
# <<project>>
#
#-------------------------------------------------------------------------------
Line 15: Line 13:
Using wxPython requires a pretty good understanding of Object Oriented
(OO) programming in Python, and all of the tutorials and references that
I will refer to later assume this knowledge.		 import wxversion
wxversion.select("2.8")
import wx, wx.html
import sys
Line 19: Line 18:
To learn Python, go to the Python for Beginners page at the main Python
web site:		 aboutText = """<p>Sorry, there is no information about this program. It is
running on version %(wxpy)s of <b>wxPython</b> and %(python)s of <b>Python</b>.
See <a href="http://wiki.wxpython.org">wxPython Wiki</a></p>"""
Line 22: Line 22:
http://www.python.org/doc/Newbies.html class HtmlWindow(wx.html.HtmlWindow):
    def __init__(self, parent, id, size=(600,400)):
        wx.html.HtmlWindow.__init__(self,parent, id, size=size)
        if "gtk2" in wx.PlatformInfo:
            self.SetStandardFonts()
Line 24: Line 28:
Follow the links on that page, and you should find something to your
liking.		     def OnLinkClicked(self, link):
        wx.LaunchDefaultBrowser(link.GetHref())
        
class AboutBox(wx.Dialog):
    def __init__(self):
        wx.Dialog.__init__(self, None, -1, "About <<project>>",
            style=wx.DEFAULT_DIALOG_STYLE|wx.THICK_FRAME|wx.RESIZE_BORDER|
                wx.TAB_TRAVERSAL)
        hwin = HtmlWindow(self, -1, size=(400,200))
        vers = {}
        vers["python"] = sys.version.split()[0]
        vers["wxpy"] = wx.VERSION_STRING
        hwin.SetPage(aboutText % vers)
        btn = hwin.FindWindowById(wx.ID_OK)
        irep = hwin.GetInternalRepresentation()
        hwin.SetSize((irep.GetWidth()+25, irep.GetHeight()+10))
        self.SetClientSize(hwin.GetSize())
        self.CentreOnParent(wx.BOTH)
        self.SetFocus()
Line 27: Line 48:
Once you have a fundamental understanding of programming in Python, you
can start to learn wxPython for GUI programming.		 class Frame(wx.Frame):
    def __init__(self, title):
        wx.Frame.__init__(self, None, -1, title, pos=(150,150), size=(350,200))
        menuBar = wx.MenuBar()
        menu = wx.Menu()
        menu.Append(wx.ID_EXIT, "E&xit\tAlt-X", "Close window and exit program.")
        self.Bind(wx.EVT_MENU, self.OnClose, id=wx.ID_EXIT)
        menuBar.Append(menu, "&File")
        menu = wx.Menu()
        menu.Append(wx.ID_ABOUT, "&About", "Information about this program")
        self.Bind(wx.EVT_MENU, self.OnAbout, id=wx.ID_ABOUT)
        menuBar.Append(menu, "&Help")
        self.SetMenuBar(menuBar)
        
        self.CreateStatusBar()
Line 30: Line 64:
I would suggest starting with the Tutorial. It is brief, and not
complete, but it is a good start. You can find it here:		         panel = wx.Panel(self)
        box = wx.BoxSizer(wx.VERTICAL)
        
        m_text = wx.StaticText(panel, -1, "Hello World!")
        m_text.SetFont(wx.Font(14, wx.SWISS, wx.NORMAL, wx.BOLD))
        m_text.SetSize(m_text.GetBestSize())
        box.Add(m_text, 0, wx.ALL, 10)
        
        m_close = wx.Button(panel, wx.ID_CLOSE, "Close")
        m_close.Bind(wx.EVT_BUTTON, self.OnClose)
        box.Add(m_close, 0, wx.ALL, 10)
        
        panel.SetSizer(box)
        panel.Layout()
        self.Show(True)
Line 33: Line 80:
http://wxpython.org/tutorial.php     def OnClose(self, event):
        self.Close()
Line 35: Line 83:
Once you have gone through that, you might want to go through the
wxpython wiki getting started section:		     def OnAbout(self, event):
        dlg = AboutBox()
        dlg.ShowModal()
        dlg.Destroy()
Line 38: Line 88:
http://wiki.wxpython.org/index.cgi/Getting_20Started app = wx.App(False) # Error messages go shell
top = Frame("<<project>>")
app.SetTopWindow(top)
app.MainLoop()
}}}
Line 40: Line 94:
Between these two, you should have a basic grasp of how wxPython works,
and be ready to make you own application. To so this, you will want two
things: examples and a reference.

The wxPython demo is your best source of examples. It is distributed
with wxPython, and demonstrates virtually all the features of
wxPython. When you run it, you can see how different features work, and
see the source code that made it happen. Many of us look for something
in the demo that is close to what we want to do, copy it, and then alter
it to fit our needs.

Another source of examples is the wxPython cookbook:

http://wiki.wxpython.org/index.cgi/wxPython_20Cookbook


The reference manual for wxPython is the same as the reference for the
C++ version of wxWindows, and can be found here:

http://www.wxpython.org/onlinedocs.php

It is written in C++ syntax, with notes inserted for when the Python
implementation differs from the C++. The fact that the docs are written
for C++ is unfortunate, not because they aren't useful to Python
programmers, but because is can be very intimidating to new users who
don't know C++. In fact, many Python programmers who don't know a bit of
C++ find that the docs can be very useful. It only takes a little while
to learn to translate form the C++ in the docs to the equivalent
Python. One of the best way to learn to do this is to compare code form
the examples n the wxPython demo to what is in the reference manual.

[NOTE: it would be great if someone would add a section here with
examples of how to translate from C++ to Python.]


 This example is based on the wxPython template that is used in the [[http://luke-sdk.berlios.de|Luke-SDK ]] IDE.

Learning wxPython by Example.

The following code shows an example of a wxPython application with a frame containing a menu bar, status bar and panel. The panel contains a label and a button that is bound to an exit function. The menu bar has a Help->About action that is bound to a dialog box. The dialog box shows how to display an HTML message and bring up a link in the user's default browser. You might find this example useful as a starting point that you can adapt. In a larger program it would be best to put the about box code into a separate file so that the main program file does not become too large. 

# -*- coding: <<encoding>> -*-
#-------------------------------------------------------------------------------
#   <<project>>
# 
#-------------------------------------------------------------------------------

import wxversion
wxversion.select("2.8")
import wx, wx.html
import sys

aboutText = """<p>Sorry, there is no information about this program. It is
running on version %(wxpy)s of <b>wxPython</b> and %(python)s of <b>Python</b>.
See <a href="http://wiki.wxpython.org">wxPython Wiki</a></p>""" 

class HtmlWindow(wx.html.HtmlWindow):
    def __init__(self, parent, id, size=(600,400)):
        wx.html.HtmlWindow.__init__(self,parent, id, size=size)
        if "gtk2" in wx.PlatformInfo:
            self.SetStandardFonts()

    def OnLinkClicked(self, link):
        wx.LaunchDefaultBrowser(link.GetHref())
        
class AboutBox(wx.Dialog):
    def __init__(self):
        wx.Dialog.__init__(self, None, -1, "About <<project>>",
            style=wx.DEFAULT_DIALOG_STYLE|wx.THICK_FRAME|wx.RESIZE_BORDER|
                wx.TAB_TRAVERSAL)
        hwin = HtmlWindow(self, -1, size=(400,200))
        vers = {}
        vers["python"] = sys.version.split()[0]
        vers["wxpy"] = wx.VERSION_STRING
        hwin.SetPage(aboutText % vers)
        btn = hwin.FindWindowById(wx.ID_OK)
        irep = hwin.GetInternalRepresentation()
        hwin.SetSize((irep.GetWidth()+25, irep.GetHeight()+10))
        self.SetClientSize(hwin.GetSize())
        self.CentreOnParent(wx.BOTH)
        self.SetFocus()

class Frame(wx.Frame):
    def __init__(self, title):
        wx.Frame.__init__(self, None, -1, title, pos=(150,150), size=(350,200))
        menuBar = wx.MenuBar()
        menu = wx.Menu()
        menu.Append(wx.ID_EXIT, "E&xit\tAlt-X", "Close window and exit program.")
        self.Bind(wx.EVT_MENU, self.OnClose, id=wx.ID_EXIT)
        menuBar.Append(menu, "&File")
        menu = wx.Menu()
        menu.Append(wx.ID_ABOUT, "&About", "Information about this program")
        self.Bind(wx.EVT_MENU, self.OnAbout, id=wx.ID_ABOUT)
        menuBar.Append(menu, "&Help")
        self.SetMenuBar(menuBar)
        
        self.CreateStatusBar()

        panel = wx.Panel(self)
        box = wx.BoxSizer(wx.VERTICAL)
        
        m_text = wx.StaticText(panel, -1, "Hello World!")
        m_text.SetFont(wx.Font(14, wx.SWISS, wx.NORMAL, wx.BOLD))
        m_text.SetSize(m_text.GetBestSize())
        box.Add(m_text, 0, wx.ALL, 10)
        
        m_close = wx.Button(panel, wx.ID_CLOSE, "Close")
        m_close.Bind(wx.EVT_BUTTON, self.OnClose)
        box.Add(m_close, 0, wx.ALL, 10)
        
        panel.SetSizer(box)
        panel.Layout()
        self.Show(True)

    def OnClose(self, event):
        self.Close()

    def OnAbout(self, event):
        dlg = AboutBox()
        dlg.ShowModal()
        dlg.Destroy()  

app = wx.App(False)   # Error messages go shell
top = Frame("<<project>>")
app.SetTopWindow(top)
app.MainLoop()

This example is based on the wxPython template that is used in the Luke-SDK IDE.

wxPython by Example (last edited 2012-06-28 08:10:48 by SWM-HIGH-SPEED2-22)

NOTE: To edit pages in this wiki you must be a member of the TrustedEditorsGroup.