Volume 7B: XView Reference Manual

CURSOR_SRC_CHAR

Specifies the index into the shape font. Predefined shapes are in <xview/cursor.h>.

Argument: unsigned int

Default: -1

Procs: create, get, set

Objects: Xv_Cursor

Usage:

xv_set(cursor,

CURSOR_SRC_CHAR, OLC_BASIC_PTR,

CURSOR_MASK_CHAR, OLC_BASIC_MASK_PTR,

NULL);

See Also: 13.2,

CURSOR_MASK_CHAR

CURSOR_STRING

Creates a text drag and drop cursor. The value of the attribute is the string which is to be displayed in-

side the “flying punch card.” If the string exceeds 3 characters, then only the first 3 characters are

displayed, and a “More arrow” is shown within the cursor. CURSOR_STRING is mutually exclusive

of

CURSOR_IMAGE, CURSOR_SRC_CHAR, and CURSOR_MASK_CHAR. The string is not copied. Once the

drag and drop operation is complete, the text cursor objects used in the operation must be destroyed.

Argument: char *

Default: None

Procs: create,get

Objects: Cursor

See Also: 13.5,

CURSOR_DRAG_STATE, CURSOR_DRAG_TYPE

CURSOR_XHOT

Specifies the x coordinate of the hotspot. Its value cannot be negative.

Argument: int

Default: 0

Procs: create, get, set

Objects: Cursor

See Also: 13.3

CURSOR_YHOT

Specifies the y coordinate of the hotspot. Its value cannot be negative.

Argument: int

Default: 0

Procs: create, get, set

Objects: Cursor

See Also: 13.3

DND_ACCEPT_CURSOR

During a drag and drop operation, this defines the mouse cursor that is used when the cursor is over

an acceptable drop-site.

Argument: Xv_cursor

Default: Predefined

OPEN LOOK drag and drop cursor

Procs: create,get,set

Objects: Dnd

See Also: 19.3.3

XView Attributes

XView Attributes 41

DND_ACCEPT_X_CURSOR

An alternative to DND_ACCEPT_CURSOR, this attribute accepts an XID of a cursor instead of an

Xv_cursor.

Argument: XID

Default: Predefined

OPEN LOOK drag and drop cursor

Procs: create,get,set

Objects: Dnd

See Also: 19.3.3

DND_CURSOR

Defines the mouse cursor that will be used during the drag portion of the drag and drop operation.

Argument: Xv_cursor

Default: Predefined

OPEN LOOK drag and drop cursor

Procs: create,get,set

Objects: Dnd

See Also: 19.3.3,

DND_ACCEPT_CURSOR

DND_TIMEOUT_VALUE

Defines the amount of time to wait for an acknowledgment from the drop destination after the kicker

message has been sent (ACTION_DRAG_COPY or ACTION_DRAG_MOVE ). The kicker message is sent

when the user releases the mouse button, forcing the drop.

Argument: struct timeval *

Default: Default selection package timeout

Procs: create,get,set

Objects: Dnd

See Also: 19.3.4

DND_TYPE

Defines whether this drag and drop operation will be a copy or a move. This is just a hint to the desti-

nation. If the type is a move operation and if the destination honors the hint, the destination will ask

the source to convert the

DELETE target.

Valid Values:

DND_COPY or DND_MOVE

Default:

DND_MOVE

Procs: create,get,set

See Also: 19.3

DND_X_CURSOR

An alternative to DND_CURSOR, but accepts an XID of a cursor instead of an Xv_cursor.

Argument: XID

Default: Predefined

OPEN LOOK drag and drop cursor

Procs: create,get,set

Objects: Dnd

See Also: 19.3.3, DND_ACCEPT_X_CURSOR

42 XView Reference Manual

DROP_SITE_DEFAULT

Specifies that this drop-site wants forwarded drops from the window manager. Such drops include

drops on icons and window manager decorations. Only one drop-site default should be specified per

base frame (specifying more than one will have unpredictable results). This attribute is only a hint to

the window manager.

Argument: Bool

Default: False

Procs: create,get,set

Objects: Drop_site_item

See Also: 19.2

DROP_SITE_DELETE_REGION

Used to remove a region from the drop item. If the owner is destroyed with xv_destroy(), any

drop-site regions attached to it will also be destroyed. When a NULL is passed as an argument, all re-

gions in the drop-site will be removed.

Argument: Rect *

Default: N/A

Procs: create,set

Objects: Drop_site_item

See Also: 19.2.1

DROP_SITE_DELETE_REGION_PTR

Used to remove a list of regions from the drop item. Passing a NULL as an argument removes all re-

gions in the drop-site.

Argument: Rect * (a

NULL-terminated array of Rect structs)

Default: N/A

Procs: create,set

Objects: Drop_site_item

See Also: 19.2.1

DROP_SITE_EVENT_MASK

A mask used to specify if the regions within the site will receive synthetic previewing events. The pre-

viewing events will come with event_action() set to

ACTION_DRAG_PREVIEW and

event_id() set to one of LOC_WINENTER, LOC_WINEXIT or LOC_DRAG. These events will be

delivered to the event procedure of the owner of the drop-site item. This mask is only a hint to the

source. There is no guarantee the source will send these previewing events.

Argument: int

Valid Values: {

DND_ENTERLEAVE, DND_MOTION} Defined in <xview/dragdrop.h>

Default:

NULL

Procs: create,get,set

Objects: Drop_site_item

See Also: 19.2.2.1

DROP_SITE_ID

