Eclipse SUMO - Simulation of Urban MObility
FXEX::MFXBaseObject Class Reference

#include <MFXBaseObject.h>

Inheritance diagram for FXEX::MFXBaseObject:
[legend]
Collaboration diagram for FXEX::MFXBaseObject:
[legend]

Public Types

enum  {
  ID_NONE = 0 , ID_DELETE = 6 , ID_DISABLE , ID_ENABLE ,
  ID_SETVALUE = 17 , ID_SETINTVALUE , ID_SETREALVALUE , ID_SETSTRINGVALUE ,
  ID_SETINTRANGE , ID_SETREALRANGE , ID_GETINTVALUE , ID_GETREALVALUE ,
  ID_GETSTRINGVALUE , ID_XML , ID_META , ID_COMMENT ,
  ID_DOCUMENT , ID_TAG , ID_CONTENT , ID_LAST
}
 

Public Member Functions

virtual void create ()
 create resource More...
 
virtual void destroy ()
 destroy resource More...
 
virtual void detach ()
 detach resource More...
 
virtual void disable ()
 disable us More...
 
virtual void enable ()
 enable us More...
 
FXApp * getApp ()
 application pointer More...
 
FXSelector getSelector ()
 get the message More...
 
FXObject * getTarget ()
 get the target More...
 
void * getUserData ()
 get user data More...
 
FXuint getUserDataLen ()
 get user daat length More...
 
FXbool isEnabled ()
 are we enabled? More...
 
virtual FXbool isReadonly ()
 are we modifiable More...
 
virtual void load (FXStream &store)
 load object from stream More...
 
 MFXBaseObject (FXApp *a, FXObject *tgt=NULL, FXSelector sel=0)
 Alternnatively, supply the app object as well. More...
 
 MFXBaseObject (FXObject *tgt=NULL, FXSelector sel=0)
 Just supply the target and selector (de-serialisation too) More...
 
long onCmdDisable (FXObject *, FXSelector, void *)
 
long onCmdEnable (FXObject *, FXSelector, void *)
 
long onUpdate (FXObject *, FXSelector, void *)
 
virtual void save (FXStream &store) const
 save object to stream More...
 
virtual void setReadonly (FXbool mode=TRUE)
 set modifiable mode More...
 
void setSelector (FXSelector sel)
 set the selector More...
 
void setTarget (FXObject *tgt)
 set the target More...
 
void setUserData (void *d)
 set user data More...
 
void setUserDataLen (FXuint len)
 set the user data length More...
 
virtual ~MFXBaseObject ()
 dtor More...
 

Protected Types

enum  {
  FLAG_ENABLED = 0x00000002 , FLAG_UPDATE = 0x00000004 , FLAG_FOCUSED = 0x00000010 , FLAG_DIRTY = 0x00000020 ,
  FLAG_RECALC = 0x00000040 , FLAG_DEFAULT = 0x00000200 , FLAG_INITIAL = 0x00000400 , FLAG_ACTIVE = 0x00001000 ,
  FLAG_CHANGED = 0x00010000 , FLAG_READONLY = 0x10000000
}
 flags defined are the same as those defined in FXWindow, etc. More...
 

Protected Attributes

void * data
 
FXuint datalen
 
FXuint flags
 
FXSelector message
 
FXuint options
 
FXObject * target
 

Private Attributes

FXApp * app
 

Detailed Description

This is a base class for ojects which can send messages to the application

Definition at line 53 of file MFXBaseObject.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

flags defined are the same as those defined in FXWindow, etc.

Enumerator
FLAG_ENABLED 
FLAG_UPDATE 
FLAG_FOCUSED 
FLAG_DIRTY 
FLAG_RECALC 
FLAG_DEFAULT 
FLAG_INITIAL 
FLAG_ACTIVE 
FLAG_CHANGED 
FLAG_READONLY 

Definition at line 59 of file MFXBaseObject.h.

◆ anonymous enum

anonymous enum
Enumerator
ID_NONE 
ID_DELETE 
ID_DISABLE 
ID_ENABLE 
ID_SETVALUE 
ID_SETINTVALUE 
ID_SETREALVALUE 
ID_SETSTRINGVALUE 
ID_SETINTRANGE 
ID_SETREALRANGE 
ID_GETINTVALUE 
ID_GETREALVALUE 
ID_GETSTRINGVALUE 
ID_XML 
ID_META 
ID_COMMENT 
ID_DOCUMENT 
ID_TAG 
ID_CONTENT 
ID_LAST 

Definition at line 84 of file MFXBaseObject.h.

Constructor & Destructor Documentation

◆ MFXBaseObject() [1/2]

FXEX::MFXBaseObject::MFXBaseObject ( FXObject *  tgt = NULL,
FXSelector  sel = 0 
)

Just supply the target and selector (de-serialisation too)

Definition at line 58 of file MFXBaseObject.cpp.

◆ MFXBaseObject() [2/2]

FXEX::MFXBaseObject::MFXBaseObject ( FXApp *  a,
FXObject *  tgt = NULL,
FXSelector  sel = 0 
)

Alternnatively, supply the app object as well.

Definition at line 70 of file MFXBaseObject.cpp.

References app, data, flags, message, and target.

◆ ~MFXBaseObject()

FXEX::MFXBaseObject::~MFXBaseObject ( )
virtual

dtor

Definition at line 85 of file MFXBaseObject.cpp.

References app, data, and target.

Member Function Documentation

◆ create()

virtual void FXEX::MFXBaseObject::create ( )
inlinevirtual

create resource

Definition at line 186 of file MFXBaseObject.h.

◆ destroy()

virtual void FXEX::MFXBaseObject::destroy ( )
inlinevirtual

destroy resource

Definition at line 192 of file MFXBaseObject.h.

