KiCad PCB EDA Suite
PANEL_SETUP_FORMATTING Class Reference

#include <panel_setup_formatting.h>

Inheritance diagram for PANEL_SETUP_FORMATTING:
PANEL_SETUP_FORMATTING_BASE PANEL_SETUP_FORMATTING_BASE

Public Member Functions

 PANEL_SETUP_FORMATTING (wxWindow *aWindow, SCH_EDIT_FRAME *aFrame)
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void ImportSettingsFrom (SCHEMATIC_SETTINGS &aSettings)
 
 PANEL_SETUP_FORMATTING (PAGED_DIALOG *aParent, PCB_EDIT_FRAME *aFrame)
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void ImportSettingsFrom (BOARD *aBoard)
 

Protected Member Functions

void onCheckBoxIref (wxCommandEvent &event) override
 

Protected Attributes

wxStaticText * m_staticText26
 
wxChoice * m_choiceSeparatorRefId
 
wxStaticText * m_textSizeLabel
 
wxTextCtrl * m_textSizeCtrl
 
wxStaticText * m_textSizeUnits
 
wxStaticText * m_textOffsetRatioLabel
 
wxTextCtrl * m_textOffsetRatioCtrl
 
wxStaticText * m_offsetRatioUnits
 
wxStaticText * m_labelSizeRatioLabel
 
wxTextCtrl * m_labelSizeRatioCtrl
 
wxStaticText * m_labelSizeRatioUnits
 
wxStaticText * m_lineWidthLabel
 
wxTextCtrl * m_lineWidthCtrl
 
wxStaticText * m_lineWidthUnits
 
wxStaticText * m_pinSymbolSizeLabel
 
wxTextCtrl * m_pinSymbolSizeCtrl
 
wxStaticText * m_pinSymbolSizeUnits
 
wxStaticText * m_staticText261
 
wxChoice * m_choiceJunctionDotSize
 
wxCheckBox * m_showIntersheetsReferences
 
wxCheckBox * m_listOwnPage
 
wxRadioButton * m_radioFormatStandard
 
wxRadioButton * m_radioFormatAbbreviated
 
wxStaticText * m_prefixLabel
 
wxTextCtrl * m_prefixCtrl
 
wxStaticText * m_suffixLabel
 
wxTextCtrl * m_suffixCtrl
 
wxStaticText * dashLengthLabel
 
wxTextCtrl * m_dashLengthCtrl
 
wxStaticText * gapLengthLabel
 
wxTextCtrl * m_gapLengthCtrl
 
wxStaticText * m_dashedLineHelp
 

Private Member Functions

void _wxFB_onCheckBoxIref (wxCommandEvent &event)
 

Private Attributes

SCH_EDIT_FRAMEm_frame
 
UNIT_BINDER m_textSize
 
UNIT_BINDER m_lineWidth
 
UNIT_BINDER m_pinSymbolSize
 
PCB_EDIT_FRAMEm_frame
 

Detailed Description

Definition at line 31 of file eeschema/dialogs/panel_setup_formatting.h.

Constructor & Destructor Documentation

◆ PANEL_SETUP_FORMATTING() [1/2]

PANEL_SETUP_FORMATTING::PANEL_SETUP_FORMATTING ( wxWindow *  aWindow,
SCH_EDIT_FRAME aFrame 
)

Definition at line 35 of file eeschema/dialogs/panel_setup_formatting.cpp.

35 :
37 m_frame( aFrame ),
41{
42 m_dashedLineHelp->SetFont( KIUI::GetInfoFont( this ).Italic() );
43}
PANEL_SETUP_FORMATTING_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:144

References KIUI::GetInfoFont(), and PANEL_SETUP_FORMATTING_BASE::m_dashedLineHelp.

◆ PANEL_SETUP_FORMATTING() [2/2]

PANEL_SETUP_FORMATTING::PANEL_SETUP_FORMATTING ( PAGED_DIALOG aParent,
PCB_EDIT_FRAME aFrame 
)

Definition at line 33 of file pcbnew/dialogs/panel_setup_formatting.cpp.

33 :
35 m_frame( aFrame )
36{
37}
wxTreebook * GetTreebook()
Definition: paged_dialog.h:37

Member Function Documentation

◆ _wxFB_onCheckBoxIref()

void PANEL_SETUP_FORMATTING_BASE::_wxFB_onCheckBoxIref ( wxCommandEvent &  event)
inlineprivateinherited

◆ ImportSettingsFrom() [1/2]

void PANEL_SETUP_FORMATTING::ImportSettingsFrom ( BOARD aBoard)

