Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNETemplateElementDialog< T > Class Template Referenceabstract

#include <GNETemplateElementDialog.h>

Inheritance diagram for GNETemplateElementDialog< T >:
[legend]
Collaboration diagram for GNETemplateElementDialog< T >:
[legend]

Public Types

basic dialog type
enum class  Buttons {
  OK , YES_NO , YES_NO_CANCEL , ACCEPT ,
  ACCEPT_CANCEL , ACCEPT_CANCEL_RESET , SAVE_DONTSAVE_CANCEL , RUN_CANCEL_RESET ,
  RUN_ADVANCED_CANCEL , RERUN_BACK_CLOSE
}
 
enum class  OpenType { MODAL , NON_MODAL }
 Open dialog type. More...
 

Public Member Functions

T * getElement () const
 get edited element
 
 GNETemplateElementDialog (T *element)
 constructor
 
virtual void runInternalTest (const InternalTestStep::DialogArgument *dialogArgument)=0
 run internal test
 
 ~GNETemplateElementDialog ()
 destructor
 
FOX-callbacks

event after press accept button

virtual long onCmdAccept (FXObject *sender, FXSelector sel, void *ptr)=0
 called when accept or yes button is pressed (can be reimplemented in children)
 
virtual long onCmdReset (FXObject *, FXSelector, void *)=0
 event after press cancel button
 
long onCmdCancel (FXObject *, FXSelector, void *)
 called when cancel or no button is pressed
 
long onCmdAbort (FXObject *, FXSelector, void *)
 called when abort is called either closing dialog or pressing abort button
 
FOX-callbacks
virtual long onCmdRun (FXObject *, FXSelector, void *)
 called when run button is pressed (must be reimplemented in children)
 
virtual long onCmdBack (FXObject *, FXSelector, void *)
 called when back button is pressed (must be reimplemented in children)
 
virtual long onCmdAdvanced (FXObject *, FXSelector, void *)
 called when advanced button is pressed (must be reimplemented in children)
 
long onKeyPress (FXObject *obj, FXSelector sel, void *ptr)
 called when user presses a key on the dialog
 
long onKeyRelease (FXObject *obj, FXSelector sel, void *ptr)
 called when user releases a key on the dialog
 

Protected Member Functions

long acceptElementDialog ()
 close dialog commiting changes
 
long closeDialogAborting ()
 close dialog aborting the changes
 
long closeDialogAccepting ()
 close dialog accepting the changes
 
long closeDialogCanceling ()
 close dialog declining the changes
 
 GNETemplateElementDialog ()
 default constructor
 
void openDialog (FXWindow *focusableElement=nullptr)
 open dialog
 
void resetChanges ()
 reset changes did in this dialog.
 
void updateIcon (GUIIcon newIcon)
 update icon
 
void updateTitle (const std::string &newTitle)
 update title
 

Protected Attributes

FXButton * myAbortButton = nullptr
 abort button
 
FXButton * myAcceptButton = nullptr
 accept button
 
FXButton * myAdvancedButton = nullptr
 advanced button
 
GNEApplicationWindowmyApplicationWindow = nullptr
 FOX needs this.
 
FXButton * myBackButton = nullptr
 back button
 
FXButton * myCancelButton = nullptr
 cancel button
 
FXVerticalFrame * myContentFrame = nullptr
 content frame
 
T * myElement = nullptr
 pointer to edited element
 
FXButton * myResetButton = nullptr
 reset button
 
Result myResult = Result::CANCEL
 result to indicate if this dialog was closed accepting or rejecting changes
 
FXButton * myRunButton = nullptr
 run button
 

Private Member Functions

void buildDialog (GUIIcon titleIcon, Buttons buttons)
 build dialog
 
 GNETemplateElementDialog (const GNETemplateElementDialog &)=delete
 Invalidated copy constructor.
 
GNETemplateElementDialogoperator= (const GNETemplateElementDialog &)=delete
 Invalidated assignment operator.
 

Private Attributes

std::string myChangesDescription
 description of changes did in this element dialog
 
FXButton * myFocusButton = nullptr
 focus button, used for focusing the default button when dialog is opened
 
OpenType myOpenType
 open type
 
bool myTesting = false
 flag to indicate if this dialog is being tested using internal test
 

Resize mode

Result getResult () const
 get result to indicate if this dialog was closed accepting or rejecting changes
 
GNEApplicationWindowgetApplicationWindow () const
 get pointer to the application window
 
FXVerticalFrame * getContentFrame () const
 get content frame
 
enum class  ResizeMode { STATIC , RESIZABLE }
 
