Index Parent

SpeedBar class

The SpeedBar class is used to create image buttons bars.

SpeedBar is a subclass of SpeedBar.mcc so you must have SpeedBar.mcc in MUI:Libs/MUI to use it.

Note that SpeedBar is a group and any attribute of Group class may be used with it.

If you need the buttons to be in a Virtgroup, use SpeedBarVirt with Layout set to Left.

SpeedBar.rxmec is also an ARexx shared library.

You don't have to worry about adding SpeedBar.rxmec to the ARexx libraries list, because it is done automatically.

 

SBNotify
Adds a notification.
Synopsis
res = SBNotify(notifier,button,attr,value,target,method,parameters)
<notifier/V>,<id/N>,<attr/V>,<value>,<target/V>,<method/V>,{parms}
Function
Adds a notification from notifier, a SpeedBar object button with id button, to target triggered by attr when it changes to value invoking method on target with parms.

You may use this function only with SpeedBar objects, when you want to set up a notify triggered by a SpeedBar button.

attr may be one of:

  • Disabled
  • Pressed
  • Selected
  • ShowMe
  • Timer
Inputs
notifier - the object that notifies
id - the id of a button of the bar (0,...)
attr - the attribute that triggers the notification
value - the value of attr that causes the notification
target - the target of the notification. Specials values are:
  • _app - the application notifier belongs to
  • _win - the window notifier belongs to
  • _self - notifier itself
method - a valid an indirect method to invoke on target
parms - parameters for method 
Result
res - 0 for success or >0 for failure
The function may fail if:
[NO_OBJ] notifier or target not found
[NO_METHOD] method is not valid for target
[METHOD_NONOTIFY] method is direct-only
[BAD_NOTIFY] the notification can't be added for some reason
See
Notification

 

Bar attributes
Name Type Class Note
Active N ISGN This is the active button in a mutual exclude set of buttons. Note that if just one mutual exclude set is defined, this attribute may be used for notification of the active one; if more that one mutual exclude set is defined in the same SpeedBar, this attribute reflects the last set active button in a set of mutual exclude buttons and notifications triggered by active buttons must be set up via the attribute Selected of any single button.
BarSpacer B IS Only valid for SpeedBar.mcc V12. Before V12 it is ignored. The Spacer is a special bar.
BorderLess B ISGN It is GN only with SpeedBar.mcc V12.1
EnableUnderscore B IS Only valid for SpeedBar.mcc V12. Before V12 it is ignored. Enable underscoring of label. Note that it may be set iff it was set to 1 at Init time.
ImagesDrawer S I Path to the drawer where images are.
LabelPosition M ISGN G2N A number or one of:
  • Bottom
  • Top
  • Right
  • Left
Layout M ISGN G2N A number or one of:
  • Left
  • Center
  • Right
  • Up
  • Down
NoBrushes B G If, for any reason, the image of a button can't be read, this attribute is set to 1 and the SpeedBar falls back to Text ViewMode.
RaisingFrame B ISGN It is GN only with SpeedBar.mcc V12.1
SBSameHeight B I  
SBSameWidth B I  
SmallImages B ISGN It is GN only with SpeedBar.mcc V12.1
Spacer S I Name of a datatype picture file to use as spacer
Spread B I  
StripUnderscore B I Drops the "_" in the text of the buttons. Default is 1.
Sunny B ISGN It is GN only with SpeedBar.mcc V12.1
ViewMode M ISG G2N A number or one of:
  • TextGFX
  • GFX
  • Text

 

Buttons attributes
Name Type Class Note
Exclude N I Mutual exclude mask. Note that more than one set of mutual exclude buttons may be specified in a single SpeedBar. This attribute forces Flags to Immediate (Toggle is disabled)
Img S I Name of a datatype picture file or the string Spacer to add a space
Text S I  
Help S I  
Flags S I One of:
  • Disabled
  • Selected
  • Immediate
  • Toggle

 

Methods
Name Parameters Note
SBGet <id/N><attr>,<var/V> Reads the value of the attribute attr of the button id and writes it in var.
attrs is one of:
  • Disabled
  • Selected
  • ShowMe
SBSet <id/N><attr>,<value/N> Set the attr of the button id to value.
attrs is one of:
  • Disabled
  • Selected
  • ShowMe

 

Example

    SpeedBar.SameSize=1
    SpeedBar.Horiz=1
    SpeedBar.RaisingFrame=0
    SpeedBar.Borderless=0
    SpeedBar.ImagesDrawer="Pics"
    SpeedBar.Spacer="Spacer"
    SpeedBar.StripUnderscore=1  /* Both so that if under V12, we don't */
    SpeedBar.EnableUnderscore=1 /* display trash                       */
     SpeedBar.0.Img="back.iff"
     SpeedBar.0.Text="Back"
     SpeedBar.1.Img="forward.iff"
     SpeedBar.1.Text="Forward"
     SpeedBar.2.Img="reload.iff"
     SpeedBar.2.Text="Reload"
     SpeedBar.2.Flags="Immediate"
     SpeedBar.3.Img="stop.iff"
     SpeedBar.3.Text="Stop"
     SpeedBar.4.Img="SPACER"
     SpeedBar.5.Img="home.iff"
     SpeedBar.5.Text="Home"
     SpeedBar.5.Flags="Immediate Selected"
     SpeedBar.5.Exclude=2**6
     SpeedBar.6.Img="find.iff"
     SpeedBar.6.Text="Find"
     SpeedBar.6.Flags="Immediate"
     SpeedBar.6.Exclude=2**5