Definition at line 75 of file pcbnew/dialogs/panel_setup_formatting.cpp.

76{
77 const PCB_PLOT_PARAMS& importedSettings = aBoard->GetPlotOptions();
78
80 importedSettings.GetDashedLineDashRatio() ) );
81
83 importedSettings.GetDashedLineGapRatio() ) );
84}
constexpr EDA_IU_SCALE unityScale
Definition: base_units.h:112
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:629
Parameters and options when plotting/printing a board.
double GetDashedLineGapRatio() const
double GetDashedLineDashRatio() const
wxString StringFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Returns the string from aValue according to aUnits (inch, mm ...) for display.
Definition: eda_units.cpp:229

References PCB_PLOT_PARAMS::GetDashedLineDashRatio(), PCB_PLOT_PARAMS::GetDashedLineGapRatio(), BOARD::GetPlotOptions(), PANEL_SETUP_FORMATTING_BASE::m_dashLengthCtrl, PANEL_SETUP_FORMATTING_BASE::m_gapLengthCtrl, EDA_UNIT_UTILS::UI::StringFromValue(), unityScale, and UNSCALED.

◆ ImportSettingsFrom() [2/2]

void PANEL_SETUP_FORMATTING::ImportSettingsFrom ( SCHEMATIC_SETTINGS aSettings)

Definition at line 168 of file eeschema/dialogs/panel_setup_formatting.cpp.

169{
173
177 m_prefixCtrl->ChangeValue( aSettings.m_IntersheetRefsPrefix );
178 m_suffixCtrl->ChangeValue( aSettings.m_IntersheetRefsSuffix );
179 m_listOwnPage->SetValue( aSettings.m_IntersheetRefsListOwnPage );
180
181#define SET_VALUE( ctrl, units, value ) \
182 ctrl->SetValue( EDA_UNIT_UTILS::UI::StringFromValue( unityScale, units, value ) )
183
188
189#undef SET_VALUE
190}
virtual void SetValue(long long int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
#define SET_VALUE(ctrl, units, value)

References SCHEMATIC_SETTINGS::m_DashedLineDashRatio, SCHEMATIC_SETTINGS::m_DashedLineGapRatio, PANEL_SETUP_FORMATTING_BASE::m_dashLengthCtrl, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCHEMATIC_SETTINGS::m_DefaultTextSize, PANEL_SETUP_FORMATTING_BASE::m_gapLengthCtrl, SCHEMATIC_SETTINGS::m_IntersheetRefsFormatShort, SCHEMATIC_SETTINGS::m_IntersheetRefsListOwnPage, SCHEMATIC_SETTINGS::m_IntersheetRefsPrefix, SCHEMATIC_SETTINGS::m_IntersheetRefsShow, SCHEMATIC_SETTINGS::m_IntersheetRefsSuffix, SCHEMATIC_SETTINGS::m_LabelSizeRatio, PANEL_SETUP_FORMATTING_BASE::m_labelSizeRatioCtrl, m_lineWidth, PANEL_SETUP_FORMATTING_BASE::m_listOwnPage, m_pinSymbolSize, SCHEMATIC_SETTINGS::m_PinSymbolSize, PANEL_SETUP_FORMATTING_BASE::m_prefixCtrl, PANEL_SETUP_FORMATTING_BASE::m_radioFormatAbbreviated, PANEL_SETUP_FORMATTING_BASE::m_radioFormatStandard, PANEL_SETUP_FORMATTING_BASE::m_showIntersheetsReferences, PANEL_SETUP_FORMATTING_BASE::m_suffixCtrl, SCHEMATIC_SETTINGS::m_TextOffsetRatio, PANEL_SETUP_FORMATTING_BASE::m_textOffsetRatioCtrl, m_textSize, PERCENT, SET_VALUE, UNIT_BINDER::SetValue(), and UNSCALED.

Referenced by DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), and DIALOG_BOARD_SETUP::onAuxiliaryAction().

◆ onCheckBoxIref()

◆ TransferDataFromWindow() [1/2]

bool PANEL_SETUP_FORMATTING::TransferDataFromWindow ( )
override

Definition at line 117 of file eeschema/dialogs/panel_setup_formatting.cpp.

