CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Attributes
Vispa.Main.VispaPlugin.VispaPlugin Class Reference
Inheritance diagram for Vispa.Main.VispaPlugin.VispaPlugin:
Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin Vispa.Plugins.ConfigEditor.ConfigEditorPlugin.ConfigEditorPlugin Vispa.Plugins.EventBrowser.EventBrowserPlugin.EventBrowserPlugin Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin

Public Member Functions

def __init__
 
def addNewFileAction
 
def application
 
def filetypes
 
def getNewFileActions
 
def openFile
 
def registerFiletype
 
def registerFiletypesFromTabController
 
def shutdown
 

Private Attributes

 _application
 
 _createNewFileActions
 
 _filetypes
 

Detailed Description

Interface for all VispaPlugins

Definition at line 7 of file VispaPlugin.py.

Constructor & Destructor Documentation

def Vispa.Main.VispaPlugin.VispaPlugin.__init__ (   self,
  application = None 
)

Definition at line 10 of file VispaPlugin.py.

10 
11  def __init__(self, application = None):
12  QObject.__init__(self, application)
13  self._application = application
14 
15  self._createNewFileActions = []
16  self._filetypes = []

Member Function Documentation

def Vispa.Main.VispaPlugin.VispaPlugin.addNewFileAction (   self,
  label,
  slot = None 
) 
Creates a new file action with label and optionally with a callable slot set and appends it to local new file actions list.

Definition at line 50 of file VispaPlugin.py.

Referenced by Vispa.Plugins.ConfigEditor.ConfigEditorPlugin.ConfigEditorPlugin.__init__().

50 
51  def addNewFileAction(self, label, slot=None):
52  """Creates a new file action with label and optionally with a callable slot set and appends it to local new file actions list. """
53  self._createNewFileActions.append(self._application.createAction(label, slot,image='filenew'))
def Vispa.Main.VispaPlugin.VispaPlugin.application (   self) 
Returns application object.

Definition at line 17 of file VispaPlugin.py.

References Vispa.Main.AboutDialog.AboutDialog._application, Vispa.Main.VispaPlugin.VispaPlugin._application, and Vispa.Main.MainWindow.MainWindow._application.

