Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNEFrame Class Reference

#include <GNEFrame.h>

Inheritance diagram for GNEFrame:
[legend]
Collaboration diagram for GNEFrame:
[legend]

Public Member Functions

void focusUpperElement ()
 focus upper element of frame
virtual void frameWidthUpdated ()
 function called after setting new width in current frame (can be reimplemented in frame children)
FXVerticalFrame * getContentFrame () const
 get vertical frame that holds all widgets of frame
FXFont * getFrameHeaderFont () const
 get font of the header's frame
FXLabel * getFrameHeaderLabel () const
 get the label for the frame's header
int getScrollBarWidth () const
 get scrollBar width (zero if is hidden)
GNEViewNet * getViewNet () const
 get view net
 GNEFrame (GNEViewParent *viewParent, GNEViewNet *viewNet, const std::string &frameLabel)
 Constructor.
virtual void hide ()
 hide Frame
void openHelpAttributesDialog (const GNEAttributeCarrier *AC) const
 Open help attributes dialog.
void setFrameWidth (const int newWidth)
 set width of GNEFrame
virtual void show ()
 show Frame
virtual void updateFrameAfterUndoRedo ()
 function called after undo/redo in the current frame (can be reimplemented in frame children)
 ~GNEFrame ()
 destructor
functions called by moduls that can be reimplemented in frame children (note: reimplement as protected, just for safety)
virtual void tagSelected ()
 Tag selected in GNETagSelector.
virtual void demandElementSelected ()
 selected demand element in DemandElementSelector
virtual bool shapeDrawed ()
 build a shaped element using the drawed shape
virtual void attributeUpdated (SumoXMLAttr attribute)
 function called after set a valid attribute in AttributeCreator/AttributeEditor/ParametersEditor/...
virtual void selectedOverlappedElement (GNEAttributeCarrier *AC)
 open GNEAttributesCreator extended dialog
virtual bool createPath (const bool useLastRoute)
 create path between two elements

Protected Member Functions

const std::vector< std::string > & getPredefinedTagsMML () const
 get predefinedTagsMML

Static Protected Member Functions

static FXLabel * buildRainbow (FXComposite *parent)
 build rainbow in frame modul

Protected Attributes

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

Private Member Functions

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

Private Attributes

FXLabel * myFrameHeaderLabel = nullptr
 the label for the frame's header
std::vector< std::string > myPredefinedTagsMML
 Map of attribute ids to their (readable) string-representation (needed for SUMOSAXAttributesImpl_Cached).
FXScrollWindow * myScrollWindowsContents = nullptr
 scroll windows that holds the content frame

Static Private Attributes

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

Detailed Description

Definition at line 41 of file GNEFrame.h.

Constructor & Destructor Documentation

◆ GNEFrame() [1/2]

GNEFrame::GNEFrame ( GNEViewParent * viewParent,
GNEViewNet * viewNet,
const std::string & frameLabel )

Constructor.

viewParent GNEViewParent in which this GNEFrame is placed

viewNet viewNet that uses this GNEFrame

frameLabel label of the frame

Definition at line 42 of file GNEFrame.cpp.

References SUMOXMLDefinitions::attrs, GUIDesignAuxiliarFrame, GUIDesignAuxiliarFrameFixedWidth, GUIDesignAuxiliarHorizontalFrame, GUIDesignAuxiliarHorizontalFrameCenteredVertically, GUIDesignHorizontalSeparator, GUIDesignLabelFrameInformation, GUIDesignScrollWindowFixedWidth, myContentFrame, myFrameHeaderFont, myFrameHeaderLabel, myHeaderFrame, myHeaderLeftFrame, myHeaderRightFrame, myPredefinedTagsMML, myScrollWindowsContents, myViewNet, and SUMO_ATTR_NOTHING.

