A generic class to easily create a dialog widget from a normal one. More...

#include <qsettingsdialogwidget.h>

Inheritance diagram for QSettingsDialogWidget< TSettingsWidget >:

Public Member Functions
	QSettingsDialogWidget (QWidget *parent=nullptr)
	Creates a new dialog widget with a parent.

bool	hasValueChanged () const final
	Will be called to determine, whether the value has changed or not. More...

void	resetValueChanged () final
	Resets the value changed status to unchanged. More...

void	setValue (const QVariant &value) final
	Sets the edit widgets "value".

QVariant	getValue () const final
	Gets the edit widgets "value".

void	resetValue () final
	Resets the edit widgets "value".

bool	searchExpression (const QRegularExpression &regex) final
	Will be called to search for a specific expression inside the edit widget. More...

QString	buttonText () const override
	Returns the text to be shown in the dialog button.

QIcon	buttonIcon () const override
	Returns the icon to be shown in the dialog button.

void	showDialog () final
	Will be called to show the dialog.

Public Member Functions inherited from QSettingsDialogWidgetBase
	QSettingsDialogWidgetBase (QWidget *parent=nullptr)
	Creates a new dialog widget with a parent.

Public Member Functions inherited from QSettingsWidget< QWidget >
	QSettingsWidget (QWidget *parent=nullptr)
	Creates a new widget with a parent.

QWidget *	asWidget () final
	Must return this as QWidget (a cast) More...

void	initialize (const UiPropertyMap &uiPropertyMap) override
	Will be called to initialize the widgets properties with the given ones.

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

WId	winId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *style)

bool	isTopLevel () const

bool	isWindow () const

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *ancestor) const

bool	isEnabledToTLW () const

void	setEnabled (bool)

void	setDisabled (bool disable)

void	setWindowModified (bool)

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

void	setupUi (QWidget *widget)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFixedHeight (int h)

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const

QWidget *	window () const

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole role)

QPalette::ColorRole	backgroundRole () const

void	setForegroundRole (QPalette::ColorRole role)

QPalette::ColorRole	foregroundRole () const

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const

QFontInfo	fontInfo () const

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

QRegion	mask () const

void	clearMask ()

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

QPixmap	grab (const QRect &rectangle)

QGraphicsEffect *	graphicsEffect () const

void	setGraphicsEffect (QGraphicsEffect *effect)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	ungrabGesture (Qt::GestureType gesture)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &role)

QString	windowRole () const

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

void	setToolTip (const QString &)

QString	toolTip () const

void	setToolTipDuration (int msec)

int	toolTipDuration () const

void	setStatusTip (const QString &)

QString	statusTip () const

void	setWhatsThis (const QString &)

QString	whatsThis () const

QString	accessibleName () const

void	setAccessibleName (const QString &name)

QString	accessibleDescription () const

void	setAccessibleDescription (const QString &description)

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

void	setFocus ()

bool	isActiveWindow () const

void	activateWindow ()

void	clearFocus ()

void	setFocus (Qt::FocusReason reason)

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *w)

QWidget *	focusProxy () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

void	releaseMouse ()

void	grabKeyboard ()

void	releaseKeyboard ()

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

void	releaseShortcut (int id)

void	setShortcutEnabled (int id, bool enable)

void	setShortcutAutoRepeat (int id, bool enable)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

QGraphicsProxyWidget *	graphicsProxyWidget () const

void	update ()

void	repaint ()

void	update (int x, int y, int w, int h)

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)

void	show ()

void	hide ()

void	showMinimized ()

void	showMaximized ()

void	showFullScreen ()

void	showNormal ()

bool	close ()

void	raise ()

void	lower ()

void	stackUnder (QWidget *w)

void	move (int x, int y)

void	move (const QPoint &)

void	resize (int w, int h)

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()

bool	isVisible () const

bool	isVisibleTo (const QWidget *ancestor) const

bool	isHidden () const

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const

void	setWindowState (Qt::WindowStates windowState)

virtual QSize	sizeHint () const

virtual QSize	minimumSizeHint () const

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

virtual int	heightForWidth (int w) const

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	getContentsMargins (int left, int top, int right, int bottom) const

QMargins	contentsMargins () const

QRect	contentsRect () const

QLayout *	layout () const

void	setLayout (QLayout *layout)

void	updateGeometry ()

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

QWidget *	focusWidget () const

QWidget *	nextInFocusChain () const

QWidget *	previousInFocusChain () const

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	insertActions (QAction before, QList< QAction > actions)

void	insertAction (QAction before, QAction action)

void	removeAction (QAction *action)

QList< QAction * >	actions () const

QWidget *	parentWidget () const

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const

void	overrideWindowFlags (Qt::WindowFlags flags)

Qt::WindowType	windowType () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

bool	testAttribute (Qt::WidgetAttribute attribute) const

virtual QPaintEngine *	paintEngine () const

void	ensurePolished () const

bool	isAncestorOf (const QWidget *child) const

bool	hasEditFocus () const

void	setEditFocus (bool enable)

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const

void	windowTitleChanged (const QString &title)

void	windowIconChanged (const QIcon &icon)

void	windowIconTextChanged (const QString &iconText)

void	customContextMenuRequested (const QPoint &pos)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual bool	eventFilter (QObject watched, QEvent event)

virtual const QMetaObject *	metaObject () const

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const

bool	blockSignals (bool block)

QThread *	thread () const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

bool	inherits (const char *className) const

void	deleteLater ()