Referenced by Vispa.Plugins.ConfigEditor.ConfigEditorPlugin.ConfigEditorPlugin.__init__(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin._collapseAll(), Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin._eventContent(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin._expandAll(), Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin._expandToDepth(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin._expandToDepth(), Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin._filterBranches(), Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin._hideUnderscoreProperties(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin._showBoxContentDialog(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin.addCenterView(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin.filterDialog(), Vispa.Plugins.EventBrowser.EventBrowserPlugin.EventBrowserPlugin.first(), Vispa.Plugins.EventBrowser.EventBrowserPlugin.EventBrowserPlugin.goto(), Vispa.Plugins.EventBrowser.EventBrowserPlugin.EventBrowserPlugin.last(), Vispa.Plugins.ConfigEditor.ConfigEditorPlugin.ConfigEditorPlugin.newFile(), Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin.newTab(), Vispa.Plugins.ConfigEditor.ConfigEditorPlugin.ConfigEditorPlugin.newTab(), Vispa.Plugins.EventBrowser.EventBrowserPlugin.EventBrowserPlugin.next(), Vispa.Main.VispaPlugin.VispaPlugin.openFile(), Vispa.Plugins.EventBrowser.EventBrowserPlugin.EventBrowserPlugin.previous(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin.saveImage(), Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin.switchCenterViewSlot(), and Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin.zoomDialog().

17 
18  def application(self):
19  """ Returns application object.
20  """
21  return self._application
def Vispa.Main.VispaPlugin.VispaPlugin.filetypes (   self) 
Returns local list of Filetype objects.

Definition at line 29 of file VispaPlugin.py.

References Vispa.Main.VispaPlugin.VispaPlugin._filetypes.

Referenced by Vispa.Plugins.Browser.BrowserPlugin.BrowserPlugin.openFile().

29 
30  def filetypes(self):
31  """ Returns local list of Filetype objects.
32  """
33  return self._filetypes
def Vispa.Main.VispaPlugin.VispaPlugin.getNewFileActions (   self) 
Returns local list of new file actions.

Definition at line 54 of file VispaPlugin.py.

References Vispa.Main.VispaPlugin.VispaPlugin._createNewFileActions.

54 
55  def getNewFileActions(self):
56  """ Returns local list of new file actions.
57  """
58  return self._createNewFileActions
def Vispa.Main.VispaPlugin.VispaPlugin.openFile (   self,
  filename 
) 
This function has to be implemented by each plugin which can open files.

On success it should return True

Definition at line 41 of file VispaPlugin.py.

References Vispa.Main.VispaPlugin.VispaPlugin.application(), and Vispa.Main.MainWindow.MainWindow.application().

41 
42  def openFile(self, filename):
43  """This function has to be implemented by each plugin which can open files.
44 
45  On success it should return True
46  """
47  logging.warning('VispaPlugin: openFile() method not implemented by '+ self.__class__.__name__ +'.')
48  self.application().statusBar().showMessage('Opening of desired file type not implemented.', 10000)
49  return False
def Vispa.Main.VispaPlugin.VispaPlugin.registerFiletype (   self,
  ext,
  description 
) 
Registers Filetype object for given extension with description.

Description will be shown in open and save dialogs.

Definition at line 22 of file VispaPlugin.py.

Referenced by Vispa.Main.VispaPlugin.VispaPlugin.registerFiletypesFromTabController().

22 
23  def registerFiletype(self, ext, description):
24  """ Registers Filetype object for given extension with description.
25 
26  Description will be shown in open and save dialogs.
27  """
28  self._filetypes.append(Filetype(ext,description))
def Vispa.Main.VispaPlugin.VispaPlugin.registerFiletypesFromTabController (   self,
  TabControllerClass 
) 
Adds supported file types from TabControllerClass.

Evaluates the static function staticSupportedFileTypes() of class TabControllerClass.

Definition at line 34 of file VispaPlugin.py.

References Vispa.Main.VispaPlugin.VispaPlugin.registerFiletype().

Referenced by Vispa.Plugins.EdmBrowser.EdmBrowserPlugin.EdmBrowserPlugin.__init__(), and Vispa.Plugins.ConfigEditor.ConfigEditorPlugin.ConfigEditorPlugin.__init__().

34 
35  def registerFiletypesFromTabController(self, TabControllerClass):
36  """Adds supported file types from TabControllerClass.
37 
38  Evaluates the static function staticSupportedFileTypes() of class TabControllerClass."""
39  for (ext, description) in TabControllerClass.staticSupportedFileTypes():
40  self.registerFiletype(ext, description)
def Vispa.Main.VispaPlugin.VispaPlugin.shutdown (   self) 
Cleanup actions for the plugins

Definition at line 59 of file VispaPlugin.py.

59 
60  def shutdown(self):
61  """ Cleanup actions for the plugins
62  """
63  pass

Member Data Documentation

Vispa.Main.VispaPlugin.VispaPlugin._application
private

Definition at line 12 of file VispaPlugin.py.

Referenced by Vispa.Main.VispaPlugin.VispaPlugin.application().

Vispa.Main.VispaPlugin.VispaPlugin._createNewFileActions
private

Definition at line 14 of file VispaPlugin.py.

Referenced by Vispa.Main.VispaPlugin.VispaPlugin.getNewFileActions().

Vispa.Main.VispaPlugin.VispaPlugin._filetypes
private

Definition at line 15 of file VispaPlugin.py.

Referenced by Vispa.Main.VispaPlugin.VispaPlugin.filetypes().

Generated for CMSSW Reference Manual by doxygen 1.8.5