A stacked dialog for guiding a user through a multi-step troubleshooting workflow, presenting yes/no questions, acknowledgments, and loading states. More...

Inheritance diagram for TroubleshootingDialog:

[legend]

Collaboration diagram for TroubleshootingDialog:

[legend]

Public Member Functions
void	requestHideSignal ()
	Signal emitted to request that the dialog be hidden.
Public Member Functions inherited from QCustomStackedWidget
	QCustomStackedWidget (QWidget *parent=nullptr)
	Constructs a stacked widget.
uint04	activeIndex () const
	Returns the index of the currently active (or animating-to) widget.
QWidget *	activeWidget () const
	Returns the currently active (or animating-to) widget.
virtual uint04	addWidget (QWidget *w) override
	Adds a widget as a new page in the stacked widget.
uint04	count () const
	Returns the number of pages in the stacked widget.
uint04	currentIndex () const
	Returns the index of the currently displayed page.
QWidget *	currentWidget () const
	Returns the currently displayed widget.
bool	hasWidget (QWidget *widget) const
	Checks whether the given widget is contained in the stacked widget.
uint04	indexOf (QWidget *widget) const
	Returns the index of the given widget.
void	insertWidget (uint04 index, QWidget *w)
	Inserts a widget at a specific index.
void	moveContent (uint04 from, uint04 to) override
	Moves a child widget from one index to another.
void	removeWidget (QWidget *widget)
	Removes a widget from the stacked widget.
void	removeWidget (QWidget widget, QWidget slide_in)
	Removes a widget and slides to a replacement widget if it was active.
void	setCurrentIndex (uint04 idx)
	Sets the current visible page index without animation.
void	slideInAnimation (enum StackAnimationDirection direction=e_automatic, bool cache_in_image=false) override
	Executes the slide animation between the current and next pages.
void	slideInAnimation (PopupInfo origin_rect, enum StackAnimationDirection direction=e_automatic, bool cache_in_image=false) override
	Executes the slide animation using popup origin information.
void	slideInIdx (uint04 idx, enum StackAnimationDirection direction) override
	Slides to the page at the given index with the specified direction.
void	slideInIdx (uint04 idx, int delay_time=0, enum StackAnimationDirection direction=e_automatic) override
	Slides to the page at the given index with animation.
void	slideInIdx (uint04 idx, PopupInfo origin_rect, int delay_time=0, enum StackAnimationDirection direction=e_automatic) override
	Slides to the page at the given index with animation and popup origin info.
virtual void	slideInNext () override
	Slides to the next page with animation.
virtual void	slideInPrev () override
	Slides to the previous page with animation.
void	slideInWgt (QWidget *widget, enum StackAnimationDirection direction=e_automatic, bool force_slide=false) override
	Slides to a specific widget with animation.
void	swapIndices (uint04 a, uint04 b) override
	Swaps two child widgets at the given indices.
QWidget *	widget (uint04 idx) const
	Returns the widget at the given index.
Public Member Functions inherited from QCustomStackedWidgetBase
void	animationFinished ()
	Signal emitted when a slide animation completes.
QSize	minimumSizeHint () const override
	Returns the minimum recommended size for the stacked widget.
void	setAnimation (enum QEasingCurve::Type animationtype)
	Sets the easing curve type used for slide animations.
virtual void	setCurrentIdx (uint04 current_index)
	Sets the current visible page index without animation.
void	setCustomPixmap (QPixmap *pixmap)
	Sets a custom pixmap to render during slide transitions instead of widget captures.
void	setSpeed (int speed)
	Sets the animation duration in milliseconds for slide transitions.
void	setVerticalMode (bool vertical=true)
	Enables or disables vertical slide animation mode.
void	setWrap (bool wrap)
	Sets whether page navigation wraps around from last to first and vice versa.
QSize	sizeHint () const override
	Returns the recommended size for the stacked widget.

Protected Member Functions
	TroubleshootingDialog (const TranslatedString &title, QWidget *parent=nullptr)
	Constructs a troubleshooting dialog with the given title.
void	setupAck (const TranslatedString &message, const StringView &image, fltp08 image_size_mult, std::function< void()> on_select)
	Adds an acknowledgment page with an image at a custom size.
void	setupAck (const TranslatedString &message, const StringView &image, std::function< void()> on_select)
	Adds an acknowledgment page with an accompanying image.
