#include <GNEAdditionalFrame.h>

Inheritance diagram for GNEAdditionalFrame::HelpCreationModule:

Collaboration diagram for GNEAdditionalFrame::HelpCreationModule:

Public Types
enum	Options { NOTHING = 1 << 0 , COLLAPSIBLE = 1 << 1 , EXTENSIBLE = 1 << 2 , SAVE = 1 << 3 , LOAD = 1 << 4 }
	GroupBoxModule options. More...

Public Member Functions
FXVerticalFrame *	getCollapsableFrame ()
	get collapsable frame (used by all elements that will be collapsed if button is toggled)

	HelpCreationModule (GNEFrame *frameParent)
	constructor

void	hideHelpCreationModule ()
	hide Legend modul

long	onCmdCollapseButton (FXObject , FXSelector, void )
	collapse GroupBoxModule

long	onCmdExtendButton (FXObject , FXSelector, void )
	extends GroupBoxModule

long	onCmdLoadButton (FXObject , FXSelector, void )
	load contents

long	onCmdResetButton (FXObject , FXSelector, void )
	reset GroupBoxModule

long	onCmdSaveButton (FXObject , FXSelector, void )
	save contents

long	onPaint (FXObject , FXSelector, void )
	draw MFXGroupBoxModule

long	onUpdResetButton (FXObject , FXSelector, void )
	update reset GroupBoxModule

void	setText (const std::string &text)
	set text

void	showHelpCreationModule (SumoXMLTag XMLTag)
	show Legend modul

	~HelpCreationModule ()
	destructor

Protected Member Functions
virtual bool	loadContents () const
	load contents (can be reimplemented in children)

virtual bool	saveContents () const
	save contents (can be reimplemented in children)

void	toggleSaveButton (const bool value)
	enable or disable save buttons

Private Member Functions
std::string	addTLString (const std::string &str)
	add translated string

Private Attributes
FXVerticalFrame *	myCollapsableFrame = nullptr
	vertical collapsable frame

FXButton *	myCollapseButton = nullptr
	button for collapse elements

bool	myCollapsed
	flag to check if this groupbox is collapsed

MFXButtonTooltip *	myExtendButton = nullptr
	button for extend elements

GNEFrame *	myFrameParent = nullptr
	GNEFrame in which this GroupBox is placed.

FXLabel *	myHelpLabel = nullptr
	help label

std::map< SumoXMLTag, std::string >	myHelpMap
	map with tags and their associated help

FXLabel *	myLabel = nullptr
	label used in non collapsable MFXGroupBoxModule

FXButton *	myLoadButton = nullptr
	button for load elements

const int	myOptions
	GroupBoxModule options.

FXButton *	myResetWidthButton = nullptr
	button for reset frame width

FXButton *	mySaveButton = nullptr
	button for save elements

Detailed Description

Definition at line 66 of file GNEAdditionalFrame.h.

Member Enumeration Documentation

◆ Options

enum MFXGroupBoxModule::Options

inherited

GroupBoxModule options.

Enumerator
NOTHING
COLLAPSIBLE
EXTENSIBLE
SAVE
LOAD

Definition at line 38 of file MFXGroupBoxModule.h.

Constructor & Destructor Documentation

◆ HelpCreationModule()

GNEAdditionalFrame::HelpCreationModule::HelpCreationModule ( GNEFrame * frameParent )

constructor

Definition at line 82 of file GNEAdditionalFrame.cpp.

References addTLString(), MFXGroupBoxModule::getCollapsableFrame(), GUIDesignLabelFrameInformation, myHelpLabel, myHelpMap, SUMO_TAG_DET_ENTRY, SUMO_TAG_DET_EXIT, SUMO_TAG_ENTRY_EXIT_DETECTOR, SUMO_TAG_INDUCTION_LOOP, SUMO_TAG_INSTANT_INDUCTION_LOOP, SUMO_TAG_LANE_AREA_DETECTOR, and TL.

◆ ~HelpCreationModule()

GNEAdditionalFrame::HelpCreationModule::~HelpCreationModule ( )

destructor

Definition at line 106 of file GNEAdditionalFrame.cpp.

Member Function Documentation

◆ addTLString()

std::string GNEAdditionalFrame::HelpCreationModule::addTLString ( const std::string & str )

private

add translated string

Definition at line 127 of file GNEAdditionalFrame.cpp.

Referenced by HelpCreationModule().

Here is the caller graph for this function:

◆ getCollapsableFrame()

