Document revision date: 10 November 2000

Retrieves (returns) the sensitivity of an entry in the display.

Format

int DXmSvnGetEntrySensitivity(widget, entry) Widget widget; int entry;

Return Value

An integer that represents the entry sensitivity value, as follows:

Value	Description
0	The entry is not sensitive (the user cannot select it).
1	The entry is sensitive (the user can select it).

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the entry number.

Description

The DXmSvnGetEntrySensitivity routine returns the sensitivity state (which indicates whether the user can select an entry) whenever the application requires that information for a given entry.

Retrieves (returns) an entry's tag for a specified entry number.

Format

XtPointer DXmSvnGetEntryTag(widget, entry) Widget widget; int entry;

Return Value

Represents the entry tag.

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the entry number.

Description

The DXmSvnGetEntryTag routine retrieves an entry tag value for a specified entry number. The routine returns a value of 0 if the entry tag value has never been specified for the given entry number in a call to either the DXmSvnAddEntries or DXmSvnSetEntry routine.

Retrieves (returns) a list of entries currently highlighted by the user.

Format

void DXmSvnGetHighlighted(widget, entries, tags, len) Widget widget; int *entries[]; unsigned int tags[]; int len;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entries

A pointer to an array of integers to receive the highlighted entry numbers.

tags

A pointer to an array of longwords to receive the application's entry_tag value for each highlighted entry. If tags are not required, a null pointer may be passed.

len

An integer that represents the number of entries allocated in the provided array.

Description

The DXmSvnGetHighlighted routine returns a list of entries that are currently highlighted by the user. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay to ensure that the highlighted list is not changing.

The application is responsible for managing the memory used to return this list of highlighted entries. As such, note the following:

• At the minimum, the number of entries in the array should be capable of holding the number of entries indicated by the value returned from the DXmSvnGetNumHighlighted routine.
• If there are more entries in the array than the application will need, the SVN widget will set the value for those extra entries to 0.
• If the capacity of the arrays passed is less than the number of selected entries, only the number of entries allocated in the provided array (the value for len) will be returned.

Retrieves (returns) the number of entries currently being displayed in the window.

Format

int DXmSvnGetNumDisplayed(widget) Widget widget;

Return Value

An integer that represents the number of entries currently being displayed.

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnGetNumDisplayed routine returns the number of entries currently being displayed in the SVN window. Use this routine to determine the number of entries required in the arrays being passed to the DXmSvnGetDisplayed routine.

Note that this routine is not supported in tree mode (it will return a value of 0).

Retrieves (returns) the number of highlighted entries.

Format

int DXmSvnGetNumHighlighted(widget) Widget widget;

Return Value

An integer that represents the number of highlighted entries.

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnGetNumHighlighted routine returns the number of entries currently highlighted by the user. Use this routine to determine the number of entries required in the array being passed to the DXmSvnGetHighlighted routine. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay to ensure that the highlighted list is not changing.

Retrieves (returns) the number of selected entries.

Format

int DXmSvnGetNumSelections(widget) Widget widget;

Return Value

An integer that represents the number of selected entries.

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnGetNumSelections routine returns the number of entries currently selected by the user. Use this routine to determine the number of entries required in the array being passed to the DXmSvnGetSelections routine. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay to ensure that the selected list is not changing.

Retrieves (returns) the identifier (widget ID) of the primary SVN work widget.

Format

Widget DXmSvnGetPrimaryWorkWidget(widget) Widget widget;

Return Value

The identifier (widget ID) of the primary SVN work widget.

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnGetPrimaryWorkWidget routine is a read-only routine that returns the identifier (widget ID) of the primary work widget (window).

Retrieves (returns) the identifier (widget ID) of the secondary SVN work widget.

Format

Widget DXmSvnGetSecondaryWorkWidget(widget) Widget widget;

Return Value

The identifier (widget ID) of the secondary SVN work widget.

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnGetSecondaryWorkWidget routine is a read-only routine that returns the identifier (widget ID) of the secondary work widget (window).

Retrieves (returns) a list of selected entry numbers.

Format

void DXmSvnGetSelections(widget, entries, comps, tags, len) Widget widget; int *entries[]; int *comps[]; unsigned int *tags[]; int len;

Arguments

widget

The identifier (widget ID) of the SVN widget.

entries

A pointer to an array of integers to receive the selected entry numbers.

comps

A pointer to an array of integers to receive the component numbers on which the entry was selected. A component number of 0 means that the entry was selected using range selection and not by directly clicking on the entry. If components are not needed, a Null pointer may be passed.

tags

A pointer to an array of longwords to receive the application tag value for each entry selected. If tags are not needed, a Null pointer may be passed.

len

An integer that represents the number of entries allocated in the provided array.

Description

The DXmSvnGetSelections routine returns a list of entries that are currently selected by the user. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay to ensure that the selected list is not changing.

The application is responsible for managing the memory used to return this list of highlighted entries. As such, note the following:

• At the minimum, the number of entries in the array should be capable of holding the number of entries indicated by the value returned from the DXmSvnGetNumHighlighted routine.
• If there are more entries in the array than the application will need, the SVN widget will set the value for those extra entries to 0.
• If the capacity of the arrays passed is less than the number of selected entries, only the number of entries allocated in the provided array (the value for len) will be returned.

Retrieves (returns) the position of the display window for future use.

Format

void DXmSvnGetTreePosition(widget, x, y) Widget widget; int *x; int *y;

