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_OK , OK_COPY_REPORT
}
enum class  OpenType { MODAL , NON_MODAL }
 Open dialog type. More...

Public Member Functions

T * getElement () const
 get edited element
 GNETemplateElementDialog (T *element, DialogType type)
 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 depending of Buttons)
virtual long onCmdBack (FXObject *, FXSelector, void *)
 called when back button is pressed (must be reimplemented in children depending of Buttons)
virtual long onCmdAdvanced (FXObject *, FXSelector, void *)
 called when advanced button is pressed (must be reimplemented in children depending of Buttons)
virtual long onCmdCopy (FXObject *, FXSelector, void *)
 called when copy button is pressed (must be reimplemented in children depending of Buttons)
virtual long onCmdReport (FXObject *, FXSelector, void *)
 called when report button is pressed (must be reimplemented in children depending of Buttons)
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
FXButton * myCopyButton = nullptr
 copy button
T * myElement = nullptr
 pointer to edited element
FXButton * myReportButton = nullptr
 report button
FXButton * myResetButton = nullptr
 reset button
FXWindow * myRestoringFocusWindow = nullptr
 FXWindows that restoring focus window.
Result myResult = Result::CANCEL
 result to indicate if this dialog was closed accepting or rejecting changes
FXButton * myRunButton = nullptr
 run button
DialogType myType = DialogType::DEFAULT
 dialog type

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
void setRestoringFocusWindow (FXWindow *window)
 wet FXWindows uses for restoring focus
enum class  ResizeMode { STATIC , RESIZABLE }
enum class  Result {
  ACCEPT , CANCEL , ABORT , ACCEPT_ALL ,
  CANCEL_ALL
}
 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_OK 
OK_COPY_REPORT 

Definition at line 43 of file GNEDialog.h.

◆ OpenType

enum class GNEDialog::OpenType
stronginherited

Open dialog type.

Enumerator
MODAL 
NON_MODAL 

Definition at line 58 of file GNEDialog.h.

◆ ResizeMode

enum class GNEDialog::ResizeMode
stronginherited
Enumerator
STATIC 
RESIZABLE 

Definition at line 64 of file GNEDialog.h.

◆ Result

enum class GNEDialog::Result
stronginherited

list of possible results when closing the dialog

Enumerator
ACCEPT 
CANCEL 
ABORT 
ACCEPT_ALL 
CANCEL_ALL 

Definition at line 70 of file GNEDialog.h.

Constructor & Destructor Documentation

◆ GNETemplateElementDialog() [1/3]

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

constructor

Definition at line 35 of file GNETemplateElementDialog.h.

References GNEDialog::GNEDialog(), myChangesDescription, myElement, and TLF.

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

Here is the caller graph for this function:

◆ ~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.

References GNEDialog::GNEDialog().

◆ GNETemplateElementDialog() [3/3]

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

Invalidated copy constructor.

References GNETemplateElementDialog().

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 myElement.

◆ buildDialog()

◆ closeDialogAborting()

long GNEDialog::closeDialogAborting ( )
protectedinherited

close dialog aborting the changes

Definition at line 295 of file GNEDialog.cpp.

References ABORT, MODAL, myApplicationWindow, myOpenType, myRestoringFocusWindow, myResult, and myTesting.

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

Here is the caller graph for this function:

◆ closeDialogAccepting()

long GNEDialog::closeDialogAccepting ( )
protectedinherited

◆ closeDialogCanceling()

◆ getApplicationWindow()

GNEApplicationWindow * GNEDialog::getApplicationWindow ( ) const
inherited

get pointer to the application window

Definition at line 102 of file GNEDialog.cpp.

References myApplicationWindow.

Referenced by GNEPythonToolDialog::buildArguments().

Here is the caller graph for this function:

◆ getContentFrame()

FXVerticalFrame * GNEDialog::getContentFrame ( ) const
inherited

get content frame

Definition at line 108 of file GNEDialog.cpp.

References myContentFrame.

Referenced by GNEColorDialog::GNEColorDialog(), and 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 96 of file GNEDialog.cpp.

References myResult.

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

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 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 depending of Buttons)

Reimplemented in GNENetgenerateDialog.

Definition at line 156 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 depending of Buttons)

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

Definition at line 150 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 myElement.

◆ onCmdCopy()

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

called when copy button is pressed (must be reimplemented in children depending of Buttons)

Reimplemented in GNECrashDialog.

