#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 67 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 80 of file GNEAdditionalFrame.cpp.

References addTLString(), MFXGroupBoxModule::getCollapsableFrame(), GNEFrame::GNEFrame(), GUIDesignLabelFrameInformation, MFXGroupBoxModule::MFXGroupBoxModule(), 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 104 of file GNEAdditionalFrame.cpp.

Member Function Documentation

◆ addTLString()

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

private

add translated string

Definition at line 125 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 126 of file MFXGroupBoxModule.cpp.

References myCollapsableFrame.

Referenced by GNEGenericDataFrame::AttributeSelector::AttributeSelector(), GNEMoveFrame::ChangeZInSelection::ChangeZInSelection(), GNEMoveFrame::CommonMoveOptions::CommonMoveOptions(), GNETAZRelDataFrame::ConfirmTAZRelation::ConfirmTAZRelation(), GNEConnectorFrame::ConnectionModifications::ConnectionModifications(), GNEConnectorFrame::ConnectionOperations::ConnectionOperations(), GNEConnectorFrame::ConnectionSelection::ConnectionSelection(), GNECrossingFrame::CreateCrossing::CreateCrossing(), GNECrossingFrame::CrossingParameters::CrossingParameters(), GNEConnectorFrame::CurrentLane::CurrentLane(), GNETAZFrame::CurrentTAZ::CurrentTAZ(), GNEGenericDataFrame::DataSetSelector::DataSetSelector(), GNEDeleteFrame::DeleteOptions::DeleteOptions(), GNEMoveFrame::DemandMoveOptions::DemandMoveOptions(), GNEDistributionFrame::DistributionEditor::DistributionEditor(), GNEDistributionFrame::DistributionSelector::DistributionSelector(), GNEDistributionFrame::DistributionValuesEditor::DistributionValuesEditor(), GNEAdditionalFrame::E2MultilaneLegendModule::E2MultilaneLegendModule(), GNECrossingFrame::EdgesSelector::EdgesSelector(), GNECreateEdgeFrame::EdgeTypeSelector::EdgeTypeSelector(), GNEFixElementsDialog< T >::FixOptions::FixOptions(), GNEShapeFrame::GEOPOICreator::GEOPOICreator(), GNEAttributesEditorType::GNEAttributesEditorType(), GNEConsecutiveSelector::GNEConsecutiveSelector(), GNEDemandElementSelector::GNEDemandElementSelector(), GNEDrawingShape::GNEDrawingShape(), GNEElementTree::GNEElementTree(), GNEMatchAttribute::GNEMatchAttribute(), GNEOptionsEditor::GNEOptionsEditor(), GNEOverlappedInspection::GNEOverlappedInspection(), GNEPathCreator::GNEPathCreator(), GNEPathLegendModule::GNEPathLegendModule(), GNEPlanCreator::GNEPlanCreator(), GNEPlanCreatorLegend::GNEPlanCreatorLegend(), GNEPlanSelector::GNEPlanSelector(), GNESelectorParent::GNESelectorParent(), GNETagSelector::GNETagSelector(), GNEViewObjectSelector::GNEViewObjectSelector(), GNEStopFrame::HelpCreation::HelpCreation(), GNEVehicleFrame::HelpCreation::HelpCreation(), GNEAdditionalFrame::HelpCreationModule::HelpCreationModule(), GNECrossingFrame::Information::Information(), GNEMoveFrame::Information::Information(), GNESelectorFrame::Information::Information(), GNEGenericDataFrame::IntervalSelector::IntervalSelector(), GNECrossingFrame::JunctionInformation::JunctionInformation(), GNECreateEdgeFrame::LaneTypeSelector::LaneTypeSelector(), GNEConnectorFrame::Legend::Legend(), GNECreateEdgeFrame::Legend::Legend(), GNEProhibitionFrame::Legend::Legend(), GNETAZRelDataFrame::Legend::Legend(), GNEMeanDataFrame::MeanDataEditor::MeanDataEditor(), GNEMeanDataFrame::MeanDataSelector::MeanDataSelector(), GNEMeanDataFrame::MeanDataTypeSelector::MeanDataTypeSelector(), GNESelectorFrame::ModificationMode::ModificationMode(), GNEMoveFrame::NetworkMoveOptions::NetworkMoveOptions(), GNESelectorFrame::SelectionOperation::onCmdLoad(), GNETLSEditorFrame::TLSFile::onCmdLoadTLSProgram(), GNETLSEditorFrame::TLSJunction::onCmdToggleJoinTLS(), GNEDeleteFrame::ProtectElements::ProtectElements(), GNEDistributionFrame::DistributionValuesEditor::refreshRows(), GNEProhibitionFrame::RelativeToConnection::RelativeToConnection(), GNERouteFrame::RouteModeSelector::RouteModeSelector(), GNEProhibitionFrame::Selection::Selection(), GNESelectorFrame::SelectionHierarchy::SelectionHierarchy(), GNESelectorFrame::SelectionInformation::SelectionInformation(), GNESelectorFrame::SelectionOperation::SelectionOperation(), GNEMoveFrame::ShiftEdgeSelectedGeometry::ShiftEdgeSelectedGeometry(), GNEMoveFrame::ShiftShapeGeometry::ShiftShapeGeometry(), GNETAZFrame::TAZChildDefaultParameters::TAZChildDefaultParameters(), GNETAZFrame::TAZCommonStatistics::TAZCommonStatistics(), GNETAZFrame::TAZEdgesGraphic::TAZEdgesGraphic(), GNETAZFrame::TAZSaveChanges::TAZSaveChanges(), GNETAZFrame::TAZSelectionStatistics::TAZSelectionStatistics(), GNEInspectorFrame::TemplateEditor::TemplateEditor(), GNETLSEditorFrame::TLSAttributes::TLSAttributes(), GNETLSEditorFrame::TLSFile::TLSFile(), GNETLSEditorFrame::TLSJunction::TLSJunction(), GNETLSEditorFrame::TLSPhases::TLSPhases(), GNETLSEditorFrame::TLSPrograms::TLSPrograms(), GNETypeFrame::TypeEditor::TypeEditor(), GNETypeFrame::TypeSelector::TypeSelector(), and GNESelectorFrame::VisualScaling::VisualScaling().