118{
120
121 // Reference style one of: "A" ".A" "-A" "_A" ".1" "-1" "_1"
122 int firstRefId, refSeparator;
123
124 switch( m_choiceSeparatorRefId->GetSelection() )
125 {
126 default:
127 case 0: firstRefId = 'A'; refSeparator = 0; break;
128 case 1: firstRefId = 'A'; refSeparator = '.'; break;
129 case 2: firstRefId = 'A'; refSeparator = '-'; break;
130 case 3: firstRefId = 'A'; refSeparator = '_'; break;
131 case 4: firstRefId = '1'; refSeparator = '.'; break;
132 case 5: firstRefId = '1'; refSeparator = '-'; break;
133 case 6: firstRefId = '1'; refSeparator = '_'; break;
134 }
135
136 if( refSeparator != LIB_SYMBOL::GetSubpartIdSeparator() ||
137 firstRefId != LIB_SYMBOL::GetSubpartFirstId() )
138 {
139 LIB_SYMBOL::SetSubpartIdNotation( refSeparator, firstRefId );
140 }
141
142 settings.m_DefaultTextSize = (int) m_textSize.GetValue();
143 settings.m_DefaultLineWidth = (int) m_lineWidth.GetValue();
144 settings.m_PinSymbolSize = (int) m_pinSymbolSize.GetValue();
145
146 if( m_choiceJunctionDotSize->GetSelection() != wxNOT_FOUND )
147 settings.m_JunctionSizeChoice = m_choiceJunctionDotSize->GetSelection();
148
151 settings.m_IntersheetRefsPrefix = m_prefixCtrl->GetValue();
152 settings.m_IntersheetRefsSuffix = m_suffixCtrl->GetValue();
153 settings.m_IntersheetRefsListOwnPage = m_listOwnPage->GetValue();
154
155#define GET_VALUE( units, str ) EDA_UNIT_UTILS::UI::DoubleValueFromString( unityScale, units, str )
156
157 settings.m_TextOffsetRatio = GET_VALUE( EDA_UNITS::PERCENT, m_textOffsetRatioCtrl->GetValue() ) / 100.0;
160 settings.m_LabelSizeRatio = GET_VALUE( EDA_UNITS::PERCENT, m_labelSizeRatioCtrl->GetValue() ) / 100.0;
161
162#undef GET_VALUE
163
164 return true;
165}
static int GetSubpartIdSeparator()
Definition: lib_symbol.h:581
static int GetSubpartFirstId()
Definition: lib_symbol.h:587
static void SetSubpartIdNotation(int aSep, int aFirstId)
Set the separator char between the subpart id and the reference 0 (no separator) or '.
These settings were stored in SCH_BASE_FRAME previously.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:172
SCHEMATIC & Schematic() const
virtual long long int GetValue()
Return the current value in Internal Units.
#define GET_VALUE(units, str)

References GET_VALUE, LIB_SYMBOL::GetSubpartFirstId(), LIB_SYMBOL::GetSubpartIdSeparator(), UNIT_BINDER::GetValue(), PANEL_SETUP_FORMATTING_BASE::m_choiceJunctionDotSize, PANEL_SETUP_FORMATTING_BASE::m_choiceSeparatorRefId, SCHEMATIC_SETTINGS::m_DashedLineDashRatio, SCHEMATIC_SETTINGS::m_DashedLineGapRatio, PANEL_SETUP_FORMATTING_BASE::m_dashLengthCtrl, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCHEMATIC_SETTINGS::m_DefaultTextSize, m_frame, PANEL_SETUP_FORMATTING_BASE::m_gapLengthCtrl, SCHEMATIC_SETTINGS::m_IntersheetRefsFormatShort, SCHEMATIC_SETTINGS::m_IntersheetRefsListOwnPage, SCHEMATIC_SETTINGS::m_IntersheetRefsPrefix, SCHEMATIC_SETTINGS::m_IntersheetRefsShow, SCHEMATIC_SETTINGS::m_IntersheetRefsSuffix, SCHEMATIC_SETTINGS::m_JunctionSizeChoice, SCHEMATIC_SETTINGS::m_LabelSizeRatio, PANEL_SETUP_FORMATTING_BASE::m_labelSizeRatioCtrl, m_lineWidth, PANEL_SETUP_FORMATTING_BASE::m_listOwnPage, m_pinSymbolSize, SCHEMATIC_SETTINGS::m_PinSymbolSize, PANEL_SETUP_FORMATTING_BASE::m_prefixCtrl, PANEL_SETUP_FORMATTING_BASE::m_radioFormatStandard, PANEL_SETUP_FORMATTING_BASE::m_showIntersheetsReferences, PANEL_SETUP_FORMATTING_BASE::m_suffixCtrl, SCHEMATIC_SETTINGS::m_TextOffsetRatio, PANEL_SETUP_FORMATTING_BASE::m_textOffsetRatioCtrl, m_textSize, PERCENT, SCH_EDIT_FRAME::Schematic(), LIB_SYMBOL::SetSubpartIdNotation(), SCHEMATIC::Settings(), and UNSCALED.

