HP OpenVMS Systems Documentation

Removes a component from each SVN entry.

Format

void DXmSvnRemoveComponent(widget, comp_number)
      Widget  widget;
      int     comp_number;

Arguments

widget

The identifier (widget ID) of the SVN widget.

comp_number

An integer that represents the component number to be removed.

Description

The DXmSvnRemoveComponent routine removes a new component for any entry currently recognized by the SVN widget. All entries that are currently valid continue to be valid after the component is removed.

Note the following:

• A warning message is generated if an attempt is made to remove a component that is not within the range of the number of components in the entry (for example, you cannot remove component 3 if there are only 2 components in the entry).
• During the remove operation, the corresponding tag and width values for the component being removed are deleted from the widget's component width and tag arrays. Those values are discarded and cannot be retrieved.

Selects all entries.

Format

void DXmSvnSelectAll(widget)
      Widget  widget;

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnSelectAll routine allows the application to designate all entries in the structure as selected (they are displayed using reverse video) using a command from the application's menu. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

Selects an entry using a specific component.

Format

void DXmSvnSelectComponent(widget, entry, comp_number)
      Widget  widget;
      int     entry;
      int     comp_number;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the entry to select.

comp_number

An integer that represents the component to select.

Description

The DXmSvnSelectComponent routine designates a specified entry as selected. It differs from the DXmSvnSelectEntry routine because it associates a specific component with the selection. If the entry is already selected with this component, this call has no effect. Use this routine when different selection modes are being used and make the call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

Selects a specified entry.

Format

void DXmSvnSelectEntry(widget, entry)
      Widget  widget;
      int     entry;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the entry to select.

Description

The DXmSvnSelectEntry routine designates a particular entry as selected. If the entry is already selected, this call is ignored. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

Turns application dragging mode on or off in the SVN widget.

Format

void DXmSvnSetApplDragging(widget, on_off)
      Widget  widget;
      int     on_off;

Arguments

widget

The identifier (widget ID) of the SVN widget.

on_off

An integer that sets the application dragging mode to be either on (1) or off (0).

Description

The DXmSvnSetApplDragging routine either turns application dragging mode on or off. When application dragging mode is on (on_off is set to 1), the application controls dragging operations by calling the DXmSvnCRDragging callback (when the user presses MB2 and drags the mouse downward) and the DXmSvnCRDraggingEnd callback (when the dragging operation is completed).

When application dragging mode is off (on_off is set to 0), the SVN widget controls MB2 dragging operations with DXmSvnNselectionsDraggedCallback.

Controls which modes the SVN widget uses to display a particular component.

Format

void DXmSvnSetComponentHidden(widget, entry, comp_number, mode)
      Widget  widget;
      int     entry;
      int     comp_number;
      int     mode;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry for which information is to be set or changed.

comp_number

An integer that represents the number of the component for which information is to be set or changed. This cannot be a component of the type Widget.

mode

The display mode in which this component should not be displayed, indicated by one of the following values:

Value	Description
DXmSvnKdisplayNone	Display in all modes (hidden in none)
DXmSvnKdisplayOutline	Do not display in outline mode
DXmSvnKdisplayTree	Do not display in tree mode
DXmSvnKdisplayAllModes	Do not display in outline, tree, or column mode
DXmSvnKdisplayColumns	Do not display in column mode

Description

The DXmSvnSetComponentHidden routine enables an application to prevent a component (excluding subwidgets) from being displayed in a particular mode, thus making that component "hidden." By default, components are visible in all modes. However, you can use this routine to prevent a component from displaying in one mode (outline, tree, or column) or all modes.

Using this routine can reduce the amount of information displayed when the application is in tree mode, making the application less complex and easier to use. This routine is also useful if you want your application to display different icons in each of the two modes.

Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

Adds a pixmap component to an entry.

Format

void DXmSvnSetComponentPixmap(widget, entry, comp_number, x, y,
                              pixmap, width, height)
      Widget  widget;
      int     entry;
      int     comp_number;
      int     x;
      int     y;
      Pixmap  pixmap;
      int     width;
      int     height;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry that this component belongs to.

comp_number

An integer that represents the component number within the entry.

x

An integer that represents the x offset within the entry where this component should be placed.

