Module omix.api
Package omix.plugin

Interface AbstractAccessManager

All Known Subinterfaces:
ApplicationAccessManager, DocumentAccessManager
public interface AbstractAccessManager
This interface allows to access features of the Omix Plugin Interface as super type of ApplicationAccessManager and DocumentAccessManager.
Since:
Omix 2.0.0
Author:
Dr. Peter Droste, Omix Visualization

  • Method Details

    • addMenuItem

      void addMenuItem​(QAction action)
      Adds an action to the extras menu of Omix. equals: addMenuItem(action, PluginMenuItemType.Default)
      Parameters:
      action -

    • removeMenuItem

      void removeMenuItem​(QAction action)
      Removes the action from the menubar.
      Parameters:
      action -

    • addMenuItem

      void addMenuItem​(QAction action, PluginMenuItemType type)
      Adds an action to the menubar of Omix according to the PluginMenuItemType parameter.
      Parameters:
      action -
      type - in which menu the new item shall be inserted

    • addToolBarAction

      void addToolBarAction​(QAction action)
      Adds an action to the plugin toolbar of Omix. The same as addToolBarAction(QAction, PluginToolbarItemType.Default)
      Parameters:
      action -

    • addToolBarAction

      void addToolBarAction​(QAction action, PluginToolbarItemType type)
      Adds an action to the plugin toolbar of Omix according to the PluginToolbarItemType parameter.
      Parameters:
      action -
      type - on which toolbar the new item shall be inserted

    • removeToolBarAction

      void removeToolBarAction​(QAction action)
      Removes the action from the plugin toolbar.
      Parameters:
      action -

    • addMenu

      void addMenu​(QMenu menu)
      Adds a menu to the menubar of Omix.
      Parameters:
      menu -

    • removeMenu

      void removeMenu​(QMenu menu)
      Removes the menu from the menubar of Omix.
      Parameters:
      menu -

    • addToolBar

      void addToolBar​(QToolBar toolbar)
      Adds a toolbar to the mainwindow.
      Parameters:
      toolbar -

    • addToolBar

      void addToolBar​(QToolBar toolbar, Qt.ToolBarArea preferredToolBarArea)
      Adds a toolbar to the mainwindow.
      Parameters:
      toolbar -
      preferredToolBarArea - the preferred ToolBarArea to be used.

    • removeToolBar

      void removeToolBar​(QToolBar toolbar)
      Removes the toolbar from the mainwindow.
      Parameters:
      toolbar -

    • addDockWidget

      void addDockWidget​(QDockWidget dockWidget)
      Adds a dock widget to the Omix mainwindow.
      Parameters:
      dockWidget -

    • addDockWidget

      void addDockWidget​(QDockWidget dockWidget, Qt.DockWidgetArea preferredDockWidgetArea)
      Adds a dock widget to the Omix mainwindow.
      Parameters:
      preferredDockWidgetArea - the preferred DockWidgetArea to be used.
      dockWidget -

    • removeDockWidget

      void removeDockWidget​(QDockWidget dockWidget)
      Removes the dock widget to the Omix mainwindow.
      Parameters:
      dockWidget -

    • parentWidget

      QWidget parentWidget()
      A parent widget important to create modal dialog windows.
      For instance:
      QDialog dialog = new QDialog(parentWidget());
      dialog.show();
      Returns:
      parent widget

    • message

      void message​(String title, String message, String detail, MessageType messageType)
      Shows a message from the plugin. The MessageType parameter specifies the way, the message and detail text is displayed.
      Parameters:
      title - of the dialog window (not necessary for MessageType.STATUSBAR)
      message - text
      detail - text (not necessary for MessageType.STATUSBAR)
      messageType -

    • requestExportImageProcedure

      void requestExportImageProcedure​(String dialogtitle, QSizeF size, ImageRenderer exportImageProcedure)
      This method allows a plug-in to ask for an image export procedure. Here, the plug-in can use all installed image export filters even of other plug-ins.
      Parameters:
      dialogtitle - Title of the image export dialog.
      size - 1:1 size of the image.
      exportImageProcedure - The export executing object.
      Since:
      Omix 1.4.20

    • authenticator

      Authenticator authenticator()
      An authenticator asking the user for passwords.
      Returns:
      authenticator

    • settings

      Settings settings()
      Omix settings.
      Returns:
      Omix settings

    • newOVLCompiler

      OVLCompiler newOVLCompiler()
      Returns a new instance of OVL compiler allowing to compile OVL code to executable OVLPrograms.
      Returns:
      ovl compiler
      Since:
      Omix 1.9.0

    • vodObjectFactory

      VoDObjectFactory vodObjectFactory()
      returns a factory for Visualization On Demand Objects
      Returns:
      VoDObjectFactory
      Since:
      Omix 1.9.0

    • getPublicIdentifierManager

      PublicIdentifierManager getPublicIdentifierManager()
      Returns the manager for public model identifiers.
      Returns:
      PublicIdentifierManager
      Since:
      Omix 1.9.0

    • httpProxy

      Proxy httpProxy()
      HTTP proxy
      Returns:
      HTTP Proxy if available. null otherwise.

    • getPluginLicense

      LicenseKey getPluginLicense()
      Returns the license key of the plugin.
      Returns:
      license
      Since:
      Omix 1.5.22

    • editValue

      <T> T editValue​(T value, Class<T> cls, boolean allowNullValue, String windowTitle, String message) throws SilentAbort
      Causes a dialog to appear for editing the given value type.
      Parameters:
      value -
      cls - class of the value
      allowNullValue - true if value may also be null
      windowTitle -
      message -
      Returns:
      the edited value
      Throws:
      SilentAbort - if procedure was canceled by user.
      Since:
      Omix 1.9.0