Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

spedas/gui/objects/

spd_ui_highlight_settings__define.pro


NAME: spd_ui_highlight_settings__define PURPOSE: highlight properties is an object that holds all parameters associated with theh Trace Properties Highlight panel CALLING SEQUENCE: highlightProperties = Obj_New("SPD_UI_HIGHLIGHT_SETTINGS") INPUT: none KEYWORDS: markVertical flag to mark vertical lineStyle line style object symbol symbol object placement droplistfor placement of symbol top, bottom, both top and bottom labelWith 0=No label, 1=X value, 2=Y value format numeric format for label markWhenY flag to mark y value whenYEquals y value to mark markEvery flag to mark every y value .. whenEveryEquals y value to mark setBackground flag to set background backgroundWhenY droplist of logical operators backgroundYValue value for logical operator backgroundColor r,g,b color for background OUTPUT: highlight property object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetPlacements returns a string array with placement options GetPlacement return a string with placement option of given index GetOperators returns a string array with operator options ['<','<=', ...] GetOperator return a string with placement option of given index 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_highlight_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_highlight_settings__define.pro $

Class description for SPD_UI_HIGHLIGHT_SETTINGS

Inheritance

Properties

Properties in spd_ui_getset

Properties in SPD_UI_HIGHLIGHT_SETTINGS

BackgroundColor init
BackgroundWhenY init
BackgroundYValue init
Debug init
Format init
LabelWith init
LineStyle init
MarkEvery init
MarkVertical init
MarkWhenY init
Placement init
SetBackground init
Symbol init
WhenEveryEquals init
WhenYEquals init

Fields

Fields in spd_ui_getset

Fields in SPD_UI_HIGHLIGHT_SETTINGS

BACKGROUNDCOLOR [0S, 0S, 0S]
BACKGROUNDWHENY 0S
BACKGROUNDYVALUE 0S
FORMAT 0S
LABELWITH 0S
LINESTYLE obj_new()
MARKEVERY 0S
MARKVERTICAL 0S
MARKWHENY 0S
PLACEMENT 0S
SETBACKGROUND 0S
SYMBOL obj_new()
WHENEVERYEQUALS 0S
WHENYEQUALS 0S

Routines

Methods inherited from spd_ui_getset

Routines from spd_ui_highlight_settings__define.pro

result = SPD_UI_HIGHLIGHT_SETTINGS::Copy()
result = SPD_UI_HIGHLIGHT_SETTINGS::GetOperators()
result = SPD_UI_HIGHLIGHT_SETTINGS::GetOperator(index)
result = SPD_UI_HIGHLIGHT_SETTINGS::GetPlacements()
result = SPD_UI_HIGHLIGHT_SETTINGS::GetPlacement(index)
result = SPD_UI_HIGHLIGHT_SETTINGS::Init(MarkVertical=MarkVertical, LineStyle=LineStyle, Symbol=Symbol, Placement=Placement, LabelWith=LabelWith, Format=Format, MarkWhenY=MarkWhenY, WhenYEquals=WhenYEquals, MarkEvery=MarkEvery, WhenEveryEquals=WhenEveryEquals, SetBackground=SetBackground, BackgroundWhenY=BackgroundWhenY, BackgroundYValue=BackgroundYValue, BackgroundColor=BackgroundColor, Debug=Debug)
SPD_UI_HIGHLIGHT_SETTINGS__DEFINE

Routine details

top source SPD_UI_HIGHLIGHT_SETTINGS::Copy

result = SPD_UI_HIGHLIGHT_SETTINGS::Copy()

top source SPD_UI_HIGHLIGHT_SETTINGS::GetOperators

result = SPD_UI_HIGHLIGHT_SETTINGS::GetOperators()

top source SPD_UI_HIGHLIGHT_SETTINGS::GetOperator

result = SPD_UI_HIGHLIGHT_SETTINGS::GetOperator(index)

Parameters

index

top source SPD_UI_HIGHLIGHT_SETTINGS::GetPlacements

result = SPD_UI_HIGHLIGHT_SETTINGS::GetPlacements()

top source SPD_UI_HIGHLIGHT_SETTINGS::GetPlacement

result = SPD_UI_HIGHLIGHT_SETTINGS::GetPlacement(index)

Parameters

index

top source SPD_UI_HIGHLIGHT_SETTINGS::Init

result = SPD_UI_HIGHLIGHT_SETTINGS::Init(MarkVertical=MarkVertical, LineStyle=LineStyle, Symbol=Symbol, Placement=Placement, LabelWith=LabelWith, Format=Format, MarkWhenY=MarkWhenY, WhenYEquals=WhenYEquals, MarkEvery=MarkEvery, WhenEveryEquals=WhenEveryEquals, SetBackground=SetBackground, BackgroundWhenY=BackgroundWhenY, BackgroundYValue=BackgroundYValue, BackgroundColor=BackgroundColor, Debug=Debug)

Keywords

MarkVertical
LineStyle
Symbol
Placement
LabelWith
Format
MarkWhenY
WhenYEquals
MarkEvery
WhenEveryEquals
SetBackground
BackgroundWhenY
BackgroundYValue
BackgroundColor
Debug

top source SPD_UI_HIGHLIGHT_SETTINGS__DEFINE

SPD_UI_HIGHLIGHT_SETTINGS__DEFINE

File attributes

Modification date: Thu Feb 13 16:41:39 2014
Lines: 106