y

An integer that represents the y offset within the entry where this component should be placed. (Note that if you want the SVN widget to automatically create a layout of the entry for you, set the value of this argument to 0.)

pixmap

The Pixmap value.

width

An integer that represents the width specified when the pixmap was created.

height

An integer that represents the height specified when the pixmap was created.

Description

The DXmSvnSetComponentPixmap routine sets a component of an entry to be a pixmap. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay. If your application passes 0 for the value of the y offset, the SVN widget will automatically create a layout of the entry.

Sets the tag of a component.

Format

void DXmSvnSetComponentTag(widget, comp_number, tag)
      Widget           widget;
      int              comp_number;
      XtPointer        tag;

Arguments

widget

The identifier (widget ID) of the SVN widget.

comp_number

An integer that represents the component number.

tag

A value that represents the entry tag.

Description

The DXmSvnSetComponentTag routine sets the widget level component tag data. (The SVN widget never examines this tag.) This tag may be lost if the corresponding component is removed with the DXmSvnRemoveComponent routine.

Use the DXmSvnGetComponentTag routine to retrieve the current value of the tag; use the DXmSvnGetComponentNumber routine to return the component number associated with the supplied tag.

Adds a read-only component string to an entry.

Format

void DXmSvnSetComponentText(widget, entry, comp_number,
                            x, y, text, font)
      Widget       widget;
      int          entry;
      int          comp_number;
      int          x;
      int          y;
      XmString     text;
      XmFontList   font;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry that this component belongs to.

comp_number

An integer that represents the component number within the entry.

x

An integer that specifies the x position of the component within the entry.

y

An integer that specifies the y position of the component within the entry. (Note that if you want the SVN widget to automatically create a layout of the entry for you, set the value of this argument to 0.)

text

A compound string.

font

A valid XmFontList.

Description

The DXmSvnSetComponentText routine sets a component of an entry to be a read-only compound string. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay. If your application passes 0 for the value of the y offset, the SVN widget will automatically create a layout of the entry.

Adds an SVN subwidget component to an entry.

Format

void DXmSvnSetComponentWidget(widget, entry, comp_number, x, y, subw)
      Widget  widget;
      int     entry;
      int     comp_number;
      int     x;
      int     y;
      Widget  subw;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the entry number that this component belongs to.

comp_number

An integer that represents the component number within the entry.

x

An integer that represents the x offset within the entry where this component should be placed.

y

An integer that represents the y offset within the entry where this component should be placed. (Note that if you want the SVN widget to automatically create a layout of the entry for you, set the value of this argument to 0.)

subw

The identifier (widget ID) of the subwidget. This subwidget will be a managed child of the SVN widget.

Description

The DXmSvnSetComponentWidget routine sets a component of an entry to be a subwidget, which enables an application to put read-write text or a push button in an entry. The application is responsible for creating this subwidget and destroying it when the entry is deleted. If your application passes 0 for the value of the y offset, the SVN widget will automatically create a layout of the entry.

Sets the width of a component.

Format

void DXmSvnSetComponentWidth(widget, comp_number, width)
      Widget     widget;
      int        comp_number;
      Dimension  width;

Arguments

widget

The identifier (widget ID) of the SVN widget.

comp_number

An integer that represents the component number.

width

The width to set.

Return Value

An integer that represents the width of the component.

Description

The DXmSvnSetComponentWidth routine sets the widget level component width data. This width is used only when the widget is displaying in column mode. If a component found in this column is larger than the value currently set, the component width is automatically adjusted (which makes setting the component width optional).

New components inserted with the DXmSvnInsertComponent routine may include the component width as an argument to that routine.

Provides the SVN widget with new entry level information.

Format

void DXmSvnSetEntry(widget, entry, width, height, number, sens,
                     tag, index)

      Widget        widget;
      int           entry;
      int           width;
      int           height;
      int           number;
      Boolean       sens;
      unsigned int  tag;
      Boolean       index;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry for which information will be set or changed.

width

An integer that represents the width of the entry. This value is used to allocate sufficient display space for the entry. If 0 is specified, the SVN widget will calculate the width based on the components and font.

height

An integer that represents the height of the entry. This value is used to allocate sufficient display space for the entry. If 0 is specified, the SVN widget will calculate the height based on the components and font.