◆ TransferDataFromWindow() [2/2]

bool PANEL_SETUP_FORMATTING::TransferDataFromWindow ( )
override

◆ TransferDataToWindow() [1/2]

bool PANEL_SETUP_FORMATTING::TransferDataToWindow ( )
override

Definition at line 60 of file eeschema/dialogs/panel_setup_formatting.cpp.

61{
63
64 // Reference style one of: "A" ".A" "-A" "_A" ".1" "-1" "_1"
65 int refStyleSelection;
66
68 {
69 default:
70 case 0: refStyleSelection = 0; break;
71 case '.': refStyleSelection = LIB_SYMBOL::GetSubpartFirstId() == '1' ? 4 : 1; break;
72 case '-': refStyleSelection = LIB_SYMBOL::GetSubpartFirstId() == '1' ? 5 : 2; break;
73 case '_': refStyleSelection = LIB_SYMBOL::GetSubpartFirstId() == '1' ? 6 : 3; break;
74 }
75
76 m_choiceSeparatorRefId->SetSelection( refStyleSelection );
77
81
85 m_choiceJunctionDotSize->SetSelection( settings.m_JunctionSizeChoice );
86
88
91 m_prefixLabel->Enable( settings.m_IntersheetRefsShow );
92 m_prefixCtrl->Enable( settings.m_IntersheetRefsShow );
93 m_suffixLabel->Enable( settings.m_IntersheetRefsShow );
94 m_suffixCtrl->Enable( settings.m_IntersheetRefsShow );
95 m_listOwnPage->Enable( settings.m_IntersheetRefsShow );
96
99 m_prefixCtrl->ChangeValue( settings.m_IntersheetRefsPrefix );
100 m_suffixCtrl->ChangeValue( settings.m_IntersheetRefsSuffix );
101 m_listOwnPage->SetValue( settings.m_IntersheetRefsListOwnPage );
102
103#define SET_VALUE( ctrl, units, value ) \
104 ctrl->SetValue( EDA_UNIT_UTILS::UI::StringFromValue( unityScale, units, value ) )
105
110
111#undef SET_VALUE
112
113 return true;
114}
virtual void SetUnits(EDA_UNITS aUnits)
Normally not needed (as the UNIT_BINDER inherits from the parent frame), but can be used to set to DE...

References LIB_SYMBOL::GetSubpartFirstId(), LIB_SYMBOL::GetSubpartIdSeparator(), PANEL_SETUP_FORMATTING_BASE::m_choiceJunctionDotSize, PANEL_SETUP_FORMATTING_BASE::m_choiceSeparatorRefId, SCHEMATIC_SETTINGS::m_DashedLineDashRatio, SCHEMATIC_SETTINGS::m_DashedLineGapRatio, PANEL_SETUP_FORMATTING_BASE::m_dashLengthCtrl, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCHEMATIC_SETTINGS::m_DefaultTextSize, m_frame, PANEL_SETUP_FORMATTING_BASE::m_gapLengthCtrl, SCHEMATIC_SETTINGS::m_IntersheetRefsFormatShort, SCHEMATIC_SETTINGS::m_IntersheetRefsListOwnPage, SCHEMATIC_SETTINGS::m_IntersheetRefsPrefix, SCHEMATIC_SETTINGS::m_IntersheetRefsShow, SCHEMATIC_SETTINGS::m_IntersheetRefsSuffix, SCHEMATIC_SETTINGS::m_JunctionSizeChoice, SCHEMATIC_SETTINGS::m_LabelSizeRatio, PANEL_SETUP_FORMATTING_BASE::m_labelSizeRatioCtrl, m_lineWidth, PANEL_SETUP_FORMATTING_BASE::m_listOwnPage, m_pinSymbolSize, SCHEMATIC_SETTINGS::m_PinSymbolSize, PANEL_SETUP_FORMATTING_BASE::m_prefixCtrl, PANEL_SETUP_FORMATTING_BASE::m_prefixLabel, PANEL_SETUP_FORMATTING_BASE::m_radioFormatAbbreviated, PANEL_SETUP_FORMATTING_BASE::m_radioFormatStandard, PANEL_SETUP_FORMATTING_BASE::m_showIntersheetsReferences, PANEL_SETUP_FORMATTING_BASE::m_suffixCtrl, PANEL_SETUP_FORMATTING_BASE::m_suffixLabel, SCHEMATIC_SETTINGS::m_TextOffsetRatio, PANEL_SETUP_FORMATTING_BASE::m_textOffsetRatioCtrl, m_textSize, MILS, PERCENT, SCH_EDIT_FRAME::Schematic(), SET_VALUE, SCHEMATIC::Settings(), UNIT_BINDER::SetUnits(), UNIT_BINDER::SetValue(), and UNSCALED.

