NDEVR
API Documentation
GenericOptionsGroup

Creates a clean formatted dialog for any number of GenericOptions within a GenericOptionGroup Each option is labelled. More...

Collaboration diagram for GenericOptionsGroup:
[legend]

Public Member Functions

 GenericOptionsGroup (const GenericOptionGroup &option, bool vertical_layout=false, QWidget *parent=nullptr)
 Constructs a GenericOptionsGroup from a GenericOptionGroup.
 GenericOptionsGroup (QWidget *parent=nullptr)
 Constructs an empty GenericOptionsGroup.
void edited ()
 Emitted when any option in the group has been edited.
void editingFinished ()
 Emitted when the user finishes editing any option.
const GenericOptionGroupgroup ()
 Returns the current GenericOptionGroup.
void setOptionGroup (const GenericOptionGroup &option)
 Sets the option group and rebuilds the widget.
void setVerticalLayout (bool vertical_layout)
 Sets whether options should be laid out vertically.

Protected Member Functions

void init ()
 Initializes the grid layout and creates child widgets for each option.

Protected Attributes

GenericOptionGroup m_group
 The option group being displayed.
QGridLayout * m_layout
 The grid layout containing option widgets.
bool m_vertical_layout = false
 Whether options are laid out vertically.

Detailed Description

Creates a clean formatted dialog for any number of GenericOptions within a GenericOptionGroup Each option is labelled.


Definition at line 86 of file GenericOptionsWidgets.h.

Constructor & Destructor Documentation

◆ GenericOptionsGroup() [1/2]

GenericOptionsGroup::GenericOptionsGroup ( const GenericOptionGroup & option,
bool vertical_layout = false,
QWidget * parent = nullptr )

Constructs a GenericOptionsGroup from a GenericOptionGroup.

Parameters
[in]optionThe option group to display.
[in]vertical_layoutWhether to lay out options vertically.
[in]parentThe parent widget.

◆ GenericOptionsGroup() [2/2]

GenericOptionsGroup::GenericOptionsGroup ( QWidget * parent = nullptr)

Constructs an empty GenericOptionsGroup.

Parameters
[in]parentThe parent widget.

Member Function Documentation

◆ group()

const GenericOptionGroup & GenericOptionsGroup::group ( )

Returns the current GenericOptionGroup.

Returns
A const reference to the option group.

Referenced by ProgressWidgetDemo::OptionsButton().

◆ setOptionGroup()

void GenericOptionsGroup::setOptionGroup ( const GenericOptionGroup & option)

Sets the option group and rebuilds the widget.

Parameters
[in]optionThe new GenericOptionGroup to display.

◆ setVerticalLayout()

void GenericOptionsGroup::setVerticalLayout ( bool vertical_layout)

Sets whether options should be laid out vertically.

Parameters
[in]vertical_layoutWhether to use a vertical layout.

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