FXVerticalFrame * MFXGroupBoxModule::getCollapsableFrame ( )

inherited

get collapsable frame (used by all elements that will be collapsed if button is toggled)

Definition at line 123 of file MFXGroupBoxModule.cpp.

References MFXGroupBoxModule::myCollapsableFrame.

Referenced by GNEInspectorFrame::AdditionalDialog::AdditionalDialog(), GNEFrameAttributeModules::AttributesEditor::AttributesEditor(), GNEFrameAttributeModules::AttributesEditorExtended::AttributesEditorExtended(), GNEGenericDataFrame::AttributeSelector::AttributeSelector(), GNEOverlappedInspection::buildFXElements(), GNEMoveFrame::ChangeZInSelection::ChangeZInSelection(), GNEConnectorFrame::ConnectionModifications::ConnectionModifications(), GNEConnectorFrame::ConnectionOperations::ConnectionOperations(), GNEConnectorFrame::ConnectionSelection::ConnectionSelection(), GNECrossingFrame::CreateCrossing::CreateCrossing(), GNECrossingFrame::CrossingParameters::CrossingParameters(), GNETAZFrame::CurrentTAZ::CurrentTAZ(), GNEMoveFrame::DemandModeOptions::DemandModeOptions(), GNEDistributionFrame::DistributionSelector::DistributionSelector(), GNEDistributionFrame::DistributionValuesEditor::DistributionValuesEditor(), GNEAdditionalFrame::E2MultilaneLegendModule::E2MultilaneLegendModule(), GNECrossingFrame::EdgesSelector::EdgesSelector(), GNEFrameAttributeModules::GenericDataAttributes::GenericDataAttributes(), GNEInspectorFrame::GEOAttributesEditor::GEOAttributesEditor(), GNEDemandElementSelector::GNEDemandElementSelector(), GNEOptionsDialog::GNEOptionsDialog(), GNEPathCreator::GNEPathCreator(), GNEPathLegendModule::GNEPathLegendModule(), GNEPlanCreator::GNEPlanCreator(), GNEPlanCreatorLegend::GNEPlanCreatorLegend(), GNESelectorParent::GNESelectorParent(), GNEStopFrame::HelpCreation::HelpCreation(), GNEVehicleFrame::HelpCreation::HelpCreation(), HelpCreationModule(), GNECrossingFrame::Information::Information(), GNEMoveFrame::Information::Information(), GNESelectorFrame::Information::Information(), GNEGenericDataFrame::IntervalSelector::IntervalSelector(), GNECreateEdgeFrame::LaneTypeSelector::LaneTypeSelector(), GNEConnectorFrame::Legend::Legend(), GNECreateEdgeFrame::Legend::Legend(), GNEProhibitionFrame::Legend::Legend(), GNETAZRelDataFrame::Legend::Legend(), GNEMeanDataFrame::MeanDataEditor::MeanDataEditor(), GNEMeanDataFrame::MeanDataSelector::MeanDataSelector(), GNESelectorFrame::ModificationMode::ModificationMode(), GNEMoveFrame::NetworkModeOptions::NetworkModeOptions(), GNEMatchAttribute::onCmdHelp(), GNEMatchGenericDataAttribute::onCmdHelp(), GNENeteditAttributes::onCmdHelp(), GNEOverlappedInspection::onCmdOverlappingHelp(), GNEFrameAttributeModules::ParametersEditor::ParametersEditor(), GNEFrameAttributeModules::ParametersEditor::ParametersEditor(), GNEDeleteFrame::ProtectElements::ProtectElements(), GNEAttributesCreator::refreshRows(), GNEProhibitionFrame::Selection::Selection(), GNESelectorFrame::SelectionHierarchy::SelectionHierarchy(), GNESelectorFrame::SelectionOperation::SelectionOperation(), GNEMoveFrame::ShiftEdgeSelectedGeometry::ShiftEdgeSelectedGeometry(), GNEMoveFrame::ShiftShapeGeometry::ShiftShapeGeometry(), GNETAZFrame::TAZChildDefaultParameters::TAZChildDefaultParameters(), GNETAZFrame::TAZCommonStatistics::TAZCommonStatistics(), GNETAZFrame::TAZEdgesGraphic::TAZEdgesGraphic(), GNETAZFrame::TAZParameters::TAZParameters(), GNETAZFrame::TAZSaveChanges::TAZSaveChanges(), GNETAZFrame::TAZSelectionStatistics::TAZSelectionStatistics(), GNEInspectorFrame::TemplateEditor::TemplateEditor(), GNETLSEditorFrame::TLSAttributes::TLSAttributes(), GNETLSEditorFrame::TLSDefinition::TLSDefinition(), GNETLSEditorFrame::TLSFile::TLSFile(), GNETLSEditorFrame::TLSJunction::TLSJunction(), GNETLSEditorFrame::TLSPhases::TLSPhases(), GNETypeFrame::TypeEditor::TypeEditor(), and GNESelectorFrame::VisualScaling::VisualScaling().

