=== agw.aui.AuiNotebook ===
{{http://www.blog.pythonlibrary.org/wp-content/uploads/2009/12/agwAuiNotebookDemo.png}}
=== Introduction ===
Andrea Gavana went to the trouble of creating a pure python version of the Advanced User Interface (AUI) that provides perspective saving, floating sub-windows that can be docked, customizable look and feel and the splittable AUI Notebook. His notebook will be the focus of this section. The AGW AUI Notebook has lots of features, but I’m just going to go over some of the basics. If you want to see all the features, be sure to read the code and check out the demo in the official wxPython Demo. As I mentioned at the beginning of this tutorial, be sure to download the [[http://svn.wxwidgets.org/svn/wx/wxPython/3rdParty/AGW/agw/|latest version]] of AUI (or AGW as a whole) from SVN to get all the bug fixes.
Let’s take a look at the simple example I used for the screenshot above:
'''Listing 1'''
{{{#!python
import wx
import wx.lib.agw.aui as aui
########################################################################
class TabPanelOne(wx.Panel):
"""
A simple wx.Panel class
"""
#----------------------------------------------------------------------
def __init__(self, parent):
""""""
wx.Panel.__init__(self, parent=parent, id=wx.ID_ANY)
sizer = wx.BoxSizer(wx.VERTICAL)
txtOne = wx.TextCtrl(self, wx.ID_ANY, "")
txtTwo = wx.TextCtrl(self, wx.ID_ANY, "")
sizer = wx.BoxSizer(wx.VERTICAL)
sizer.Add(txtOne, 0, wx.ALL, 5)
sizer.Add(txtTwo, 0, wx.ALL, 5)
self.SetSizer(sizer)
########################################################################
class DemoFrame(wx.Frame):
"""
wx.Frame class
"""
#----------------------------------------------------------------------
def __init__(self):
wx.Frame.__init__(self, None, wx.ID_ANY,
"AGW AUI Notebook Tutorial",
size=(600,400))
self._mgr = aui.AuiManager()
# tell AuiManager to manage this frame
self._mgr.SetManagedWindow(self)
notebook = aui.AuiNotebook(self)
panelOne = TabPanelOne(notebook)
panelTwo = TabPanelOne(notebook)
notebook.AddPage(panelOne, "PanelOne", False)
notebook.AddPage(panelTwo, "PanelTwo", False)
self._mgr.AddPane(notebook,
aui.AuiPaneInfo().Name("notebook_content").
CenterPane().PaneBorder(False))
self._mgr.Update()
#notebook.EnableTab(1, False)
#----------------------------------------------------------------------
# Run the program
if __name__ == "__main__":
app = wx.PySimpleApp()
frame = DemoFrame()
frame.Show()
app.MainLoop()
}}}
The first difference between this notebook and the original !AuiNotebook is that this one requires an !AuiManager object. It may be that something similar is behind the original as well, but that’s hidden from us. Anyway, the first step is instantiating the !AuiManager and then giving it the frame to manage via its !SetManagedWindow() method. Now we can add the AUI Notebook. Note that we pass the frame as the parent of the notebook instead of the !AuiManager. I think the reason is that when the !AuiManager is given the frame, it becomes the top level window.
The next part of the equation should look familiar: !AddPage(). Let’s see what it accepts:
{{{#!python
AddPage(self, page, caption, select=False,
bitmap=wx.NullBitmap,
disabled_bitmap=wx.NullBitmap,
control=None)
}}}
In my code, I only pass in the first three parameters, but you can also add a couple bitmaps and a wx.Window for the control. The next bit is a little tricky. We need to call the !AuiManager’s !AddPane() method to tell the !AuiManager that we want it to “manage” something (in this case, the notebook). We also pass in a second argument which looks kind of confusing:
{{{#!python
self.aui_mgr.AddPane(self.notebook,
aui.AuiPaneInfo().Name("notebook_content").
CenterPane().PaneBorder(False))
}}}
This line of code tells the !AuiManager what to do with the notebook. In this case, we are telling it that the pane’s (i.e the notebook’s) name is “notebook_content”, which is what we use to look up the pane. We’re also telling the !AuiManager that we want the pane to be in the centered dock position and the !PaneBorder(False) command tells the !AuiManager that we want a hidden border drawn around the notebook pane.
=== Changing a Few AuiNotebook Settings ===
Our next example will be more complex and will show you how to change a few notebook settings (and yes, it's a doozy!).
'''Listing 2''' [[attachment:AuiNotebook_Demo_2.py]]
{{{#!python
import wx
import wx.lib.agw.aui as aui
ID_NotebookArtGloss = 0
ID_NotebookArtSimple = 1
ID_NotebookArtVC71 = 2
ID_NotebookArtFF2 = 3
ID_NotebookArtVC8 = 4
ID_NotebookArtChrome = 5
########################################################################
class TabPanelOne(wx.Panel):
"""
A simple wx.Panel class
"""
#----------------------------------------------------------------------
def __init__(self, parent):
""""""
wx.Panel.__init__(self, parent=parent, id=wx.ID_ANY)
izer = wx.BoxSizer(wx.VERTICAL)
txtOne = wx.TextCtrl(self, wx.ID_ANY, "")
txtTwo = wx.TextCtrl(self, wx.ID_ANY, "")
sizer = wx.BoxSizer(wx.VERTICAL)
sizer.Add(txtOne, 0, wx.ALL, 5)
sizer.Add(txtTwo, 0, wx.ALL, 5)
self.SetSizer(sizer)
########################################################################
class AUIManager(aui.AuiManager):
"""
AUI Manager class
"""
#----------------------------------------------------------------------
def __init__(self, managed_window):
"""Constructor"""
aui.AuiManager.__init__(self)
self.SetManagedWindow(managed_window)
########################################################################
class AUINotebook(aui.AuiNotebook):
"""
AUI Notebook class
"""
#----------------------------------------------------------------------
def __init__(self, parent):
"""Constructor"""
aui.AuiNotebook.__init__(self, parent=parent)
self.default_style = aui.AUI_NB_DEFAULT_STYLE | aui.AUI_NB_TAB_EXTERNAL_MOVE | wx.NO_BORDER
self.SetWindowStyleFlag(self.default_style)
# add some pages to the notebook
pages = [TabPanel, TabPanel, TabPanel]
x = 1
for page in pages:
label = "Tab #%i" % x
tab = page(self)
self.AddPage(tab, label, False)
x += 1
########################################################################
class DemoFrame(wx.Frame):
"""
wx.Frame class
"""
#----------------------------------------------------------------------
def __init__(self):
"""Constructor"""
title = "AGW AUI Notebook Feature Tutorial"
wx.Frame.__init__(self, None, wx.ID_ANY,
title=title, size=(600,400))
self.themeDict = {"Glossy Theme (Default)":0,
"Simple Theme":1,
"VC71 Theme":2,
"Firefox 2 Theme":3,
"VC8 Theme":4,
"Chrome Theme":5,
}
# create the AUI manager
self.aui_mgr = AUIManager(self)
# create the AUI Notebook
self.notebook = AUINotebook(self)
self._notebook_style = self.notebook.default_style
# add notebook to AUI manager
self.aui_mgr.AddPane(self.notebook,
aui.AuiPaneInfo().Name("notebook_content").
CenterPane().PaneBorder(False))
self.aui_mgr.Update()
# create menu and tool bars
self.createMenu()
self.createTB()
#----------------------------------------------------------------------
def createMenu(self):
"""
Create the menu
"""
def doBind(item, handler):
""" Create menu events. """
self.Bind(wx.EVT_MENU, handler, item)
menubar = wx.MenuBar()
fileMenu = wx.Menu()
doBind( fileMenu.Append(wx.ID_ANY, "&Exit\tAlt+F4",
"Exit Program"),self.onExit)
optionsMenu = wx.Menu()
doBind( optionsMenu.Append(wx.ID_ANY,
"Disable Current Tab"),
self.onDisableTab)
# add the menus to the menubar
menubar.Append(fileMenu, "File")
menubar.Append(optionsMenu, "Options")
self.SetMenuBar(menubar)
#----------------------------------------------------------------------
def createTB(self):
"""
Create the toolbar
"""
TBFLAGS = ( wx.TB_HORIZONTAL
| wx.NO_BORDER
| wx.TB_FLAT )
tb = self.CreateToolBar(TBFLAGS)
keys = self.themeDict.keys()
keys.sort()
choices = keys
cb = wx.ComboBox(tb, wx.ID_ANY, "Glossy Theme (Default)",
choices=choices,
size=wx.DefaultSize,
style=wx.CB_DROPDOWN)
cb.Bind(wx.EVT_COMBOBOX, self.onChangeTheme)
tb.AddControl(cb)
tb.AddSeparator()
self.closeChoices = ["No Close Button", "Close Button At Right",
"Close Button On All Tabs",
"Close Button On Active Tab"]
cb = wx.ComboBox(tb, wx.ID_ANY,
self.closeChoices[3],
choices=self.closeChoices,
size=wx.DefaultSize,
style=wx.CB_DROPDOWN)
cb.Bind(wx.EVT_COMBOBOX, self.onChangeTabClose)
tb.AddControl(cb)
tb.Realize()
#----------------------------------------------------------------------
def onChangeTabClose(self, event):
"""
Change how the close button behaves on a tab
Note: Based partially on the agw AUI demo
"""
choice = event.GetString()
self._notebook_style &= ~(aui.AUI_NB_CLOSE_BUTTON |
aui.AUI_NB_CLOSE_ON_ACTIVE_TAB |
aui.AUI_NB_CLOSE_ON_ALL_TABS)
# note that this close button doesn't work for some reason
if choice == "Close Button At Right":
self._notebook_style ^= aui.AUI_NB_CLOSE_BUTTON
elif choice == "Close Button On All Tabs":
self._notebook_style ^= aui.AUI_NB_CLOSE_ON_ALL_TABS
elif choice == "Close Button On Active Tab":
self._notebook_style ^= aui.AUI_NB_CLOSE_ON_ACTIVE_TAB
self.notebook.SetWindowStyleFlag(self._notebook_style)
self.notebook.Refresh()
self.notebook.Update()
#----------------------------------------------------------------------
def onChangeTheme(self, event):
"""
Changes the notebook's theme
Note: Based partially on the agw AUI demo
"""
print event.GetString()
evId = self.themeDict[event.GetString()]
print evId
all_panes = self.aui_mgr.GetAllPanes()
for pane in all_panes:
if isinstance(pane.window, aui.AuiNotebook):
nb = pane.window
if evId == ID_NotebookArtGloss:
nb.SetArtProvider(aui.AuiDefaultTabArt())
self._notebook_theme = 0
elif evId == ID_NotebookArtSimple:
nb.SetArtProvider(aui.AuiSimpleTabArt())
self._notebook_theme = 1
elif evId == ID_NotebookArtVC71:
nb.SetArtProvider(aui.VC71TabArt())
self._notebook_theme = 2
elif evId == ID_NotebookArtFF2:
nb.SetArtProvider(aui.FF2TabArt())
self._notebook_theme = 3
elif evId == ID_NotebookArtVC8:
nb.SetArtProvider(aui.VC8TabArt())
self._notebook_theme = 4
elif evId == ID_NotebookArtChrome:
nb.SetArtProvider(aui.ChromeTabArt())
self._notebook_theme = 5
#nb.SetWindowStyleFlag(self._notebook_style)
nb.Refresh()
nb.Update()
#----------------------------------------------------------------------
def onDisableTab(self, event):
"""
Disables the current tab
"""
page = self.notebook.GetCurrentPage()
page_idx = self.notebook.GetPageIndex(page)
self.notebook.EnableTab(page_idx, False)
self.notebook.AdvanceSelection()
#----------------------------------------------------------------------
def onExit(self, event):
"""
Close the demo
"""
self.Close()
#----------------------------------------------------------------------
if __name__ == "__main__":
app = wx.PySimpleApp()
frame = DemoFrame()
frame.Show()
app.MainLoop()
}}}
For this demo, I decided to try subclassing !AuiManager and the aui.!AuiNotebook. While I think this could be helpful if you ever needed to instantiate multiple !AuiManager instances, for the purposes of this demo, it really didn’t help much other than showing you how to do it. Let’s unpack this example bit by bit and see how it works!
In the !AuiManager class, I force the programmer to pass in the window to be managed and it calls the !SetManagedWindow() automatically. You could do this with some of !AuiManager’s other functions as well. In the !AuiNotebook’s case, I set a default style using its !SetWindowStyleFlag() method and then I add some pages to the notebook. This gives me a quick and easy way to create multiple notebooks quickly.
The !DemoFrame does the bulk of the work. It creates a theme dictionary for later use, instantiates the !AuiManager and !AuiNotebook, and creates a toolbar and menubar. Our focus will be the event handlers related to the menubar and the toolbar as they affect the way the !AuiNotebook functions. Our first method of interest is onChangeTabClose().
'''Listing 3 - Messing with the Close Button Position'''
{{{#!python
def onChangeTabClose(self, event):
"""
Change how the close button behaves on a tab
Note: Based partially on the agw AUI demo
"""
choice = event.GetString()
self._notebook_style &= ~(aui.AUI_NB_CLOSE_BUTTON |
aui.AUI_NB_CLOSE_ON_ACTIVE_TAB |
aui.AUI_NB_CLOSE_ON_ALL_TABS)
# note that this close button doesn't work for some reason
if choice == "Close Button At Right":
self._notebook_style ^= aui.AUI_NB_CLOSE_BUTTON
elif choice == "Close Button On All Tabs":
self._notebook_style ^= aui.AUI_NB_CLOSE_ON_ALL_TABS
elif choice == "Close Button On Active Tab":
self._notebook_style ^= aui.AUI_NB_CLOSE_ON_ACTIVE_TAB
self.notebook.SetWindowStyleFlag(self._notebook_style)
self.notebook.Refresh()
self.notebook.Update()
}}}
This event handler is invoked from combobox events generated by the second combobox in the toolbar. Its purpose is to decide the placement of the close button on the tabs. First, it grabs the user’s choice by calling “event.!GetString()”. Next it uses some bitwise operators to clear the close button related styles. If I’m reading it correctly, it “ands” the current notebook style with a “notted” multi-”or”. Yes, it’s confusing. To put it simply, it says that the three styles (aui.AUI_NB_CLOSE_BUTTON, aui.AUI_NB_CLOSE_ON_ACTIVE_TAB, aui.AUI_NB_CLOSE_ON_ALL_TABS) will be subtracted from the current notebook style.
Then I use a conditional to decide which style to actually apply to the notebook. Once that’s added to the variable, I use the notebook’s !SetWindowStyleFlag() to apply it and then Refresh and Update the display so the user can see the changes.
Now we turn to changing the notebook’s theme:
'''Listing 4 - Changing the !AuiNotebook's Theme'''
{{{#!python
def onChangeTheme(self, event):
"""
Changes the notebook's theme
Note: Based partially on the agw AUI demo
"""
evId = self.themeDict[event.GetString()]
all_panes = self.aui_mgr.GetAllPanes()
for pane in all_panes:
if isinstance(pane.window, aui.AuiNotebook):
nb = pane.window
if evId == ID_NotebookArtGloss:
nb.SetArtProvider(aui.AuiDefaultTabArt())
elif evId == ID_NotebookArtSimple:
nb.SetArtProvider(aui.AuiSimpleTabArt())
elif evId == ID_NotebookArtVC71:
nb.SetArtProvider(aui.VC71TabArt())
elif evId == ID_NotebookArtFF2:
nb.SetArtProvider(aui.FF2TabArt())
elif evId == ID_NotebookArtVC8:
nb.SetArtProvider(aui.VC8TabArt())
elif evId == ID_NotebookArtChrome:
nb.SetArtProvider(aui.ChromeTabArt())
nb.Refresh()
nb.Update()
}}}
The event handler is called from the first toolbar’s combobox events. It too grabs the user’s choice via event.!GetString() and then uses the string as a key for my theme dictionary. The dictionary returns an integer which is assigned to “evId”. Next, the !AuiManager instance calls !GetAllPanes() to get a list of all the pages in the notebook. Finally, the handler then loops over the pages and uses a nested conditional to change the notebook’s them the call to !SetArtProvider(). To show the changes, we finish by calling the notebook’s Refresh and Update methods.
The last method that I’m going to go over from this demo is “onDisableTab”:
'''Listing 5 - Disabling/Enabling !AuiNotebook Pages'''
{{{#!python
def onDisableTab(self, event):
"""
Disables the current tab
"""
page = self.notebook.GetCurrentPage()
page_idx = self.notebook.GetPageIndex(page)
self.notebook.EnableTab(page_idx, False)
self.notebook.AdvanceSelection()
}}}
This event handler gets fired by a menu event and is a pretty simple piece of code. First, we call the notebook’s !GetCurrentPage() method and then pass the result to the notebook’s !GetPageIndex() method. Now that we have the page index, we can use that to disable it via the notebook’s !EnableTab method. As you can see, by passing False, we disable the page. You can also use the !EnableTab method to re-enable the tab by passing True.
And there you have it. Now you know how to use the basics of this fun widget too. Be sure to check out the real demo too to see the other features of the AGW AuiNotebook!
'''All code was tested on the following:'''
* Windows XP, wxPython 2.8.10.1 (unicode), Python 2.5
* Windows Vista, wxPython 2.8.10.1 (unicode), Python 2.5
=== For Further Information ===
* [[http://xoomer.virgilio.it/infinity77/AGW_Docs/index.html|Official AGW Documentation]]
* [[http://wxpython.org/download.php|Official wxPython Demo]]
''Note: The tutorial on this page is a modified version of the tutorial on my [[http://www.blog.pythonlibrary.org/2009/12/09/the-“book”-controls-of-wxpython-part-2-of-2/|blog]]''