Introduction

Sun WorkShop Visual has its own set of application resource settings. This appendix briefly describes the resources you are most likely to change to suit your personal preference. They can be altered in or appended to any application resource file, according to the configuration of your system. For example, you might only want to change the Sun WorkShop Visual application resource file, which is:

$VISUROOT/lib/locale/<YourLocale>/app-defaults/visu

or

$VISUROOT/lib/locale/<YourLocale>/app--defaults/CDE/visu

for the CDE window manager.

$VISUROOT is the path to the root of the Sun WorkShop Visual installation directory. The locale directory, named "YourLocale" above, defaults to "C". If you are using a different locale, however, the directory used will have the same name as the locale you are using. See "Locale" on page 620 for more details on locales. See Appendix  E, "Further Reading", starting on page 889, for some suggestions on books on the X Window System.

You may also add any of the Sun WorkShop Visual resource settings to the .Xdefaults file in your home directory. If you do not yet have one of these, you can create one. It can contain resource information, in the format described in this chapter, for any X Windows application. See your X Window System documentation for more details.

In this section, the resource names appear in bold type and the default values in italic. To turn these into a resource file setting, simply add a line to the appropriate resource file. For example, in the following line:

visu.autoSave: true

autoSave is the name of the resource and true is the setting.

The visu resource file contains many resources that are not mentioned here. Most of these only need to be changed if you are working in a language other than English or have some other special requirements. For information on resources not documented in this appendix, see the comments in the visu resource file.

A resource can have different settings for the large and small-screen versions of Sun WorkShop Visual. Use the application class name visu for the large-screen version and small_visu for the small-screen version. Resources set under the name visu also apply to small_visu, unless there is a specific setting under the name small_visu.

Refer to Chapter 25, "Configuration", starting on page 705, for information on customizing the Sun WorkShop Visual interface using some resources not covered in this chapter.

General

The font in which widget names are displayed. Default for visu:
-*-helvetica-medium-r-normal--12-*-*-*-*-*-*-*
Default for small_visu:
-*-helvetica-medium-r-normal--10-*-*-*-*-*-*-*

labelFontList

The font in which labels are displayed in dialogs, menus etc. Default for visu:
-*-helvetica-medium-r-normal--12-*-*-*-*-*-*-*
Default for small_visu:
-*-helvetica-medium-r-normal--10-*-*-*-*-*-*-*

buttonFontList

The font in which button labels are displayed in dialogs, menus etc. Default for visu:
-*-helvetica-medium-r-normal--12-*-*-*-*-*-*-*
Default for small_visu:
-*-helvetica-medium-r-normal--10-*-*-*-*-*-*-*

textFontList

The font in which text is displayed in text boxes, list etc. Default for visu:
-*-helvetica-medium-r-normal--12-*-*-*-*-*-*-*
Default for small_visu:
-*-helvetica-medium-r-normal--10-*-*-*-*-*-*-*

warnOnClose

Causes Sun WorkShop Visual to warn you if you try to close a dialog with outstanding changes. Default: true.

warnOnSelect

Causes Sun WorkShop Visual to warn you if you try to select a different widget with outstanding changes on the currently selected widget. Default: true.

dialogsTopLevel

Causes Sun WorkShop Visual to create Top Level Shells rather than Dialog Shells for the dynamic display. This alters the way that the dialogs are iconised and their stacking properties. It does not, however, affect the final application. Default: false.

visu*dialogs.transient:false produces a similar effect.

smallScreen

Makes Sun WorkShop Visual use the small icons. Default: false for visu, true for small_visu.

intrinsicsHeadersPrefix

The prefix of the X intrinsics header file names. An important resource that depends on where X is installed on your system. Default: X11.

definitionsFileName

The file containing the specifications for the definitions which you have configured onto the palette. The value of this resource is expanded by /bin/sh and so can contain environment variables, etc. Default: $HOME/.xddefinitionsrc.

Callback and Prelude Editing

This resource controls whether callback editing is enabled; if it is set to false then the buttons relating to this feature do not appear. Default: true.

