6X - X11 Utility Methods for ImageMagick;/


NAME



'X - X11 Utility Methods for ImageMagick




(

SYNOPSIS



'option=IsTrue(message)

Nstatus=XAnnotateImage(display,pixel_info,annotate_info,image)

@font=XBestFont(display,resource_info,text_font)

4XBestIconSize(display,window,image)

Npixel=XBestPixel(display,colormap,colors,number_colors,color)

Lvisual_info=XBestVisualInfo(display,map_info,resource_info)

6XCheckRefreshWindows(display,windows)

JXClientMessage(display,window,protocol,message,timestamp)

Cclient_window=XClientWindow(display,target_window)

MXConfigureImageColormap(display,resource_info,windows,image)

>XConstrainWindowPosition(display,window_info)

-XDelay(display,milliseconds)

5XDestroyWindowColors(display,window)

RXDisplayImageInfo(display,resource_info,windows,undo_image,image)

Fstatus=XDrawImage(display,pixel_info,draw_info,image)

&XError(display,error)

OXFreeStandardColormap(display,visual_info,map_info,pixel_info)

0XGetAnnotateInfo(annotate_info)

;XGetMapInfo(visual_info,colormap,map_info)

Wvalue=XGetResourceClass(database,client_name,keyword,resource_default)

Cdatabase=XGetResourceDatabase(display,client_name)

EXGetResourceInfo(database,client_name,resource_info)

Zvalue=XGetResourceInstance(database,client_name,keyword,resource_default)

3density=XGetScreenDensity(display)

<subwindow=XGetSubwindow(display,window,x,y)

5status=XGetWindowColor(display,name)

Dimage=XGetWindowImage(display,window,borders,level)

RXHighlightEllipse(display,window,annotate_context,highlight_info)

OXHighlightLine(display,window,annotate_context,highlight_info)

TXHighlightRectangle(display,window,annotate_context,highlight_info)

<image=XImportImage(image_info,ximage_info);

Bwindows=XInitializeWindows(display,resource_info)

WXMakeCursor(display,window,colormap,background_color,foreground_color)

Sstatus=XMakeImage(display,resource_info,window,image,width,height)

3XMakeMagnifyImage(display,windows)

Astatus=XMakePixmap(display,resource_info,window)

4XProgressMonitor(task,quantum,span)

9status=XQueryColorDatabase(target,color)

3XQueryPosition(display,window,x,y)

5XRefreshWindow(display,window,event)

8XRemoteCommand(display,window,filename)

4XRetainWindowColors(display,window)

?target_window=XSelectWindow(display,crop_info)

7XSetCursorState(display,windows,state)

2windows=XSetWindows(windows_info)

'XSignalHandler(status)

0XUserPreferences(resource_info)

4visual_type=XVisualClassName(class)

4XWarning(warning,message,qualifier)

5child=XWindowByID(display,window,id)

?window=XWindowByName(display,root_window,name)




B

FUNCTION DESCRIPTIONS






$

IsTrue



IMethod IsTrue returns True if the message is ``true'', ``on'', ``yes'' or``1''.

$The format of the IsTrue routine is:

#

        option=IsTrue(message)


(A description of each parameter follows:

5
option:


8either True or False depending on the message parameter.!

message:


)Specifies a pointer to a character array.






4

XAnnotateImage



4Method XAnnotateImage annotates the image with text.

,The format of the XAnnotateImage routine is:

H

      status=XAnnotateImage(display,pixel_info,annotate_info,image)


(A description of each parameter follows:

status:


IMethod XAnnotateImage returns True if the image is successfully annotated;with text. False is returned is there is a memory shortage.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.'

annotate_info:


1Specifies a pointer to a XAnnotateInfo structure.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.






*

XBestFont



IMethod XBestFont returns the ``best'' font. ``Best'' is defined as a fontGspecified in the X resource database or a font such that the text widthDdisplayed with the font does not exceed the specified maximum width.

'The format of the XBestFont routine is:

<

        font=XBestFont(display,resource_info,text_font)


(A description of each parameter follows:


font:


7XBestFont returns a pointer to a XFontStruct structure.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.#

text_font:


6True is font should be mono-spaced (typewriter style).






2

XBestIconSize



KMethod XBestIconSize returns the ``best'' icon size. ``Best'' is defined asHan icon size that maintains the aspect ratio of the image. If the windowEmanager has preferred icon sizes, one of the preferred sizes is used.

+The format of the XBestIconSize routine is:

0

        XBestIconSize(display,window,image)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.






,

XBestPixel



IMethod XBestPixel returns a pixel from an array of pixels that is closestKto the requested color. If the color array is NULL, the colors are obtainedfrom the X server.

(The format of the XBestPixel routine is:

J

        pixel=XBestPixel(display,colormap,colors,number_colors,color)


(A description of each parameter follows:


pixel:


BXBestPixel returns the pixel value closest to the requested color.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay."

colormap:


*Specifies the ID of the X server colormap.

colors:


(Specifies an array of XColor structures.'

number_colors:


HSpecifies the number of XColor structures in the color definition array.

color:


<Specifies the desired RGB value to find in the colors array.






6

XBestVisualInfo



JMethod XBestVisualInfo returns visual information for a visual that is the5``best'' the server supports. ``Best'' is defined as:

    +
  1. .

    H

     Restrict the visual list to those supported by the default screen.
    
  2. .

    T

     If a visual type is specified, restrict the visual list to those of that type.
    
  3. .

    k

     If a map type is specified, choose the visual that matches the id specified by the Standard Colormap.
    


H

  4  From the list of visuals, choose one that can display the most


L

     simultaneous colors.  If more than one visual can display the same


G

     number of simultaneous colors, one is chosen based on a rank.


-The format of the XBestVisualInfo routine is:

H

        visual_info=XBestVisualInfo(display,map_info,resource_info)


(A description of each parameter follows:

%
visual_info:


AXBestVisualInfo returns a pointer to a X11 XVisualInfo structure.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay."

map_info:


JIf map_type is specified, this structure is initialized with info from theStandard Colormap.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.






@

XCheckRefreshWindows



IMethod XCheckRefreshWindows checks the X server for exposure events for aGparticular window and updates the area associated withe exposure event.

2The format of the XCheckRefreshWindows routine is:

2

        XCheckRefreshWindows(display,windows)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.!

windows:


,Specifies a pointer to a XWindows structure.






4

XClientMessage



FMethod XClientMessage sends a message to a window with XSendEvent. The@message is initialized with a particular protocol type and atom.

-The format of the XClientMessage function is:

F

        XClientMessage(display,window,protocol,message,timestamp)


(A description of each parameter follows:

!
display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.

window:


*Specifies a pointer to a Window structure."

protocol:


Specifies an atom value.!

message:


5Specifies an atom value which is the message to send.#

timestamp:


Specifies a value of type Time.






2

XClientWindow



FMethod XClientWindow finds a window, at or below the specified window,Iwhich has a WM_STATE property. If such a window is found, it is returned,*otherwise the argument window is returned.

,The format of the XClientWindow function is:

?

        client_window=XClientWindow(display,target_window)


(A description of each parameter follows:

'
client_window:


KXClientWindow returns a window, at or below the specified window, which hasEa WM_STATE property otherwise the argument target_window is returned.!

display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.'

target_window:


1Specifies the window to find a WM_STATE property.






F

XConfigureImageColormap



8Method XConfigureImageColormap creates a new X colormap.

5The format of the XConfigureImageColormap routine is:

G

      XConfigureImageColormap(display,resource_info,windows,image)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.!

windows:


,Specifies a pointer to a XWindows structure.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.






H

XConstrainWindowPosition



JMethod XConstrainWindowPosition assures a window is positioned witin the Xserver boundaries.

6The format of the XConstrainWindowPosition routine is:

:

        XConstrainWindowPosition(display,window_info)


(A description of each parameter follows:

!
display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.%

window_info:


/Specifies a pointer to a XWindowInfo structure.






$

XDelay



GMethod XDelay suspends program execution for the number of milliseconds specified.

#The format of the Delay routine is:

)

        XDelay(display,milliseconds)


(A description of each parameter follows:

!
display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.&

milliseconds:


?Specifies the number of milliseconds to delay before returning.






@

XDestroyWindowColors



KMethod XDestroyWindowColors frees X11 color resources previously saved on a8window by XRetainWindowColors or programs like xsetroot.

2The format of the XDestroyWindowColors routine is:

1

        XDestroyWindowColors(display,window)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


*Specifies a pointer to a Window structure.






:

XDisplayImageInfo



?Method XDisplayImageInfo displays information about an X image.

/The format of the XDisplayImageInfo routine is:

N

        XDisplayImageInfo(display,resource_info,windows,undo_image,image)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.!

windows:


,Specifies a pointer to a XWindows structure.$

undo_image:


BSpecifies a pointer to a Image structure; returned from ReadImage.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.






,

XDrawImage



,Method XDrawImage draws a line on the image.

(The format of the XDrawImage routine is:

@

      status=XDrawImage(display,pixel_info,draw_info,image)


(A description of each parameter follows:

status:


FMethod XDrawImage returns True if the image is successfully drawd with6text. False is returned is there is a memory shortage.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.#

draw_info:


-Specifies a pointer to a XDrawInfo structure.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.






$

XError



9Method XError ignores BadWindow errors for XQueryTree andJXGetWindowAttributes, and ignores BadDrawable errors for XGetGeometry, andIignores BadValue errors for XQueryColor. It returns False in those cases.Otherwise it returns True.

%The format of the XError function is:

"

        XError(display,error)


(A description of each parameter follows:

!
display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.

error:


Specifies the error event.






4

XFreeResources



*Method XFreeResources frees X11 resources.

,The format of the XFreeResources routine is:

J

    XFreeResources(display,visual_info,map_info,pixel_info,font_info,


%

      resource_info,window_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.%

visual_info:


ASpecifies a pointer to a X11 XVisualInfo structure; returned fromXGetVisualInfo."

map_info:


JIf map_type is specified, this structure is initialized with info from theStandard Colormap.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.#

font_info:


/Specifies a pointer to a XFontStruct structure.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.%

window_info:


3Specifies a pointer to a X11 XWindowInfo structure.






B

XFreeStandardColormap



3Method XFreeStandardColormap frees an X11 colormap.

3The format of the XFreeStandardColormap routine is:

K

        XFreeStandardColormap(display,visual_info,map_info,pixel_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.%

visual_info:


ASpecifies a pointer to a X11 XVisualInfo structure; returned fromXGetVisualInfo."

map_info:


JIf map_type is specified, this structure is initialized with info from theStandard Colormap.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.






8

XGetAnnotateInfo



?Method XGetAnnotateInfo initializes the AnnotateInfo structure.

-The format of the GetAnnotateInfo routine is:

,

        XGetAnnotateInfo(annotate_info)


(A description of each parameter follows:

'
annotate_info:


1Specifies a pointer to a XAnnotateInfo structure.






.

XGetMapInfo



?Method XGetMapInfo initializes the XStandardColormap structure.

/The format of the XStandardColormap routine is:

7

        XGetMapInfo(visual_info,colormap,map_info)


(A description of each parameter follows:

"
colormap:


*Specifies the ID of the X server colormap.%

visual_info:


ASpecifies a pointer to a X11 XVisualInfo structure; returned fromXGetVisualInfo."

map_info:


9Specifies a pointer to a X11 XStandardColormap structure.






2

XGetImageInfo



<Method XGetImportInfo initializes the XImportInfo structure.

,The format of the XGetImportInfo routine is:

$

    XGetImportInfo(ximage_info)


(A description of each parameter follows:

%
ximage_info:


-Specifies a pointer to a ImageInfo structure.






2

XGetPixelInfo



9Method XGetPixelInfo initializes the PixelInfo structure.

+The format of the XGetPixelInfo routine is:

H

    XGetPixelInfo(display,visual_info,map_info,resource_info,image,




      pixel_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.%

visual_info:


ASpecifies a pointer to a X11 XVisualInfo structure; returned fromXGetVisualInfo."

map_info:


JIf map_type is specified, this structure is initialized with info from theStandard Colormap.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.






:

XGetResourceClass



HMethod XGetResourceClass queries the X server for the specified resourceBname or class. If the resource name or class is not defined in the1database, the supplied default value is returned.

/The format of the XGetResourceClass routine is:

S

        value=XGetResourceClass(database,client_name,keyword,resource_default)


(A description of each parameter follows:


value:


GMethod XGetResourceClass returns the resource value associated with theHname or class. If none is found, the supplied default value is returned."

database:


BSpecifies a resource database; returned from XrmGetStringDatabase.%

client_name:


HSpecifies the application name used to retrieve resource info from the Xserver database.!

keyword:


3Specifies the keyword of the value being retrieved.*

resource_default:


DSpecifies the default value to return if the query fails to find thespecified keyword/class.






@

XGetResourceDatabase



KMethod XGetResourceDatabase creates a new resource database and initializesit.

2The format of the XGetResourceDatabase routine is:

?

        database=XGetResourceDatabase(display,client_name)


(A description of each parameter follows:

"
database:


IMethod XGetResourceDatabase returns the database after it is initialized.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.%

client_name:


HSpecifies the application name used to retrieve resource info from the Xserver database.






8

XGetResourceInfo



?Method XGetResourceInfo initializes the ResourceInfo structure.

.The format of the XGetResourceInfo routine is:

A

        XGetResourceInfo(database,client_name,resource_info)


(A description of each parameter follows:

"
database:


BSpecifies a resource database; returned from XrmGetStringDatabase.%

client_name:


HSpecifies the application name used to retrieve resource info from the Xserver database.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.






@

XGetResourceInstance



KMethod XGetResourceInstance queries the X server for the specified resourceGname. If the resource name is not defined in the database, the supplieddefault value is returned.

2The format of the XGetResourceInstance routine is:

V

        value=XGetResourceInstance(database,client_name,keyword,resource_default)


(A description of each parameter follows:


value:


JMethod XGetResourceInstance returns the resource value associated with theHname or class. If none is found, the supplied default value is returned."

database:


BSpecifies a resource database; returned from XrmGetStringDatabase.%

client_name:


HSpecifies the application name used to retrieve resource info from the Xserver database.!

keyword:


3Specifies the keyword of the value being retrieved.*

resource_default:


DSpecifies the default value to return if the query fails to find thespecified keyword/class.






:

XGetScreenDensity



FMethod XGetScreenDensity returns the density of the X server screen indots-per-inch.

/The format of the XGetScreenDensity routine is:

/

        density=XGetScreenDensity(display)


(A description of each parameter follows:

!
density:


?Method XGetScreenDensity returns the density of the X screen indots-per-inch.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.






2

XGetSubwindow



KMethod XGetSubwindow returns the subwindow of a window chosen the user withthe pointer and a button press.

+The format of the XGetSubwindow routine is:

8

        subwindow=XGetSubwindow(display,window,x,y)


(A description of each parameter follows:

#
subwindow:


HMethod XGetSubwindow returns NULL if no subwindow is found otherwise thesubwindow is returned.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


Specifies a pointer to a Window.

x:


Ethe x coordinate of the pointer relative to the origin of the window.

y:


Ethe y coordinate of the pointer relative to the origin of the window.






6

XGetWindowColor



HMethod XGetWindowColor returns the color of a pixel interactively chosenfrom the X server.

-The format of the XGetWindowColor routine is:

1

        status=XGetWindowColor(display,name)


(A description of each parameter follows:

status:


GMethod XGetWindowColor returns True if the color is obtained from the X/server. False is returned if any errors occurs.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

name:


HThe name of of the color if found in the X Color Database is returned inthis character string.






6

XGetWindowImage



JMethod XGetWindowImage reads an image from the target X window and returnsIit. XGetWindowImage optionally descends the window hierarchy and overlaysIthe target image with each child image in an optimized fashion. Any childKwindow that have the same visual, colormap, and are contained by its parent are exempted.

-The format of the XGetWindowImage routine is:

@

        image=XGetWindowImage(display,window,borders,level)


(A description of each parameter follows:


image:


JMethod XGetWindowImage returns a MIFF image if it can be successfully readAfrom the X window. A null image is returned if any errors occurs.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


.Specifies the window to obtain the image from.!

borders:


@Specifies whether borders pixels are to be saved with the image.

level:


ESpecifies an unsigned integer representing the level of decent in theGwindow hierarchy. This value must be zero or one on the initial call toGXGetWindowImage. A value of zero returns after one call. A value of oneJcauses the function to descend the window hierarchy and overlay the target image with each subwindow image.






4

XGetWindowInfo



<Method XGetWindowInfo initializes the XWindowInfo structure.

,The format of the XGetWindowInfo routine is:

J

    XGetWindowInfo(display,visual_info,map_info,pixel_info,font_info,


      resource_info,window)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.%

visual_info:


ASpecifies a pointer to a X11 XVisualInfo structure; returned fromXGetVisualInfo."

map_info:


JIf map_type is specified, this structure is initialized with info from theStandard Colormap.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.#

font_info:


/Specifies a pointer to a XFontStruct structure.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.






:

XHighlightEllipse



FMethod XHighlightEllipse puts a border on the X server around a regiondefined by highlight_info.

/The format of the XHighlightEllipse routine is:

L

      XHighlightEllipse(display,window,annotate_context,highlight_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


*Specifies a pointer to a Window structure.*

annotate_context:


&Specifies a pointer to a GC structure.(

highlight_info:


ISpecifies a pointer to a RectangleInfo structure. It contains the extentsof any highlighting rectangle.






4

XHighlightLine



KMethod XHighlightLine puts a border on the X server around a region definedby highlight_info.

,The format of the XHighlightLine routine is:

I

      XHighlightLine(display,window,annotate_context,highlight_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


*Specifies a pointer to a Window structure.*

annotate_context:


&Specifies a pointer to a GC structure.(

highlight_info:


ISpecifies a pointer to a RectangleInfo structure. It contains the extentsof any highlighting rectangle.






>

XHighlightRectangle



HMethod XHighlightRectangle puts a border on the X server around a regiondefined by highlight_info.

1The format of the XHighlightRectangle routine is:

N

      XHighlightRectangle(display,window,annotate_context,highlight_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


*Specifies a pointer to a Window structure.*

annotate_context:


&Specifies a pointer to a GC structure.(

highlight_info:


ISpecifies a pointer to a RectangleInfo structure. It contains the extentsof any highlighting rectangle.






0

XImportImage



7Procedure XImportImage reads an image from an X window.

*The format of the XImportImage routine is:

8

        image=XImportImage(image_info,ximage_info);


(A description of each parameter follows:

$
image_info:


.Specifies a pointer to an ImageInfo structure.%

ximage_info:


0Specifies a pointer to an XImportInfo structure.






<

XInitializeWindows



=Method XInitializeWindows initializes the XWindows structure.

0The format of the XInitializeWindows routine is:

>

        windows=XInitializeWindows(display,resource_info)


(A description of each parameter follows:

!
windows:


=XInitializeWindows returns a pointer to a XWindows structure.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.






.

XMakeCursor



3Method XMakeCursor creates a crosshairs X11 cursor.

)The format of the XMakeCursor routine is:

S

        XMakeCursor(display,window,colormap,background_color,foreground_color)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


@Specifies the ID of the window for which the cursor is assigned."

colormap:


ISpecifies the ID of the colormap from which the background and foregroundcolor will be retrieved.*

background_color:


5Specifies the color to use for the cursor background.*

foreground_color:


5Specifies the color to use for the cursor foreground.






,

XMakeImage



JMethod XMakeImage creates an X11 image. If the image size differs from the+X11 image size, the image is first resized.

(The format of the XMakeImage routine is:

O

        status=XMakeImage(display,resource_info,window,image,width,height)


(A description of each parameter follows:

status:


FMethod XMakeImage returns True if the X image is successfully created.0False is returned is there is a memory shortage.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.

window:


/Specifies a pointer to a XWindowInfo structure.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage.

width:


ASpecifies the width in pixels of the rectangular area to display.

height:


BSpecifies the height in pixels of the rectangular area to display.






:

XMakeMagnifyImage



JMethod XMakeMagnifyImage magnifies a region of an X image and displays it.

/The format of the XMakeMagnifyImage routine is:

/

        XMakeMagnifyImage(display,windows)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.!

windows:


,Specifies a pointer to a XWindows structure.






.

XMakePixmap



)Method XMakePixmap creates an X11 pixmap.

)The format of the XMakePixmap routine is:

=

        status=XMakePixmap(display,resource_info,window)


(A description of each parameter follows:

status:


HMethod XMakePixmap returns True if the X pixmap is successfully created.0False is returned is there is a memory shortage.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.!

display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


/Specifies a pointer to a XWindowInfo structure.






B

XMakeStandardColormap



>Method XMakeStandardColormap creates an X11 Standard Colormap.

3The format of the XMakeStandardColormap routine is:

G

    XMakeStandardColormap(display,visual_info,resource_info,image,




      map_info,pixel_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.%

visual_info:


ASpecifies a pointer to a X11 XVisualInfo structure; returned fromXGetVisualInfo.'

resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.

image:


BSpecifies a pointer to a Image structure; returned from ReadImage."

map_info:


GIf a Standard Colormap type is specified, this structure is initialized%with info from the Standard Colormap.$

pixel_info:


.Specifies a pointer to a XPixelInfo structure.






.

XMakeWindow



)Method XMakeWindow creates an X11 window.

)The format of the XMakeWindow routine is:

G

    XMakeWindow(display,parent,argv,argc,class_hint,manager_hints,




      window_info)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

parent:


!Specifies the parent window_info.

argv:


*Specifies the application's argument list.

argc:


"Specifies the number of arguments.$

class_hint:


2Specifies a pointer to a X11 XClassHint structure.'

manager_hints:


0Specifies a pointer to a X11 XWMHints structure.%

window_info:


3Specifies a pointer to a X11 XWindowInfo structure.






8

XProgressMonitor



AMethod XProgressMonitor displays the progress a task is making incompleting a task.

.The format of the XProgressMonitor routine is:

0

        XProgressMonitor(task,quantum,span)


(A description of each parameter follows:


task:


Identifies the task in progress.!

quantum:


HSpecifies the quantum position within the span which represents how much,progress has been made in completing a task.

span:


1Specifies the span relative to completing a task.






>

XQueryColorDatabase



IMethod XQueryColorDatabase looks up a RGB values for a color given in thetarget string.

1The format of the XQueryColorDatabase routine is:

3

      status=XQueryColorDatabase(target,color)


(A description of each parameter follows:

status:


GMethod XQueryColorDatabase returns True if the RGB values of the target.color is defined, otherwise False is returned.

target:


6Specifies the color to lookup in the X color database.

color:


FA pointer to an XColor structure. The RGB value of the target color isreturned as this value.






4

XQueryPosition



HMethod XQueryPosition gets the pointer coordinates relative to a window.

,The format of the XQueryPosition routine is:

-

      XQueryPosition(display,window,x,y)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


Specifies a pointer to a Window.

x:


DReturn the x coordinate of the pointer relative to the origin of thewindow.

y:


DReturn the y coordinate of the pointer relative to the origin of thewindow.






4

XRefreshWindow



7Method XRefreshWindow refreshes an image in a X window.

,The format of the XRefreshWindow routine is:

1

        XRefreshWindow(display,window,event)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


/Specifies a pointer to a XWindowInfo structure.

event:


JSpecifies a pointer to a XEvent structure. If it is NULL, the entire image is refreshed.






4

XRemoteCommand



HMethod XRemoteCommand forces a remote display(1) to displaythe specified image filename.

,The format of the XRemoteCommand routine is:

2

      XRemoteCommand(display,window,filename)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


(Specifies the name or id of an X window."

filename:


*The name of the image filename to display.






>

XRetainWindowColors



EMethod XRetainWindowColors sets X11 color resources on a window. ThisFpreserves the colors associated with an image displayed on the window.

1The format of the XRetainWindowColors routine is:

0

        XRetainWindowColors(display,window)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.

window:


/Specifies a pointer to a XWindowInfo structure.






2

XSelectWindow



IMethod XSelectWindow allows a user to select a window using the mouse. IfEthe mouse moves, a cropping rectangle is drawn and the extents of the1rectangle is returned in the crop_info structure.

,The format of the XSelectWindow function is:

;

        target_window=XSelectWindow(display,crop_info)


(A description of each parameter follows:

window:


$XSelectWindow returns the window id.!

display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.#

crop_info:


ISpecifies a pointer to a RectangleInfo structure. It contains the extentsof any cropping rectangle.






4

XSignalHandler



HMethod XSignalHandler is called if the program execution is interrupted.

,The format of the XSignalHandler routine is:

!

      XSignalHandler(status)





6

XSetCursorState



JMethod XSetCursorState sets the cursor state to busy, otherwise the cursorare reset to their default.

.The format of the XXSetCursorState routine is:

3

        XSetCursorState(display,windows,state)


(A description of each parameter follows:

!
display:


BSpecifies a connection to an X server; returned from XOpenDisplay.!

windows:


,Specifies a pointer to a XWindows structure.

state:


KAn unsigned integer greater than 0 sets the cursor state to busy, otherwise&the cursor are reset to their default.






.

XSetWindows



FMethod XSetWindows sets the X windows structure if the windows info is?specified. Otherwise the current windows structure is returned.

)The format of the XSetWindows routine is:

.

        windows=XSetWindows(windows_info)


(A description of each parameter follows:

!
windows:


?Method XSetWindows returns a pointer to the XWindows structure.&

windows_info:


7Initialize the Windows structure with this information.






8

XUserPreferences



HMethod XUserPreferences saves the preferences in a configuration file inthe users' home directory.

.The format of the XUserPreferences routine is:

,

        XUserPreferences(resource_info)


(A description of each parameter follows:

'
resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.






8

XVisualClassName



DMethod XVisualClassName returns the visual class name as a characterstring.

.The format of the XVisualClassName routine is:

0

        visual_type=XVisualClassName(class)


(A description of each parameter follows:

%
visual_type:


@XVisualClassName returns the visual class as a character string.

class:


Specifies the visual class.






(

XWarning



>Method XWarning displays a warning message in a Notice widget.

&The format of the XWarning routine is:

0

        XWarning(warning,message,qualifier)


(A description of each parameter follows:

!
warning:


'Specifies the numeric warning category.!

message:


@Specifies the message to display before terminating the program.#

qualifier:


'Specifies any qualifier to the message.






.

XWindowByID



HMethod XWindowByID locates a child window with a given ID. If not windowJwith the given name is found, 0 is returned. Only the window specified andits subwindows are searched.

*The format of the XWindowByID function is:

1

        child=XWindowByID(display,window,id)


(A description of each parameter follows:


child:


GXWindowByID returns the window with the specified id. If no windows arefound, XWindowByID returns 0.!

display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.

id:


)Specifies the id of the window to locate.






2

XWindowByName



KMethod XWindowByName locates a window with a given name on a display. If noKwindow with the given name is found, 0 is returned. If more than one windowIhas the given name, the first one is returned. Only root and its children are searched.

,The format of the XWindowByName function is:

;

        window=XWindowByName(display,root_window,name)


(A description of each parameter follows:

window:


$XWindowByName returns the window id.!

display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay.%

root_window:


$Specifies the id of the root window.

name:


+Specifies the name of the window to locate.






8

XWindowByPropery



IMethod XWindowByProperty locates a child window with a given property. IfGno window with the given name is found, 0 is returned. If more than oneIwindow has the given property, the first one is returned. Only the window*specified and its subwindows are searched.

0The format of the XWindowByProperty function is:

9

    child=XWindowByProperty(display,window,property)


(A description of each parameter follows:


child:


JXWindowByProperty returns the window id with the specified property. If no/windows are found, XWindowByProperty returns 0.!

display:


ISpecifies a pointer to the Display structure; returned from XOpenDisplay."

property:


/Specifies the property of the window to locate.