Public Member Functions | Private Member Functions | Private Attributes | List of all members
te::qt::widgets::SymbolInfoDialog Class Reference

A dialog used to configure informations about a symbol. More...

#include <SymbolInfoDialog.h>

Inheritance diagram for te::qt::widgets::SymbolInfoDialog:
QDialog

Public Member Functions

SymbolInfo getSymbolInfo () const
 Gets the configured symbol information. More...
 
void setReadMode (bool enable=true)
 
void setSymbolInfo (const SymbolInfo &info)
 Sets the symbol information to this dialog. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 SymbolInfoDialog (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a symbol info dialog which is a child of parent, with widget flags set to f. More...
 
 ~SymbolInfoDialog ()
 Destructor. More...
 

Private Member Functions

void updateUi ()
 Updates the dialog form based on internal symbol info object. More...
 

Private Attributes

SymbolInfo m_symbolInfo
 Symbol information that will be configured by the dialog. More...
 
std::unique_ptr< Ui::SymbolInfoDialogForm > m_ui
 Dialog form. More...
 

Detailed Description

A dialog used to configure informations about a symbol.

Definition at line 53 of file SymbolInfoDialog.h.

Constructor & Destructor Documentation

te::qt::widgets::SymbolInfoDialog::SymbolInfoDialog ( QWidget *  parent = 0,
Qt::WindowFlags  f = 0 
)

Constructs a symbol info dialog which is a child of parent, with widget flags set to f.

Definition at line 30 of file SymbolInfoDialog.cpp.

References m_ui, and ~SymbolInfoDialog().

te::qt::widgets::SymbolInfoDialog::~SymbolInfoDialog ( )
default

Destructor.

Referenced by SymbolInfoDialog().

Member Function Documentation

te::qt::widgets::SymbolInfo te::qt::widgets::SymbolInfoDialog::getSymbolInfo ( ) const

Gets the configured symbol information.

Returns
The configured symbol information.

Definition at line 39 of file SymbolInfoDialog.cpp.

References m_symbolInfo.

void te::qt::widgets::SymbolInfoDialog::setReadMode ( bool  enable = true)

Definition at line 50 of file SymbolInfoDialog.cpp.

References m_ui.

Referenced by te::qt::widgets::SymbolSelectorDialog::onShowSymbolInfoPushButtonPressed().

void te::qt::widgets::SymbolInfoDialog::setSymbolInfo ( const SymbolInfo &  info)

Sets the symbol information to this dialog.

Parameters
infoThe symbol information.
Note
The dialog form will be update based on given information parameters.

Definition at line 44 of file SymbolInfoDialog.cpp.

References m_symbolInfo, and updateUi().

Referenced by te::qt::widgets::SymbolSelectorDialog::onShowSymbolInfoPushButtonPressed(), and SymbolEditor().

void te::qt::widgets::SymbolInfoDialog::updateUi ( )
private

Updates the dialog form based on internal symbol info object.

Definition at line 58 of file SymbolInfoDialog.cpp.

References te::qt::widgets::SymbolInfo::m_author, te::qt::widgets::SymbolInfo::m_description, te::qt::widgets::SymbolInfo::m_id, te::qt::widgets::SymbolInfo::m_name, m_symbolInfo, te::qt::widgets::SymbolInfo::m_tags, and m_ui.

Referenced by setSymbolInfo().

Member Data Documentation

SymbolInfo te::qt::widgets::SymbolInfoDialog::m_symbolInfo
private

Symbol information that will be configured by the dialog.

Definition at line 98 of file SymbolInfoDialog.h.

Referenced by getSymbolInfo(), setSymbolInfo(), and updateUi().

std::unique_ptr<Ui::SymbolInfoDialogForm> te::qt::widgets::SymbolInfoDialog::m_ui
private

Dialog form.

Definition at line 97 of file SymbolInfoDialog.h.

Referenced by setReadMode(), SymbolInfoDialog(), and updateUi().

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