editor

This resource specifies the location of the executable program which is used for editing files. Default:

$BINARYROOT/lib/scripts/xd_edit

sunEditService

This is a boolean resource which determines whether Sun WorkShop Visual uses the Sun Edit Server or not. If not, use the "editor" resource described above. Default: True

sunEditServerPath

This specifies the path of the eserve binary, including the binary name. It defaults to NULL if not defined in the resource file, which has the same effect as setting sunEditService to false.

Microsoft Windows

If this resource is set, Sun WorkShop Visual will run in Microsoft Windows Mode. See the Cross Platform Development chapter for further details. Default false.

mfcTextWarningBackground

The color used to indicate that a resource is not used in Microsoft Windows flavor code.

mfcCarriageReturn

If this resource is set Sun WorkShop Visual will generate carriage return characters as well as newline characters in files generated for Microsoft Windows. Default true.

Filters

Object file suffix used in generated Makefiles. Default: .o.

executableFileSuffix

Executable file suffix used in generated Makefiles. Default: empty string.

uidFileSuffix

uid file suffix used in generated Makefiles. Default: .uid.

Generate Dialog

The Generate dialog is primed with default names for the files to be generated. The defaults used can be changed, as detailed below.

cCodeSuffix

The default suffix for the code file when generating C. Default ".c"

cppCodeSuffix

The default suffix for the code file when generating C++. Default ".cpp"

cStubsCodeSuffix

The default suffix for the stubs file when generating C. Default ".c"

cppStubsCodeSuffix

The default suffix for the stubs file when generating C++. Default ".cpp"

cExternsCodeSuffix

The default suffix for the externs file when generating C. Default ".h"

cppExternsCodeSuffix

The default suffix for the externs file when generating C++. Default ".h"

uilExternsCodeSuffix

The default suffix for the externs file when generating UIL. Default ".h"

uilCodeSuffix

The default suffix for the code file when generating UIL. Default ".uil"

cUilCodeSuffix

The default suffix for the code file when generating C for UIL. Default ".c"

cPixmapsCodeSuffix

The default suffix for the pixmaps file when generating C. Default ".h"

cppPixmapsCodeSuffix

The default suffix for the pixmaps file when generating C++. Default ".h"

uilPixmapsCodeSuffix

The default suffix for the pixmaps file when generating UIL. Default ".h"

xResourcesCodeSuffix

The default suffix for the X resources file. Default ".res"

windowsResourcesCodeSuffix

The default suffix for the Microsoft Windows resource file. Default ".rc"

backupCodeSuffix

The default suffix for the backup file used for incremental stubs file generation. Default ".bak"

defaultCodeFileName

The default base name for all files to be generated, except the makefile. If the design has been saved, the save filename is used instead. Default "untitled".

makefileCodeFileName

The default name of the makefile. Default "Makefile".

---

Note - You can construct your own resource name for filenames based on a language tag and the word "CodeFileName". For example: "cCodeFileName" means the code file name for C code generation.

---

cUilCodeExtension

The extension added to the code filename when generating C for UIL. Default "_uil".

cStubsCodeExtension

The extension added to the stubs filename when generating C. Default "_stubs".

cppStubsCodeExtension

The extension added to the stubs filename when generating C++. Default "_stubs".

cPixmapsCodeExtension

The extension added to the pixmaps filename when generating C. Default "_pixmaps".

cppPixmapsCodeExtension

The extension added to the pixmaps filename when generating C++. Default "_pixmaps".

uilPixmapsCodeExtension

The extension added to the pixmaps filename when generating UIL. Default "_pixmaps".

Generation

Defines the default Makefile. For details, see the Configuration chapter.

motifMakeTemplateFile

Points to the default makefile template for Motif flavor. Default: $VISUROOT/make_templates/motif.

mmfcMakeTemplateFile

Points to the default makefile template for Motif XP flavor. Default: $VISUROOT/make_templates/mfc.

javaWidgetsLib and javaWidgetsInclude

