Phoenix Logo

phoenix_title wx.lib.pydocview.DocTabbedParentFrame

The DocTabbedParentFrame class provides a default top-level frame for applications using the document/view framework. This class can only be used for MDI parent frames that use a tabbed interface.

It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate classes.


class_hierarchy Class Hierarchy

Inheritance diagram for class DocTabbedParentFrame:


method_summary Methods Summary

__init__ Constructor. Note that the event table must be rebuilt for the
ActivateNotebookPage Sets the notebook to the specified panel.
AddNotebookPage Adds a document page to the notebook.
CreateNotebook Creates the notebook to use for the tabbed document interface.
GetActiveChild Returns the active notebook page, which to the framework is treated as
GetNotebook Returns the notebook used by the tabbed document interface.
GetNotebookPageIndex Returns the index of particular notebook panel.
GetNotebookPageTitle  
OnCloseWindow Called when the frame is closed. Remembers the frame size.
OnExit Called when File/Exit is chosen and closes the window.
OnMRUFile Opens the appropriate file when it is selected from the file history
OnNotebookMiddleClick Handles middle clicks for the notebook, closing the document whose tab was
OnNotebookMouseOver  
OnNotebookPageChanged Activates a notebook page’s view when it is selected.
OnNotebookRightClick Handles right clicks for the notebook, enabling users to either close
OnSize Called when the frame is resized and lays out the client window.
ProcessEvent Processes an event, searching event tables and calling zero or more
ProcessUpdateUIEvent Processes a UI event, searching event tables and calling zero or more
RemoveNotebookPage Removes a document page from the notebook.
SetNotebookPageTitle  

api Class API



class DocTabbedParentFrame(wx.Frame, DocFrameMixIn, DocMDIParentFrameMixIn)

The DocTabbedParentFrame class provides a default top-level frame for applications using the document/view framework. This class can only be used for MDI parent frames that use a tabbed interface.

It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate classes.


Methods



__init__(self, docManager, frame, id, title, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.DEFAULT_FRAME_STYLE, name = "DocTabbedParentFrame", embeddedWindows = 0, minSize=20)

Constructor. Note that the event table must be rebuilt for the frame since the EvtHandler is not virtual.



ActivateNotebookPage(self, panel)

Sets the notebook to the specified panel.



AddNotebookPage(self, panel, title)

Adds a document page to the notebook.



CreateNotebook(self)

Creates the notebook to use for the tabbed document interface.



GetActiveChild(self)

Returns the active notebook page, which to the framework is treated as a document frame.



GetNotebook(self)

Returns the notebook used by the tabbed document interface.



GetNotebookPageIndex(self, panel)

Returns the index of particular notebook panel.



GetNotebookPageTitle(self, panel)


OnCloseWindow(self, event)

Called when the frame is closed. Remembers the frame size.



OnExit(self, event)

Called when File/Exit is chosen and closes the window.



OnMRUFile(self, event)

Opens the appropriate file when it is selected from the file history menu.



OnNotebookMiddleClick(self, event)

Handles middle clicks for the notebook, closing the document whose tab was clicked on.



OnNotebookMouseOver(self, event)


OnNotebookPageChanged(self, event)

Activates a notebook page’s view when it is selected.



OnNotebookRightClick(self, event)

Handles right clicks for the notebook, enabling users to either close a tab or select from the available documents if the user clicks on the notebook’s white space.



OnSize(self, event)

Called when the frame is resized and lays out the client window.



ProcessEvent(self, event)

Processes an event, searching event tables and calling zero or more suitable event handler function(s). Note that the ProcessEvent method is called from the wxPython docview framework directly since wxPython does not have a virtual ProcessEvent function.



ProcessUpdateUIEvent(self, event)

Processes a UI event, searching event tables and calling zero or more suitable event handler function(s). Note that the ProcessEvent method is called from the wxPython docview framework directly since wxPython does not have a virtual ProcessEvent function.



RemoveNotebookPage(self, panel)

Removes a document page from the notebook.



SetNotebookPageTitle(self, panel, title)