wx.lib.pydocview.DocApp¶

The DocApp class serves as the base class for pydocview applications and offers functionality such as services, creation of SDI and MDI frames, show tips, and a splash screen.

Class Hierarchy¶

Inheritance diagram for class DocApp:

Known Superclasses¶

wx.core.App

Methods Summary¶

`CloseChildDocuments`	Closes the child windows of a Document.
`CloseSplash`	Closes the splash window.
`CreateChildDocument`	Creates a child window of a document that edits an object. The child window
`CreateDocumentFrame`	Called by the DocManager to create and return a new Frame for a Document.
`CreateMDIDocumentFrame`	Creates and returns an MDI Document Frame.
`CreateSDIDocumentFrame`	Creates and returns an SDI Document Frame.
`CreateTabbedDocumentFrame`	Creates and returns an MDI Document Frame for a Tabbed MDI view
`DoBackgroundListenAndLoad`	Open any files specified in the given command line argument passed in via shared memory
`GetDebug`	Returns `True` if the application is in debug mode.
`GetDefaultDocManagerFlags`	Returns the default flags to use when creating the DocManager.
`GetDefaultIcon`	Returns the application’s default icon.
`GetDocumentManager`	Returns the document manager associated to the DocApp.
`GetEditMenu`	Utility method that finds the Edit menu within the menubar of a frame.
`GetService`	Returns the instance of a particular type of service that has been installed
`GetServices`	Returns the DocService instances that have been installed into the DocApp.
`GetSingleInstance`	Returns `True` if the application is in single instance mode. Used to determine if multiple instances of the application is allowed to launch.
`GetUseTabbedMDI`	Returns `True` if Windows MDI should use folder tabs instead of child windows.
`InstallService`	Installs an instance of a DocService into the DocApp.
`IsMDI`	Returns `True` if the application is in MDI mode.
`IsSDI`	Returns `True` if the application is in SDI mode.
`MacOpenFile`
`OnCloseChildWindow`	Called when an MDI Child Frame is closed. Calls SaveMDIDocumentFrameMaximizedState to
`OnCloseMainWindow`	Called when the MDI Parent Frame is closed. Remembers whether the MDI Parent Frame is
`OnExit`	Called when the DocApp is exited, enables the installed DocServices to exit
`OnInit`	Initializes the DocApp.
`OpenCommandLineArgs`	Called to open files that have been passed to the application from the
`OpenMainFrame`
`ProcessEvent`	Processes an event, searching event tables and calling zero or more
`ProcessEventBeforeWindows`	Enables services to process an event before the main window has a chance to
`ProcessUpdateUIEvent`	Processes a UI event, searching event tables and calling zero or more
`ProcessUpdateUIEventBeforeWindows`	Enables services to process a UI event before the main window has a chance
`SaveMDIDocumentFrameMaximizedState`	Remember in the config whether the MDI Frame is maximized so that it can be restored
`SetDebug`	Sets the application’s debug mode.
`SetDefaultIcon`	Sets the application’s default icon.
`SetDocumentManager`	Sets the document manager associated with the DocApp and loads the
`SetSingleInstance`	Sets application’s single instance mode.
`SetUseTabbedMDI`	Set to `True` if Windows MDI should use folder tabs instead of child windows.
`ShowSplash`	Shows a splash window with the given image. Input parameter ‘image’ can either be a wx.Bitmap or a filename.
`ShowTip`	Shows the tip window, generally this is called when an application starts.

Class API¶

class DocApp(wx.App)¶