Package wx :: Package lib :: Module pydocview :: Class DocApp
[frames | no frames]

Type DocApp

object --+                    
         |                    
    Object --+                
             |                
    EvtHandler --+            
                 |            
             PyApp --+        
                     |        
                   App --+    
                         |    
               PySimpleApp --+
                             |
                            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.


Method Summary
  CloseChildDocuments(self, parentDocument)
Closes the child windows of a Document.
  CloseSplash(self)
Closes the splash window.
  CreateChildDocument(self, parentDocument, documentType, objectToEdit, path)
Creates a child window of a document that edits an object.
  CreateDocumentFrame(self, view, doc, flags, id, title, pos, size, style)
Called by the DocManager to create and return a new Frame for a Document.
  CreateMDIDocumentFrame(self, doc, view, id, title, pos, size, style)
Creates and returns an MDI Document Frame.
  CreateSDIDocumentFrame(self, doc, view, id, title, pos, size, style)
Creates and returns an SDI Document Frame.
  CreateTabbedDocumentFrame(self, doc, view, id, title, pos, size, style)
Creates and returns an MDI Document Frame for a Tabbed MDI view
  DoBackgroundListenAndLoad(self)
Open any files specified in the given command line argument passed in via shared memory
  GetDebug(self)
Returns True if the application is in debug mode.
  GetDefaultDocManagerFlags(self)
Returns the default flags to use when creating the DocManager.
  GetDefaultIcon(self)
Returns the application's default icon.
  GetDocumentManager(self)
Returns the document manager associated to the DocApp.
  GetEditMenu(self, frame)
Utility method that finds the Edit menu within the menubar of a frame.
  GetService(self, type)
Returns the instance of a particular type of service that has been installed into the DocApp.
  GetServices(self)
Returns the DocService instances that have been installed into the DocApp.
  GetSingleInstance(self)
Returns True if the application is in single instance mode.
  GetUseTabbedMDI(self)
Returns True if Windows MDI should use folder tabs instead of child windows.
  InstallService(self, service)
Installs an instance of a DocService into the DocApp.
  IsMDI(self)
Returns True if the application is in MDI mode.
  IsSDI(self)
Returns True if the application is in SDI mode.
  MacOpenFile(self, filename)
  OnCloseChildWindow(self, event)
Called when an MDI Child Frame is closed.
  OnCloseMainWindow(self, event)
Called when the MDI Parent Frame is closed.
  OnExit(self)
Called when the DocApp is exited, enables the installed DocServices to exit and saves the DocManager's file history.
  OnInit(self)
Initializes the DocApp.
  OpenCommandLineArgs(self)
Called to open files that have been passed to the application from the command line.
  OpenMainFrame(self)
  ProcessEvent(self, event)
Processes an event, searching event tables and calling zero or more suitable event handler function(s).
  ProcessEventBeforeWindows(self, event)
Enables services to process an event before the main window has a chance to process the window.
  ProcessUpdateUIEvent(self, event)
Processes a UI event, searching event tables and calling zero or more suitable event handler function(s).
  ProcessUpdateUIEventBeforeWindows(self, event)
Enables services to process a UI event before the main window has a chance to process the window.
  SaveMDIDocumentFrameMaximizedState(self, maximized)
Remember in the config whether the MDI Frame is maximized so that it can be restored on open.
  SetDebug(self, debug)
Sets the application's debug mode.
  SetDefaultIcon(self, icon)
Sets the application's default icon.
  SetDocumentManager(self, docManager)
Sets the document manager associated with the DocApp and loads the DocApp's file history into the document manager.
  SetSingleInstance(self, singleInstance)
Sets application's single instance mode.
  SetUseTabbedMDI(self, useTabbedMDI)
Set to True if Windows MDI should use folder tabs instead of child windows.
  ShowSplash(self, image)
Shows a splash window with the given image.
  ShowTip(self, frame, tipProvider)
Shows the tip window, generally this is called when an application starts.
    Inherited from PySimpleApp
  __init__(self, redirect, filename, useBestVisual, clearSigInt)
    Inherited from App
  __del__(self, destroy)
  Destroy(self)
  MainLoop(self)