Definition at line 162 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdReport()

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

called when report button is pressed (must be reimplemented in children depending of Buttons)

Reimplemented in GNECrashDialog.

Definition at line 168 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ 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 depending of Buttons)

Reimplemented in GNENetgenerateDialog, GNENetgenerateOptionsDialog, GNEPythonToolDialog, and GNERunDialog.

Definition at line 144 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 174 of file GNEDialog.cpp.

References closeDialogAborting(), myApplicationWindow, and 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 190 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ openDialog()

◆ operator=()

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

Invalidated assignment operator.

References GNETemplateElementDialog().

◆ resetChanges()

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

reset changes did in this dialog.

Definition at line 94 of file GNETemplateElementDialog.h.

References myChangesDescription, and myElement.

◆ runInternalTest()

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

◆ setRestoringFocusWindow()

void GNEDialog::setRestoringFocusWindow ( FXWindow * window)
inherited

wet FXWindows uses for restoring focus

Definition at line 114 of file GNEDialog.cpp.

References myRestoringFocusWindow.

Referenced by GNEFileDialog::GNEFileDialog().

Here is the caller graph for this function:

◆ updateIcon()

void GNEDialog::updateIcon ( GUIIcon newIcon)
protectedinherited

update icon

Definition at line 321 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 315 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 161 of file GNEDialog.h.

Referenced by buildDialog().

◆ myAcceptButton

FXButton* GNEDialog::myAcceptButton = nullptr
protectedinherited

◆ myAdvancedButton

FXButton* GNEDialog::myAdvancedButton = nullptr
protectedinherited

advanced button

Definition at line 173 of file GNEDialog.h.

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

◆ myApplicationWindow

◆ myBackButton

FXButton* GNEDialog::myBackButton = nullptr
protectedinherited

back button

Definition at line 170 of file GNEDialog.h.

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

◆ myCancelButton

FXButton* GNEDialog::myCancelButton = nullptr
protectedinherited

cancel button

Definition at line 158 of file GNEDialog.h.

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

◆ myContentFrame

◆ myCopyButton

FXButton* GNEDialog::myCopyButton = nullptr
protectedinherited

copy button

Definition at line 176 of file GNEDialog.h.

Referenced by buildDialog(), and GNECrashDialog::GNECrashDialog().

◆ myElement

template<typename T>
T* GNETemplateElementDialog< T >::myElement = nullptr
protected

pointer to edited element

Definition at line 85 of file GNETemplateElementDialog.h.

Referenced by acceptElementDialog(), getElement(), GNETemplateElementDialog(), onCmdAbort(), onCmdCancel(), and resetChanges().

◆ myFocusButton

FXButton* GNEDialog::myFocusButton = nullptr
privateinherited

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

Definition at line 207 of file GNEDialog.h.

Referenced by buildDialog().

◆ myOpenType

OpenType GNEDialog::myOpenType
privateinherited

open type

Definition at line 210 of file GNEDialog.h.

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

◆ myReportButton

FXButton* GNEDialog::myReportButton = nullptr
protectedinherited

report button

Definition at line 179 of file GNEDialog.h.

Referenced by buildDialog().

◆ myResetButton

FXButton* GNEDialog::myResetButton = nullptr
protectedinherited

reset button

Definition at line 164 of file GNEDialog.h.

Referenced by buildDialog().

◆ myRestoringFocusWindow

FXWindow* GNEDialog::myRestoringFocusWindow = nullptr
protectedinherited

FXWindows that restoring focus window.

Definition at line 149 of file GNEDialog.h.

Referenced by closeDialogAborting(), closeDialogAccepting(), closeDialogCanceling(), and setRestoringFocusWindow().

◆ myResult

Result GNEDialog::myResult = Result::CANCEL
protectedinherited

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

Definition at line 185 of file GNEDialog.h.

Referenced by closeDialogAborting(), closeDialogAccepting(), closeDialogCanceling(), getResult(), GNESaveDialog::onCmdAccept(), and GNESaveDialog::onCmdCancel().

◆ 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 213 of file GNEDialog.h.

Referenced by closeDialogAborting(), closeDialogAccepting(), closeDialogCanceling(), and onKeyPress().

◆ myType

DialogType GNEDialog::myType = DialogType::DEFAULT
protectedinherited

dialog type

Definition at line 182 of file GNEDialog.h.

Referenced by GNEDialog(), and GNEDialog().


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