omix.util.ui.AbstractConfigWidget

All Implemented Interfaces:: QPaintDevice, QtObjectInterface, QtSignalBlockerInterface, QtSignalEmitterInterface, QtThreadAffineInterface, ConfigWidgetInterface

public abstract class AbstractConfigWidget
extends QWidget
implements ConfigWidgetInterface

This abstract class can be derived to realize a member widget of the configuration dialog window.

Since:: Omix 1.3.11
Author:: Dr. Peter Droste, Omix Visualization
See Also:: ConfigWidgetFactory

Nested Class Summary

Nested classes/interfaces inherited from class io.qt.widgets.QWidget
QWidget.RenderFlag, QWidget.RenderFlags

Nested classes/interfaces inherited from class io.qt.core.QObject
QObject.MultiSignal, QObject.PrivateSignal0, QObject.PrivateSignal1<A extends Object>, QObject.PrivateSignal2<A extends Object,B extends Object>, QObject.PrivateSignal3<A extends Object,B extends Object,C extends Object>, QObject.PrivateSignal4<A extends Object,B extends Object,C extends Object,D extends Object>, QObject.PrivateSignal5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.PrivateSignal6<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.PrivateSignal7<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.PrivateSignal8<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.PrivateSignal9<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.QDeclarativeConstructor, QObject.Signal0, QObject.Signal1<A extends Object>, QObject.Signal1Default1<A extends Object>, QObject.Signal2<A extends Object,B extends Object>, QObject.Signal2Default1<A extends Object,B extends Object>, QObject.Signal2Default2<A extends Object,B extends Object>, QObject.Signal3<A extends Object,B extends Object,C extends Object>, QObject.Signal3Default1<A extends Object,B extends Object,C extends Object>, QObject.Signal3Default2<A extends Object,B extends Object,C extends Object>, QObject.Signal3Default3<A extends Object,B extends Object,C extends Object>, QObject.Signal4<A extends Object,B extends Object,C extends Object,D extends Object>, QObject.Signal4Default1<A extends Object,B extends Object,C extends Object,D extends Object>, QObject.Signal4Default2<A extends Object,B extends Object,C extends Object,D extends Object>, QObject.Signal4Default3<A extends Object,B extends Object,C extends Object,D extends Object>, QObject.Signal4Default4<A extends Object,B extends Object,C extends Object,D extends Object>, QObject.Signal5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.Signal5Default1<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.Signal5Default2<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.Signal5Default3<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.Signal5Default4<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.Signal5Default5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object>, QObject.Signal6<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal6Default1<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal6Default2<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal6Default3<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal6Default4<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal6Default5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal6Default6<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object>, QObject.Signal7<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default1<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default2<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default3<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default4<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default6<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal7Default7<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object>, QObject.Signal8<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default1<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default2<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default3<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default4<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default6<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default7<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal8Default8<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object>, QObject.Signal9<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default1<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default2<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default3<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default4<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default5<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default6<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default7<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default8<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.Signal9Default9<A extends Object,B extends Object,C extends Object,D extends Object,E extends Object,F extends Object,G extends Object,H extends Object,I extends Object>, QObject.SignalConfiguration

Nested classes/interfaces inherited from class io.qt.QtObject
QtObject.QPrivateConstructor

Nested classes/interfaces inherited from interface io.qt.gui.QPaintDevice
QPaintDevice.Impl, QPaintDevice.MemberAccess, QPaintDevice.PaintDeviceMetric
Field Summary

Fields inherited from class io.qt.widgets.QWidget
customContextMenuRequested, staticMetaObject, windowIconChanged, windowIconTextChanged, windowTitleChanged

Fields inherited from class io.qt.core.QObject
destroyed, objectNameChanged

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractConfigWidget()`	Same as AbstractConfigWidget(null, null)
`protected`	`AbstractConfigWidget(QWidget parent)`	Same as AbstractConfigWidget(parent, null)
`protected`	`AbstractConfigWidget(QWidget parent, Settings settings)`	Sets the parent widget and the settings variable of the config widget.
`protected`	`AbstractConfigWidget(Settings settings)`	Same as AbstractConfigWidget(null, settings)

Method Summary

Modifier and Type	Method	Description
`abstract QPixmap`	`buttonPixmap()`	Tells the configuration dialog the pixmap displayed on the representing button.
`abstract 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.
`boolean`	`isValid()`	can be implemented to check the settings of the page.
`abstract void`	`reinitialize()`	Is called by the configuration window when the reset button is pressed. Here, a custom program must reset all displayed settings.
`void`	`setRestartRequired()`	Called once to request a restart of Omix.
`protected Settings`	`settings()`	protected access to the settings file

Methods inherited from class io.qt.widgets.QWidget

acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, backingStore, baseSize, changeEvent, childAt, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, closeEvent, colorCount, contentsMargins, contentsRect, contextMenuEvent, contextMenuPolicy, createWindowContainer, createWindowContainer, createWindowContainer, createWindowContainer, createWinId, cursor, depth, destroy, destroy, destroy, devicePixelRatio, devicePixelRatioF, devicePixelRatioFScale, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, ensurePolished, enterEvent, event, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grab, grab, grabGesture, grabGesture, grabGesture, grabKeyboard, grabMouse, grabMouse, grabShortcut, grabShortcut, graphicsEffect, graphicsProxyWidget, hasFocus, hasHeightForWidth, hasMouseTracking, hasTabletTracking, height, heightForWidth, heightMM, hide, hideEvent, initPainter, inputMethodEvent, inputMethodHints, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isEnabledToTLW, isFullScreen, isHidden, isLeftToRight, isMaximized, isMinimized, isModal, isRightToLeft, isTopLevel, isVisible, isVisibleTo, isWindow, isWindowModified, keyboardGrabber, keyPressEvent, keyReleaseEvent, layout, layoutDirection, leaveEvent, locale, logicalDpiX, logicalDpiY, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, move, moveEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowFlags, overrideWindowState, overrideWindowState, paintEngine, paintEvent, paintingActive, palette, parentWidget, physicalDpiX, physicalDpiY, pos, previousInFocusChain, raise, rect, redirected, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, render, render, render, render, render, render, render, render, repaint, repaint, repaint, repaint, resize, resize, resizeEvent, restoreGeometry, saveGeometry, screen, scroll, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setBaseSize, setContentsMargins, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedSize, setFixedWidth, setFocus, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGeometry, setGraphicsEffect, setHidden, setInputMethodHints, setInputMethodHints, setLayout, setLayoutDirection, setLocale, setMask, setMask, setMaximumHeight, setMaximumSize, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setParent, setParent, setShortcutAutoRepeat, setShortcutAutoRepeat, setShortcutEnabled, setShortcutEnabled, setSizeIncrement, setSizeIncrement, setSizePolicy, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabletTracking, setTabOrder, setToolTip, setToolTipDuration, setUpdatesEnabled, setVisible, setWhatsThis, setWindowFilePath, setWindowFlag, setWindowFlag, setWindowFlags, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowState, setWindowTitle, sharedPainter, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeHint, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, toolTipDuration, topLevelWidget, toString, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, update, update, update, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, widthMM, window, windowFilePath, windowFlags, windowHandle, windowIcon, windowIconText, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowType, winId, x, y

Methods inherited from class io.qt.core.QObject

blockSignals, childEvent, children, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connectNotify, customEvent, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectNotify, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, eventFilter, findChild, findChild, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, inherits, inherits, installEventFilter, isSignalConnected, isWidgetType, isWindowType, killTimer, metaObject, moveToThread, objectName, parent, property, qt_metacast, receivers, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setParent, setProperty, signalsBlocked, startTimer, startTimer, thread, timerEvent, tr, tr, tr

Methods inherited from class io.qt.QtObject

dispose, equals, isDisposed

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface omix.plugin.ui.ConfigWidgetInterface

buttonIcon

Methods inherited from interface io.qt.QtObjectInterface

dispose, isDisposed

Constructor Details
- AbstractConfigWidget
  
  protected AbstractConfigWidget()
  
  Same as AbstractConfigWidget(null, null)
- AbstractConfigWidget
  
  protected AbstractConfigWidget(QWidget parent)
  
  Same as AbstractConfigWidget(parent, null)
  
  Parameters:
  
  parent -
- AbstractConfigWidget
  
  protected AbstractConfigWidget(Settings settings)
  
  Same as AbstractConfigWidget(null, settings)
  
  Parameters:
  
  settings -
- AbstractConfigWidget
  
  protected AbstractConfigWidget(QWidget parent, Settings settings)
  
  Sets the parent widget and the settings variable of the config widget.
  
  Parameters:
  
  parent -
  
  settings -
Method Details
- settings
  
  protected Settings settings()
  
  protected access to the settings file
  
  Returns:
  
  settings
- isRestartRequired
  
  public final 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.
  
  Specified by:
  
  isRestartRequired in interface ConfigWidgetInterface
  
  Returns:
  
  restartRequired
- setRestartRequired
  
  public final void setRestartRequired()
  
  Called once to request a restart of Omix.
- buttonText
  
  public abstract String buttonText()
  
  Tells the configuration dialog the text displayed on the representing button.
  
  Specified by:
  
  buttonText in interface ConfigWidgetInterface
  
  Returns:
  
  text
- buttonPixmap
  
  public abstract QPixmap buttonPixmap()
  
  Tells the configuration dialog the pixmap displayed on the representing button.
  
  Specified by:
  
  buttonPixmap in interface ConfigWidgetInterface
  
  Returns:
  
  pixmap
- reinitialize
  
  public abstract void reinitialize()
  
  Is called by the configuration window when the reset button is pressed.
  Here, a custom program must reset all displayed settings.
  
  Specified by:
  
  reinitialize in interface ConfigWidgetInterface
- isValid
  
  public boolean isValid()
  
  can be implemented to check the settings of the page. Is called before, the current page is changed or the config dialog is closed. By default, the method simply returns true.
  
  Returns:
  
  when returning false, the page remains.

Class AbstractConfigWidget

Nested Class Summary

Nested classes/interfaces inherited from class io.qt.widgets.QWidget

Nested classes/interfaces inherited from class io.qt.core.QObject

Nested classes/interfaces inherited from class io.qt.QtObject

Nested classes/interfaces inherited from interface io.qt.gui.QPaintDevice

Field Summary

Fields inherited from class io.qt.widgets.QWidget

Fields inherited from class io.qt.core.QObject