Execute the main GUI event loop
  RedirectStdio(self, filename)
Redirect sys.stdout and sys.stderr to a file or a popup window.
  RestoreStdio(self)
  SetOutputWindowAttributes(self, title, pos, size)
Set the title, position and/or size of the output window if the stdio has been redirected.
  SetTopWindow(self, frame)
Set the "main" top level window
    Inherited from PyApp
  __repr__(self)
bool Dispatch(self)
Process the first event in the event queue (blocks until an event appears if there are none currently)
  Exit(self)
Exit the main loop thus terminating the application.
  ExitMainLoop(self)
Exit the main GUI loop during the next iteration of the main loop, (i.e.
String GetAppName(self)
Get the application name.
int GetAssertMode(self)
Get the current OnAssert behaviour setting.
String GetClassName(self)
Get the application's class name.
int GetComCtl32Version()
Returns 400, 470, 471, etc. (Static method)
bool GetExitOnFrameDelete(self)
Get the current exit behaviour setting.
long GetMacAboutMenuItemId()
(Static method)
long GetMacExitMenuItemId()
(Static method)
String GetMacHelpMenuTitleName()
(Static method)
long GetMacPreferencesMenuItemId()
(Static method)
bool GetMacSupportPCMenuShortcuts()
(Static method)
int GetPrintMode(self)
Window GetTopWindow(self)
Return the main top level window (if it hadn't been set previously with SetTopWindow(), will return just some top level window and, if there not any, will return None)
wxAppTraits GetTraits(self)
Return (and create if necessary) the app traits object to which we delegate for everything which either should be configurable by the user (then he can change the default behaviour simply by overriding CreateTraits() and returning his own traits object) or which is GUI/console dependent as then wx.AppTraits allows us to abstract the differences behind the common facade.
bool GetUseBestVisual(self)
Get current UseBestVisual setting.
String GetVendorName(self)
Get the application's vendor name.
bool IsActive(self)
Return True if our app has focus.
bool IsMainLoopRunning()
Returns True if we're running the main loop, i.e. (Static method)
bool Pending(self)
Returns True if there are unprocessed events in the event queue.
bool ProcessIdle(self)
Called from the MainLoop when the application becomes idle (there are no pending events) and sends a wx.IdleEvent to all interested parties.
  ProcessPendingEvents(self)
Process all events in the Pending Events list -- it is necessary to call this function to process posted events.
bool SendIdleEvents(self, win, event)
Send idle event to window and all subwindows.
  SetAppName(self, name)
Set the application name.
  SetAssertMode(self, mode)
Set the OnAssert behaviour for debug and hybrid builds.The following flags may be or'd together:
  SetClassName(self, name)
Set the application's class name.
  SetExitOnFrameDelete(self, flag)
Control the exit behaviour: by default, the program will exit the main loop (and so, usually, terminate) when the last top-level program window is deleted.
  SetMacAboutMenuItemId(val)
(Static method)
  SetMacExitMenuItemId(val)
(Static method)
  SetMacHelpMenuTitleName(val)
(Static method)
  SetMacPreferencesMenuItemId(val)
(Static method)
  SetMacSupportPCMenuShortcuts(val)
(Static method)
  SetPrintMode(self, mode)
  SetUseBestVisual(self, flag)
Set whether the app should try to use the best available visual on systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
  SetVendorName(self, name)
Set the application's vendor name.
  WakeUpIdle(self)
Make sure that idle events are sent again.
bool Yield(self, onlyIfNeeded)
Process all currently pending events right now, instead of waiting until return to the event loop.
    Inherited from EvtHandler
  AddPendingEvent(self, event)
  Bind(self, event, handler, source, id, id2)
Bind an event to an event handler.
  Connect(self, id, lastId, eventType, func)
bool Disconnect(self, id, lastId, eventType)
bool GetEvtHandlerEnabled(self)
EvtHandler GetNextHandler(self)
EvtHandler GetPreviousHandler(self)
  SetEvtHandlerEnabled(self, enabled)
  SetNextHandler(self, handler)
  SetPreviousHandler(self, handler)
  Unbind(self, event, source, id, id2)
Disconencts the event handler binding for event from self.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Instance Method Details

CloseChildDocuments(self, parentDocument)

Closes the child windows of a Document.

CloseSplash(self)

Closes the splash window.

CreateChildDocument(self, parentDocument, documentType, objectToEdit, path='')

Creates a child window of a document that edits an object. The child window is managed by the parent document frame, so it will be prompted to close if its parent is closed, etc. Child Documents are useful when there are complicated Views of a Document and users will need to tunnel into the View.

CreateDocumentFrame(self, view, doc, flags, id=-1, title='', pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=541072960)

Called by the DocManager to create and return a new Frame for a Document. Chooses whether to create an MDIChildFrame or SDI Frame based on the DocManager's flags.

CreateMDIDocumentFrame(self, doc, view, id=-1, title='', pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=541072960)

Creates and returns an MDI Document Frame.

CreateSDIDocumentFrame(self, doc, view, id=-1, title='', pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=541072960)

Creates and returns an SDI Document Frame.

CreateTabbedDocumentFrame(self, doc, view, id=-1, title='', pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=541072960)

Creates and returns an MDI Document Frame for a Tabbed MDI view

DoBackgroundListenAndLoad(self)

Open any files specified in the given command line argument passed in via shared memory

GetDebug(self)

Returns True if the application is in debug mode.

GetDefaultDocManagerFlags(self)

Returns the default flags to use when creating the DocManager.

GetDefaultIcon(self)

Returns the application's default icon.

GetDocumentManager(self)

Returns the document manager associated to the DocApp.

GetEditMenu(self, frame)

Utility method that finds the Edit menu within the menubar of a frame.

GetService(self, type)

Returns the instance of a particular type of service that has been installed into the DocApp. For example, "wx.GetApp().GetService(pydocview.OptionsService)" returns the isntance of the OptionsService that is running within the DocApp.

GetServices(self)

Returns the DocService instances that have been installed into the DocApp.

GetSingleInstance(self)

Returns True if the application is in single instance mode. Used to determine if multiple instances of the application is allowed to launch.

GetUseTabbedMDI(self)

Returns True if Windows MDI should use folder tabs instead of child windows.

InstallService(self, service)

Installs an instance of a DocService into the DocApp.

IsMDI(self)

Returns True if the application is in MDI mode.

IsSDI(self)

Returns True if the application is in SDI mode.

OnCloseChildWindow(self, event)

Called when an MDI Child Frame is closed. Calls SaveMDIDocumentFrameMaximizedState to remember whether the MDI Frame is maximized so that it can be restored on open.

OnCloseMainWindow(self, event)

Called when the MDI Parent Frame is closed. Remembers whether the MDI Parent Frame is maximized.

OnExit(self)

Called when the DocApp is exited, enables the installed DocServices to exit and saves the DocManager's file history.

OnInit(self)

Initializes the DocApp.

Overrides:
wx.PySimpleApp.OnInit

OpenCommandLineArgs(self)

Called to open files that have been passed to the application from the command line.

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.

Overrides:
wx.EvtHandler.ProcessEvent

ProcessEventBeforeWindows(self, event)

Enables services to process an event before the main window has a chance to process the window.

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.

ProcessUpdateUIEventBeforeWindows(self, event)

Enables services to process a UI event before the main window has a chance to process the window.

SaveMDIDocumentFrameMaximizedState(self, maximized)

Remember in the config whether the MDI Frame is maximized so that it can be restored on open.

SetDebug(self, debug)

Sets the application's debug mode.

SetDefaultIcon(self, icon)

Sets the application's default icon.

SetDocumentManager(self, docManager)

Sets the document manager associated with the DocApp and loads the DocApp's file history into the document manager.

SetSingleInstance(self, singleInstance)

Sets application's single instance mode.

SetUseTabbedMDI(self, useTabbedMDI)

Set to True if Windows MDI should use folder tabs instead of child windows.

ShowSplash(self, image)

Shows a splash window with the given image. Input parameter 'image' can either be a wx.Bitmap or a filename.

ShowTip(self, frame, tipProvider)

Shows the tip window, generally this is called when an application starts. A wx.TipProvider must be passed.


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:49:40 2007 http://epydoc.sf.net