Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNEPythonToolDialogElements::StringArgument Class Reference

string argument More...

#include <GNEPythonToolDialogElements.h>

Inheritance diagram for GNEPythonToolDialogElements::StringArgument:
[legend]
Collaboration diagram for GNEPythonToolDialogElements::StringArgument:
[legend]

Public Member Functions

const std::string getArgument () const
 get argument
MFXLabelTooltip * getParameterLabel () const
 get parameter label
long onCmdSetValue (FXObject *, FXSelector, void *)
 Called when user set string value.
bool requiredAttributeSet () const
 check if required attribute is set
void reset ()
 reset to default value
 StringArgument (GNEPythonToolDialog *toolDialogParent, const GNEPythonTool *pythonTool, GNEApplicationWindow *applicationWindow, FXVerticalFrame *argumentFrame, const std::string name, Option *option)
 constructor
FOX-callbacks
long onCmdResetValue (FXObject *, FXSelector, void *)
 Called when user press reset button.
long onUpdResetValue (FXObject *, FXSelector, void *)
 Called when user press reset button.

Protected Member Functions

const std::string getValue () const
 get value

Protected Attributes

const std::string myDefaultValue
 default value
FXHorizontalFrame * myElementsFrame = nullptr
 auxiliar elements frame
Option * myOption = nullptr
 option
FXTextField * myStringTextField = nullptr
 string textField
GNEPythonToolDialog * myToolDialogParent = nullptr
 tool dialog parent

Private Member Functions

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

Private Attributes

MFXLabelTooltip * myParameterLabel = nullptr
 parameter label
FXButton * myResetButton = nullptr
 reset button

Detailed Description

string argument

Definition at line 426 of file GNEPythonToolDialogElements.h.

Constructor & Destructor Documentation

◆ StringArgument() [1/2]

GNEPythonToolDialogElements::StringArgument::StringArgument ( GNEPythonToolDialog * toolDialogParent,
const GNEPythonTool * pythonTool,
GNEApplicationWindow * applicationWindow,
FXVerticalFrame * argumentFrame,
const std::string name,
Option * option )

constructor

Definition at line 640 of file GNEPythonToolDialogElements.cpp.

References GNEPythonToolDialogElements::Argument::Argument(), Option::getValueString(), GUIDesignTextField, GUIDesignTextFieldNCol, MID_GNE_SET_ATTRIBUTE, GNEPythonToolDialogElements::Argument::myElementsFrame, and myStringTextField.

Referenced by operator=(), and StringArgument().

Here is the caller graph for this function:

◆ StringArgument() [2/2]

GNEPythonToolDialogElements::StringArgument::StringArgument ( const StringArgument & )
privatedelete

Invalidated copy constructor.

References StringArgument().

Member Function Documentation

◆ getArgument()

const std::string GNEPythonToolDialogElements::Argument::getArgument ( ) const
inherited

get argument

Definition at line 149 of file GNEPythonToolDialogElements.cpp.

References getValue(), myDefaultValue, and myParameterLabel.

◆ getParameterLabel()

MFXLabelTooltip * GNEPythonToolDialogElements::Argument::getParameterLabel ( ) const
inherited

get parameter label

Definition at line 143 of file GNEPythonToolDialogElements.cpp.

References myParameterLabel.

◆ getValue()

const std::string GNEPythonToolDialogElements::StringArgument::getValue ( ) const
protectedvirtual

get value

Implements GNEPythonToolDialogElements::Argument.

Definition at line 671 of file GNEPythonToolDialogElements.cpp.

References myStringTextField.

◆ onCmdResetValue()

long GNEPythonToolDialogElements::Argument::onCmdResetValue ( FXObject * ,
FXSelector ,
void *  )
inherited

Called when user press reset button.

Definition at line 169 of file GNEPythonToolDialogElements.cpp.

References reset().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdSetValue()

long GNEPythonToolDialogElements::StringArgument::onCmdSetValue ( FXObject * ,
FXSelector ,
void *  )
virtual

Called when user set string value.

Implements GNEPythonToolDialogElements::Argument.

Definition at line 659 of file GNEPythonToolDialogElements.cpp.

References GNEPythonToolDialogElements::Argument::myOption, myStringTextField, and reset().

◆ onUpdResetValue()

long GNEPythonToolDialogElements::Argument::onUpdResetValue ( FXObject * ,
FXSelector ,
void *  )
inherited

Called when user press reset button.

Definition at line 177 of file GNEPythonToolDialogElements.cpp.

References getValue(), myDefaultValue, and myResetButton.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ operator=()

StringArgument & GNEPythonToolDialogElements::StringArgument::operator= ( const StringArgument & )
privatedelete

Invalidated assignment operator.

References StringArgument().

◆ requiredAttributeSet()

bool GNEPythonToolDialogElements::Argument::requiredAttributeSet ( ) const
inherited

check if required attribute is set

Definition at line 159 of file GNEPythonToolDialogElements.cpp.

References getValue(), myDefaultValue, and myOption.