void	setupAck (const TranslatedString &message, std::function< void()> on_select)
	Adds an acknowledgment page requiring the user to confirm.
void	setupLoading (const TranslatedString &message)
	Adds a loading page with a progress indicator and message.
void	setupLoading (const TranslatedString &message, const StringView &image)
	Adds a loading page with a progress indicator, message, and image.
void	setupYesNo (const TranslatedString &message, const StringView &image, fltp08 image_size_mult, std::function< void()> on_yes, std::function< void()> on_no)
	Adds a yes/no question page with an image at a custom size.
void	setupYesNo (const TranslatedString &message, const StringView &image, std::function< void()> on_yes, std::function< void()> on_no)
	Adds a yes/no question page with an accompanying image.
void	setupYesNo (const TranslatedString &message, std::function< void()> on_yes, std::function< void()> on_no)
	Adds a yes/no question page to the dialog.
Protected Member Functions inherited from QCustomStackedWidgetBase
	QCustomStackedWidgetBase (QWidget *parent=nullptr)
	Constructs the stacked widget base.
uint04	activeIndex () const
	Returns the index of the currently active (or animating-to) widget.
QWidget *	activeWidget () const
	Returns the currently active (or animating-to) widget.
void	animationDoneSlot ()
	Slot called when the slide animation completes to finalize the transition.
double	animationPercent () const
	Returns the current animation interpolation percent.
void	childDestroyedSlot (QObject *widget)
	Slot called when a child widget is destroyed, to remove it from the page list.
uint04	count () const
	Returns the number of pages in the stacked widget.
uint04	currentIndex () const
	Returns the index of the currently displayed page.
QWidget *	currentWidget () const
	Returns the currently displayed widget.
bool	eventFilter (QObject object, QEvent event) override
	Filters events for child widgets to handle layout and visibility changes.
uint04	indexOf (QWidget *widget) const
	Returns the index of the given widget in the stacked widget.
void	insertWidget (uint04 index, QWidget *w)
	Inserts a widget at a specific index in the stacked widget.
void	paintEvent (QPaintEvent *) override
	Custom paint event that renders slide transition animations.
void	removeWidget (QWidget *widget)
	Removes a widget from the stacked widget.
void	removeWidget (QWidget widget, QWidget slide_to_if_active)
	Removes a widget and slides to a replacement widget if it was the active page.
void	resizeEvent (QResizeEvent *event) override
	Handles resize events to update child widget geometries.
void	setAnimationPercent (double animation_percent)
	Sets the current animation interpolation percent for the Q_PROPERTY system.
void	showEvent (QShowEvent *event) override
	Handles show events to ensure proper layout of the active widget.
QWidget *	widget (uint04 index) const
	Returns the widget at the given index.

Protected Attributes
ProgressWidget *	m_loading_page
	The progress widget used for loading pages.
QCustomMessageBox *	m_message_box
	The message box used for question and acknowledgment pages.
Protected Attributes inherited from QCustomStackedWidgetBase
double	m_animation_percent
	The current animation interpolation percent (0.0 to 1.0).
enum QEasingCurve::Type	m_animationtype
	The easing curve type for slide animations.
Buffer< QWidget * >	m_child_widgets
	The list of child page widgets.
uint04	m_current_index
	The index of the currently displayed page.
bool	m_is_animating
	Whether a slide animation is currently in progress.
uint04	m_last
	The index of the previously displayed page.
int	m_last_animation_time
	The duration of the last animation in milliseconds.
QPointer< QPropertyAnimation >	m_move_animation
	The property animation driving slide transitions.
uint04	m_next
	The index of the page being animated to.
uint04	m_now
	The index of the currently displayed page during animation.
QPoint	m_offset
	The pixel offset used during slide animation rendering.
PopupInfo	m_popup_info
	The popup info used for animation origin calculations.
int	m_speed
	The animation duration in milliseconds.
bool	m_vertical
	Whether slide animations are in vertical mode.
bool	m_wrap = false
	Whether page navigation wraps around at boundaries.

Additional Inherited Members
Public Types inherited from QCustomStackedWidgetBase
enum	StackAnimationDirection { e_left_to_right , e_right_to_left , e_top_to_bottom , e_bottom_to_top , e_automatic }
	Defines the direction of slide animations between stacked pages. More...