Public Member Functions inherited from QPaintDevice
bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

int	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Public Member Functions inherited from QSettingsWidgetBase
	QSettingsWidgetBase ()
	Constructor.

virtual	~QSettingsWidgetBase ()
	Virtual Destructor.

Additional Inherited Members
Static Public Member Functions inherited from QWidget
void	setTabOrder (QWidget first, QWidget second)

QWidget *	mouseGrabber ()

QWidget *	keyboardGrabber ()

QWidget *	find (WId id)

QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QWidget
typedef	RenderFlags

Protected Member Functions inherited from QSettingsDialogWidgetBase
void	showEvent (QShowEvent *event) final
	Overwritten to load button data when showed.

Protected Member Functions inherited from QWidget
virtual bool	event (QEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	wheelEvent (QWheelEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

virtual void	actionEvent (QActionEvent *event)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	hideEvent (QHideEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	changeEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	initPainter (QPainter *painter) const

virtual void	inputMethodEvent (QInputMethodEvent *event)

void	updateMicroFocus ()

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual bool	focusNextPrevChild (bool next)

bool	focusNextChild ()

bool	focusPreviousChild ()

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Static Protected Member Functions inherited from QSettingsDialogWidgetBase
static void	wrapInDialog (QDialog dialog, QWidget element, bool fixedSize=false)
	Helper to "wrap" any widget inside a dialog.

Properties inherited from QWidget
	modal

	windowModality

	enabled

	geometry

	frameGeometry

	normalGeometry

	x

	y

	pos

	frameSize

	size

	width

	height

	rect

	childrenRect

	childrenRegion

	sizePolicy

	minimumSize

	maximumSize

	minimumWidth

	minimumHeight

	maximumWidth

	maximumHeight

	sizeIncrement

	baseSize

	palette

	font

	cursor

	mouseTracking

	isActiveWindow

	focusPolicy

	focus

	contextMenuPolicy

	updatesEnabled

	visible

	minimized

	maximized

	fullScreen

	sizeHint

	minimumSizeHint

	acceptDrops

	windowTitle

	windowIcon

	windowIconText

	windowOpacity

	windowModified

	toolTip

	toolTipDuration

	statusTip

	whatsThis

	accessibleName

	accessibleDescription

	layoutDirection

	windowFlags

	autoFillBackground

	styleSheet

	locale

	windowFilePath

	inputMethodHints

Properties inherited from QObject
	objectName

Detailed Description

template<typename TSettingsWidget>
class QSettingsDialogWidget< TSettingsWidget >

A generic class to easily create a dialog widget from a normal one.

Template Parameters

TDialog The class to create this dialog for. Must be a QSettingsWidget with a TWidget that inherits from QWidget

You can use this class to simply create a dialog widget by simply implementing a normal QSettingsWidget and using this type for the registration. If your QSettingsWidget inherits QDialog instead of just QWidget, the widget itself will be shown as dialog. If it does not inherit QDialog, the settings dialog widget will create a wrapping QDialog to show the custom widget inside of it.

Simple example. Your custom widget looks like this:

class MyDialog : QSettingsQWidget<QDialog>
{
public:
    MyDialog(QWidget *parent = nullptr);
...
}

To register it as a dialog, simply use the QSettingsDialogWidget for the registration:

QSettingsWidgetDialogEngine *engine = (QSettingsWidgetDialogEngine*)settingsDialog->displayEngine();

engine->addWidgetType<QSettingsDialogWidget<MyDialog>>(424242);

Note: The default implementation of this class uses the dialogs QWidget::windowTitle and QWidget::windowIcon for the button.

Member Function Documentation

template<typename TSettingsWidget >

bool QSettingsDialogWidget< TSettingsWidget >::hasValueChanged ( ) const

inlinefinalvirtual

Will be called to determine, whether the value has changed or not.

Returns: true, if the value has changed since the last reset, false if not

This function will determine whether the data within this edit will be saved or not. Only if it returs true, data will actually be saved. The "changed" is relative to the status from the last QSettingsWidgetBase::resetValueChanged. This means, immediatly after a call to that function, this one should always return false. And only if the current state of the edit is different from the one it had when that funcion was called, true shall be returned

Note: For most edit widgets, the default implementation is sufficient.

Reimplemented from QSettingsWidgetBase.

template<typename TSettingsWidget >

void QSettingsDialogWidget< TSettingsWidget >::resetValueChanged ( )

inlinefinalvirtual

Resets the value changed status to unchanged.

See QSettingsWidgetBase::hasValueChanged.

Note: For most edit widgets, the default implementation is sufficient.

Reimplemented from QSettingsWidgetBase.

template<typename TSettingsWidget >

bool QSettingsDialogWidget< TSettingsWidget >::searchExpression ( const QRegularExpression & regex )

inlinefinalvirtual

Will be called to search for a specific expression inside the edit widget.

Parameters

regex The regular expression to match against

Returns: true, if this edit matches the expression, false if not

Reimplement this function if your edit should be used to help find search entries. The default implementation matches on nothing

Note: If the regex is empty, this function must always return true.

Reimplemented from QSettingsWidgetBase.

The documentation for this class was generated from the following file:

D:/felix/linked/Qworkplace/QSettingsDialog/QSettingsDialog/dialogui/qsettingsdialogwidget.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename TSettingsWidget> class QSettingsDialogWidget< TSettingsWidget >

Member Function Documentation

template<typename TSettingsWidget>
class QSettingsDialogWidget< TSettingsWidget >