Placed in the link/compile lines in generated Makefiles to point to the libjavawidgets.a library and associated include files. Default values are $VISUROOT/src/java_widgets/lib/libjavawidgets.a and ---I$VISUROOT/src/java_widgets/h respectively.

c++BaseClassHeader

Header file for C++ that contains the base class definitions. Include quotes ("") or angle brackets (<>) as required; defaults to angle brackets. To disable, set it to an empty string. Default: xdclass.h.

xpmHeader

Header file for definitions required by XPM library. Include quotes ("") or angle brackets (<>) as required; defaults to angle brackets. Default: <xpm.h>.

generateXFuncCLinkage

Causes Sun WorkShop Visual to generate _XFUNCPROTOBEGIN and _XFUNCPROTOEND macros around the help link externs. Default: true.

generateRedefineDefaultWidgetName

In C++ base class declarations, Sun WorkShop Visual generates the default value for the widget name parameter to the create() member function: widget_name = NULL. In derived classes this should not be necessary as derived classes inherit such default parameter values from their base classes. However, many compilers require it if the create() function is called without a widget_name parameter. Sun WorkShop Visual will never generate such code, but you may have existing source where this is the case. Default: true.

Comments in Generated Code

Text put in as part of the guard comments in generated Java code. This text is only used for readability purposes. Default:

Sun WorkShop Visual-generated code - do not edit >>>

and

<<< Sun WorkShop Visual-generated code ends.

respectively.

Help

The key to invoke the help callback. Default: <Key>F1. If your keyboard has a Help key, try <Key>Help.

helpDir

The search path to use when looking for help files. The search path is a colon-separated list. Sun WorkShop Visual looks in these directories for the file named entry.html, which is the starting point for links to other help files. If you are using text help for user-defined widgets or definitions, Sun WorkShop Visual looks in this directory for a local subdirectory. Default: $VISUROOT/lib/locale/<YourLocale>/help (where $VISUROOT is the path to the root of the Sun WorkShop Visual installation directory).

userHelpCatString

Separator string used to build help file names for user-defined widgets and definitions. Default: "."

Text file help for user-defined widgets is defined by file and tag pairs. The file and tag are concatenated to produce a filename relative to helpDir/local. The value of userHelpCatString is used as a separator between document and tag when creating the string. For example, if userHelpCatString is "." the help file is document.tag. An alternative setting would be "/" to produce document/tag. The help file is assumed to be in HTML format.

Auto Save

Activates the auto save facility. Default: true (active).

autoSaveThreshold

The number of changes made before an auto save occurs. Default: 20.

autoSaveExt

The extension to the filename added by auto save. Default: .sav. For example, fred.xd becomes fred.xd.sav.

Layout Editor

The following resources control colors in the Layout Editor:

formFillColor

The background color of the Layout Editor. Default: #dededededede.

formStrokeColor

The color used to outline the Form in the Layout Editor. Default: Black.

widgetFillColor

The color used to fill the boxes representing the widgets in the Layout Editor. Default: Blue.

widgetStrokeColor

The color used to outline the widgets. Default: Black.

widgetDestinationColor

The color used to denote the last selected widget when doing align and distribute operations. This is the reference widget for the operation. Default: #9a9ae1163232.

widgetSelectColor

The color used to denote selected widgets when doing align and distribute operations. These are the widgets that will be moved by the operation. Default: #ecc9c9eacdda.

attachmentColor

The color used for the lines representing attachments in the Layout Editor. Default: Black.

Hierarchy Colors

The following resources are used when drawing widgets in the design hierarchy:

widgetForeground

The foreground color of bitmap-type widget icons. Default: Black. This refers to the color in which the pixmap or icon is drawn. For bitmap icons, it must contrast with the widgetBackground resource. It is unused for color pixmap icons.

widgetBackground

The background color of the widget icon. This color shows through the sections of color pixmaps that are set to color none. Default: #fdfdf5f5ebeb.

highlightForeground

The foreground color used for drawing bitmap-type icons when the widget is highlighted. For bitmap icons, it must contrast with the highlightBackground resource. It is unused for color pixmap icons. Default: #fdfdf5f5ebeb.