Referenced by GNEAdditionalFrame::E2MultilaneLegendModule::E2MultilaneLegendModule(), GNEAdditionalFrame::GNEAdditionalFrame(), GNEConnectorFrame::GNEConnectorFrame(), GNEContainerFrame::GNEContainerFrame(), GNEContainerPlanFrame::GNEContainerPlanFrame(), GNECreateEdgeFrame::GNECreateEdgeFrame(), GNECrossingFrame::GNECrossingFrame(), GNEDecalFrame::GNEDecalFrame(), GNEDeleteFrame::GNEDeleteFrame(), GNEFrame(), GNEGenericDataFrame::GNEGenericDataFrame(), GNEInspectorFrame::GNEInspectorFrame(), GNEMeanDataFrame::GNEMeanDataFrame(), GNEMoveFrame::GNEMoveFrame(), GNEPersonFrame::GNEPersonFrame(), GNEPersonPlanFrame::GNEPersonPlanFrame(), GNEProhibitionFrame::GNEProhibitionFrame(), GNERouteDistributionFrame::GNERouteDistributionFrame(), GNERouteFrame::GNERouteFrame(), GNESelectorFrame::GNESelectorFrame(), GNEShapeFrame::GNEShapeFrame(), GNEStopFrame::GNEStopFrame(), GNETAZFrame::GNETAZFrame(), GNETLSEditorFrame::GNETLSEditorFrame(), GNETypeDistributionFrame::GNETypeDistributionFrame(), GNETypeFrame::GNETypeFrame(), GNEVehicleFrame::GNEVehicleFrame(), GNEWireFrame::GNEWireFrame(), GNEAdditionalFrame::HelpCreationModule::HelpCreationModule(), and operator=().

Here is the caller graph for this function:

◆ ~GNEFrame()

GNEFrame::~GNEFrame ( )

destructor

Definition at line 94 of file GNEFrame.cpp.

References myFrameHeaderFont.

◆ GNEFrame() [2/2]

GNEFrame::GNEFrame ( const GNEFrame & )
privatedelete

Invalidated copy constructor.

References GNEFrame().

Member Function Documentation

◆ attributeUpdated()

void GNEFrame::attributeUpdated ( SumoXMLAttr attribute)
virtual

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

Reimplemented in GNEMeanDataFrame, GNERouteDistributionFrame, GNETypeDistributionFrame, and GNETypeFrame.

Definition at line 220 of file GNEFrame.cpp.

◆ buildRainbow()

FXLabel * GNEFrame::buildRainbow ( FXComposite * parent)
staticprotected

build rainbow in frame modul

Definition at line 245 of file GNEFrame.cpp.

References MFXUtils::getFXColor(), GNEViewNetHelper::getRainbowScaledColors(), GUIDesignAuxiliarHorizontalFrame, GUIDesignLabel, GUIDesignLabelThick, and TL.

Referenced by GNEGenericDataFrame::AttributeSelector::AttributeSelector(), and GNETAZFrame::TAZEdgesGraphic::TAZEdgesGraphic().

Here is the caller graph for this function:

◆ createPath()

bool GNEFrame::createPath ( const bool useLastRoute)
virtual

create path between two elements

Reimplemented in GNEAdditionalFrame, GNEContainerFrame, GNEContainerPlanFrame, GNEEdgeRelDataFrame, GNEGenericDataFrame, GNEPersonFrame, GNEPersonPlanFrame, GNERouteFrame, GNEVehicleFrame, and GNEWireFrame.

Definition at line 232 of file GNEFrame.cpp.

◆ demandElementSelected()

void GNEFrame::demandElementSelected ( )
virtual

selected demand element in DemandElementSelector

Reimplemented in GNEContainerFrame, GNEContainerPlanFrame, GNEPersonFrame, GNEPersonPlanFrame, GNEStopFrame, and GNEVehicleFrame.

Definition at line 207 of file GNEFrame.cpp.

◆ focusUpperElement()

void GNEFrame::focusUpperElement ( )

focus upper element of frame

Definition at line 104 of file GNEFrame.cpp.

References myFrameHeaderLabel.

Referenced by GNEInspectorFrame::inspectClickedElements().

Here is the caller graph for this function:

◆ frameWidthUpdated()

void GNEFrame::frameWidthUpdated ( )
virtual

function called after setting new width in current frame (can be reimplemented in frame children)

Reimplemented in GNETLSEditorFrame.

Definition at line 192 of file GNEFrame.cpp.

Referenced by setFrameWidth().

Here is the caller graph for this function:

◆ getContentFrame()

FXVerticalFrame * GNEFrame::getContentFrame ( ) const

get vertical frame that holds all widgets of frame

Definition at line 151 of file GNEFrame.cpp.

References myContentFrame.

◆ getFrameHeaderFont()

FXFont * GNEFrame::getFrameHeaderFont ( ) const

get font of the header's frame

Definition at line 163 of file GNEFrame.cpp.

References myFrameHeaderFont.

◆ getFrameHeaderLabel()

FXLabel * GNEFrame::getFrameHeaderLabel ( ) const

get the label for the frame's header

Definition at line 157 of file GNEFrame.cpp.

References myFrameHeaderLabel.