◆ TransferDataToWindow() [2/2]

bool PANEL_SETUP_FORMATTING::TransferDataToWindow ( )
override

Member Data Documentation

◆ dashLengthLabel

wxStaticText * PANEL_SETUP_FORMATTING_BASE::dashLengthLabel
protectedinherited

◆ gapLengthLabel

wxStaticText * PANEL_SETUP_FORMATTING_BASE::gapLengthLabel
protectedinherited

◆ m_choiceJunctionDotSize

wxChoice* PANEL_SETUP_FORMATTING_BASE::m_choiceJunctionDotSize
protectedinherited

◆ m_choiceSeparatorRefId

wxChoice* PANEL_SETUP_FORMATTING_BASE::m_choiceSeparatorRefId
protectedinherited

◆ m_dashedLineHelp

wxStaticText * PANEL_SETUP_FORMATTING_BASE::m_dashedLineHelp
protectedinherited

◆ m_dashLengthCtrl

wxTextCtrl * PANEL_SETUP_FORMATTING_BASE::m_dashLengthCtrl
protectedinherited

◆ m_frame [1/2]

SCH_EDIT_FRAME* PANEL_SETUP_FORMATTING::m_frame
private

◆ m_frame [2/2]

PCB_EDIT_FRAME* PANEL_SETUP_FORMATTING::m_frame
private

Definition at line 42 of file pcbnew/dialogs/panel_setup_formatting.h.

◆ m_gapLengthCtrl

wxTextCtrl * PANEL_SETUP_FORMATTING_BASE::m_gapLengthCtrl
protectedinherited

◆ m_labelSizeRatioCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_labelSizeRatioCtrl
protectedinherited

◆ m_labelSizeRatioLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_labelSizeRatioLabel
protectedinherited

◆ m_labelSizeRatioUnits

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_labelSizeRatioUnits
protectedinherited

◆ m_lineWidth

UNIT_BINDER PANEL_SETUP_FORMATTING::m_lineWidth
private

◆ m_lineWidthCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_lineWidthCtrl
protectedinherited

◆ m_lineWidthLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_lineWidthLabel
protectedinherited

◆ m_lineWidthUnits

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_lineWidthUnits
protectedinherited

◆ m_listOwnPage

wxCheckBox* PANEL_SETUP_FORMATTING_BASE::m_listOwnPage
protectedinherited

◆ m_offsetRatioUnits

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_offsetRatioUnits
protectedinherited

◆ m_pinSymbolSize

UNIT_BINDER PANEL_SETUP_FORMATTING::m_pinSymbolSize
private

◆ m_pinSymbolSizeCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_pinSymbolSizeCtrl
protectedinherited

◆ m_pinSymbolSizeLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_pinSymbolSizeLabel
protectedinherited

◆ m_pinSymbolSizeUnits

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_pinSymbolSizeUnits
protectedinherited

◆ m_prefixCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_prefixCtrl
protectedinherited

◆ m_prefixLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_prefixLabel
protectedinherited

◆ m_radioFormatAbbreviated

wxRadioButton* PANEL_SETUP_FORMATTING_BASE::m_radioFormatAbbreviated
protectedinherited

◆ m_radioFormatStandard

wxRadioButton* PANEL_SETUP_FORMATTING_BASE::m_radioFormatStandard
protectedinherited

◆ m_showIntersheetsReferences

wxCheckBox* PANEL_SETUP_FORMATTING_BASE::m_showIntersheetsReferences
protectedinherited

◆ m_staticText26

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_staticText26
protectedinherited

◆ m_staticText261

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_staticText261
protectedinherited

◆ m_suffixCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_suffixCtrl
protectedinherited

◆ m_suffixLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_suffixLabel
protectedinherited

◆ m_textOffsetRatioCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_textOffsetRatioCtrl
protectedinherited

◆ m_textOffsetRatioLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_textOffsetRatioLabel
protectedinherited

◆ m_textSize

UNIT_BINDER PANEL_SETUP_FORMATTING::m_textSize
private

◆ m_textSizeCtrl

wxTextCtrl* PANEL_SETUP_FORMATTING_BASE::m_textSizeCtrl
protectedinherited

◆ m_textSizeLabel

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_textSizeLabel
protectedinherited

◆ m_textSizeUnits

wxStaticText* PANEL_SETUP_FORMATTING_BASE::m_textSizeUnits
protectedinherited

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