◆ hideHelpCreationModule()

void GNEAdditionalFrame::HelpCreationModule::hideHelpCreationModule ( )

hide Legend modul

Definition at line 121 of file GNEAdditionalFrame.cpp.

References GNEFrame::hide().

Referenced by GNEAdditionalFrame::tagSelected().

Here is the caller graph for this function:

◆ loadContents()

bool MFXGroupBoxModule::loadContents ( ) const

protectedvirtualinherited

load contents (can be reimplemented in children)

Definition at line 231 of file MFXGroupBoxModule.cpp.

Referenced by MFXGroupBoxModule::onCmdLoadButton().

Here is the caller graph for this function:

◆ onCmdCollapseButton()

long MFXGroupBoxModule::onCmdCollapseButton	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

collapse GroupBoxModule

Definition at line 142 of file MFXGroupBoxModule.cpp.

References COLLAPSE, GUIIconSubSys::getIcon(), MFXGroupBoxModule::myCollapsableFrame, MFXGroupBoxModule::myCollapseButton, MFXGroupBoxModule::myCollapsed, and UNCOLLAPSE.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdExtendButton()

long MFXGroupBoxModule::onCmdExtendButton	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

extends GroupBoxModule

Definition at line 158 of file MFXGroupBoxModule.cpp.

References GNEFrame::getScrollBarWidth(), GNETLSEditorFrame::TLSPhases::getTLSEditorParent(), GNETLSTable::getTLSPhasesParent(), GNEFrame::getViewNet(), GNEViewNet::getViewParent(), MFXGroupBoxModule::myCollapsableFrame, MFXGroupBoxModule::myFrameParent, and GNEViewParent::setFrameAreaWidth().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdLoadButton()

long MFXGroupBoxModule::onCmdLoadButton	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

load contents

Definition at line 212 of file MFXGroupBoxModule.cpp.

References MFXGroupBoxModule::loadContents().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdResetButton()

long MFXGroupBoxModule::onCmdResetButton	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

reset GroupBoxModule

Definition at line 184 of file MFXGroupBoxModule.cpp.

References GNEFrame::getViewNet(), GNEViewNet::getViewParent(), MFXGroupBoxModule::myFrameParent, and GNEViewParent::setFrameAreaWidth().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdSaveButton()

long MFXGroupBoxModule::onCmdSaveButton	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

save contents

Definition at line 206 of file MFXGroupBoxModule.cpp.

References MFXGroupBoxModule::saveContents().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onPaint()

long MFXGroupBoxModule::onPaint	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

inherited

draw MFXGroupBoxModule

Definition at line 129 of file MFXGroupBoxModule.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onUpdResetButton()

long MFXGroupBoxModule::onUpdResetButton	(	FXObject *	sender,
		FXSelector	,
		void *
	)

inherited

update reset GroupBoxModule

Definition at line 193 of file MFXGroupBoxModule.cpp.

References GNEViewParent::getFrameAreaWidth(), GNEFrame::getViewNet(), GNEViewNet::getViewParent(), and MFXGroupBoxModule::myFrameParent.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ saveContents()

bool MFXGroupBoxModule::saveContents ( ) const

protectedvirtualinherited

save contents (can be reimplemented in children)

Reimplemented in GNEFixDemandElements::FixOptions, and GNEFixNetworkElements::FixOptions.

Definition at line 224 of file MFXGroupBoxModule.cpp.

Referenced by MFXGroupBoxModule::onCmdSaveButton().

Here is the caller graph for this function:

◆ setText()

void MFXGroupBoxModule::setText ( const std::string & text )

inherited

set text

Definition at line 117 of file MFXGroupBoxModule.cpp.

References MFXGroupBoxModule::myLabel.

Referenced by GNETagSelector::setCurrentTagType(), and GNESelectorFrame::SelectionInformation::updateInformationLabel().

Here is the caller graph for this function:

◆ showHelpCreationModule()

void GNEAdditionalFrame::HelpCreationModule::showHelpCreationModule ( SumoXMLTag XMLTag )