enum class  Result { ACCEPT , CANCEL , ABORT }
 list of possible results when closing the dialog More...
 

Detailed Description

template<typename T>
class GNETemplateElementDialog< T >

Definition at line 31 of file GNETemplateElementDialog.h.

Member Enumeration Documentation

◆ Buttons

enum class GNEDialog::Buttons
stronginherited
Enumerator
OK 
YES_NO 
YES_NO_CANCEL 
ACCEPT 
ACCEPT_CANCEL 
ACCEPT_CANCEL_RESET 
SAVE_DONTSAVE_CANCEL 
RUN_CANCEL_RESET 
RUN_ADVANCED_CANCEL 
RERUN_BACK_CLOSE 

Definition at line 41 of file GNEDialog.h.

◆ OpenType

enum class GNEDialog::OpenType
stronginherited

Open dialog type.

Enumerator
MODAL 
NON_MODAL 

Definition at line 55 of file GNEDialog.h.

◆ ResizeMode

enum class GNEDialog::ResizeMode
stronginherited
Enumerator
STATIC 
RESIZABLE 

Definition at line 61 of file GNEDialog.h.

◆ Result

enum class GNEDialog::Result
stronginherited

list of possible results when closing the dialog

Enumerator
ACCEPT 
CANCEL 
ABORT 

Definition at line 67 of file GNEDialog.h.

Constructor & Destructor Documentation

◆ GNETemplateElementDialog() [1/3]

template<typename T >
GNETemplateElementDialog< T >::GNETemplateElementDialog ( T *  element)
inline

◆ ~GNETemplateElementDialog()

template<typename T >
GNETemplateElementDialog< T >::~GNETemplateElementDialog ( )
inline

destructor

Definition at line 47 of file GNETemplateElementDialog.h.

◆ GNETemplateElementDialog() [2/3]

template<typename T >
GNETemplateElementDialog< T >::GNETemplateElementDialog ( )
inlineprotected

default constructor

Definition at line 81 of file GNETemplateElementDialog.h.

◆ GNETemplateElementDialog() [3/3]

template<typename T >
GNETemplateElementDialog< T >::GNETemplateElementDialog ( const GNETemplateElementDialog< T > &  )
privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ acceptElementDialog()

template<typename T >
long GNETemplateElementDialog< T >::acceptElementDialog ( )
inlineprotected

close dialog commiting changes

Definition at line 88 of file GNETemplateElementDialog.h.

References GNEDialog::closeDialogAccepting(), and GNETemplateElementDialog< T >::myElement.

◆ buildDialog()

◆ closeDialogAborting()

long GNEDialog::closeDialogAborting ( )
protectedinherited

close dialog aborting the changes

Definition at line 259 of file GNEDialog.cpp.

References GNEDialog::ABORT, GNEDialog::MODAL, GNEDialog::myApplicationWindow, GNEDialog::myOpenType, GNEDialog::myResult, and GNEDialog::myTesting.

Referenced by GNEOverwriteElement::onCmdAbort(), GNETemplateElementDialog< T >::onCmdAbort(), GNEDialog::onCmdAbort(), and GNEDialog::onKeyPress().

Here is the caller graph for this function:

◆ closeDialogAccepting()

long GNEDialog::closeDialogAccepting ( )
protectedinherited

◆ closeDialogCanceling()

◆ getApplicationWindow()

◆ getContentFrame()

FXVerticalFrame * GNEDialog::getContentFrame ( ) const
inherited

get content frame

Definition at line 99 of file GNEDialog.cpp.

References GNEDialog::myContentFrame.

Referenced by GNEVClassesDialog::GNEVClassesDialog().

Here is the caller graph for this function:

◆ getElement()

◆ getResult()

GNEDialog::Result GNEDialog::getResult ( ) const
inherited

get result to indicate if this dialog was closed accepting or rejecting changes

Definition at line 87 of file GNEDialog.cpp.

References GNEDialog::myResult.

Referenced by GNEDataHandler::checkDuplicatedDataSet(), GNEMeanDataHandler::checkDuplicatedMeanDataElement(), GNEAdditionalHandler::checkElement(), and GNERouteHandler::checkElement().

Here is the caller graph for this function:

◆ onCmdAbort()

template<typename T >
long GNETemplateElementDialog< T >::onCmdAbort ( FXObject *  ,
FXSelector  ,
void *   
)
inlinevirtual

called when abort is called either closing dialog or pressing abort button

Reimplemented from GNEDialog.

Definition at line 72 of file GNETemplateElementDialog.h.

