Eclipse SUMO - Simulation of Urban MObility
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | Friends
GNEFrame Class Reference

#include <GNEFrame.h>

Inheritance diagram for GNEFrame:
Collaboration diagram for GNEFrame:

Public Member Functions

void focusUpperElement ()
 focus upper element of frame More...
 
FXFont * getFrameHeaderFont () const
 get font of the header's frame More...
 
FXLabel * getFrameHeaderLabel () const
 get the label for the frame's header More...
 
GNEViewNet * getViewNet () const
 get view net More...
 
 GNEFrame (FXHorizontalFrame *horizontalFrameParent, GNEViewNet *viewNet, const std::string &frameLabel)
 Constructor. More...
 
virtual void hide ()
 hide Frame More...
 
void setFrameWidth (int newWidth)
 set width of GNEFrame More...
 
virtual void show ()
 show Frame More...
 
virtual void updateFrameAfterUndoRedo ()
 function called after undo/redo in the current frame (can be reimplemented in frame children) More...
 
 ~GNEFrame ()
 destructor More...
 

Protected Member Functions

const RGBColor & getEdgeCandidateColor () const
 get edge candidate color More...
 
const RGBColor & getEdgeCandidateSelectedColor () const
 get selected color More...
 
const std::map< int, std::string > & getPredefinedTagsMML () const
 get predefinedTagsMML More...
 
void openHelpAttributesDialog (const GNEAttributeCarrier::TagProperties &tagProperties) const
 Open help attributes dialog. More...
 
functions called by moduls that can be reimplemented in frame children
virtual void tagSelected ()
 Tag selected in TagSelector. More...
 
virtual void demandElementSelected ()
 selected demand element in DemandElementSelector More...
 
virtual void edgePathCreated ()
 finish edge path creation More...
 
virtual bool shapeDrawed ()
 build a shaped element using the drawed shape (can be reimplemented in frame children) More...
 
virtual void attributeUpdated ()
 function called after set a valid attribute in AttributeCreator/AttributeEditor/ParametersEditor/... More...
 
virtual void attributesEditorExtendedDialogOpened ()
 open AttributesCreator extended dialog (can be reimplemented in frame children) More...
 
virtual void selectedOverlappedElement (GNEAttributeCarrier *AC)
 open AttributesCreator extended dialog (can be reimplemented in frame children) More...
 

Protected Attributes

FXVerticalFrame * myContentFrame = nullptr
 Vertical frame that holds all widgets of frame. More...
 
FXHorizontalFrame * myHeaderFrame = nullptr
 fame for header elements More...
 
FXHorizontalFrame * myHeaderLeftFrame = nullptr
 fame for left header elements More...
 
FXHorizontalFrame * myHeaderRightFrame = nullptr
 fame for right header elements More...
 
GNEViewNet * myViewNet = nullptr
 View Net. More...
 

Private Member Functions

 GNEFrame (const GNEFrame &)=delete
 Invalidated copy constructor. More...
 
GNEFrame & operator= (const GNEFrame &)=delete
 Invalidated assignment operator. More...
 

Private Attributes

RGBColor myEdgeCandidateColor
 edge candidate color (used by some modulds to mark edges) More...
 
RGBColor myEdgeCandidateSelectedColor
 selected edge candidate color (used by some modulds to selected mark edges) More...
 
FXLabel * myFrameHeaderLabel = nullptr
 the label for the frame's header More...
 
std::map< int, std::string > myPredefinedTagsMML
 Map of attribute ids to their (readable) string-representation (needed for SUMOSAXAttributesImpl_Cached) More...
 
FXScrollWindow * myScrollWindowsContents = nullptr
 scroll windows that holds the content frame More...
 

Static Private Attributes