◆ hideHelpCreationModule()

void GNEAdditionalFrame::HelpCreationModule::hideHelpCreationModule ( )

hide Legend modul

Definition at line 119 of file GNEAdditionalFrame.cpp.

References GNEFrame::hide().

◆ loadContents()

bool MFXGroupBoxModule::loadContents ( ) const

protectedvirtualinherited

load contents (can be reimplemented in children)

Definition at line 234 of file MFXGroupBoxModule.cpp.

Referenced by onCmdLoadButton().

Here is the caller graph for this function:

◆ onCmdCollapseButton()

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

inherited

collapse GroupBoxModule

Definition at line 145 of file MFXGroupBoxModule.cpp.

References COLLAPSE, GUIIconSubSys::getIcon(), myCollapsableFrame, myCollapseButton, 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 161 of file MFXGroupBoxModule.cpp.

References myCollapsableFrame, and myFrameParent.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdLoadButton()

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

inherited

load contents

Definition at line 215 of file MFXGroupBoxModule.cpp.

References 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 187 of file MFXGroupBoxModule.cpp.

References myFrameParent.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdSaveButton()

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

inherited

save contents

Definition at line 209 of file MFXGroupBoxModule.cpp.

References 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 132 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 196 of file MFXGroupBoxModule.cpp.

References 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 GNEFixElementsDialog< T >::FixOptions.

Definition at line 227 of file MFXGroupBoxModule.cpp.

Referenced by onCmdSaveButton().

Here is the caller graph for this function:

◆ setText()

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

inherited

set text

Definition at line 120 of file MFXGroupBoxModule.cpp.

References myLabel.

Referenced by GNEViewObjectSelector::showNetworkElementsSelector(), and GNETagSelector::updateTagTypes().

Here is the caller graph for this function:

◆ showHelpCreationModule()

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

show Legend modul

Definition at line 108 of file GNEAdditionalFrame.cpp.

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

◆ toggleSaveButton()

void MFXGroupBoxModule::toggleSaveButton ( const bool value )

protectedinherited

enable or disable save buttons

Definition at line 241 of file MFXGroupBoxModule.cpp.

References invalid_return< std::string >::value, and mySaveButton.

Field Documentation

◆ myCollapsableFrame

FXVerticalFrame* MFXGroupBoxModule::myCollapsableFrame = nullptr

privateinherited

vertical collapsable frame

Definition at line 103 of file MFXGroupBoxModule.h.

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

◆ myCollapseButton

FXButton* MFXGroupBoxModule::myCollapseButton = nullptr

privateinherited

button for collapse elements

Definition at line 109 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule(), MFXGroupBoxModule(), and 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(), MFXGroupBoxModule(), MFXGroupBoxModule(), and onCmdCollapseButton().

◆ myExtendButton

MFXButtonTooltip* MFXGroupBoxModule::myExtendButton = nullptr

privateinherited

button for extend elements

Definition at line 112 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule().

◆ 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(), onCmdResetButton(), and onUpdResetButton().

◆ myHelpLabel

FXLabel* GNEAdditionalFrame::HelpCreationModule::myHelpLabel = nullptr

private

help label

Definition at line 87 of file GNEAdditionalFrame.h.

Referenced by HelpCreationModule(), and showHelpCreationModule().

◆ myHelpMap

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

private

map with tags and their associated help

Definition at line 90 of file GNEAdditionalFrame.h.

Referenced by HelpCreationModule(), and showHelpCreationModule().

◆ 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 setText().

◆ myLoadButton

FXButton* MFXGroupBoxModule::myLoadButton = nullptr

privateinherited

button for load elements

Definition at line 121 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule(), and MFXGroupBoxModule().

◆ myOptions

const int MFXGroupBoxModule::myOptions

privateinherited

GroupBoxModule options.

Definition at line 97 of file MFXGroupBoxModule.h.

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

◆ myResetWidthButton

FXButton* MFXGroupBoxModule::myResetWidthButton = nullptr

privateinherited

button for reset frame width

Definition at line 115 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule().

◆ mySaveButton

FXButton* MFXGroupBoxModule::mySaveButton = nullptr

privateinherited

button for save elements

Definition at line 118 of file MFXGroupBoxModule.h.

Referenced by MFXGroupBoxModule(), MFXGroupBoxModule(), and 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