◆ reset()

void GNEPythonToolDialogElements::StringArgument::reset ( )
virtual

reset to default value

Implements GNEPythonToolDialogElements::Argument.

Definition at line 651 of file GNEPythonToolDialogElements.cpp.

References GNEPythonToolDialogElements::Argument::myDefaultValue, GNEPythonToolDialogElements::Argument::myOption, and myStringTextField.

Referenced by onCmdSetValue().

Here is the caller graph for this function:

Field Documentation

◆ myDefaultValue

const std::string GNEPythonToolDialogElements::Argument::myDefaultValue
protectedinherited

default value

Definition at line 118 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), getArgument(), GNEPythonToolDialogElements::BoolArgument::onCmdSetValue(), onUpdResetValue(), requiredAttributeSet(), GNEPythonToolDialogElements::BoolArgument::reset(), GNEPythonToolDialogElements::EdgeArgument::reset(), GNEPythonToolDialogElements::EdgeVectorArgument::reset(), GNEPythonToolDialogElements::FileNameArgument::reset(), GNEPythonToolDialogElements::FloatArgument::reset(), GNEPythonToolDialogElements::IntArgument::reset(), and GNEPythonToolDialogElements::StringArgument::reset().

◆ myElementsFrame

FXHorizontalFrame* GNEPythonToolDialogElements::Argument::myElementsFrame = nullptr
protectedinherited

auxiliar elements frame

Definition at line 121 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), GNEPythonToolDialogElements::BoolArgument::BoolArgument(), GNEPythonToolDialogElements::EdgeArgument::EdgeArgument(), GNEPythonToolDialogElements::EdgeVectorArgument::EdgeVectorArgument(), GNEPythonToolDialogElements::FileNameArgument::FileNameArgument(), GNEPythonToolDialogElements::FloatArgument::FloatArgument(), GNEPythonToolDialogElements::IntArgument::IntArgument(), and GNEPythonToolDialogElements::StringArgument::StringArgument().

◆ myOption

Option* GNEPythonToolDialogElements::Argument::myOption = nullptr
protectedinherited

option

Definition at line 115 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), GNEPythonToolDialogElements::AdditionalArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::DataArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::FileNameArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::NetworkArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::RouteArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::SumoConfigArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::BoolArgument::onCmdSetValue(), GNEPythonToolDialogElements::EdgeArgument::onCmdSetValue(), GNEPythonToolDialogElements::EdgeVectorArgument::onCmdSetValue(), GNEPythonToolDialogElements::FileNameArgument::onCmdSetValue(), GNEPythonToolDialogElements::FloatArgument::onCmdSetValue(), GNEPythonToolDialogElements::IntArgument::onCmdSetValue(), GNEPythonToolDialogElements::StringArgument::onCmdSetValue(), requiredAttributeSet(), GNEPythonToolDialogElements::BoolArgument::reset(), GNEPythonToolDialogElements::EdgeArgument::reset(), GNEPythonToolDialogElements::EdgeVectorArgument::reset(), GNEPythonToolDialogElements::FileNameArgument::reset(), GNEPythonToolDialogElements::FloatArgument::reset(), GNEPythonToolDialogElements::IntArgument::reset(), and GNEPythonToolDialogElements::StringArgument::reset().

◆ myParameterLabel

MFXLabelTooltip* GNEPythonToolDialogElements::Argument::myParameterLabel = nullptr
privateinherited

parameter label

Definition at line 125 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), getArgument(), and getParameterLabel().

◆ myResetButton

FXButton* GNEPythonToolDialogElements::Argument::myResetButton = nullptr
privateinherited

reset button

Definition at line 128 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), and onUpdResetValue().

◆ myStringTextField

FXTextField* GNEPythonToolDialogElements::StringArgument::myStringTextField = nullptr
protected

string textField

Definition at line 445 of file GNEPythonToolDialogElements.h.

Referenced by getValue(), onCmdSetValue(), reset(), and StringArgument().

◆ myToolDialogParent

GNEPythonToolDialog* GNEPythonToolDialogElements::Argument::myToolDialogParent = nullptr
protectedinherited

tool dialog parent

Definition at line 112 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), GNEPythonToolDialogElements::AdditionalArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::DataArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::FileNameArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::NetworkArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::RouteArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::SumoConfigArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::EdgeVectorArgument::onCmdUseCurrent(), GNEPythonToolDialogElements::EdgeVectorArgument::onUpdUseCurrent(), GNEPythonToolDialogElements::AdditionalArgument::onUpdUseCurrentAdditionalFile(), GNEPythonToolDialogElements::DataArgument::onUpdUseCurrentDataFile(), GNEPythonToolDialogElements::NetworkArgument::onUpdUseCurrentNetworkFile(), GNEPythonToolDialogElements::RouteArgument::onUpdUseCurrentRouteFile(), and GNEPythonToolDialogElements::SumoConfigArgument::onUpdUseCurrentSumoConfigFile().

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