static FXFont * myFrameHeaderFont = nullptr
 static Font for the Header (it's common for all headers, then create only one time) More...
 

Friends

class GNEFrameAttributesModuls
 
class GNEFrameModuls
 friend class More...
 

Detailed Description

Abstract class for lateral frames in NetEdit

Definition at line 34 of file GNEFrame.h.

Constructor & Destructor Documentation

◆ GNEFrame() [1/2]

GNEFrame::GNEFrame ( FXHorizontalFrame *  horizontalFrameParent,
GNEViewNet *  viewNet,
const std::string &  frameLabel 
)

Constructor.

parent FXHorizontalFrame in which this GNEFrame is placed

viewNet viewNet that uses this GNEFrame

frameLabel label of the frame

Definition at line 41 of file GNEFrame.cpp.

References SUMOXMLDefinitions::attrs, GUIDesignAuxiliarHorizontalFrame, GUIDesignContentsFrame, GUIDesignContentsScrollWindow, GUIDesignHorizontalSeparator, GUIDesignLabelFrameInformation, myContentFrame, myFrameHeaderFont, myFrameHeaderLabel, myHeaderFrame, myHeaderLeftFrame, myHeaderRightFrame, myPredefinedTagsMML, myScrollWindowsContents, SUMO_ATTR_NOTHING, and toString().

◆ ~GNEFrame()

GNEFrame::~GNEFrame ( )

destructor

Definition at line 91 of file GNEFrame.cpp.

References myFrameHeaderFont.

◆ GNEFrame() [2/2]

GNEFrame::GNEFrame ( const GNEFrame &  )
privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ attributesEditorExtendedDialogOpened()

void GNEFrame::attributesEditorExtendedDialogOpened ( )
protectedvirtual

open AttributesCreator extended dialog (can be reimplemented in frame children)

Reimplemented in GNEVehicleTypeFrame.

Definition at line 190 of file GNEFrame.cpp.

◆ attributeUpdated()

void GNEFrame::attributeUpdated ( )
protectedvirtual

function called after set a valid attribute in AttributeCreator/AttributeEditor/ParametersEditor/...

Reimplemented in GNEInspectorFrame, GNEVehicleTypeFrame, and GNEPersonTypeFrame.

Definition at line 184 of file GNEFrame.cpp.

◆ demandElementSelected()

void GNEFrame::demandElementSelected ( )
protectedvirtual

selected demand element in DemandElementSelector

Reimplemented in GNEPersonPlanFrame, GNEStopFrame, GNEVehicleFrame, and GNEPersonFrame.

Definition at line 165 of file GNEFrame.cpp.

◆ edgePathCreated()

void GNEFrame::edgePathCreated ( )
protectedvirtual

finish edge path creation

Reimplemented in GNEVehicleFrame, and GNEPersonFrame.

Definition at line 171 of file GNEFrame.cpp.

◆ focusUpperElement()

void GNEFrame::focusUpperElement ( )

focus upper element of frame

Definition at line 101 of file GNEFrame.cpp.

References myFrameHeaderLabel.

Referenced by GNEViewNet::hotkeyFocusFrame(), GNEInspectorFrame::processDemandSupermodeClick(), GNEInspectorFrame::processNetworkSupermodeClick(), GNEViewNet::updateDemandModeSpecificControls(), and GNEViewNet::updateNetworkModeSpecificControls().

◆ getEdgeCandidateColor()

const RGBColor & GNEFrame::getEdgeCandidateColor ( ) const
protected

get edge candidate color

Definition at line 269 of file GNEFrame.cpp.

References myEdgeCandidateColor.

Referenced by GNECrossingFrame::GNECrossingFrame().

◆ getEdgeCandidateSelectedColor()

const RGBColor & GNEFrame::getEdgeCandidateSelectedColor ( ) const
protected

get selected color

Definition at line 275 of file GNEFrame.cpp.

References myEdgeCandidateSelectedColor.

Referenced by GNECrossingFrame::GNECrossingFrame().

◆ getFrameHeaderFont()

FXFont * GNEFrame::getFrameHeaderFont ( ) const

get font of the header's frame

Definition at line 144 of file GNEFrame.cpp.

References myFrameHeaderFont.

◆ getFrameHeaderLabel()

FXLabel * GNEFrame::getFrameHeaderLabel ( ) const

get the label for the frame's header

Definition at line 138 of file GNEFrame.cpp.

References myFrameHeaderLabel.

Referenced by GNEProhibitionFrame::GNEProhibitionFrame(), and GNEInspectorFrame::inspectMultisection().

◆ getPredefinedTagsMML()

const std::map< int, std::string > & GNEFrame::getPredefinedTagsMML ( ) const
protected

get predefinedTagsMML

Definition at line 281 of file GNEFrame.cpp.

References myPredefinedTagsMML.

Referenced by GNEVehicleFrame::addVehicle(), GNEAdditionalFrame::buildAdditionalOverEdge(), GNEAdditionalFrame::buildAdditionalOverLane(), GNEAdditionalFrame::buildAdditionalOverLanes(), GNEAdditionalFrame::buildAdditionalOverView(), GNEPersonFrame::buildPerson(), GNEVehicleFrame::edgePathCreated(), and GNETAZFrame::shapeDrawed().

◆ getViewNet()

GNEViewNet * GNEFrame::getViewNet ( ) const

get view net

Definition at line 132 of file GNEFrame.cpp.

References myViewNet.

Referenced by GNEInternalLane::drawGL(), GNEInternalLane::getPopUpMenu(), and GNEDeleteFrame::removeAttributeCarrier().

◆ hide()

void GNEFrame::hide ( )
virtual

hide Frame

Note
some GNEFrames needs a re-implementation

Reimplemented in GNETAZFrame, GNESelectorFrame, GNEInspectorFrame, GNERouteFrame, GNECrossingFrame, GNEPersonPlanFrame, GNEProhibitionFrame, GNEDeleteFrame, and GNECreateEdgeFrame.

Definition at line 116 of file GNEFrame.cpp.

References GNEViewNet::getViewParent(), GNEViewParent::hideFramesArea(), and myViewNet.

Referenced by GNECreateEdgeFrame::hide(), GNEDeleteFrame::hide(), GNEProhibitionFrame::hide(), GNEPersonPlanFrame::hide(), GNECrossingFrame::hide(), GNERouteFrame::hide(), GNEInspectorFrame::hide(), GNESelectorFrame::hide(), GNETAZFrame::hide(), GNEPolygonFrame::GEOPOICreator::hideGEOPOICreatorModul(), GNEPersonFrame::HelpCreation::hideHelpCreation(), GNEVehicleFrame::HelpCreation::hideHelpCreation(), GNEStopFrame::HelpCreation::hideHelpCreation(), GNEPersonTypeFrame::PersonTypeEditor::hidePersonTypeEditorModul(), and GNEVehicleTypeFrame::VehicleTypeEditor::hideVehicleTypeEditorModul().

◆ openHelpAttributesDialog()

void GNEFrame::openHelpAttributesDialog ( const GNEAttributeCarrier::TagProperties &  tagProperties) const
protected

Open help attributes dialog.

Definition at line 202 of file GNEFrame.cpp.

References GUIIconSubSys::getIcon(), GNEAttributeCarrier::TagProperties::getNumberOfAttributes(), GNEAttributeCarrier::TagProperties::getTagStr(), GUIDesignAuxiliarHorizontalFrame, GUIDesignButtonOK, GUIDesignDialogBoxResizable, GUIDesignHorizontalSeparator, GUIDesignTableNotEditable, ICON_ACCEPT, ICON_MODEINSPECT, MAX2(), MID_TABLE, myScrollWindowsContents, toString(), and WRITE_DEBUG.

◆ operator=()

GNEFrame& GNEFrame::operator= ( const GNEFrame &  )
privatedelete

Invalidated assignment operator.

◆ selectedOverlappedElement()

void GNEFrame::selectedOverlappedElement ( GNEAttributeCarrier *  AC)
protectedvirtual

open AttributesCreator extended dialog (can be reimplemented in frame children)

Reimplemented in GNETLSEditorFrame, and GNEInspectorFrame.

Definition at line 196 of file GNEFrame.cpp.

◆ setFrameWidth()

void GNEFrame::setFrameWidth ( int  newWidth)

set width of GNEFrame

Definition at line 125 of file GNEFrame.cpp.

References myScrollWindowsContents.

◆ shapeDrawed()

bool GNEFrame::shapeDrawed ( )
protectedvirtual

build a shaped element using the drawed shape (can be reimplemented in frame children)

Reimplemented in GNETAZFrame, and GNEPolygonFrame.

Definition at line 177 of file GNEFrame.cpp.

◆ show()

void GNEFrame::show ( )
virtual

show Frame

Note
some GNEFrames needs a re-implementation

Reimplemented in GNESelectorFrame, GNETLSEditorFrame, GNEAdditionalFrame, GNEInspectorFrame, GNERouteFrame, GNEPersonPlanFrame, GNEVehicleTypeFrame, GNEProhibitionFrame, GNEPersonTypeFrame, GNEPolygonFrame, GNEDeleteFrame, GNEStopFrame, GNEVehicleFrame, GNEPersonFrame, and GNECreateEdgeFrame.

Definition at line 107 of file GNEFrame.cpp.

References GNEViewNet::getViewParent(), myViewNet, and GNEViewParent::showFramesArea().

Referenced by GNECreateEdgeFrame::show(), GNEPersonFrame::show(), GNEVehicleFrame::show(), GNEStopFrame::show(), GNEDeleteFrame::show(), GNEPolygonFrame::show(), GNEPersonTypeFrame::show(), GNEProhibitionFrame::show(), GNEVehicleTypeFrame::show(), GNEPersonPlanFrame::show(), GNERouteFrame::show(), GNEInspectorFrame::show(), GNEAdditionalFrame::show(), GNETLSEditorFrame::show(), GNESelectorFrame::show(), GNEAdditionalFrame::showSelectorChildLanesModul(), GNETAZFrame::TAZChildDefaultParameters::showTAZChildDefaultParametersModul(), GNETAZFrame::TAZCommonStatistics::showTAZCommonStatisticsModul(), GNETAZFrame::TAZEdgesGraphic::showTAZEdgesGraphicModul(), GNETAZFrame::TAZSaveChanges::showTAZSaveChangesModul(), GNETAZFrame::TAZSelectionStatistics::showTAZSelectionStatisticsModul(), and GNEViewNet::updateNetworkModeSpecificControls().

◆ tagSelected()

void GNEFrame::tagSelected ( )
protectedvirtual

Tag selected in TagSelector.

Reimplemented in GNEAdditionalFrame, GNEPersonPlanFrame, GNEPolygonFrame, GNEStopFrame, GNEVehicleFrame, and GNEPersonFrame.

Definition at line 159 of file GNEFrame.cpp.

◆ updateFrameAfterUndoRedo()

void GNEFrame::updateFrameAfterUndoRedo ( )
virtual

function called after undo/redo in the current frame (can be reimplemented in frame children)

Reimplemented in GNEInspectorFrame.

Definition at line 150 of file GNEFrame.cpp.

Referenced by GNEApplicationWindow::onCmdRedo(), and GNEApplicationWindow::onCmdUndo().

Friends And Related Function Documentation

◆ GNEFrameAttributesModuls

friend class GNEFrameAttributesModuls
friend

Definition at line 38 of file GNEFrame.h.

◆ GNEFrameModuls

friend class GNEFrameModuls
friend

friend class

Definition at line 37 of file GNEFrame.h.

Field Documentation

◆ myContentFrame

FXVerticalFrame* GNEFrame::myContentFrame = nullptr
protected

Vertical frame that holds all widgets of frame.

Definition at line 124 of file GNEFrame.h.

Referenced by GNECrossingFrame::GNECrossingFrame(), GNEFrame(), and GNEInspectorFrame::inspectMultisection().

◆ myEdgeCandidateColor

RGBColor GNEFrame::myEdgeCandidateColor
private

edge candidate color (used by some modulds to mark edges)

Definition at line 146 of file GNEFrame.h.

Referenced by getEdgeCandidateColor().

◆ myEdgeCandidateSelectedColor

RGBColor GNEFrame::myEdgeCandidateSelectedColor
private

selected edge candidate color (used by some modulds to selected mark edges)

Definition at line 149 of file GNEFrame.h.

Referenced by getEdgeCandidateSelectedColor().

◆ myFrameHeaderFont

FXFont * GNEFrame::myFrameHeaderFont = nullptr
staticprivate

static Font for the Header (it's common for all headers, then create only one time)

Definition at line 140 of file GNEFrame.h.

Referenced by getFrameHeaderFont(), GNEFrame(), and ~GNEFrame().

◆ myFrameHeaderLabel

FXLabel* GNEFrame::myFrameHeaderLabel = nullptr
private

the label for the frame's header

Definition at line 143 of file GNEFrame.h.

Referenced by focusUpperElement(), getFrameHeaderLabel(), and GNEFrame().

◆ myHeaderFrame

FXHorizontalFrame* GNEFrame::myHeaderFrame = nullptr
protected

fame for header elements

Definition at line 127 of file GNEFrame.h.

Referenced by GNEFrame().

◆ myHeaderLeftFrame

FXHorizontalFrame* GNEFrame::myHeaderLeftFrame = nullptr
protected

fame for left header elements

Definition at line 130 of file GNEFrame.h.

Referenced by GNEFrame(), GNEInspectorFrame::inspectChild(), GNEInspectorFrame::inspectFromDeleteFrame(), and GNEInspectorFrame::inspectMultisection().

◆ myHeaderRightFrame

FXHorizontalFrame* GNEFrame::myHeaderRightFrame = nullptr
protected

fame for right header elements

Definition at line 133 of file GNEFrame.h.

Referenced by GNEFrame().

◆ myPredefinedTagsMML

std::map<int, std::string> GNEFrame::myPredefinedTagsMML
private

Map of attribute ids to their (readable) string-representation (needed for SUMOSAXAttributesImpl_Cached)

Definition at line 152 of file GNEFrame.h.

Referenced by getPredefinedTagsMML(), and GNEFrame().

◆ myScrollWindowsContents

FXScrollWindow* GNEFrame::myScrollWindowsContents = nullptr
private

scroll windows that holds the content frame

Definition at line 137 of file GNEFrame.h.

Referenced by GNEFrame(), openHelpAttributesDialog(), and setFrameWidth().

◆ myViewNet

GNEViewNet* GNEFrame::myViewNet = nullptr
protected

View Net.

Definition at line 121 of file GNEFrame.h.

Referenced by GNEDeleteFrame::ACsToDelete(), GNESelectorFrame::ACsToSelected(), GNEAdditionalFrame::addAdditional(), GNECrossingFrame::addCrossing(), GNETAZFrame::addOrRemoveTAZMember(), GNEPersonFrame::addPerson(), GNEPersonPlanFrame::addPersonPlan(), GNEPolygonFrame::addPOI(), GNEPolygonFrame::addPOILane(), GNEPolygonFrame::addPolygon(), GNEStopFrame::addStop(), GNEVehicleFrame::addVehicle(), GNEFrameAttributesModuls::AttributesEditorRow::AttributesEditorRow(), GNEAdditionalFrame::buildAdditionalOverEdge(), GNEAdditionalFrame::buildAdditionalOverLane(), GNEAdditionalFrame::buildAdditionalOverLanes(), GNEAdditionalFrame::buildAdditionalOverView(), GNEConnectorFrame::buildConnection(), GNETLSEditorFrame::buildIinternalLanes(), GNEPersonFrame::buildPerson(), GNEPersonFrame::buildPersonOverRoute(), GNEPersonFrame::buildPersonOverStop(), GNEProhibitionFrame::buildProhibition(), GNETLSEditorFrame::cleanup(), GNESelectorFrame::clearCurrentSelection(), GNEInspectorFrame::clearInspectedAC(), GNETAZFrame::dropTAZMembers(), GNEPersonFrame::edgePathCreated(), GNEVehicleFrame::edgePathCreated(), GNETLSEditorFrame::editJunction(), GNETLSEditorFrame::editTLS(), GNEAdditionalFrame::generateID(), GNESelectorFrame::getMatches(), getViewNet(), GNEPersonTypeFrame::GNEPersonTypeFrame(), GNEVehicleTypeFrame::GNEVehicleTypeFrame(), GNETLSEditorFrame::handleChange(), GNERouteFrame::handleEdgeClick(), GNESelectorFrame::handleIDs(), GNEConnectorFrame::handleLaneClick(), GNETLSEditorFrame::handleMultiChange(), GNEProhibitionFrame::handleProhibitionClick(), hide(), GNEInspectorFrame::hide(), GNERouteFrame::hotkeyBackSpace(), GNERouteFrame::hotkeyEnter(), GNERouteFrame::hotkeyEsc(), GNEConnectorFrame::initTargets(), GNEInspectorFrame::inspectSingleElement(), GNEProhibitionFrame::onCmdCancel(), GNETLSEditorFrame::onCmdCancel(), GNETLSEditorFrame::onCmdDefCreate(), GNETLSEditorFrame::onCmdDefDelete(), GNETLSEditorFrame::onCmdDefSwitch(), GNEInspectorFrame::onCmdGoBack(), GNETLSEditorFrame::onCmdOK(), GNETLSEditorFrame::onCmdPhaseSwitch(), GNETLSEditorFrame::parseTLSPrograms(), GNEPersonPlanFrame::personPlanCreated(), GNECreateEdgeFrame::processClick(), GNEPolygonFrame::processClick(), GNEInspectorFrame::processDemandSupermodeClick(), GNEInspectorFrame::processNetworkSupermodeClick(), GNEProhibitionFrame::ProhibitionLegend::ProhibitionLegend(), GNEDeleteFrame::removeAttributeCarrier(), GNEDeleteFrame::removeSelectedAttributeCarriers(), GNEInspectorFrame::selectedOverlappedElement(), GNEPolygonFrame::shapeDrawed(), GNETAZFrame::shapeDrawed(), show(), GNEStopFrame::show(), GNEDeleteFrame::show(), and GNEPersonPlanFrame::show().

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