QDialog subclass providing logging, validation, persistence, and button-box management. More...

#include <dialog.h>

Inheritance diagram for Dialog:

Collaboration diagram for Dialog:

Public Slots
virtual void	onPreferencesChanged ()
	Called when application preferences change; override to react.

Signals
void	itemAdded (const EntityMetadata &metadata)
	Emitted after an item is added via this dialog.

void	itemDeleted (const EntityMetadata &metadata)
	Emitted after an item is deleted via this dialog.

void	itemUpdated (const EntityMetadata &metadata)
	Emitted after an item is updated via this dialog.

Public Member Functions
	Dialog (QWidget *parent=nullptr)
	Construct with an optional parent.

	Dialog (const QString &loggingCategory, QWidget *parent=nullptr)
	Construct with a logging category and optional parent.

virtual	~Dialog ()
	Destructor — closes any open log consumer.

bool	persistPosition () const
	Return whether the dialog persists its position between sessions.

void	setPersistPosition (bool value)
	Enable or disable position persistence.

bool	persistSize () const
	Return whether the dialog persists its size between sessions.

void	setPersistSize (bool value)
	Enable or disable size persistence.

bool	restoreToParentScreen () const
	Return whether to restore to the parent screen on show.

void	setRestoreToParentScreen (bool value)
	Enable or disable restore-to-parent-screen behaviour.

Protected Slots
virtual void	enableAppropriateButtons ()
	Update button enabling based on current validity and dirty state.

virtual void	stringChanged (const QString &)
	Trigger validation when a string input changes.

virtual void	intChanged (int)
	Trigger validation when an integer input changes.

virtual void	boolChanged (bool)
	Trigger validation when a boolean input changes.

virtual void	voidChanged ()
	Trigger validation when a parameterless signal fires.

Protected Member Functions
void	performLayout ()
	Perform layout and button-box wiring; call from the subclass constructor.

bool	isValid () const
	Return whether the current form state is valid.

void	setValid (bool value)
	Set the form validity state and update button enabling accordingly.

bool	isDirty () const
	Return whether the form has unsaved changes.

void	setDirty (bool value)
	Set the dirty flag.

bool	formLoadFailed () const
	Return whether the form failed to load.

void	setFormLoadFailed (bool value)
	Set the form load failure flag.

bool	formLoadComplete () const
	Return whether the form has finished loading.

void	setApplyEnabled (bool value)
	Enable or disable the Apply button.

void	setCancelEnabled (bool value)
	Enable or disable the Cancel button.

void	setOkEnabled (bool value)
	Enable or disable the OK button.

void	setStatusBarVisible (bool value)
	Show or hide the status bar.

void	setLogHookEnabled (bool enabled)
	Enable or disable the log consumer hook for this dialog.

void	connectValidationSignals ()
	Connect all child input widget signals to the validation slots.

void	setChildInputWidgetsEnabled (QWidget *widget, bool enabled)
	Enable or disable all input child widgets of a given widget.

QColor	defaultTextColor () const
	Return the default text color from the current palette.

QSize	defaultSize () const
	Return the default dialog size.

void	setDefaultSize (const QSize &value)
	Set the default dialog size.

void	setDefaultSize (int width, int height)
	Set the default dialog size by width and height.

QDialogButtonBox *	buttonBox () const
	Return the dialog button box.

QStatusBar *	statusBar () const
	Return the dialog status bar.

virtual void	validate ()=0
	Implement to validate the form and call setValid()/setDirty().

virtual void	loggedItem (const Log::LogEntry &entry)
	Called when a log entry is delivered (no-op by default).

bool	compare (const QString &a, const QString &b)
	Return true if a != b (used with COMPARE macro).

bool	compare (const QUuid &a, const QUuid &b)
	Return true if a != b (used with COMPARE macro).

bool	compare (const QList< QUuid > &a, const QList< QUuid > &b)
	Return true if a != b (used with COMPARE macro).

bool	compare (const int a, int b)
	Return true if a != b (used with COMPARE macro).

bool	compare (const TimeSpan &a, const TimeSpan &b)
	Return true if a != b (used with COMPARE macro).

virtual void	okClicked ()
	Called when the OK button is clicked (no-op by default).

virtual void	applyClicked ()
	Called when the Apply button is clicked (no-op by default).

virtual void	cancelClicked ()
	Called when the Cancel button is clicked (no-op by default).

virtual void	moveEvent (QMoveEvent *event) override
	Persist position on move.

virtual void	resizeEvent (QResizeEvent *event) override
	Persist size on resize.

virtual void	showEvent (QShowEvent *event) override
	Restore geometry and complete form load on first show.

Detailed Description

QDialog subclass providing logging, validation, persistence, and button-box management.

Dialog wires common input widget signals to validate(), manages OK/Apply/Cancel button enabling, optionally persists window position and size, and provides a built-in QStatusBar. Subclasses must implement validate().

Definition at line 31 of file dialog.h.

Constructor & Destructor Documentation

◆ Dialog()

Dialog::Dialog	(	const QString &	loggingCategory,
		QWidget *	parent = `nullptr`
	)

explicit

Construct with a logging category and optional parent.

Parameters

loggingCategory	Category name used for log output
parent	Optional QWidget parent

Member Function Documentation

◆ applyClicked()

virtual void Dialog::applyClicked ( )

inlineprotectedvirtual

Called when the Apply button is clicked (no-op by default).

Definition at line 231 of file dialog.h.

◆ buttonBox()

QDialogButtonBox * Dialog::buttonBox ( ) const

inlineprotected

Return the dialog button box.

Returns: Pointer to the QDialogButtonBox

Definition at line 200 of file dialog.h.

◆ cancelClicked()

virtual void Dialog::cancelClicked ( )

inlineprotectedvirtual

Called when the Cancel button is clicked (no-op by default).

Definition at line 233 of file dialog.h.