An uninterpreted ID used to distinguish one drop-site from the next. Ideal when more than one site

has been set on an object.

Argument: long

Default: A value generated from xv_unique_key()

Procs: create,get,set

Objects: Drop_site_item

See Also: 19.2.2.1

XView Attributes

XView Attributes 43

DROP_SITE_REGION

This attribute is used to associate a region to a drop-site item. The region is a Rect *.

DROP_SITE_REGION will add to any existing regions within the drop-site item. The rect pointed to

by Rect * will be copied. The coordinates in the rect should be relative to the drop-site item’s own-

er’s window. An xv_get() of a region of type Rect * will return an allocated Rect structure.

This should be freed using xv_free() once the application has finished using it.

Argument: Rect *

Default:

NULL

Procs: create,get,set

Objects: Drop_site_item

See Also: 19.2.1,

DROP_SITE_DELETE_REGION

DROP_SITE_REGION_PTR

This attribute is similar to DROP_SITE_REGION except that it accepts a NULL-terminated array of re-

gions. It will add to any existing regions that exist within the drop item. A

NULL rect is defined to be

one with width or height equal to 0. An xv_get() of a region list will return a NULL-terminated list

of Rects. This data should be freed once the application has finished using it.

Argument: Rect * (A

NULL-terminated array of Rect structs)

Default:

NULL

Procs: create,get,set

Objects: Drop_site_item

See Also: 19.2.1,

DROP_SITE_DELETE_REGION

FILE_CHOOSER_ABBREV_VIEW

Specifies if the FILE_CHOOSER should show invalid file names grayed out or not display them at all.

An invalid file name is specified by the

FILE_CHOOSER_FILTER_FUNC returning a value of

FILE_CHOOSER_IGNORE or with an op set to FILE_CHOOSER_NOT_MATCHED for files, but not for

directories. This only works for

FILE_CHOOSER_FILTER_STRING. Note that the Save and Save As

dialogs require that all documents are grayed out; setting this attribute on them will result in a display

with nothing but folders and the “Go up one” entry.

Argument: Bool

Default:

FALSE

Procs: create, get, set

Objects: File_chooser

See Also: Appendix D, Version 3.2 and the File Chooser, of XView Programming Manual.

FILE_CHOOSER_APP_DIR

Adds an application-specific path name to the Go To History Menu’s fixed space. The first argument

is the string that will show on the Menu_item, and the second is the path name represented by this

label. Both strings may be the same. The Application File Choosing Specification imposes a limit of

five application-specific entries in the Go To menu. Any more than five unique entries will be silently

truncated by the

FILE_CHOOSER package.

Note that the Goto List is, by default, shared amongst the various

FILE_CHOOSER instances, so setting

this on one

FILE_CHOOSER will affect the rest of the instances. Also, the Default History List used by

FILE_CHOOSER ignores duplicate entries in the Recent Space.

Argument 1: char *

Argument 2: char *

Procs: create, set

Objects: File_chooser

See Also: Appendix D, Version 3.2 and the File Chooser, of XView Programming Manual.

44 XView Reference Manual

FILE_CHOOSER_AUTO_UPDATE

Tells the FILE_CHOOSER not to re-read its current directory until either FILE_CHOOSER_UPDATE is

called explicitly, or until the user performs some action to read the directory.

Argument: Bool

Default:

TRUE

Procs: create, get, set

Objects: File_chooser

See Also: Appendix D, Version 3.2 and the File Chooser, of XView Programming Manual.

FILE_CHOOSER_CD_FUNC

Specifies a callback to be invoked with an op of FILE_CHOOSER_BEFORE_CD before the

FILE_CHOOSER attempts to change to another directory.

Argument: int (*cd_func)()

Procs: create, get, set

Objects: File_chooser

Callback:

int

cd_func( chooser, path, stats, op )

File_chooser chooser;

char * path;

struct stat * stats;

File_chooser_op op;

The expected return values are

XV_OK or XV_ERROR. If XV_ERROR is returned, the direc-

tory change is effectively vetoed. It is expected that the application provides the user with

the appropriate feedback.

The callback is invoked again with an op of

FILE_CHOOSER_AFTER_CD after the con-

tents of the scrolling list have been loaded, but before it has been displayed to the user.

The return value is ignored from this invocation.

FILE_CHOOSER_CHILD

Get a handle to the opaque handles to the UI objects.

Warning: relying on values that use xv_set or xv_get from these handles is not guaranteed to be

compatible in future releases.

Argument: File_chooser_child

Valid Values:

FILE_CHOOSER_GOTO_MESSAGE_CHILD

FILE_CHOOSER_GOTO_BUTTON_CHILD

FILE_CHOOSER_GOTO_PATH_CHILD

FILE_CHOOSER_HISTORY_MENU_CHILD

FILE_CHOOSER_CURRENT_FOLDER_CHILD

FILE_CHOOSER_SELECT_MESSAGE_CHILD

FILE_CHOOSER_FILE_LIST_CHILD

FILE_CHOOSER_DOCUMENT_NAME_CHILD

FILE_CHOOSER_OPEN_BUTTON_CHILD

FILE_CHOOSER_SAVE_BUTTON_CHILD

FILE_CHOOSER_CANCEL_BUTTON_CHILD

FILE_CHOOSER_CUSTOM_BUTTON_CHILD

Procs: get

Objects: File_chooser

See Also: Appendix D, Version 3.2 and the File Chooser, of XView Programming Manual.

XView Attributes

XView Attributes 45