If you have a monochrome display, the default setting may cause some icons to show as all black. In this case set it to the same value as widgetBackground.

highlightBackground

The background color used when the widget is highlighted. For bitmap icons, it must contrast with the highlightBackground resource. Default: Red. This color shows through sections of color pixmaps that are set to color none.

If you have a monochrome display, the default setting may cause some icons to show as all black. In this case set it to the same value as widgetForeground.

Structure Colors

The following resources control the colors that indicate widgets that are designated as structures or C++ classes. They are effective only when the "Structure colors" toggle is set:

widgetFunctionBackground

Background color for widgets designated as function structures. Default: #ecc9c9eacdda.

widgetStructBackground

Background color for widgets designated as data structures. Default: #9a9ae1163232.

widgetClassBackground

Background color for widgets designated as C++ classes. Default: #d2dfe785f3ce.

widgetChildrenBackground

Background color for widgets designated as Children only. Default: #d8c0d2d1f3f2.

Background for Definitions and Instances

The following resources control displays of definitions and instances:

widgetInstanceBackground

The background color in the tree for instances. Default: #ecc0ecc086db.

widgetDefinitionBackground

The background color in the tree for definitions. Default: .#86dbecc0ecc0

widgetInstanceBitmap

On monochrome displays only, this is the background bitmap in the tree for hierarchies that are instances. Default: 25_foreground.

widgetDefinitionBitmap

On monochrome displays only, this is the background bitmap in the tree for hierarchies that are definitions. Default: 25_foreground.

Work-arounds

Works around problems on some servers which have difficulty displaying the tree icons. Default: false.

alternateFolding

Works around problem on some servers which cannot do the stippling for folding. Draws folded icons with a cross through them. Default: false.

xorByInvert

In order that color map cells are not used up needlessly, Sun WorkShop Visual simply does XOR drawing using whatever happens to be in the color map. This will sometimes cause interactive drawing to be invisible. You can change the mechanism to use INVERT rather than XOR which may produce different results. Default: false.

freeStaticColors

Some servers do not allow the application to free colors cells in a static color map (more typically they simply ignore the request). Set this resource to false if you have a display with a default visual type of static (typically a VGA type screen), and your Sun WorkShop Visual is crashing with an X error when it tries to free a color. Default: true.

closeColourMatching

If your server is taking an unacceptably long time to load the main Sun WorkShop Visual window, setting this resource to false will prevent lengthy searches for close color matches when colors cannot be found. This would mean, however, that the pixmaps in Sun WorkShop Visual may look strange. Default: true.

FrameMaker

These resources are used to specify parameters used when using FrameMaker to develop help for your application.

frameMakerBinary

The binary that is executed to display FrameMaker help files. Default: viewer.

frameMakerTimeout

Number of seconds to wait for FrameMaker to start up before Sun WorkShop Visual attempts to talk to it. Default: 20.

Configuration

See Chapter 25, "Configuration", starting on page 705 for details on configuring the palette and toolbar.

stopList

A comma separated list of widgets that are not to be on the palette. The complete list for the Motif widgets is:

XmDialogShell, XmMainWindow, XmMenuBar, XmPulldownMenu, XmRadioBox, 
XmRowColumn, XmFrame, XmDrawingArea, XmBulletinBoard, XmForm, 
XmPanedWindow, XmScrolledWindow, XmMessageBox, XmMessageTemplate, 
XmCommand, XmSelectionPrompt, XmSelectionBox, XmFileSelectionBox, 
XmLabel, XmPushButton, XmToggleButton, XmDrawnButton, XmArrowButton, 
XmCascadeButton, XmOptionMenu, XmSeparator, XmScale, XmScrollBar, 
XmTextField, XmText, XmScrolledText, XmList, XmScrolledList

Use class names for user-defined widgets, e.g:

boxWidgetClass, formWidgetClass

Default: empty.

pm_icons, pm_labels, pm_both

These are the three toggle buttons in the Palette Layout menu. Set one of them for the default layout. Default: visu*pm_icons.set:true