Referenced by GNEInspectorFrame::refreshInspection().

Here is the caller graph for this function:

◆ getPredefinedTagsMML()

const std::vector< std::string > & GNEFrame::getPredefinedTagsMML ( ) const
protected

get predefinedTagsMML

Definition at line 239 of file GNEFrame.cpp.

References myPredefinedTagsMML.

Referenced by GNEContainerFrame::buildContainer(), GNEPersonFrame::buildPerson(), GNEVehicleFrame::buildVehicleOverRoute(), and GNEVehicleFrame::createPath().

Here is the caller graph for this function:

◆ getScrollBarWidth()

int GNEFrame::getScrollBarWidth ( ) const

get scrollBar width (zero if is hidden)

Definition at line 169 of file GNEFrame.cpp.

References myScrollWindowsContents.

◆ getViewNet()

GNEViewNet * GNEFrame::getViewNet ( ) const

get view net

Definition at line 145 of file GNEFrame.cpp.

References myViewNet.

Referenced by GNEGenericDataFrame::AttributeSelector::AttributeSelector(), GNEAttributesEditorType::buildRows(), GNEDeleteFrame::SubordinatedElements::checkElements(), GNETLSTable::Column::Column(), GNEDistributionFrame::DistributionSelector::DistributionSelector(), GNEDistributionFrame::DistributionValuesEditor::DistributionValuesEditor(), GNEAdditionalFrame::E2MultilaneLegendModule::E2MultilaneLegendModule(), GNEDemandElementSelector::GNEDemandElementSelector(), GNEMatchAttribute::GNEMatchAttribute(), GNEPathLegendModule::GNEPathLegendModule(), GNECrossingFrame::Information::Information(), GNECreateEdgeFrame::LaneTypeSelector::LaneTypeSelector(), GNEConnectorFrame::Legend::Legend(), GNEProhibitionFrame::Legend::Legend(), GNEMeanDataFrame::MeanDataSelector::MeanDataSelector(), GNEProhibitionFrame::Selection::Selection(), GNESelectorFrame::SelectionHierarchy::SelectionHierarchy(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNETLSEditorFrame::TLSAttributes::TLSAttributes(), GNETLSEditorFrame::TLSJunction::TLSJunction(), GNETLSEditorFrame::TLSPhases::TLSPhases(), and GNETLSEditorFrame::TLSPrograms::TLSPrograms().

Here is the caller graph for this function:

◆ hide()

void GNEFrame::hide ( )
virtual

hide Frame

Note
some GNEFrames needs a re-implementation

Reimplemented in GNEContainerFrame, GNEContainerPlanFrame, GNECreateEdgeFrame, GNECrossingFrame, GNEDeleteFrame, GNEGenericDataFrame, GNEInspectorFrame, GNEMeanDataFrame, GNEMoveFrame, GNEPersonFrame, GNEPersonPlanFrame, GNEProhibitionFrame, GNERouteFrame, GNESelectorFrame, GNETAZFrame, and GNEVehicleFrame.

Definition at line 119 of file GNEFrame.cpp.

References myViewNet.

Referenced by GNEContainerFrame::hide(), GNEContainerPlanFrame::hide(), GNECreateEdgeFrame::hide(), GNECrossingFrame::hide(), GNEDeleteFrame::hide(), GNEGenericDataFrame::hide(), GNEInspectorFrame::hide(), GNEMeanDataFrame::hide(), GNEMoveFrame::hide(), GNEPersonFrame::hide(), GNEPersonPlanFrame::hide(), GNEProhibitionFrame::hide(), GNERouteFrame::hide(), GNESelectorFrame::hide(), GNETAZFrame::hide(), GNEVehicleFrame::hide(), GNEAdditionalFrame::E2MultilaneLegendModule::hideE2MultilaneLegend(), GNEShapeFrame::GEOPOICreator::hideGEOPOICreatorModule(), GNEStopFrame::HelpCreation::hideHelpCreation(), GNEAdditionalFrame::HelpCreationModule::hideHelpCreationModule(), GNETLSEditorFrame::TLSAttributes::hideTLSAttributes(), GNETLSEditorFrame::TLSFile::hideTLSFile(), GNETLSEditorFrame::TLSPhases::hideTLSPhases(), GNETLSEditorFrame::TLSPrograms::hideTLSPrograms(), GNETypeFrame::TypeEditor::hideTypeEditorModule(), and GNEAdditionalFrame::HelpCreationModule::showHelpCreationModule().

Here is the caller graph for this function:

◆ openHelpAttributesDialog()

void GNEFrame::openHelpAttributesDialog ( const GNEAttributeCarrier * AC) const

Open help attributes dialog.

Definition at line 179 of file GNEFrame.cpp.

References myViewNet.

◆ operator=()

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

Invalidated assignment operator.

References GNEFrame().

◆ selectedOverlappedElement()

void GNEFrame::selectedOverlappedElement ( GNEAttributeCarrier * AC)
virtual

open GNEAttributesCreator extended dialog

Reimplemented in GNEInspectorFrame, and GNETLSEditorFrame.

Definition at line 226 of file GNEFrame.cpp.

◆ setFrameWidth()

void GNEFrame::setFrameWidth ( const int newWidth)

set width of GNEFrame

Definition at line 128 of file GNEFrame.cpp.

References frameWidthUpdated(), GUIDesignFrameAreaMargin, myContentFrame, and myScrollWindowsContents.

Referenced by GNEInspectorFrame::refreshInspection().

Here is the caller graph for this function:

◆ shapeDrawed()

bool GNEFrame::shapeDrawed ( )
virtual

build a shaped element using the drawed shape

Reimplemented in GNEShapeFrame, and GNETAZFrame.

Definition at line 213 of file GNEFrame.cpp.

◆ show()

void GNEFrame::show ( )
virtual

show Frame

Note
some GNEFrames needs a re-implementation

Reimplemented in GNEAdditionalFrame, GNEContainerFrame, GNEContainerPlanFrame, GNECreateEdgeFrame, GNEDeleteFrame, GNEGenericDataFrame, GNEInspectorFrame, GNEMeanDataFrame, GNEMoveFrame, GNEPersonFrame, GNEPersonPlanFrame, GNEProhibitionFrame, GNERouteDistributionFrame, GNERouteFrame, GNESelectorFrame, GNEShapeFrame, GNEStopFrame, GNETAZFrame, GNETLSEditorFrame, GNETypeDistributionFrame, GNETypeFrame, GNEVehicleFrame, and GNEWireFrame.

Definition at line 110 of file GNEFrame.cpp.

References myViewNet.

Referenced by GNEAdditionalFrame::show(), GNEContainerFrame::show(), GNEContainerPlanFrame::show(), GNECreateEdgeFrame::show(), GNEDeleteFrame::show(), GNEGenericDataFrame::show(), GNEInspectorFrame::show(), GNEMeanDataFrame::show(), GNEMoveFrame::show(), GNEPersonFrame::show(), GNEPersonPlanFrame::show(), GNEProhibitionFrame::show(), GNERouteDistributionFrame::show(), GNERouteFrame::show(), GNESelectorFrame::show(), GNEShapeFrame::show(), GNEStopFrame::show(), GNETAZFrame::show(), GNETLSEditorFrame::show(), GNETypeDistributionFrame::show(), GNETypeFrame::show(), GNEVehicleFrame::show(), and GNEWireFrame::show().

Here is the caller graph for this function:

◆ tagSelected()

void GNEFrame::tagSelected ( )
virtual

Tag selected in GNETagSelector.

Reimplemented in GNEAdditionalFrame, GNEContainerFrame, GNEContainerPlanFrame, GNEPersonFrame, GNEPersonPlanFrame, GNEShapeFrame, GNEStopFrame, GNEVehicleFrame, and GNEWireFrame.

Definition at line 201 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 GNEGenericDataFrame, GNEInspectorFrame, GNEMeanDataFrame, and GNESelectorFrame.

Definition at line 186 of file GNEFrame.cpp.

Field Documentation

◆ myContentFrame

FXVerticalFrame* GNEFrame::myContentFrame = nullptr
protected

Vertical frame that holds all widgets of frame.

Definition at line 125 of file GNEFrame.h.

Referenced by getContentFrame(), GNESelectorFrame::getContentFrame(), GNEFrame(), and setFrameWidth().

◆ 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 147 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 150 of file GNEFrame.h.

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

◆ myHeaderFrame

FXHorizontalFrame* GNEFrame::myHeaderFrame = nullptr
protected

fame for header elements

Definition at line 128 of file GNEFrame.h.

Referenced by GNEFrame().

◆ myHeaderLeftFrame

FXHorizontalFrame* GNEFrame::myHeaderLeftFrame = nullptr
protected

fame for left header elements

Definition at line 131 of file GNEFrame.h.

Referenced by GNEFrame(), GNEInspectorFrame::GNEInspectorFrame(), and GNEInspectorFrame::refreshInspection().

◆ myHeaderRightFrame

FXHorizontalFrame* GNEFrame::myHeaderRightFrame = nullptr
protected

fame for right header elements

Definition at line 134 of file GNEFrame.h.

Referenced by GNEFrame().

◆ myPredefinedTagsMML

std::vector<std::string> GNEFrame::myPredefinedTagsMML
private

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

Definition at line 153 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 144 of file GNEFrame.h.

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

◆ myViewNet

GNEViewNet* GNEFrame::myViewNet = nullptr
protected

FOX need this.

View Net

Definition at line 122 of file GNEFrame.h.

Referenced by GNEAdditionalFrame::addAdditional(), GNECreateEdgeFrame::addBikelane(), GNEContainerFrame::addContainer(), GNEContainerPlanFrame::addContainerPlanElement(), GNECrossingFrame::addCrossing(), GNEEdgeDataFrame::addEdgeData(), GNERouteFrame::addEdgeRoute(), GNETAZFrame::addOrRemoveTAZMember(), GNEPersonFrame::addPerson(), GNEPersonPlanFrame::addPersonPlanElement(), GNECreateEdgeFrame::addSidewalk(), GNEStopFrame::addStop(), GNEVehicleFrame::addVehicle(), GNEWireFrame::addWire(), GNEConnectorFrame::buildConnection(), GNEContainerFrame::buildContainer(), GNETLSEditorFrame::buildInternalLanes(), GNEPersonFrame::buildPerson(), GNEProhibitionFrame::buildProhibition(), GNETAZRelDataFrame::buildTAZRelationData(), GNEVehicleFrame::buildVehicleOverRoute(), GNEWireFrame::buildWireOverView(), GNETLSEditorFrame::cleanup(), GNEWireFrame::createBaseWireObject(), GNEAdditionalFrame::createPath(), GNEContainerFrame::createPath(), GNEContainerPlanFrame::createPath(), GNEEdgeRelDataFrame::createPath(), GNEPersonFrame::createPath(), GNEPersonPlanFrame::createPath(), GNERouteFrame::createPath(), GNEVehicleFrame::createPath(), GNEWireFrame::createPath(), GNECreateEdgeFrame::disablePedestrians(), GNETAZFrame::dropTAZMembers(), GNETLSEditorFrame::editJunction(), GNETLSEditorFrame::editTLS(), GNEStopFrame::getStopParameter(), getViewNet(), GNEFrame(), GNETypeFrame::GNETypeFrame(), GNETLSEditorFrame::handleChange(), GNESelectorFrame::handleIDs(), GNEConnectorFrame::handleLaneClick(), GNETLSEditorFrame::handleMultiChange(), GNEProhibitionFrame::handleProhibitionClick(), GNEContainerFrame::hide(), GNEContainerPlanFrame::hide(), hide(), GNEGenericDataFrame::hide(), GNEInspectorFrame::hide(), GNEPersonFrame::hide(), GNEPersonPlanFrame::hide(), GNERouteFrame::hide(), GNEVehicleFrame::hide(), GNEAdditionalFrame::initBaseAdditionalObject(), GNEConnectorFrame::initTargets(), GNEInspectorFrame::inspectClickedElements(), GNEInspectorFrame::inspectElement(), GNEInspectorFrame::inspectElements(), GNETLSEditorFrame::isTLSSaved(), GNEProhibitionFrame::Legend::Legend(), openHelpAttributesDialog(), GNETLSEditorFrame::parseTLSPrograms(), GNECreateEdgeFrame::processClick(), GNEShapeFrame::processClick(), GNEShapeFrame::processClickPOI(), GNEShapeFrame::processClickPOIGeo(), GNEShapeFrame::processClickPOILanes(), GNEInspectorFrame::refreshInspection(), GNEDeleteFrame::removeAttributeCarrier(), GNEDeleteFrame::removeGeometryPoint(), GNEDeleteFrame::removeSelectedAttributeCarriers(), GNESelectorFrame::selectAttributeCarrier(), GNEDeleteFrame::selectedACsToDelete(), GNEInspectorFrame::selectedOverlappedElement(), GNEShapeFrame::shapeDrawed(), GNETAZFrame::shapeDrawed(), GNEContainerPlanFrame::show(), show(), GNEMoveFrame::show(), GNEPersonPlanFrame::show(), GNEStopFrame::show(), GNEWireFrame::show(), and GNEAdditionalFrame::tagSelected().

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