NDEVR
API Documentation
GettingStartedDialog

This dialog is shown front and center before the user has loaded any data or created a project In touch mode large buttons are shown, while the company logo is shown as a backdrop in Desktop mode. More...

Collaboration diagram for GettingStartedDialog:
[legend]

Public Member Functions

 GettingStartedDialog (QTModelManager *model_manager, WindowManager *manager, QWidget *parent=nullptr)
 Constructs a GettingStartedDialog.
virtual ~GettingStartedDialog ()
 Destructor.
void addQuickWidget (QWidget *button)
 Adds a quick-access widget to the dialog.
void addWidget (QWidget *widget)
 Adds a widget to the getting started layout.
bool event (QEvent *event) override
 Handles events for this dialog.
void globalStyleDestroyedSlot ()
 Slot called when the global style object is destroyed.
QSize minimumSizeHint () const override
 Returns the minimum size hint for layout calculations.
void paintEvent (QPaintEvent *) override
 Paints the background image and any custom decorations.
void removeWidget (QWidget *widget)
 Removes a widget from the getting started layout.
void resizeEvent (QResizeEvent *resize_event) override
 Handles resize events to adjust the background and layout.
void setLogoVisible (bool is_visible)
 Sets whether the company logo is visible.
void setTouchThemeVisible (bool is_visible)
 Sets whether the touch/desktop theme toggle button is visible.
void showEvent (QShowEvent *event) override
 Handles the show event to update the layout on display.
QSize sizeHint () const override
 Returns the preferred size hint for layout calculations.
void updateBackgroundSlot ()
 Slot that updates the background image when the theme changes.
void updateHorizontal ()
 Updates the layout for horizontal orientation.

Protected Member Functions

void dragEnterEvent (QDragEnterEvent *event) override
 Handles drag enter events for file drop support.
void dropEvent (QDropEvent *event) override
 Handles drop events for file loading via drag and drop.
void ensureBackgroundLoaded (NDEVRLightingTheme theme)
 Ensures the background pixmap for the given theme is loaded.
void updateFont ()
 Updates the font styling for dialog elements.
void updateOpacity ()
 Updates the opacity of the dialog elements.
void updateSizeLayout ()
 Updates the layout sizing based on the current window size.
void updateTouchMode ()
 Updates the layout for touch or desktop mode.

Protected Attributes

QPixmap m_dark_background
 The background pixmap for dark theme.
bool m_is_logo_visible
 Whether the company logo is currently visible.
QPixmap m_light_background
 The background pixmap for light theme.
QTModelManagerm_model_manager
 The model manager providing data access.
TouchDesktopThemeButtonm_touch_desktop_theme
 The touch/desktop theme toggle button.
WindowManagerm_window_manager
 The window manager for managing application windows.
Ui::GettingStartedUI * ui
 The UI form for this dialog.

Detailed Description

This dialog is shown front and center before the user has loaded any data or created a project In touch mode large buttons are shown, while the company logo is shown as a backdrop in Desktop mode.


Definition at line 53 of file GettingStarted.h.

Constructor & Destructor Documentation

◆ GettingStartedDialog()

GettingStartedDialog::GettingStartedDialog ( QTModelManager * model_manager,
WindowManager * manager,
QWidget * parent = nullptr )

Constructs a GettingStartedDialog.

Parameters
[in]model_managerThe QTModelManager providing data access.
[in]managerThe WindowManager for managing application windows.
[in]parentThe parent widget.

Member Function Documentation

◆ addQuickWidget()

void GettingStartedDialog::addQuickWidget ( QWidget * button)

Adds a quick-access widget to the dialog.

Parameters
[in]buttonThe widget to add as a quick-access button.

◆ addWidget()

void GettingStartedDialog::addWidget ( QWidget * widget)

Adds a widget to the getting started layout.

Parameters
[in]widgetThe widget to add.

◆ dragEnterEvent()

void GettingStartedDialog::dragEnterEvent ( QDragEnterEvent * event)
overrideprotected

Handles drag enter events for file drop support.

Parameters
[in]eventThe drag enter event.

References event().

◆ dropEvent()

void GettingStartedDialog::dropEvent ( QDropEvent * event)
overrideprotected

Handles drop events for file loading via drag and drop.

Parameters
[in]eventThe drop event.

References event().

◆ ensureBackgroundLoaded()

void GettingStartedDialog::ensureBackgroundLoaded ( NDEVRLightingTheme theme)
protected

Ensures the background pixmap for the given theme is loaded.

Parameters
[in]themeThe lighting theme to load the background for.

◆ event()

bool GettingStartedDialog::event ( QEvent * event)
override

Handles events for this dialog.

Parameters
[in]eventThe event to process.
Returns
True if the event was handled.

References event().

Referenced by dragEnterEvent(), dropEvent(), event(), and showEvent().

◆ minimumSizeHint()

QSize GettingStartedDialog::minimumSizeHint ( ) const
override

Returns the minimum size hint for layout calculations.

Returns
The minimum size hint.

◆ paintEvent()

void GettingStartedDialog::paintEvent ( QPaintEvent * )
override

Paints the background image and any custom decorations.

Parameters
[in]eventThe paint event.

◆ removeWidget()

void GettingStartedDialog::removeWidget ( QWidget * widget)

Removes a widget from the getting started layout.

Parameters
[in]widgetThe widget to remove.

◆ resizeEvent()

void GettingStartedDialog::resizeEvent ( QResizeEvent * resize_event)
override

Handles resize events to adjust the background and layout.

Parameters
[in]resize_eventThe resize event.

◆ setLogoVisible()

void GettingStartedDialog::setLogoVisible ( bool is_visible)

Sets whether the company logo is visible.

Parameters
[in]is_visibleTrue to show the logo.

◆ setTouchThemeVisible()

void GettingStartedDialog::setTouchThemeVisible ( bool is_visible)

Sets whether the touch/desktop theme toggle button is visible.

Parameters
[in]is_visibleTrue to show the theme toggle button.

◆ showEvent()

void GettingStartedDialog::showEvent ( QShowEvent * event)
override

Handles the show event to update the layout on display.

Parameters
[in]eventThe show event.

References event().

◆ sizeHint()

QSize GettingStartedDialog::sizeHint ( ) const
override

Returns the preferred size hint for layout calculations.

Returns
The size hint.

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