Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

spedas/gui/panels/

spd_ui_page_options.pro


NAME: spd_ui_page_title_set_value PURPOSE: Reads the title settings out of the widgets and stores them in the appropriate location in the draw tree INPUTS: tlb: the top level base for this window pagesettings: the page settings associated with the current window NOTES:

NAME: spd_ui_page_footer_set_value PURPOSE: Reads the footer settings out of the widgets and stores them in the appropriate location in the draw tree INPUTS: tlb: the top level base for this window pagesettings: the page settings associated with the current window NOTES:

NAME: spd_ui_page_set_value PURPOSE: this procedure is here to provide a framework for the incremental implementation of lazy event handling in the page window. Rather than store a value every time an event occurs, this procedure queries widget values, when they are needed('OK' or 'Apply'). The advantages of this are: #1 Simplifies/Centralizes event handling code #2 Prevent routines from overwriting invalid user inputs when they are partially complete #3 Allows the window to perform more complex input validation(because it can be assumed that all inputs should be correct) INPUTS: The top level base of the page window The state variable for the window(If the state were not taken off the tlb by the time this is called, we could eliminate this parameter) NOTES: This routine is incomplete. As software maintainence tasks are performed, programmers should move functions into this routine at their perogative. Right now the title and the footer are processed using the lazy event handling.

NAME: spd_ui_page_color_event PURPOSE: abstracts duplication in handling of color/palette events INPUTS: tlb: the top level base for this window uname: the user name of the widget in question messagename: the name to be used in the output message NOTES:

Routines

Routines from spd_ui_page_options.pro

handle_pagetitle_command, state, event, ind, format=format

NAME: spd_ui_page_optionsPURPOSE: user interface panel that allows user to change page parametersCALLING SEQUENCE: spd_ui_page_options, gui_idINPUT: gui_id = the id number of the widget that calls thisOUTPUT:HISTORY:$LastChangedBy: aaflores $$LastChangedDate: 2014-05-16 17:55:52 -0700 (Fri, 16 May 2014) $$LastChangedRevision: 15162 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/panels/spd_ui_page_options.pro $Pro HANDLE_PAGETITLE_COMMAND updates the "titletext" widget, and the pagesettings object after a selection on oneof the subbuttons of the "Token" and "Format" buttons (Graph -> Page Options...

spd_ui_page_spacing_set_value, tlb, pagesettings, historywin, statusbar
spd_ui_page_canvas_update, state, orient

NAME: spd_ui_page_update_canvas PURPOSE: helper function, updates canvas size values when switching between portrait and landscape modes INPUTS: state: the panel's state structure orient: flag for landscape(1)/portrait(0) modes

spd_ui_page_canvas_set_value, tlb, pagesettings, historywin, statusbar, drawObject, windowStorage
spd_ui_page_margins_set_value, tlb, pagesettings, historywin, statusBar
spd_ui_page_title_set_value, tlb, pagesettings, historywin, statusBar
spd_ui_page_footer_set_value, tlb, pagesettings, historywin, statusBar
spd_ui_page_all_set_value, tlb, state

NAME: spd_ui_page_all_set_valuePURPOSE: this procedure is used to change values for all pages.

spd_ui_page_set_value, tlb, state
spd_ui_page_color_event, tlb, uname, messagename, historywin, statusbar
result = spd_ui_page_font_get_value(tlb, uname)

NAME: spd_ui_page_font_get_value PURPOSE: abstracts duplication in acquisition of font values INPUTS: tlb: the top level base for this window uname: the user name of the widget in question NOTES:

result = spd_ui_page_color_get_value(tlb, uname)

NAME: spd_ui_page_color_get_value PURPOSE: abstracts duplication in acquisition of font values INPUTS: tlb: the top level base for this window uname: the user name of the widget in question NOTES:

spd_ui_page_options_event, event, pagesettings
spd_ui_page_options, info

Routine details

top source handle_pagetitle_command

handle_pagetitle_command, state, event, ind, format=format

NAME: spd_ui_page_options PURPOSE: user interface panel that allows user to change page parameters CALLING SEQUENCE: spd_ui_page_options, gui_id INPUT: gui_id = the id number of the widget that calls this OUTPUT: HISTORY: $LastChangedBy: aaflores $ $LastChangedDate: 2014-05-16 17:55:52 -0700 (Fri, 16 May 2014) $ $LastChangedRevision: 15162 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/panels/spd_ui_page_options.pro $ Pro HANDLE_PAGETITLE_COMMAND updates the "titletext" widget, and the pagesettings object after a selection on one of the subbuttons of the "Token" and "Format" buttons (Graph -> Page Options... Text [tab]). For the format buttons, the FORMAT kw must be set. This routine reduces duplication in the case statement of SPD_UI_PAGE_OPTIONS_EVENT.PRO. W.M.Feuerstein, September 24, 2008. Function not currently in use.

Parameters

state
event
ind

Keywords

format

top source spd_ui_page_spacing_set_value

spd_ui_page_spacing_set_value, tlb, pagesettings, historywin, statusbar

Parameters

tlb
pagesettings
historywin
statusbar

top source spd_ui_page_canvas_update

spd_ui_page_canvas_update, state, orient

NAME: spd_ui_page_update_canvas PURPOSE: helper function, updates canvas size values when switching between portrait and landscape modes INPUTS: state: the panel's state structure orient: flag for landscape(1)/portrait(0) modes

Parameters

state
orient

top source spd_ui_page_canvas_set_value

spd_ui_page_canvas_set_value, tlb, pagesettings, historywin, statusbar, drawObject, windowStorage

Parameters

tlb
pagesettings
historywin
statusbar
drawObject
windowStorage

top source spd_ui_page_margins_set_value

spd_ui_page_margins_set_value, tlb, pagesettings, historywin, statusBar

Parameters

tlb
pagesettings
historywin
statusBar

top source spd_ui_page_title_set_value

spd_ui_page_title_set_value, tlb, pagesettings, historywin, statusBar

Parameters

tlb
pagesettings
historywin
statusBar

top source spd_ui_page_all_set_value

spd_ui_page_all_set_value, tlb, state

NAME: spd_ui_page_all_set_value PURPOSE: this procedure is used to change values for all pages. INPUTS: The top level base of the page window The state variable for the window NOTES: This routine mimics spd_ui_page_set_value which is applicable to a single page

Parameters

tlb
state

top source spd_ui_page_set_value

spd_ui_page_set_value, tlb, state

Parameters

tlb
state

top source spd_ui_page_color_event

spd_ui_page_color_event, tlb, uname, messagename, historywin, statusbar

Parameters

tlb
uname
messagename
historywin
statusbar

top source spd_ui_page_font_get_value

result = spd_ui_page_font_get_value(tlb, uname)

NAME: spd_ui_page_font_get_value PURPOSE: abstracts duplication in acquisition of font values INPUTS: tlb: the top level base for this window uname: the user name of the widget in question NOTES:

Parameters

tlb
uname

top source spd_ui_page_color_get_value

result = spd_ui_page_color_get_value(tlb, uname)

NAME: spd_ui_page_color_get_value PURPOSE: abstracts duplication in acquisition of font values INPUTS: tlb: the top level base for this window uname: the user name of the widget in question NOTES:

Parameters

tlb
uname

top source spd_ui_page_options_event

spd_ui_page_options_event, event, pagesettings

Parameters

event
pagesettings

top source spd_ui_page_options

spd_ui_page_options, info

Parameters

info

File attributes

Modification date: Mon Jun 9 05:58:57 2014
Lines: 972