Custom Toolbars

From Sigma Design Wiki

Jump to: navigation, search

This article explains how to create Custom Toolbars for ARRIS 9.3.

Contents

Toolbars.txt

The Toolbars.txt file contains the names of the toolbars to be loaded.

#Names of toolbar files to be loaded by ARRIS on startup
#Path unnecessary if file is located in USR:, STD:, or SYS:
#Toolbars are loaded in order shown
Desktop.tb
OpenGL.tb
View Control.tb

When windows starts it looks for this file in three locations:

  1. USR:toolbars.txt
  2. STD:toolbars.txt
  3. SYS:toolbars.txt ($ARRIS/lib)

The first one found is used, so if you create your own toolbars.txt file, you should place it in the USER folder or the Standards folder.

Toolbars

The .tb files for each toolbar are stored in a folder called Toolbars. The three standard locations, USR:Toolbars, STD:Toolbars and SYS:Toolbars are searched until the desired toolbar file is found. So you should place you new toolbars in USR:Toolbars or STD:Toolbars.

If you want to modify an existing toolbar, copy it from $ARRIS/lib/Toolbars to USR: or STD: and make the changes desired.

Format


Start of toolbar

  • toolbar;name;position
  • auto display
  • button size;24;24

Each button

  • button;filename -- Start of new button in current toolbar. Filename is required.
Filename is path/name of button image file.
  • command;command -- Sigmac command to be run when button is pressed
  • condition;par1;op;par2 -- Button will appear depressed when condition represented by par1;op;par2 is TRUE.
op can be: 'equals' (equals), 'not' (not equals), 'lt' (less than), 'gt' (greater than)
par1 & par2 can be:
a system variable e.g. #dbnam
a number e.g. 10 or 1.234
a string e.g. yes
%path% followed by path that $getnam would understand e.g. %path%usr:
%glob% followed by the name of a SIGMAC global of #int, #real, or #str type
  • button title;title -- Title of button. Appears on tooltip help.
If not supplied, button has no tooltip.
  • help;text -- Text becomes button's help text. '^' characters here are interpreted as newline.
  • prompt;text -- Text becomes prompt line when button is pressed.
  • separator -- Puts a separator after the current button.

End of toolbar

  • end toolbar

Sample

# ARRIS/BuildersCAD Windows Toolbar
# OpenGL Toolbar
# ******************************************************************************

toolbar;OpenGL;top1
   auto display
   button size;24;24

 button;undo24.png
    button title;Undo
    command;:mn_desktop;undo_redo;1
    help;Undoes the last database change.

 button;redo24.png
    button title;Redo
    command;:mn_desktop;undo_redo;2
    help;Redoes the last database change^removed with Undo.

 separator

 button;select24.png
    button title;Entity Select
    command;:mn_lyent
    help;Allows you to select an entity for query or edit.

end toolbar

# ******************************************************************************

Help Text

As you hover over a toolbar icon, help text is displayed. This is the text from button title.

If you right click on the icon, additional help is displayed. This is the text from help.

See also

Personal tools