diff options
Diffstat (limited to 'vendor/x11iraf/obm/ObmW/Toggle.man')
| -rw-r--r-- | vendor/x11iraf/obm/ObmW/Toggle.man | 538 |
1 files changed, 538 insertions, 0 deletions
diff --git a/vendor/x11iraf/obm/ObmW/Toggle.man b/vendor/x11iraf/obm/ObmW/Toggle.man new file mode 100644 index 00000000..fa01d492 --- /dev/null +++ b/vendor/x11iraf/obm/ObmW/Toggle.man @@ -0,0 +1,538 @@ +.\"remove .ig hn for full docs +.de hi +.ig eh +.. +.de eh +.. +.TH "" 3 "" "Version 3.0" "Free Widget Foundation" +.SH NAME +XfwfToggle +.SH DESCRIPTION +The \fIXfwfToggle\fP is a button that switches states with every activation +(which is by default with every mouse click). The states are named `on' and +`off'. The states can be indicated with a $\surd$ before the label Two +callbacks report the changed state to the application: \fIonCallback\fP is called +when the button switches to `on', \fIoffCallback\fP is called when the button +switches back to `off'. + +.SS "Public variables" + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +XfwfToggle +Name Class Type Default +XtNonCallback XtCOnCallback Callback NULL +XtNoffCallback XtCOffCallback Callback NULL +XtNon XtCOn Boolean False +XtNonIcon XtCOnIcon Icon * "filledsquare" +XtNoffIcon XtCOffIcon Icon * "emptysquare" + +.TE +.ps + +.TP +.I "XtNonCallback" +The \fIonCallback\fP is called by the \fItoggle\fP action or by the \fIswitch_on\fP +action, if the previous state was `off'. The \fIcall_data\fP argument will contain +the \fIXEvent\fP pointer that trigerred the action function. + + + +.hi + +.nf +<Callback> XtCallbackList onCallback = NULL +.fi + +.eh + +.TP +.I "XtNoffCallback" +The \fIoffCallback\fP is called from the \fItoggle\fP or \fIswitch_off\fP action, if the +previous state was `on'. The \fIcall_data\fP argument will be a pointer to the +\fIXEvent\fP that caused the action. + + + +.hi + +.nf +<Callback> XtCallbackList offCallback = NULL +.fi + +.eh + +.TP +.I "XtNon" +The variable \fIon\fP records the state of the widget: \fITrue\fP means `on' and +\fIFalse\fP means `off'. + + + +.hi + +.nf +Boolean on = False +.fi + +.eh + +.TP +.I "XtNonIcon" +By default, the button displays a $\surd$ when on and nothing when +off. The two resources \fIonIcon\fP and \fIoffPIcon\fP can replace these +two graphics with arbitrary pixmaps. Suggested size for these pixmaps +is about $16\times18$. + + + +.hi + +.nf +Icon * onIcon = <String>"filledsquare" +.fi + +.eh + +.TP +.I "XtNoffIcon" +The \fIoffIcon\fP is displayed when the button is in `off' state. By +default, nothing is displayed in this state. + + + +.hi + +.nf +Icon * offIcon = <String>"emptysquare" +.fi + +.eh + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +XfwfButton +Name Class Type Default +XtNactivate XtCActivate Callback NULL + +.TE +.ps + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +XfwfLabel +Name Class Type Default +XtNlabel XtCLabel String NULL +XtNtablist XtCTablist String NULL +XtNfont XtCFont FontStruct XtDefaultFont +XtNforeground XtCForeground Pixel XtDefaultForeground +XtNalignment XtCAlignment Alignment 0 +XtNtopMargin XtCTopMargin Dimension 2 +XtNbottomMargin XtCBottomMargin Dimension 2 +XtNleftMargin XtCLeftMargin Dimension 2 +XtNrightMargin XtCRightMargin Dimension 2 +XtNshrinkToFit XtCShrinkToFit Boolean False +XtNrvStart XtCRvStart Int 0 +XtNrvLength XtCRvLength Int 0 + +.TE +.ps + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +XfwfBoard +Name Class Type Default +XtNabs_x XtCAbs_x Position 0 +XtNrel_x XtCRel_x Float "0.0" +XtNabs_y XtCAbs_y Position 0 +XtNrel_y XtCRel_y Float "0.0" +XtNabs_width XtCAbs_width Position 0 +XtNrel_width XtCRel_width Float "1.0" +XtNabs_height XtCAbs_height Position 0 +XtNrel_height XtCRel_height Float "1.0" +XtNhunit XtCHunit Float "1.0" +XtNvunit XtCVunit Float "1.0" +XtNlocation XtCLocation String NULL + +.TE +.ps + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +XfwfFrame +Name Class Type Default +XtNcursor XtCCursor Cursor None +XtNframeType XtCFrameType FrameType XfwfRaised +XtNframeWidth XtCFrameWidth Dimension 0 +XtNouterOffset XtCOuterOffset Dimension 0 +XtNinnerOffset XtCInnerOffset Dimension 0 +XtNshadowScheme XtCShadowScheme ShadowScheme XfwfAuto +XtNtopShadowColor XtCTopShadowColor Pixel compute_topcolor +XtNbottomShadowColor XtCBottomShadowColor Pixel compute_bottomcolor +XtNtopShadowStipple XtCTopShadowStipple Bitmap NULL +XtNbottomShadowStipple XtCBottomShadowStipple Bitmap NULL + +.TE +.ps + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +XfwfCommon +Name Class Type Default +XtNtraversalOn XtCTraversalOn Boolean True +XtNhighlightThickness XtCHighlightThickness Dimension 2 +XtNhighlightColor XtCHighlightColor Pixel XtDefaultForeground +XtNhighlightPixmap XtCHighlightPixmap Pixmap None +XtNnextTop XtCNextTop Callback NULL +XtNuserData XtCUserData Pointer NULL + +.TE +.ps + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +Composite +Name Class Type Default +XtNchildren XtCChildren WidgetList NULL +insertPosition XtCInsertPosition XTOrderProc NULL +numChildren XtCNumChildren Cardinal 0 + +.TE +.ps + +.ps-2 +.TS +center box; +cBsss +lB|lB|lB|lB +l|l|l|l. +Core +Name Class Type Default +XtNx XtCX Position 0 +XtNy XtCY Position 0 +XtNwidth XtCWidth Dimension 0 +XtNheight XtCHeight Dimension 0 +borderWidth XtCBorderWidth Dimension 0 +XtNcolormap XtCColormap Colormap NULL +XtNdepth XtCDepth Int 0 +destroyCallback XtCDestroyCallback XTCallbackList NULL +XtNsensitive XtCSensitive Boolean True +XtNtm XtCTm XTTMRec NULL +ancestorSensitive XtCAncestorSensitive Boolean False +accelerators XtCAccelerators XTTranslations NULL +borderColor XtCBorderColor Pixel 0 +borderPixmap XtCBorderPixmap Pixmap NULL +background XtCBackground Pixel 0 +backgroundPixmap XtCBackgroundPixmap Pixmap NULL +mappedWhenManaged XtCMappedWhenManaged Boolean True +XtNscreen XtCScreen Screen * NULL + +.TE +.ps + +.SS "Translations" + +The \fItoggle\fP action toggles the widget between `on' and `off'. By +default it is bound to a click of the left mouse button as well as to +the Return key. + + + +.nf +<Btn1Down>: set_shadow(sunken) +.fi + +.nf +<Btn1Up>: toggle() set_shadow() +.fi + +.nf +<Key>Return: toggle() +.fi + +.hi +.SS "Actions" + +.TP +.I "toggle + +The \fItoggle\fP action switches the state. Depending on the resources +it might change the tickmark. The \fIonCallback\fP or \fIoffCallback\fP +functions are called, with the event as \fIcall_data\fP argument. + +.hi + +.nf +void toggle($, XEvent* event, String* params, Cardinal* num_params) +{ + XtVaSetValues($, "on", !$on, NULL); + XtCallCallbackList($, $on ? $onCallback : $offCallback, event); +} +.fi + +.eh + +.TP +.I "switch_on + +The \fIswitch_on\fP action switches the button to `on' if it is `off', +otherwise it does nothing. By default it isn't bound to any event. If +the widget is changed, the \fIonCallback\fP is called with the event as +\fIcall_data\fP. + +.hi + +.nf +void switch_on($, XEvent* event, String* params, Cardinal* num_params) +{ + if (! $on) { + XtVaSetValues($, "on", True, NULL); + XtCallCallbackList($, $onCallback, event); + } +} +.fi + +.eh + +.TP +.I "switch_off + +The \fIswitch_off\fP action switches the widget to `off' if the state is +`on', otherwise it does nothing. When the widget changes states, the +\fIoffCallback\fP is called, with a pointer to the \fIXEvent\fP structure as +\fIcall_data\fP argument. + +.hi + +.nf +void switch_off($, XEvent* event, String* params, Cardinal* num_params) +{ + if ($on) { + XtVaSetValues($, "on", False, NULL); + XtCallCallbackList($, $offCallback, event); + } +} +.fi + +.eh + +.hi + +.hi +.SH "Importss" + +The Converters file is needed for the \fIIcon\fP type. + +.nf + +.B incl + <Xfwf/Converters.h> +.fi + +.hi + +.hi +.SS "Private variables" + +The \fIon_gc\fP GC holds the picture of the tick mark for the `on' +state. + + + +.nf +GC on_gc +.fi + +The \fIoff_gc\fP holds the picture for the `off' state. + + + +.nf +GC off_gc +.fi + +The previous value of \fIleftMargin\fP is stored in a private variable. +This value is added to the width of the widest pixmap to give the new +value of \fIleftMargin\fP. + + + +.nf +Dimension saveLeftMargin +.fi + +.hi + +.hi +.SS "Methods" + +The GC's are created for the first time and the left margin is +increased to make room for the on and off icons. + +.nf +initialize(Widget request, $, ArgList args, Cardinal * num_args) +{ + int status; + Dimension w1, w2, w; + + $on_gc = NULL; + $off_gc = NULL; + create_on_gc($); + create_off_gc($); + + w1 = $onIcon ? $onIcon->attributes.width : 0; + w2 = $offIcon ? $offIcon->attributes.width : 0; + w = max(w1, w2); + if (w != 0) XtVaSetValues($, XtNleftMargin, $leftMargin + w, NULL); +} +.fi + +Question: Does the computation of \fIleftMargin\fP have the desired +effect? Since \fIset_values\fP is downward chained, the Label widget has +already processed it; changing \fIleftMargin\fP doesn't cause Label to +recompute the preferred size\dots + +.nf +Boolean set_values(Widget old, Widget request, $, ArgList args, Cardinal * num_args) +{ + Boolean redraw = False, compute_margin = False; + Dimension w1, w2, w; + + if ($onIcon != $old$onIcon) { + create_on_gc($); + compute_margin = True; + } + if ($offIcon != $old$offIcon) { + create_off_gc($); + compute_margin = True; + } + if ($on != $old$on) { + redraw = True; + } + if (compute_margin) { + /* Compute w = old margin between icons and text */ + w1 = $old$onIcon ? $old$onIcon->attributes.width : 0; + w2 = $old$offIcon ? $old$offIcon->attributes.width : 0; + w = $old$leftMargin - max(w1, w2); + /* Compute new left margin w = w + width of icons */ + w1 = $onIcon ? $onIcon->attributes.width : 0; + w2 = $offIcon ? $offIcon->attributes.width : 0; + w = w + max(w1, w2); + if ($old$leftMargin != w) { + XtVaSetValues($, XtNleftMargin, w, NULL); + redraw = False; + } else + redraw = True; + } + return redraw; +} +.fi + +The \fIexpose\fP method uses the \fIexpose\fP method of the superclass to draw the +button and then possibly adds a tick mark. + +.nf +expose($, XEvent * event, Region region) +{ + Position x, y; + Dimension w, h; + + if (! XtIsRealized($)) return; + #expose($, event, region); + $compute_inside($, x, y, w, h); + if ($on $onIcon) { + y = y + (h - $onIcon->attributes.height)/2; + XSetTSOrigin(XtDisplay($), $on_gc, x, y); + XSetClipOrigin(XtDisplay($), $on_gc, x, y); + XFillRectangle(XtDisplay($), XtWindow($), $on_gc, x, y, + $onIcon->attributes.width, + $onIcon->attributes.height); + } else if ($offIcon) { + y = y + (h - $offIcon->attributes.height)/2; + XSetTSOrigin(XtDisplay($), $off_gc, x, y); + XSetClipOrigin(XtDisplay($), $off_gc, x, y); + XFillRectangle(XtDisplay($), XtWindow($), $off_gc, x, y, + $offIcon->attributes.width, + $offIcon->attributes.height); + } +} +.fi + +.hi + +.hi +.SH "Utilities" + +The \fIcreate_on_gc\fP function creates a GC with the \fIonIcon\fP as tile. + +.nf +create_on_gc($) +{ + XtGCMask mask = GCFillStyle; + XGCValues values; + + if ($on_gc != NULL) XtReleaseGC($, $on_gc); + if ($onIcon $onIcon->pixmap != None) { + values.tile = $onIcon->pixmap; + mask |= GCTile; + } + if ($onIcon $onIcon->mask != None) { + values.clip_mask = $onIcon->mask; + mask |= GCClipMask; + } + values.fill_style = FillTiled; + $on_gc = XtGetGC($, mask, values); +} +.fi + +The \fIcreate_off_gc\fP function creates a GC with the \fIoffIcon\fP as tile. + +.nf +create_off_gc($) +{ + XtGCMask mask = GCFillStyle; + XGCValues values; + + if ($off_gc != NULL) XtReleaseGC($, $off_gc); + if ($offIcon $offIcon->pixmap != None) { + values.tile = $offIcon->pixmap; + mask |= GCTile; + } + if ($offIcon $offIcon->mask != None) { + values.clip_mask = $offIcon->mask; + mask |= GCClipMask; + } + values.fill_style = FillTiled; + $off_gc = XtGetGC($, mask, values); +} +.fi + +.hi |