number

An integer that represents the number of components in this entry.

sens

A Boolean value that, when True, makes this entry sensitive (the user can select it). When False, the display for that entry will be dimmed to indicate that the entry is not sensitive (the user cannot select it).

tag

The value that the application will associate with the entry. This value is returned in all callbacks that set the entry_number field in the DXmSvnCallback structure.

index

A Boolean value that, when True, indicates that all of the entries being added should be displayed in the scroll index window when the user drags the slider. Note that if you set this argument to True, the DXmNliveScrolling resource must be set to False.

Description

The DXmSvnSetEntry routine enables an application to respond to a DXmSvnCRGetEntry callback requesting the information for an entry. You can specify a subset of the information allowed on this call by using the following routines:

• DXmSvnSetEntryNumComponents
• DXmSvnSetEntryTag
• DXmSvnSetEntryIndexWindow
• DXmSvnSetEntrySensitivity
• DXmSvnSetEntry

Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay. After making a call to this routine, your application should call the DXmSvnSetComponentText, DXmSvnSetComponentPixmap, and DXmSvnSetComponentWidget routines to individually supply the component information.

Note that if your application calls the DXmSvnSetEntry routine to modify an existing entry and the number of entries changes, all previous component information is discarded.

Controls whether the SVN widget displays the entry in the index window.

Format

void DXmSvnSetEntryIndexWindow(widget, entry, index)
      Widget   widget;
      int      entry;
      Boolean  index;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry for which information will be set or changed.

index

A Boolean value that, when True, indicates that all of the entries being added will be displayed either in the scroll index window when the user drags the slider (in outline or column mode) or in the Navigation Window (in tree mode).

If you set this argument to True, the DXmNliveScrolling resource must be set to False. Note as well that if the display mode is DXmSvnKdisplayTree and you have set the DXmSvnNTreeIndexAll resource to True, this specification will be overridden.

Description

The DXmSvnSetEntryIndexWindow routine enables an application to respond to a DXmSvnCRGetEntry callback requesting the information for an entry. It provides some of the functions of the DXmSvnSetEntry routine, but only requires a subset of the information.

Provides the SVN widget with the number of components for an entry.

Format

void DXmSvnSetEntryNumComponents(widget, entry, number)
      Widget  widget;
      int     entry;
      int     number;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry for which information will be set or changed.

number

An integer that represents the number of components that make up this entry.

Description

The DXmSvnSetEntryNumComponents routine enables an application to respond to a DXmSvnCRGetEntry callback requesting information for an entry. It provides some of the functions of the DXmSvnSetEntry routine, but requires only a subset of the information.

Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay. After making a call to this routine, the application should call the DXmSvnSetComponentText, DXmSvnSetComponentPixmap, and DXmSvnSetComponentWidget routines to individually supply component information.

Note that if the number of entries changes, all previous component information is discarded.

Sets the position of an entry in user-defined tree mode.

Format

void DXmSvnSetEntryPosition(widget, entry, mode, x, y)
      Widget   widget;
      int      entry;
      Boolean  mode;
      int      x;
      int      y;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry for which information will be set or changed.

mode

A Boolean value that, when True, specifies that position information returned should be interpreted relative to the upper left corner of the SVN window. When False, the position information returned should be interpreted relative internally to the SVN widget.

x

An integer that represents the x position of the entry. If the value for mode is True, the value for x represents the distance from the corner of the SVN window in pixels. If the value for mode is False, the value for x represents the position in the entire tree, even though that position extends beyond the limit of what can currently be displayed in the SVN window.

y

An integer that represents the y position of the entry. If the value for mode is True, the value for y represents the distance from the corner of the SVN window in pixels. If the value for mode is False, the value for y represents the position in the entire tree, even though that position extends beyond the limit of what can currently be displayed in the SVN window.

Description

The DXmSvnSetEntryPosition routine allows an application to implement the layout of the tree when the tree style is DXmSvnKuserDefinedTree. The application can explicitly position an entry, whether that entry is currently visible in the display or not. This call is valid only if the display mode is set to DXmSvnKdisplayTree and the tree style to DXmSvnKuserDefinedTree. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.