WhichWorkbenchObjectA

Query whether a click at the specified coordinates would hit a Workbench icon or window. (V47)

If the specified window is a Workbench drawer window, and the passed coordinates reside within the area of a visible icon belonging to it, the function returns the constant WBO_ICON. If the window is a Workbench drawer window, and the coordinates fall into a visible area of its surface without intersecting any of its icons, the constant WBO_DRAWER is returned. If the window is not a Workbench window, or the coordinates lie within an obscured area of the window or even outside of its bounds, WBO_NONE is returned.

If the window pointer is not NULL, the coordinates you provide must be relative to the window's upper left corner. You can also pass a NULL window pointer and screen-relative coordinates, which will be translated to appropriate parameters for the topmost window intersecting those coordinates.

A tag list allows you to specify additional parameters for this function. Most of the available tags can be used to retrieve further information on the icon and/or drawer window found at the specified coordinates; as none may be there, you should only use this information if the function did return a suitable value (WBO_ICON for icon-related tags, and either WBO_DRAWER or WBO_ICON for drawer-related tags).

window

A window, possibly belonging to Workbench, or NULL.

mousex

Horizontal coordinate, relative to the window (or to the Workbench screen if the window is NULL).

mousey

Vertical coordinate, relative to the window (or to the Workbench screen if the window is NULL).

tags

Additional options.

WBOBJA_Type (ULONG *)

Get the type of the icon; this can be one of WBDISK..WBAPPICON from <workbench/workbench.h>.

WBOBJA_Left (LONG *)

Get the left edge of the icon as it is currently displayed in its parent window. If the icon is framed, this will be the left edge of the frame.

WBOBJA_Top (LONG *)

Get the top edge of the icon as it is currently displayed in its parent window. If the icon is framed, this will be the top edge of the frame.

WBOBJA_Width (ULONG *)

Get the width of the icon as it is currently displayed in its parent window. If the icon is framed, this will be the width of the frame.

WBOBJA_Height (ULONG *)

Get the height of the icon as it is currently displayed in its parent window. If the icon is framed, this will be the height of the frame.

WBOBJA_State (ULONG *)

Get the current visible state of the icon. This can be one of the IDS_#? constants from <intuition/imageclass.h>.

WBOBJA_IsFake (ULONG *)

TRUE if the icon is fake, i.e. it belongs to an object lacking a real .info file; FALSE if it comes from an .info file.

WBOBJA_IsLink (ULONG *)

TRUE if the icon represents a link, FALSE if it represents a real file.

WBOBJA_Name (STRPTR)

Get the name of the icon, as currently displayed by Workbench. The name will be copied into the buffer whose address you supply with this tag. The name will be truncated if its length exceeds the buffer size specified with WBOBJA_NameSize.

WBOBJA_NameSize (ULONG)

Specify the size of the buffer passed with WBOBJA_Name, in bytes. Defaults to 64.

WBOBJA_FullPath (STRPTR)

Get the full path of the object the icon belongs to. If this is not available/applicable (such as for AppIcons) an empty string will be returned. The path will be copied into the buffer whose address you supply with this tag. The path will be truncated if its length exceeds the size specified with WOBJA_FullPathSize.

WBOBJA_FullPathSize (ULONG)

Specify the size of the buffer passed with WBOBJA_FullPath, in bytes. Defaults to 512.

WBOBJA_DrawerPath (STRPTR)

Get the path of the drawer whose window is found at the specified coordinates. In the case of the Workbench root window, such a path is not available and an empty string will be returned. The path will be copied into the buffer whose address you supply with this tag. The path will be truncated if its length exceeds the buffer size specified with WBOBJA_DrawerPathSize.

WBOBJA_DrawerPathSize (ULONG)

Specify the size of the buffer passed with WBOBJA_DrawerPath, in bytes. Defaults to 512.

WBOBJA_DrawerFlags (ULONG *)

Get the current flags (see the DDFLAGS_#? constants in <workbench/workbench.h>) of the drawer whose window is found at the specified coordinates. Note that this may be different from the value found in the actual drawer icon, due to on-the-fly changes by the user.

WBOBJA_DrawerModes (ULONG *)

Get the current view modes (see the DDVM_#? constants in <workbench/workbench.h>) of the drawer whose window is found at the specified coordinates. Note that this may be different from the value found in the actual drawer icon, due to on-the-fly changes by the user.

which

WBO_ICON if a click at the given coordinates would actually hit a Workbench icon, WBO_DRAWER if it would hit a Workbench window but not any icons, WBO_NONE otherwise.

This function is only intended to be used by input helpers such as commodities which need to know whether a mouse click will end up hitting a Workbench object or not. For example, a "ClickToFront"-like commodity could take advantage of it to avoid bringing a window to front after a double-click if all the user really wanted to do was to open a Workbench icon. It could also prove useful to implement context-sensitive menus for Workbench icons and windows.

Usage of this function by normal applications is discouraged.