SgDropPocket(3X) UNIX System V SgDropPocket(3X)
NAME
SgDropPocket - The DropPocket widget class
SYNOPSIS
#include <Sgm/DropPocket.h>
VERSION
This page documents the version of Sgm that accompanies
Motif 1.2.
DESCRIPTION
DropPocket is designed for receiving icons. The user will
see the icon in the DropPocket as a visual reminder of the
type of the file associated with the DropPocket. The user
may drop SGI file icons onto the dropPocket. The DropPocket
will determine the name of the icon and return information
describing the icon to the application in the callback.
The DropPocket background changes color when an droppable
icon is above the DropPocket. Once an icon has been dropped
on the DropPocket, the icon is displayed in the DropPocket.
Classes
DropPocket inherits behavior and resources from Core and
XmPrimitive Classes.
The class pointer is sgDropPocketWidgetClass.
The class name is SgDropPocket.
New Resources
The following table defines a set of widget resources used
by the programmer to specify data. The programmer can also
set the resource values for the inherited classes to set
attributes for this widget. To reference a resource by name
or by class in a .Xdefaults file, remove the SgN, SgC, XmN
or XmC prefix and use the remaining letters. To specify one
of the defined values for a resource in a .Xdefaults file,
remove the prefix and use the remaining letters (in either
lowercase or uppercase, but include any underscores between
words). The codes in the access column indicate if the
given resource can be set at creation time (C), set by using
XtSetValues (S), retrieved by using XtGetValues (G), or is
not applicable (N/A).
SgDropPocket Resource Set
Name Class Type Default Access
____________________________________________________________________________________________________
SgNactivePixel XmCDropPocketActivePixel Pixel blue CSG
Page 1 (printed 4/30/98)
SgDropPocket(3X) UNIX System V SgDropPocket(3X)
SgNiconDataBasePath SgCIconDataBasePath XmString /usr/lib/filetype/workspace.ctr CSG
SgNname SgCNname XmString NULL CSG
SgNDropPocketActivePixel
Specifies the color for the background of the
DropPocket when a droppable icon is above the
DropPocket.
SgNiconDataBasePath
Specifies the location of the icon database. The
default value is /usr/lib/filetype/workspace.ctr.
Setting this resource to a filename that is not a
legal icon database will cause serious problems
for the DropPocket.
SgNname Specifies the compound string that is the name of
the current icon. By setting this resource, the
application can control the initial icon that
appears in the DropPocket. If this resource is
NULL, the DropPocket will appear empty. Refer to
XmString(3X) for more information on the creation
and structure of compound strings.
Inherited Resources
DropPocket inherits behavior and resources from the
following superclasses. For a complete description of each
resource, refer to the man page for that superclass.
XmPrimitive Resource Set
Name Class Type Default Access
________________________________________________________________________________________________
XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG
XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNforeground XmCForeground Pixel dynamic CSG
XmNhelpCallback XmCCallback XtCallbackList NULL C
XmNhighlightColor XmCHighlightColor Pixel dynamic CSG
XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG
XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG
XmNhighlightThickness XmCHighlightThickness Dimension 0 CSG
XmNnavigationType XmCNavigationType XmNavigationType XmNONE CSG
XmNshadowThickness XmCShadowThickness Dimension 0 CSG
XmNtopShadowColor XmCTopShadowColor Pixel dynamic CSG
XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG
XmNtraversalOn XmCTraversalOn Boolean False CSG
XmNunitType XmCUnitType unsigned char dynamic CSG
XmNuserData XmCUserData XtPointer NULL CSG
Core Resource Set
Page 2 (printed 4/30/98)
SgDropPocket(3X) UNIX System V SgDropPocket(3X)
Name Class Type Default Access
______________________________________________________________________________________________________________
XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG
XmNancestorSensitive XmCSensitive Boolean dynamic G
XmNbackground XmCBackground Pixel dynamic CSG
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderWidth XmCBorderWidth Dimension 0 CSG
XmNcolormap XmCColormap Colormap dynamic CG
XmNdepth XmCDepth int dynamic CG
XmNdestroyCallback XmCCallback XtCallbackList NULL C
XmNheight XmCHeight Dimension dynamic CSG
XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
XmNscreen XmCScreen Screen * dynamic CG
XmNsensitive XmCSensitive Boolean True CSG
XmNtranslations XmCTranslations XtTranslations dynamic CSG
XmNwidth XmCWidth Dimension dynamic CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
Callback Information
The Callback structure is SgDropPocketCallbackStruct. A
pointer to the following structure is passed to each
callback:
typedef struct
{
int reason;
XEvent * event;
Window window;
XmString iconName;
char * iconData;
} SgDropPocketCallbackStruct;
reason Indicates why the callback was invoked. The
constant SgCRICONCHANGE is the reason associated
with callbacks generated by a successful icon drop
on the DropPocket.
event Points to the XEvent that triggered the callback
window Specifies the window of the DropPocket.
iconName Specifies the name of the icon. For icons
representing files, this is the file name. For
other types of icons, the name may not completely
specify the icon. For example a person icon may
have the name jake, but the icon represents a
person in /usr/lib/faces/jake.
Page 3 (printed 4/30/98)
SgDropPocket(3X) UNIX System V SgDropPocket(3X)
iconData The full string description of the icon.
Translations
SgDropPocket includes translations from Primitive. The
SgDropPocket translations are listed below. These
translations may not directly correspond to a translation
table.
Enter: Enter()
Leave: Leave()
Action Routines
The SgDropPocket action routines are described below:
Enter(): When the pointer enters the DropPocket, this
action highlights the icon and changes the
background color if the pointer contains a
droppable icon.
Leave(): This unhighlights the icon and resets the
background color when the pointer leaves the
DropPocket.
Virtual Bindings
The bindings for virtual keys are vendor specific. For
information about bindings for virtual buttons and keys, see
VirtualBindings(3X).
RELATED INFORMATION
Core(3X), SgCreateDropPocket(3X), and XmPrimitive(3X).
Page 4 (printed 4/30/98)