References GNEDialog::closeDialogAborting(), and GNETemplateElementDialog< T >::myElement.

◆ onCmdAccept()

template<typename T >
virtual long GNETemplateElementDialog< T >::onCmdAccept ( FXObject *  ,
FXSelector  ,
void *   
)
pure virtual

called when accept or yes button is pressed (can be reimplemented in children)

Reimplemented from GNEDialog.

Implemented in GNEAttributeCarrierDialog, GNECalibratorDialog, GNERerouterDialog, GNERerouterIntervalDialog, GNEVariableSpeedSignDialog, and GNEVehicleTypeDialog.

◆ onCmdAdvanced()

long GNEDialog::onCmdAdvanced ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when advanced button is pressed (must be reimplemented in children)

Reimplemented in GNENetgenerateDialog.

Definition at line 141 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdBack()

long GNEDialog::onCmdBack ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when back button is pressed (must be reimplemented in children)

Reimplemented in GNERunNetgenerateDialog, GNERunPythonToolDialog, GNERunNetgenerateDialog, GNERunPythonToolDialog, and GNERunDialog.

Definition at line 135 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdCancel()

template<typename T >
long GNETemplateElementDialog< T >::onCmdCancel ( FXObject *  ,
FXSelector  ,
void *   
)
inlinevirtual

called when cancel or no button is pressed

Reimplemented from GNEDialog.

Definition at line 66 of file GNETemplateElementDialog.h.

References GNEDialog::closeDialogCanceling(), and GNETemplateElementDialog< T >::myElement.

◆ onCmdReset()

template<typename T >
virtual long GNETemplateElementDialog< T >::onCmdReset ( FXObject *  ,
FXSelector  ,
void *   
)
pure virtual

◆ onCmdRun()

long GNEDialog::onCmdRun ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when run button is pressed (must be reimplemented in children)

Reimplemented in GNERunDialog, GNENetgenerateDialog, and GNEPythonToolDialog.

Definition at line 129 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onKeyPress()

long GNEDialog::onKeyPress ( FXObject *  obj,
FXSelector  sel,
void *  ptr 
)
inherited

called when user presses a key on the dialog

Definition at line 147 of file GNEDialog.cpp.

References GNEDialog::closeDialogAborting(), GNEApplicationWindow::getInternalTest(), GNEDialog::myApplicationWindow, and GNEDialog::myTesting.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onKeyRelease()

long GNEDialog::onKeyRelease ( FXObject *  obj,
FXSelector  sel,
void *  ptr 
)
inherited

called when user releases a key on the dialog

Definition at line 163 of file GNEDialog.cpp.

References GNEApplicationWindow::getInternalTest(), GNEDialog::myApplicationWindow, and GNEDialog::myTesting.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ openDialog()

void GNEDialog::openDialog ( FXWindow *  focusableElement = nullptr)
protectedinherited

open dialog

Definition at line 173 of file GNEDialog.cpp.

References InternalTestStep::DialogArgument::ABORT, InternalTestStep::DialogArgument::ACCEPT, InternalTestStep::DialogArgument::CANCEL, InternalTestStep::DIALOG, GNEApplicationWindow::getInternalTest(), GNEDialog::MODAL, GNEDialog::myApplicationWindow, GNEDialog::myFocusButton, GNEDialog::myOpenType, GNEDialog::myTesting, GNEDialog::onCmdAbort(), GNEDialog::onCmdAccept(), GNEDialog::onCmdCancel(), GNEDialog::onCmdReset(), InternalTestStep::DialogArgument::RESET, GNEDialog::runInternalTest(), and InternalTest::setNextStep().

Referenced by GNEAboutDialog::GNEAboutDialog(), GNEAttributeCarrierDialog::GNEAttributeCarrierDialog(), GNEBasicDialog::GNEBasicDialog(), GNECalibratorDialog::GNECalibratorDialog(), GNEFileDialog::GNEFileDialog(), GNEFilePathDialog::GNEFilePathDialog(), GNEFixAdditionalElementsDialog::GNEFixAdditionalElementsDialog(), GNEFixDemandElementsDialog::GNEFixDemandElementsDialog(), GNEFixNetworkElements::GNEFixNetworkElements(), GNEHelpAttributesDialog::GNEHelpAttributesDialog(), GNENeteditOptionsDialog::GNENeteditOptionsDialog(), GNENetgenerateOptionsDialog::GNENetgenerateOptionsDialog(), GNEOverwriteElement::GNEOverwriteElement(), GNEParametersDialog::GNEParametersDialog(), GNERerouterDialog::GNERerouterDialog(), GNERerouterIntervalDialog::GNERerouterIntervalDialog(), GNERunNetgenerateDialog::GNERunNetgenerateDialog(), GNERunPythonToolDialog::GNERunPythonToolDialog(), GNESumoOptionsDialog::GNESumoOptionsDialog(), GNEVariableSpeedSignDialog::GNEVariableSpeedSignDialog(), GNEVClassesDialog::GNEVClassesDialog(), and GNEVehicleTypeDialog::GNEVehicleTypeDialog().

