![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/objects/
spd_ui_page_settings__define.pro
NAME: spd_ui_page_settings__define PURPOSE: Page Settings object - holds the settings for page text, layout and data CALLING SEQUENCE: page = Obj_New("SPD_UI_PAGE_SETTINGS") INPUT: none OUTPUT: page setting object reference ATTRIBUTES: title text object for title labels text object for labels variables text object for variables footer text object for footer marker text object for markers token droplist index for title token ifootertoken droplist index for footer token defMarkerTitle default value for marker titles maintainRead flag to maintain readability ShowTraceNames flag to display trace names xPanelSpacing horizontal spacing between panel(pts) yPanelSpacing vertical spacing between panel(pts) heightProp flag to maintain prop. heights gutterWidth width size for gutter displayOnScreen flag to display on screen altTopBottom flag to alternate top and bottom offsetFirstPage flag to offset first page orientation 0=portrait, 1=landscape backgroundColor name of background color leftPrintMargin size of left print margin (in.) rightPrintMargin size of right print margin (in.) topPrintMargin size of top print margin (in.) bottomPrintMargin size of bottom print margin (in.) canvasSize size of the page in inches overlapMajorTicks flag to overlap major ticks showValues set this flag to show values closerThanValue show data if closer than this closerThanUnits closer units (hr,min,sec,day) useSameYRange flag to use the same y range numMajorTicks number of major ticks to use numMinorTicks number of minor ticks to use skipBlanks flag to skip blanks METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetTokenNames returns all the token name options GetTokenName return a token name given an index GetUnitNames returns all closer than unit options GetUnitName returns a unit name given an index SetTokenValue places the string value of the token into the text object HISTORY: NOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset. You can still call these methods when using objects of type spd_ui_page_settings, and call them in the same way as before $LastChangedBy:pcruce $ $LastChangedDate:2009-09-10 09:15:19 -0700 (Thu, 10 Sep 2009) $ $LastChangedRevision:6707 $ $URL:svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/spedas/spd_ui/objects/spd_ui_page_settings__define.pro $
Class description for SPD_UI_PAGE_SETTINGS
Inheritance
Properties
Properties in spd_ui_getset
- _extra set
- _ref_extra get
Properties in SPD_UI_PAGE_SETTINGS
- AltTopBottom init
- BackgroundColor init
- BottomPrintMargin init
- CanvasSize init
- CloserThanUnits init
- CloserThanValue init
- Debug init
- DefMarkerTitle init
- DisplayOnScreen init
- Footer init
- GutterWidth init
- HeightProp init
- Labels init
- LeftPrintMargin init
- Marker init
- NumMajorTicks init
- NumMinorTicks init
- OffsetFirstPage init
- Orientation init
- OverlapMajorTicks init
- RightPrintMargin init
- ShowTraceNames init
- ShowValues init
- SkipBlanks init
- Title init
- Token init
- TopPrintMargin init
- UseSameYRange init
- Variables init
- _extra set
- _ref_extra get
- ifootertoken init
- maintainRead init
- nosave init
- xPanelSpacing init
- ypanelspacing get set init
Fields
Fields in SPD_UI_READWRITE
- __DUMMY 0S
Fields in spd_ui_getset
- ___DUMMY 0S
Fields in SPD_UI_PAGE_SETTINGS
- ALTTOPBOTTOM 0S
- BACKGROUNDCOLOR [0S, 0S, 0S]
- BOTTOMPRINTMARGIN 0.00000
- CANVASSIZE [0.0000000D, 0.0000000D]
- CLOSERTHANUNITS 0S
- CLOSERTHANVALUE 0S
- DEFMARKERTITLE ''
- DISPLAYONSCREEN 0S
- FOOTER obj_new()
- GUTTERWIDTH 0S
- HEIGHTPROP 0S
- IFOOTERTOKEN 0S
- LABELS obj_new()
- LEFTPRINTMARGIN 0.00000
- LOCKEDYPANELSPACING 0S
- MAINTAINREAD 0S
- MARKER obj_new()
- NUMMAJORTICKS 0S
- NUMMINORTICKS 0S
- OFFSETFIRSTPAGE 0S
- ORIENTATION 0S
- ORIGSETTINGS ptr_new()
- OVERLAPMAJORTICKS 0S
- PARENTLOCKED 0S
- RIGHTPRINTMARGIN 0.00000
- SHOWTRACENAMES 0S
- SHOWVALUES 0S
- SKIPBLANKS 0S
- TITLE obj_new()
- TOKEN 0S
- TOPPRINTMARGIN 0.00000
- UNLOCKEDYPANELSPACING 0S
- USESAMEYRANGE 0S
- VARIABLES obj_new()
- XPANELSPACING 0S
Routines
Methods inherited from spd_ui_getset
spd_ui_getset::getProperty, _ref_extra=_ref_extraspd_ui_getset::setProperty, _extra=_extraspd_ui_getset::SetAll, strresult = spd_ui_getset::GetAll()spd_ui_getset::setTouchedresult = spd_ui_getset::init()result = spd_ui_getset::equalTolerance(val1, val2)
Methods inherited from SPD_UI_READWRITE
result = spd_ui_readwrite::GetDOMElement(parent_node)spd_ui_readwrite::write, lunspd_ui_readwrite::BuildFromDOMElement, dom_elementspd_ui_readwrite::read, lunresult = spd_ui_readwrite::getNodeArray(nodelist)result = SPD_UI_READWRITE::Init()spd_ui_readwrite::appendXMLNewline, parent
Routines from spd_ui_page_settings__define.pro
result = SPD_UI_PAGE_SETTINGS::Copy()result = SPD_UI_PAGE_SETTINGS::GetTokenNames()result = SPD_UI_PAGE_SETTINGS::GetTokenName(index)result = SPD_UI_PAGE_SETTINGS::GetTokenCommands()result = SPD_UI_PAGE_SETTINGS::GetTokenCommand(index)result = spd_ui_page_settings::EvaluateToken(value, result, inittoken, token)result = SPD_UI_PAGE_SETTINGS::GetTitleString()result = SPD_UI_PAGE_SETTINGS::GetFooterString()result = spd_ui_page_settings::interpolateTitle(value)result = SPD_UI_PAGE_SETTINGS::GetTokenValue(index)result = SPD_UI_PAGE_SETTINGS::GetFormatNames()result = SPD_UI_PAGE_SETTINGS::GetFormatName(index)result = SPD_UI_PAGE_SETTINGS::GetFormatCommands()result = SPD_UI_PAGE_SETTINGS::GetFormatCommand(index)result = SPD_UI_PAGE_SETTINGS::GetUnitNames()result = SPD_UI_PAGE_SETTINGS::GetUnitName(index)result = SPD_UI_PAGE_SETTINGS::GetFontNames()result = SPD_UI_PAGE_SETTINGS::GetFontName(index)SPD_UI_PAGE_SETTINGS::Savespd_ui_page_settings::setProperty, ypanelspacing=ypanelspacing, _extra=_extraspd_ui_page_settings::getProperty, ypanelspacing=ypanelspacing, _ref_extra=_ref_extraSPD_UI_PAGE_SETTINGS::Resetresult = SPD_UI_PAGE_SETTINGS::Init(Title=Title, Labels=Labels, Variables=Variables, Footer=Footer, Marker=Marker, Token=Token, ifootertoken=ifootertoken, DefMarkerTitle=DefMarkerTitle, maintainRead=maintainRead, ShowTraceNames=ShowTraceNames, xPanelSpacing=xPanelSpacing, yPanelSpacing=yPanelSpacing, HeightProp=HeightProp, GutterWidth=GutterWidth, DisplayOnScreen=DisplayOnScreen, AltTopBottom=AltTopBottom, OffsetFirstPage=OffsetFirstPage, Orientation=Orientation, BackgroundColor=BackgroundColor, LeftPrintMargin=LeftPrintMargin, RightPrintMargin=RightPrintMargin, TopPrintMargin=TopPrintMargin, BottomPrintMargin=BottomPrintMargin, CanvasSize=CanvasSize, OverlapMajorTicks=OverlapMajorTicks, ShowValues=ShowValues, CloserThanValue=CloserThanValue, CloserThanUnits=CloserThanUnits, UseSameYRange=UseSameYRange, NumMajorTicks=NumMajorTicks, NumMinorTicks=NumMinorTicks, SkipBlanks=SkipBlanks, Debug=Debug, nosave=nosave)SPD_UI_PAGE_SETTINGS__DEFINE
Routine details
top source SPD_UI_PAGE_SETTINGS::GetTokenName
result = SPD_UI_PAGE_SETTINGS::GetTokenName(index)
Parameters
- index
top source SPD_UI_PAGE_SETTINGS::GetTokenCommand
result = SPD_UI_PAGE_SETTINGS::GetTokenCommand(index)
Parameters
- index
top source spd_ui_page_settings::EvaluateToken
result = spd_ui_page_settings::EvaluateToken(value, result, inittoken, token)
Parameters
- value
- result
- inittoken
- token
top source spd_ui_page_settings::interpolateTitle
result = spd_ui_page_settings::interpolateTitle(value)
Parameters
- value
top source SPD_UI_PAGE_SETTINGS::GetTokenValue
result = SPD_UI_PAGE_SETTINGS::GetTokenValue(index)
Parameters
- index
top source SPD_UI_PAGE_SETTINGS::GetFormatName
result = SPD_UI_PAGE_SETTINGS::GetFormatName(index)
Parameters
- index
top source SPD_UI_PAGE_SETTINGS::GetFormatCommands
result = SPD_UI_PAGE_SETTINGS::GetFormatCommands()
top source SPD_UI_PAGE_SETTINGS::GetFormatCommand
result = SPD_UI_PAGE_SETTINGS::GetFormatCommand(index)
Parameters
- index
top source SPD_UI_PAGE_SETTINGS::GetUnitName
result = SPD_UI_PAGE_SETTINGS::GetUnitName(index)
Parameters
- index
top source SPD_UI_PAGE_SETTINGS::GetFontName
result = SPD_UI_PAGE_SETTINGS::GetFontName(index)
Parameters
- index
top source spd_ui_page_settings::setProperty
spd_ui_page_settings::setProperty, ypanelspacing=ypanelspacing, _extra=_extra
Keywords
- ypanelspacing
- _extra
top source spd_ui_page_settings::getProperty
spd_ui_page_settings::getProperty, ypanelspacing=ypanelspacing, _ref_extra=_ref_extra
Keywords
- ypanelspacing
- _ref_extra
top source SPD_UI_PAGE_SETTINGS::Init
result = SPD_UI_PAGE_SETTINGS::Init(Title=Title, Labels=Labels, Variables=Variables, Footer=Footer, Marker=Marker, Token=Token, ifootertoken=ifootertoken, DefMarkerTitle=DefMarkerTitle, maintainRead=maintainRead, ShowTraceNames=ShowTraceNames, xPanelSpacing=xPanelSpacing, yPanelSpacing=yPanelSpacing, HeightProp=HeightProp, GutterWidth=GutterWidth, DisplayOnScreen=DisplayOnScreen, AltTopBottom=AltTopBottom, OffsetFirstPage=OffsetFirstPage, Orientation=Orientation, BackgroundColor=BackgroundColor, LeftPrintMargin=LeftPrintMargin, RightPrintMargin=RightPrintMargin, TopPrintMargin=TopPrintMargin, BottomPrintMargin=BottomPrintMargin, CanvasSize=CanvasSize, OverlapMajorTicks=OverlapMajorTicks, ShowValues=ShowValues, CloserThanValue=CloserThanValue, CloserThanUnits=CloserThanUnits, UseSameYRange=UseSameYRange, NumMajorTicks=NumMajorTicks, NumMinorTicks=NumMinorTicks, SkipBlanks=SkipBlanks, Debug=Debug, nosave=nosave)
Keywords
- Title
- Labels
- Variables
- Marker
- Token
- DefMarkerTitle
- maintainRead
- ShowTraceNames
- xPanelSpacing
- yPanelSpacing
- HeightProp
- GutterWidth
- DisplayOnScreen
- AltTopBottom
- OffsetFirstPage
- Orientation
- BackgroundColor
- LeftPrintMargin
- RightPrintMargin
- TopPrintMargin
- BottomPrintMargin
- CanvasSize
- OverlapMajorTicks
- ShowValues
- CloserThanValue
- CloserThanUnits
- UseSameYRange
- NumMajorTicks
- NumMinorTicks
- SkipBlanks
- Debug
- nosave
File attributes
| Modification date: | Mon Jun 9 05:58:58 2014 |
| Lines: | 344 |