spedas/gui/objects/
spd_ui_history__define.pro
NAME: spd_ui_history PURPOSE: A widget to display the all messages generated during this session $LastChangedBy: aaflores $ $LastChangedDate: 2014-05-29 12:47:11 -0700 (Thu, 29 May 2014) $ $LastChangedRevision: 15259 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_history__define.pro $ + NAME: spd_ui_history__define PURPOSE: This is a history window object used to display textual information for the user (such as a status bar for current states, message bar, or informational bar) CALLING SEQUENCE: To Create: myHistory = Obj_New("SPD_UI_HISTORY") To Use: myHistory->Update, 'This is a test' Or: result = myHistory->GetState() INPUT: KEYWORDS: name: optional name state: set this to one to display value: text to be displayed in the bar xSize: size of bar in x direction ySize: size of bar in y direction debug: set this value to one for debugging OUTPUT: message bar object reference METHODS: Draw creates/displays the bar (automatically called by INIT) Delete removes bar from display (object persists) Update updates bar with new message SetProperty procedure to set keywords GetProperty procedure to get keywords GetState returns the current state of the bar (on/off) (this is a function) HISTORY: $LastChangedBy: aaflores $ $LastChangedDate: 2014-05-29 12:47:11 -0700 (Thu, 29 May 2014) $ $LastChangedRevision: 15259 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_history__define.pro $
Class description for spd_ui_history
Properties
Properties in spd_ui_history
- Debug init
- Draw set
- ID get
- Message init
- Messages get
- State get init
- XSize get set init
- YSize get set init
- lastSaveSuccess get set init
- mainID get
- menuID get
- running_history_dir get init
- textID get
Fields
Fields in spd_ui_history
- ID 0L
- LASTSAVESUCCESS 0B
- MAINID 0L
- MENUID 0L
- MESSAGES ptr_new()
- RUNNING_HISTORY_DIR ''
- STATE 0S
- TEXTID 0L
- XSIZE 0S
- YSIZE 0S
Routines
Routines from spd_ui_history__define.pro
spd_ui_history_event, event
spd_ui_history::Save, filename=filename, append=append
SPD_UI_HISTORY::Draw
SPD_UI_HISTORY::Delete
SPD_UI_HISTORY::Update, message_in, DontShow=DontShow, nosave=nosave
result = SPD_UI_HISTORY::GetState()
result = SPD_UI_HISTORY::ReadJournalFile()
SPD_UI_HISTORY::SetProperty, XSize=XSize, YSize=YSize, lastSaveSuccess=lastSaveSuccess, Draw=Draw
SPD_UI_HISTORY::GetProperty, ID=ID, menuID=menuID, mainID=mainID, textID=textID, State=State, Messages=Messages, running_history_dir=running_history_dir, lastSaveSuccess=lastSaveSuccess, XSize=XSize, YSize=YSize
spd_ui_history::saveHistoryFile
result = SPD_UI_HISTORY::Init(menuID, mainID, State=State, Message=Message, running_history_dir=running_history_dir, lastSaveSuccess=lastSaveSuccess, XSize=XSize, YSize=YSize, Debug=Debug)
SPD_UI_HISTORY__DEFINE
Routine details
top source spd_ui_history::Save
spd_ui_history::Save, filename=filename, append=append
Keywords
- filename
- append
top source SPD_UI_HISTORY::Update
SPD_UI_HISTORY::Update, message_in, DontShow=DontShow, nosave=nosave
Parameters
- message_in
Keywords
- DontShow
- nosave
top source SPD_UI_HISTORY::SetProperty
SPD_UI_HISTORY::SetProperty, XSize=XSize, YSize=YSize, lastSaveSuccess=lastSaveSuccess, Draw=Draw
Keywords
- XSize
- YSize
- lastSaveSuccess
- Draw
top source SPD_UI_HISTORY::GetProperty
SPD_UI_HISTORY::GetProperty, ID=ID, menuID=menuID, mainID=mainID, textID=textID, State=State, Messages=Messages, running_history_dir=running_history_dir, lastSaveSuccess=lastSaveSuccess, XSize=XSize, YSize=YSize
Keywords
- ID
- mainID
- textID
- State
- Messages
- running_history_dir
- lastSaveSuccess
- XSize
- YSize
top source SPD_UI_HISTORY::Init
result = SPD_UI_HISTORY::Init(menuID, mainID, State=State, Message=Message, running_history_dir=running_history_dir, lastSaveSuccess=lastSaveSuccess, XSize=XSize, YSize=YSize, Debug=Debug)
Parameters
- mainID
Keywords
- State
- Message
- running_history_dir
- lastSaveSuccess
- XSize
- YSize
- Debug
File attributes
Modification date: | Mon Jun 9 05:58:58 2014 |
Lines: | 272 |