Here is the caller graph for this function:

◆ operator=()

template<typename T >
GNETemplateElementDialog & GNETemplateElementDialog< T >::operator= ( const GNETemplateElementDialog< T > &  )
privatedelete

Invalidated assignment operator.

◆ resetChanges()

template<typename T >
void GNETemplateElementDialog< T >::resetChanges ( )
inlineprotected

reset changes did in this dialog.

Definition at line 94 of file GNETemplateElementDialog.h.

References GNETemplateElementDialog< T >::myChangesDescription, and GNETemplateElementDialog< T >::myElement.

◆ runInternalTest()

template<typename T >
virtual void GNETemplateElementDialog< T >::runInternalTest ( const InternalTestStep::DialogArgument dialogArgument)
pure virtual

◆ updateIcon()

void GNEDialog::updateIcon ( GUIIcon  newIcon)
protectedinherited

update icon

Definition at line 281 of file GNEDialog.cpp.

References GUIIconSubSys::getIcon().

Referenced by GNEFileDialog::GNEFileDialog().

Here is the caller graph for this function:

◆ updateTitle()

void GNEDialog::updateTitle ( const std::string &  newTitle)
protectedinherited

update title

Definition at line 275 of file GNEDialog.cpp.

Referenced by GNEFileDialog::GNEFileDialog().

Here is the caller graph for this function:

Field Documentation

◆ myAbortButton

FXButton* GNEDialog::myAbortButton = nullptr
protectedinherited

abort button

Definition at line 144 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myAcceptButton

FXButton* GNEDialog::myAcceptButton = nullptr
protectedinherited

accept button

Definition at line 138 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), GNEFileDialog::GNEFileDialog(), and GNERunDialog::updateDialogButtons().

◆ myAdvancedButton

FXButton* GNEDialog::myAdvancedButton = nullptr
protectedinherited

advanced button

Definition at line 156 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), and GNENetgenerateDialog::updateRunButtons().

◆ myApplicationWindow

◆ myBackButton

FXButton* GNEDialog::myBackButton = nullptr
protectedinherited

back button

Definition at line 153 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), and GNERunDialog::updateDialogButtons().

◆ myCancelButton

FXButton* GNEDialog::myCancelButton = nullptr
protectedinherited

cancel button

Definition at line 141 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myChangesDescription

template<typename T >
std::string GNETemplateElementDialog< T >::myChangesDescription
private

description of changes did in this element dialog

Definition at line 102 of file GNETemplateElementDialog.h.

Referenced by GNETemplateElementDialog< T >::GNETemplateElementDialog(), and GNETemplateElementDialog< T >::resetChanges().

◆ myContentFrame

◆ myElement

◆ myFocusButton

FXButton* GNEDialog::myFocusButton = nullptr
privateinherited

focus button, used for focusing the default button when dialog is opened

Definition at line 181 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), and GNEDialog::openDialog().

◆ myOpenType

OpenType GNEDialog::myOpenType
privateinherited

◆ myResetButton

FXButton* GNEDialog::myResetButton = nullptr
protectedinherited

reset button

Definition at line 147 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myResult

Result GNEDialog::myResult = Result::CANCEL
protectedinherited

result to indicate if this dialog was closed accepting or rejecting changes

Definition at line 159 of file GNEDialog.h.

Referenced by GNEDialog::closeDialogAborting(), GNEDialog::closeDialogAccepting(), GNEDialog::closeDialogCanceling(), and GNEDialog::getResult().

◆ myRunButton

FXButton* GNEDialog::myRunButton = nullptr
protectedinherited

◆ myTesting

bool GNEDialog::myTesting = false
privateinherited

flag to indicate if this dialog is being tested using internal test

Definition at line 187 of file GNEDialog.h.

Referenced by GNEDialog::closeDialogAborting(), GNEDialog::closeDialogAccepting(), GNEDialog::closeDialogCanceling(), GNEDialog::onKeyPress(), GNEDialog::onKeyRelease(), and GNEDialog::openDialog().


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