X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8eda5e3588fd5ef0fa91f94991e3cdc744852d3f..6caa0f5cd18fe9fb39c207d5f31fa5633479a822:/wxPython/docs/wxPackage.html diff --git a/wxPython/docs/wxPackage.html b/wxPython/docs/wxPackage.html index 9bbc1f84f2..c1fdcef921 100644 --- a/wxPython/docs/wxPackage.html +++ b/wxPython/docs/wxPackage.html @@ -3,12 +3,12 @@ - + The wxPython wx Package - + @@ -28,13 +28,13 @@ Organization: Orbtech Date: -2003-07-02 +2004-03-26 Revision: -1.2 +1.4 -
-

Contents

+
+

Contents

-
-

Introduction

+
+

Introduction

In the begining there was Python, and Python had modules, and Python was good. But after a time Guido looked on Python and saw that Python needed organizational assistance, and so Guido took code from Python's @@ -69,10 +69,10 @@ have concerning the new wx package. Please also take a look at the 2.5 Migration Guide to see notes about other big differences in this release.

-
-

Why change anything?

+
+

Why change anything?

This change is being made for a couple of reasons. The first reason -is to discourage the use of import *, which is a dangerous +is to discourage the use of import *, which is a dangerous technique that can create name conflicts and bloated namespaces.

The second reason is to remove what some perceive to be a "wart." For example, the following code is rather ugly in that the "wx" prefix on @@ -93,8 +93,8 @@ class Frame(wx.Frame) the same thing (implement a new wx namespace and drop the "wx" prefix) and we want wxPython to lead the way.

-
-

What does the new wx package do?

+
+

What does the new wx package do?

As mentioned in the Introduction, wxPython 2.4.1 introduced a way of getting to this new syntax as quickly as possible. It would import the old names (like "wxFrame") from the old package and then create new @@ -108,8 +108,8 @@ populated with modules that simply import the new names and then complicated, but it is mostly automated and so it doesn't cause problems in most cases.

-
-

Will any of this effect my existing code?

+
+

Will any of this effect my existing code?

No. Your existing code will continue to work and be supported for some time. It will be up to you to decide when to switch to the new syntax. But all new documentation and code examples will use the new @@ -123,24 +123,24 @@ old code is depending on some of the implemtation details, or if you are using other things that have changed in the API. See the Migration Guide for more details.

-
-

What about all the other modules, like grid, html, and stc?

+
+

What about all the other modules, like grid, html, and stc?

There's more to the old wxPython than just the wxPython.wx module. And we've got those extra modules covered as well. Each of those modules (as well as the lib subpackage) has been moved to the new wx package and reverse-renamers have been placed in the wxPython package as needed.

-
-

How do I use this new wx package?

+
+

How do I use this new wx package?

The wx package is automatically created when you install wxPython version 2.4.1 or higher. So all you have to do is:

 import wx
 
-
-

What are the issues with converting old code to use the new wx package?

+
+

What are the issues with converting old code to use the new wx package?

Obviously, you need to change your import statements from:

 from wxPython import wx
@@ -161,17 +161,102 @@ class MyFrame(wx.Frame):
 

In most cases, existing code can be modified with a simple search and replace.

-
-

Where can I find example programs using the new wx syntax?

-

Example programs are included in the wxPython/samples/wx_examples -directory, and are documented in the wxPythonExamples documentation -file. Also, all the code in the py package uses the new wx syntax. -You can learn more about these in the PyManual.

-
+
+

Where can I find example programs using the new wx syntax?

+

The wxPython demo application and most of the sample apps have been +converted to use the new import wx style of programming with +wxPython, so there are lots of examples to look at and to play with. +Here is one of them, it is the simple sample.

+
+#----------------------------------------------------------------------
+# A very simple wxPython example.  Just a wx.Frame, wx.Panel,
+# wx.StaticText, wx.Button, and a wx.BoxSizer, but it shows the basic
+# structure of any wxPython application.
+#----------------------------------------------------------------------
+
+import wx
+
+
+class MyFrame(wx.Frame):
+    """
+    This is MyFrame.  It just shows a few controls on a wxPanel,
+    and has a simple menu.
+    """
+    def __init__(self, parent, title):
+        wx.Frame.__init__(self, parent, -1, title,
+                          pos=(150, 150), size=(350, 200))
+
+        # Create the menubar
+        menuBar = wx.MenuBar()
+
+        # and a menu 
+        menu = wx.Menu()
+
+        # add an item to the menu, using \tKeyName automatically
+        # creates an accelerator, the third param is some help text
+        # that will show up in the statusbar
+        menu.Append(wx.ID_EXIT, "E&xit\tAlt-X", "Exit this simple sample")
+
+        # bind the menu event to an event handler
+        self.Bind(wx.EVT_MENU, self.OnTimeToClose, id=wx.ID_EXIT)
+
+        # and put the menu on the menubar
+        menuBar.Append(menu, "&File")
+        self.SetMenuBar(menuBar)
+
+        self.CreateStatusBar()
+        
+
+        # Now create the Panel to put the other controls on.
+        panel = wx.Panel(self)
+
+        # and a few controls
+        text = wx.StaticText(panel, -1, "Hello World!")
+        text.SetFont(wx.Font(14, wx.SWISS, wx.NORMAL, wx.BOLD))
+        text.SetSize(text.GetBestSize())
+        btn = wx.Button(panel, -1, "Close")
+        funbtn = wx.Button(panel, -1, "Just for fun...")
+
+        # bind the button events to handlers
+        self.Bind(wx.EVT_BUTTON, self.OnTimeToClose, btn)
+        self.Bind(wx.EVT_BUTTON, self.OnFunButton, funbtn)
+
+        # Use a sizer to layout the controls, stacked vertically and with
+        # a 10 pixel border around each
+        sizer = wx.BoxSizer(wx.VERTICAL)
+        sizer.Add(text, 0, wx.ALL, 10)
+        sizer.Add(btn, 0, wx.ALL, 10)
+        sizer.Add(funbtn, 0, wx.ALL, 10)
+        panel.SetSizer(sizer)
+        panel.Layout()
+
+
+    def OnTimeToClose(self, evt):
+        """Event handler for the button click."""
+        print "See ya later!"
+        self.Close()
+
+    def OnFunButton(self, evt):
+        """Event handler for the button click."""
+        print "Having fun yet?"
+
+
+class MyApp(wx.App):
+    def OnInit(self):
+        frame = MyFrame(None, "Simple wxPython App")
+        self.SetTopWindow(frame)
+
+        print "Print statements go to this stdout window by default."
+
+        frame.Show(True)
+        return True
+        
+app = MyApp(redirect=True)
+app.MainLoop()
+
+
+
- -