Arguments

widget

The identifier (widget ID) of the SVN widget.

x

A pointer to the x position in the tree.

y

A pointer to the y position in the tree.

Description

The DXmSvnGetTreePosition routine obtains the upper left coordinate position of the display window that is within the virtual display. It thus provides a way for applications to determine the exact position of the display window so that window can be restored at a later time (using the DXmSvnSetTreePosition routine).

The application can call this routine only when the DXmSvnNdisplayMode resource is set to DXmSvnKdisplayTree. Note as well that the x- and y-coordinates returned are only meaningful internally to the SVN widget (they are used by the DXmSvnSetTreePosition routine when the SVN widget restores the display window to its original position).

Specifies that the SVN widget show highlighted entries in the default format, without using highlighting graphics.

Format

void DXmSvnHideHighlighting(widget) Widget widget;

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnHideHighlighting routine specifies that the SVN widget show highlighted entries in the default format, without drawing highlighting graphics around those entries. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay to ensure that the highlighted list is not changing.

To draw highlight graphics around highlighted entries, use the DXmSvnShowHighlighting routine.

Specifies that the SVN widget show selected entries in the default format, without drawing selection graphics on those entries.

Format

void DXmSvnHideSelections(widget) Widget widget;

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnHideSelections routine specifies that the SVN widget show selected entries in the default format (reverse video in outline mode), without drawing selection graphics on the entries even if the entries are selected. Use this routine if you want to hide selections when the application loses ownership of the global selection. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

To redraw entries with selection graphics, use the DXmSvnShowSelections routine.

Highlights all entries.

Format

void DXmSvnHighlightAll(widget) Widget widget;

Arguments

widget

The identifier (widget ID) of the SVN widget.

Description

The DXmSvnHighlightAll routine allows an application to highlight all entries in the structure using a command from the application's menu. The entries are displayed in a rectangular box (drawn with dashes). Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

Highlights a specified entry.

Format

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

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry to be highlighted.

Description

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

Inserts a new component into each SVN entry.

Format

void DXmSvnInsertComponent(widget, comp_number, width, tag) Widget widget; int comp_number; Dimension width; unsigned int tag;

Arguments

widget

The identifier (widget ID) of the SVN widget.

comp_number

An integer that represents the component number to insert.

width

The width of the component. This value will be inserted into the widget's component width array. You can set or examine this value by using the DXmSvnSetComponentWidth and DXmSvnGetComponentWidth routines.

tag

The tag for the component. This value will be inserted into the widget's component tag array. You can set or examine this value by using the DXmSvnSetComponentTag and DXmSvnGetComponentTag routines.

Description

The DXmSvnInsertComponent routine inserts a new component for each entry currently recognized by the SVN widget. All entries that are currently valid become invalid during this operation.

Note the following:

• A warning message is generated if an attempt is made to insert a component that is not the next in the sequence of components in the entry (for example, you cannot add component 5 if there are only 3 components in the entry; you must add component 4).
• An entry can hold a maximum of 30 components.

Specifies that the SVN widget redisplay (update) an entry.

Format

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

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the entry number to invalidate.

Description

The DXmSvnInvalidateEntry routine allows an application to modify an underlying entry (for example, changing the text or highlighting) by directing the SVN widget to issue the DXmSvnNgetEntryCallback to obtain new information about the specified entry.

Note that if an entry is selected prior to a call to the DXmSvnInvalidateEntry routine, that entry will remain selected after the entry is redisplayed. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay.

Associates the x and y position with an entry number.

Format

void DXmSvnMapPosition(widget, x, y, entry, comp_number, tag) Widget widget; int x; int y; int *entry; int *comp_number; unsigned int *tag;

Arguments

widget

The identifier (widget ID) of the SVN widget.

x

An integer that represents the x position within the widget's window where the mouse button was pressed or released.

y

An integer that represents the y position within the widget's window where the mouse button was pressed or released.

entry

A pointer to the entry number.

comp_number

A pointer to the component number within the entry. If the component number is not needed, a Null pointer may be passed.

tag

A pointer to the application's tag associated with the entry. If the tag value is not required by the application, a Null pointer may be passed.

Description

The DXmSvnMapPosition routine uses a supplied x- and y-coordinates to determine which entry the user was positioned over when the mouse button was pressed or released.

Displays a specified entry.

Format

int DXmSvnPositionDisplay(widget, entry, position) Widget widget; int entry; int position;

Return Value

An integer that returns as 1 (True). The routine returns a value of 0 (False) only when the specified position of the entry is SvnPositionNextPage and the user is already at the bottom of the page (display).

Arguments

widget

The identifier (widget ID) of the SVN widget.

entry

An integer that represents the number of the entry.

position

The position of the entry, indicated by one of the following values:

Value	Description
DXmSvnKpositionBottom	The entry is positioned at the bottom of the display.
DXmSvnKpositionTop	The entry is positioned at the top of the display.
DXmSvnKpositionMiddle	The entry is positioned in the middle of the display.
DXmSvnKpositionPreviousPage	The entry is positioned on the page (display) of entries previously displayed.
DXmSvnKpositionNextPage	The entry is positioned on the page (display) of entries to be displayed next.

Description

The DXmSvnPositionDisplay routine ensures that the entries being displayed contain a specified entry. This routine allows the application to position a particular entry at the top, middle, or bottom of the display regardless of the number of entries being displayed.

	privacy and legal statement
5635PRO_013.HTML