Module omix.api
Package omix.plugin.ui

Interface ConfigWidgetInterface

All Known Implementing Classes:
AbstractConfigWidget
public interface ConfigWidgetInterface
This interface can be derived to realize a member widget of the configuration dialog window. The implementing class must additionally be subclass of QWidget.
Since:
Omix 1.3.11
Author:
Dr. Peter Droste, Omix Visualization
See Also:
ConfigWidgetFactory

  • Method Summary

    Modifier and Type Method Description
    default QIcon buttonIcon()
    Tells the configuration dialog the icon displayed on the representing button.
    QPixmap buttonPixmap()
    Tells the configuration dialog the pixmap displayed on the representing button.
    String buttonText()
    Tells the configuration dialog the text displayed on the representing button.
    boolean isRestartRequired()
    This method is called by the configuration window after closing.
    void reinitialize()
    Is called by the configuration window when the reset button is pressed.
    Here, a custom program must reset all displayed settings.

  • Method Details

    • isRestartRequired

      boolean isRestartRequired()
      This method is called by the configuration window after closing. When this widget requests a restart, the user is asked to restart the application.
      Returns:
      restartRequired

    • buttonText

      String buttonText()
      Tells the configuration dialog the text displayed on the representing button.
      Returns:
      text

    • buttonPixmap

      QPixmap buttonPixmap()
      Tells the configuration dialog the pixmap displayed on the representing button.
      Returns:
      pixmap

    • buttonIcon

      default QIcon buttonIcon()
      Tells the configuration dialog the icon displayed on the representing button.
      Returns:
      icon
      Since:
      Omix 1.9.0

    • reinitialize

      void reinitialize()
      Is called by the configuration window when the reset button is pressed.
      Here, a custom program must reset all displayed settings.