Static Public Attributes inherited from QCustomStackedWidgetBase
static ApplicationOption< sint04 >	default_stack_animation_speed
	Default time in milliseconds to animate a slide transition.

Detailed Description

A stacked dialog for guiding a user through a multi-step troubleshooting workflow, presenting yes/no questions, acknowledgments, and loading states.

Definition at line 42 of file TroubleShooting.h.

Constructor & Destructor Documentation

◆ TroubleshootingDialog()

TroubleshootingDialog::TroubleshootingDialog	(	const TranslatedString &	title,
		QWidget *	parent = nullptr )

explicitprotected

Constructs a troubleshooting dialog with the given title.

Parameters

[in]	title	The title displayed in the dialog header.
[in]	parent	The parent widget.

Member Function Documentation

◆ setupAck() [1/3]

void TroubleshootingDialog::setupAck	(	const TranslatedString &	message,
		const StringView &	image,
		fltp08	image_size_mult,
		std::function< void()>	on_select )

protected

Adds an acknowledgment page with an image at a custom size.

Parameters

[in]	message	The message text to display.
[in]	image	The resource name of the image to show.
[in]	image_size_mult	A multiplier applied to the default image size.
[in]	on_select	Callback invoked when the user acknowledges.

◆ setupAck() [2/3]

void TroubleshootingDialog::setupAck	(	const TranslatedString &	message,
		const StringView &	image,
		std::function< void()>	on_select )

protected

Adds an acknowledgment page with an accompanying image.

Parameters

[in]	message	The message text to display.
[in]	image	The resource name of the image to show.
[in]	on_select	Callback invoked when the user acknowledges.

◆ setupAck() [3/3]

void TroubleshootingDialog::setupAck	(	const TranslatedString &	message,
		std::function< void()>	on_select )

protected

Adds an acknowledgment page requiring the user to confirm.

Parameters

[in]	message	The message text to display.
[in]	on_select	Callback invoked when the user acknowledges.

◆ setupLoading() [1/2]

void TroubleshootingDialog::setupLoading ( const TranslatedString & message )

protected

Adds a loading page with a progress indicator and message.

Parameters

[in] message The message to display during loading.

◆ setupLoading() [2/2]

void TroubleshootingDialog::setupLoading	(	const TranslatedString &	message,
		const StringView &	image )

protected

Adds a loading page with a progress indicator, message, and image.

Parameters

[in]	message	The message to display during loading.
[in]	image	The resource name of the image to show.

◆ setupYesNo() [1/3]

void TroubleshootingDialog::setupYesNo	(	const TranslatedString &	message,
		const StringView &	image,
		fltp08	image_size_mult,
		std::function< void()>	on_yes,
		std::function< void()>	on_no )

protected

Adds a yes/no question page with an image at a custom size.

Parameters

[in]	message	The question text to display.
[in]	image	The resource name of the image to show.
[in]	image_size_mult	A multiplier applied to the default image size.
[in]	on_yes	Callback invoked when the user selects yes.
[in]	on_no	Callback invoked when the user selects no.

◆ setupYesNo() [2/3]

void TroubleshootingDialog::setupYesNo	(	const TranslatedString &	message,
		const StringView &	image,
		std::function< void()>	on_yes,
		std::function< void()>	on_no )

protected

Adds a yes/no question page with an accompanying image.

Parameters

[in]	message	The question text to display.
[in]	image	The resource name of the image to show.
[in]	on_yes	Callback invoked when the user selects yes.
[in]	on_no	Callback invoked when the user selects no.

◆ setupYesNo() [3/3]

void TroubleshootingDialog::setupYesNo	(	const TranslatedString &	message,
		std::function< void()>	on_yes,
		std::function< void()>	on_no )

protected

Adds a yes/no question page to the dialog.

Parameters

[in]	message	The question text to display.
[in]	on_yes	Callback invoked when the user selects yes.
[in]	on_no	Callback invoked when the user selects no.

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

NDEVR/Headers/TroubleShooting.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TroubleshootingDialog()

Member Function Documentation

◆ setupAck() [1/3]

◆ setupAck() [2/3]

◆ setupAck() [3/3]

◆ setupLoading() [1/2]

◆ setupLoading() [2/2]

◆ setupYesNo() [1/3]

◆ setupYesNo() [2/3]

◆ setupYesNo() [3/3]