show Legend modul

Definition at line 110 of file GNEAdditionalFrame.cpp.

References GNEFrame::hide(), and GNEAdditionalFrame::show().

Referenced by GNEAdditionalFrame::tagSelected().

Here is the caller graph for this function:

◆ toggleSaveButton()

void MFXGroupBoxModule::toggleSaveButton ( const bool value )

protectedinherited

enable or disable save buttons

Definition at line 238 of file MFXGroupBoxModule.cpp.

References MFXGroupBoxModule::mySaveButton.

Field Documentation

◆ myCollapsableFrame

FXVerticalFrame* MFXGroupBoxModule::myCollapsableFrame = nullptr

privateinherited

vertical collapsable frame

Definition at line 103 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::getCollapsableFrame(), MFXGroupBoxModule::MFXGroupBoxModule(), MFXGroupBoxModule::onCmdCollapseButton(), and MFXGroupBoxModule::onCmdExtendButton().

◆ myCollapseButton

FXButton* MFXGroupBoxModule::myCollapseButton = nullptr

privateinherited

button for collapse elements

Definition at line 109 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::MFXGroupBoxModule(), and MFXGroupBoxModule::onCmdCollapseButton().

◆ myCollapsed

bool MFXGroupBoxModule::myCollapsed

privateinherited

flag to check if this groupbox is collapsed

Definition at line 124 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::onCmdCollapseButton().

◆ myExtendButton

MFXButtonTooltip* MFXGroupBoxModule::myExtendButton = nullptr

privateinherited

button for extend elements

Definition at line 112 of file MFXGroupBoxModule.h.

◆ myFrameParent

GNEFrame* MFXGroupBoxModule::myFrameParent = nullptr

privateinherited

GNEFrame in which this GroupBox is placed.

Definition at line 100 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::onCmdExtendButton(), MFXGroupBoxModule::onCmdResetButton(), and MFXGroupBoxModule::onUpdResetButton().

◆ myHelpLabel

FXLabel* GNEAdditionalFrame::HelpCreationModule::myHelpLabel = nullptr

private

help label

Definition at line 86 of file GNEAdditionalFrame.h.

Referenced by HelpCreationModule().

◆ myHelpMap

std::map<SumoXMLTag, std::string> GNEAdditionalFrame::HelpCreationModule::myHelpMap

private

map with tags and their associated help

Definition at line 89 of file GNEAdditionalFrame.h.

Referenced by HelpCreationModule().

◆ myLabel

FXLabel* MFXGroupBoxModule::myLabel = nullptr

privateinherited

label used in non collapsable MFXGroupBoxModule

Definition at line 106 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::MFXGroupBoxModule(), and MFXGroupBoxModule::setText().

◆ myLoadButton

FXButton* MFXGroupBoxModule::myLoadButton = nullptr

privateinherited

button for load elements

Definition at line 121 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::MFXGroupBoxModule().

◆ myOptions

const int MFXGroupBoxModule::myOptions

privateinherited

GroupBoxModule options.

Definition at line 97 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::MFXGroupBoxModule().

◆ myResetWidthButton

FXButton* MFXGroupBoxModule::myResetWidthButton = nullptr

privateinherited

button for reset frame width

Definition at line 115 of file MFXGroupBoxModule.h.

◆ mySaveButton

FXButton* MFXGroupBoxModule::mySaveButton = nullptr

privateinherited

button for save elements

Definition at line 118 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule::MFXGroupBoxModule(), and MFXGroupBoxModule::toggleSaveButton().

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Options

Constructor & Destructor Documentation

◆ HelpCreationModule()

◆ ~HelpCreationModule()

Member Function Documentation

◆ addTLString()

◆ getCollapsableFrame()

◆ hideHelpCreationModule()

◆ loadContents()

◆ onCmdCollapseButton()

◆ onCmdExtendButton()

◆ onCmdLoadButton()

◆ onCmdResetButton()

◆ onCmdSaveButton()

◆ onPaint()

◆ onUpdResetButton()

◆ saveContents()

◆ setText()

◆ showHelpCreationModule()

◆ toggleSaveButton()

Field Documentation

◆ myCollapsableFrame

◆ myCollapseButton

◆ myCollapsed

◆ myExtendButton

◆ myFrameParent

◆ myHelpLabel

◆ myHelpMap

◆ myLabel

◆ myLoadButton

◆ myOptions

◆ myResetWidthButton

◆ mySaveButton