Content-type: text/html Man page of DXmSvnGetEntryPosition

DXmSvnGetEntryPosition

Section: Miscellaneous Library Functions (3X)
Index Return to Main Contents
 

NAME

DXmSvnGetEntryPosition - Retrieves (returns) the position of an entry in the display.  

SYNOPSIS

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

PARAMETERS

The identifier (widget ID) of the SVN widget. An integer that represents the number of the entry for which position information is required. A Boolean value that, when True, specifies that position information returned is relative to the upper-left corner of the SVN window. When False, the position information returned is internal SVN information only (for column and outline mode) or indicates the position of the entry in the entire tree (tree mode). A pointer to the x position in the tree. A pointer to the y position in the tree.
 

DESCRIPTION

The DXmSvnGetEntryPosition routine allows an application to determine the position of entries. The routine interprets the x and y coordinates differently, depending on the application's mode: Outline and Column mode

When the application is in outline or column mode (the DXMSvnNdisplayMode resource has been set to either DXMSvnKdisplayOutline or DXMSvnKdisplayColumn) and mode for the DXmSvnGetEntryPosition routine has been set to True, the x and y coordinates indicate, in pixels, the distance of the displayed entry from the upper-left corner of the SVN window.
However, if the specified entry is not visible in the SVN window, the routine returns -1 (an invalid value) for both the x and y coordinates, because the SVN widget cannot determine the position of such an entry when the application is in outline or column mode.
When mode is False, the values returned for the x and y coordinates are only meaningful internally to the SVN widget. Tree mode
When the application is in tree mode (the DXMSvnNdisplayMode resource is set to DXMSvnKdisplayTree) and the DXMSvnNtreeStyle resource is set to DXMSvnKuserDefinedTree (the application controls the format), the x and y coordinates indicate, in pixels, the distance of the displayed entry from the upper-left corner of the SVN window, when mode is True.
If the entry is not visible in the SVN window, the mode is False. However, in tree mode, the returned x and y coordinates indicate the position of the entry in the entire tree, even though that position extends beyond the limit of what can currently be displayed in the SVN window.
Note that for position values to be valid, the SVN widget must have been enabled prior to any changes made to the contents of the display.


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION

This document was created by man2html, using the manual pages.
Time: 02:41:06 GMT, October 02, 2010