◆ detach()

virtual void FXEX::MFXBaseObject::detach ( )
inlinevirtual

detach resource

Definition at line 189 of file MFXBaseObject.h.

◆ disable()

virtual void FXEX::MFXBaseObject::disable ( )
inlinevirtual

disable us

Definition at line 173 of file MFXBaseObject.h.

References flags.

Referenced by onCmdDisable().

Here is the caller graph for this function:

◆ enable()

virtual void FXEX::MFXBaseObject::enable ( )
inlinevirtual

enable us

Definition at line 168 of file MFXBaseObject.h.

References FLAG_ENABLED, and flags.

Referenced by onCmdEnable().

Here is the caller graph for this function:

◆ getApp()

FXApp * FXEX::MFXBaseObject::getApp ( )

application pointer

Definition at line 118 of file MFXBaseObject.cpp.

References app.

Referenced by FXEX::MFXThreadEvent::~MFXThreadEvent().

Here is the caller graph for this function:

◆ getSelector()

FXSelector FXEX::MFXBaseObject::getSelector ( )
inline

get the message

Definition at line 133 of file MFXBaseObject.h.

References message.

◆ getTarget()

FXObject * FXEX::MFXBaseObject::getTarget ( )
inline

get the target

Definition at line 123 of file MFXBaseObject.h.

References target.

◆ getUserData()

void * FXEX::MFXBaseObject::getUserData ( )
inline

get user data

Definition at line 143 of file MFXBaseObject.h.

References data.

◆ getUserDataLen()

FXuint FXEX::MFXBaseObject::getUserDataLen ( )
inline

get user daat length

Definition at line 153 of file MFXBaseObject.h.

References datalen.

◆ isEnabled()

FXbool FXEX::MFXBaseObject::isEnabled ( )
inline

are we enabled?

Definition at line 163 of file MFXBaseObject.h.

References FLAG_ENABLED, and flags.

◆ isReadonly()

virtual FXbool FXEX::MFXBaseObject::isReadonly ( )
inlinevirtual

are we modifiable

Definition at line 178 of file MFXBaseObject.h.

References FLAG_READONLY, and flags.

◆ load()

void FXEX::MFXBaseObject::load ( FXStream &  store)
virtual

load object from stream

Definition at line 106 of file MFXBaseObject.cpp.

References app, data, datalen, flags, message, options, and target.

◆ onCmdDisable()

long FXEX::MFXBaseObject::onCmdDisable ( FXObject *  ,
FXSelector  ,
void *   
)

Definition at line 141 of file MFXBaseObject.cpp.

References disable().

Referenced by FXEX::FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdEnable()

long FXEX::MFXBaseObject::onCmdEnable ( FXObject *  ,
FXSelector  ,
void *   
)

Definition at line 135 of file MFXBaseObject.cpp.

References enable().

Referenced by FXEX::FXDEFMAP().

Here is the caller graph for this function:

◆ onUpdate()

long FXEX::MFXBaseObject::onUpdate ( FXObject *  sender,
FXSelector  ,
void *   
)

Definition at line 147 of file MFXBaseObject.cpp.

References FLAG_ENABLED, and flags.

Referenced by FXEX::FXDEFMAP().

Here is the caller graph for this function:

◆ save()

void FXEX::MFXBaseObject::save ( FXStream &  store) const
virtual

save object to stream

Definition at line 94 of file MFXBaseObject.cpp.

References app, data, datalen, flags, message, options, and target.

◆ setReadonly()

void FXEX::MFXBaseObject::setReadonly ( FXbool  mode = TRUE)
virtual

set modifiable mode

Definition at line 126 of file MFXBaseObject.cpp.

References FLAG_READONLY, and flags.

◆ setSelector()

void FXEX::MFXBaseObject::setSelector ( FXSelector  sel)
inline

set the selector

Definition at line 138 of file MFXBaseObject.h.

References message.

Referenced by GNEApplicationWindow::dependentBuild(), and GUIApplicationWindow::dependentBuild().

Here is the caller graph for this function:

◆ setTarget()

void FXEX::MFXBaseObject::setTarget ( FXObject *  tgt)
inline

set the target

Definition at line 128 of file MFXBaseObject.h.

References target.

Referenced by GNEApplicationWindow::dependentBuild(), and GUIApplicationWindow::dependentBuild().

Here is the caller graph for this function:

◆ setUserData()

void FXEX::MFXBaseObject::setUserData ( void *  d)
inline

set user data

Definition at line 148 of file MFXBaseObject.h.

References data.

◆ setUserDataLen()

void FXEX::MFXBaseObject::setUserDataLen ( FXuint  len)
inline

set the user data length

Definition at line 158 of file MFXBaseObject.h.

References datalen.

Field Documentation

◆ app

FXApp* FXEX::MFXBaseObject::app
private

Definition at line 73 of file MFXBaseObject.h.

Referenced by getApp(), load(), MFXBaseObject(), save(), and ~MFXBaseObject().

◆ data

void* FXEX::MFXBaseObject::data
protected

Definition at line 78 of file MFXBaseObject.h.

Referenced by getUserData(), load(), MFXBaseObject(), save(), setUserData(), and ~MFXBaseObject().

◆ datalen

FXuint FXEX::MFXBaseObject::datalen
protected

Definition at line 79 of file MFXBaseObject.h.

Referenced by getUserDataLen(), load(), save(), and setUserDataLen().

◆ flags

FXuint FXEX::MFXBaseObject::flags
protected

◆ message

FXSelector FXEX::MFXBaseObject::message
protected

◆ options

FXuint FXEX::MFXBaseObject::options
protected

Definition at line 81 of file MFXBaseObject.h.

Referenced by load(), and save().

◆ target

FXObject* FXEX::MFXBaseObject::target
protected

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