OptionLayout Class Reference

Panel to m_view and modify options() of an object. More...

#include <OptionLayout.hpp>

Inherits QFormLayout.

Signals
void	value_changed ()

Public Member Functions
	OptionLayout (QWidget *parent=nullptr)
	Constructor. More...
	~OptionLayout ()
	Destructor. More...
void	clear_options ()
	Destroys all graphical values. More...
bool	is_modified () const
	Indicates wether at least on option has been modified. More...
void	modified_options (core::CommitDetails &commitDetails) const
	Gathers modified options. More...
void	add (const boost::shared_ptr< cf3::common::Option > &option)
bool	has_options () const
void	options (QMap< QString, QString > &options, bool all) const
	Puts options in a provided map. More...
void	commit_options ()
	Marks options as commited. More...

Private Member Functions
void	set_options (const QList< boost::shared_ptr< cf3::common::Option > > &list)

Private Attributes
QMap< QString, GraphicalValue * >	m_options
	List containing basic options() components. More...
bool	m_advanced_mode
	Indicates if the panel is in advanced mode or not. More...

Detailed Description

Panel to m_view and modify options() of an object.

This class allows user to display and modify options of an object.

Author

Quentin Gasper.

Definition at line 49 of file OptionLayout.hpp.

Constructor & Destructor Documentation

OptionLayout

(

QWidget *

parent = nullptr

)

Constructor.

Builds an OptionPanel with no options. The panel is neither in read-only mode nor advanced mode.

Parameters

parent

The parent widget. Default value is nullptr

Definition at line 26 of file OptionLayout.cpp.

~OptionLayout

(

)

Destructor.

Frees the allocated memory. Parent is not destroyed.

Definition at line 34 of file OptionLayout.cpp.

Member Function Documentation

void add

(

const boost::shared_ptr< cf3::common::Option > &

option

)

Definition at line 118 of file OptionLayout.cpp.

void clear_options

(

)

Destroys all graphical values.

Definition at line 66 of file OptionLayout.cpp.

void commit_options

(

)

Marks options as commited.

Calls GraphicalOption::commit() for each graphical option the layout contains.

Definition at line 56 of file OptionLayout.cpp.

bool has_options

(

)

const

Definition at line 138 of file OptionLayout.cpp.

bool is_modified

(

)

const

Indicates wether at least on option has been modified.

Returns

Returns true if at least one option has been modified.

Definition at line 82 of file OptionLayout.cpp.

void modified_options

(

core::CommitDetails &

commitDetails

)

const

Gathers modified options.

Parameters

commitDetails

Object where modified values will be stored. The object is not cleared.

Definition at line 96 of file OptionLayout.cpp.

void options	(	QMap< QString, QString > &	options,
		bool	all
	)		const

Puts options in a provided map.

Parameters

options	A hashmap were modified options will be written. The key is the option name and the value is the option new value.
all	If false, only modified options will be put, meaning that the hashmap may be empty. If true, all option are put.

Definition at line 41 of file OptionLayout.cpp.

void set_options ( const QList< boost::shared_ptr< cf3::common::Option > > &  list )

private

void value_changed ( )

signal

Member Data Documentation

bool m_advanced_mode

private

Indicates if the panel is in advanced mode or not.

If true, the panel is in advanced mode. Advanced options() (if any) are displayed. Otherwise, they are m_hidden.

Definition at line 111 of file OptionLayout.hpp.

QMap<QString, GraphicalValue *> m_options

private

List containing basic options() components.

Definition at line 105 of file OptionLayout.hpp.

---

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

• cf3/ui/graphics/OptionLayout.hpp
• cf3/ui/graphics/OptionLayout.cpp