XmInstallImage(library call) XmInstallImage(library call)
NAME
XmInstallImage -- A pixmap caching function that adds an image to the image cache
SYNOPSIS
#include <Xm/Xm.h>
Boolean XmInstallImage(
XImage * image,
char * image_name);
DESCRIPTION
XmInstallImage stores an image in an image cache that can later be used to generate a pixmap. Part of the installation process is to
extend the resource converter used to reference these images. The resource converter is given the image name so that the image can be ref-
erenced in a .Xdefaults file. Since an image can be referenced by a widget through its pixmap resources, it is up to the application to
ensure that the image is installed before the widget is created.
image Points to the image structure to be installed. The installation process does not make a local copy of the image. Therefore, the
application should not destroy the image until it is uninstalled from the caching functions.
image_name
Specifies a string that the application uses to name the image. After installation, this name can be used in .Xdefaults for ref-
erencing the image. A local copy of the name is created by the image caching functions.
The image caching functions provide a set of eight preinstalled images. These names can be used within a .Xdefaults file for generating
pixmaps for the resource for which they are provided.
+---------------+---------------------------------------------------+
|Image Name | Description |
+---------------+---------------------------------------------------+
|background | A tile of solid background |
+---------------+---------------------------------------------------+
|25_foreground | A tile of 25% foreground, 75% background |
+---------------+---------------------------------------------------+
|50_foreground | A tile of 50% foreground, 50% background |
+---------------+---------------------------------------------------+
|75_foreground | A tile of 75% foreground, 25% background |
+---------------+---------------------------------------------------+
|horizontal | A tile of horizontal lines of the two colors |
+---------------+---------------------------------------------------+
|vertical | A tile of vertical lines of the two colors |
+---------------+---------------------------------------------------+
|slant_right | A tile of slanting lines of the two colors |
+---------------+---------------------------------------------------+
|slant_left | A tile of slanting lines of the two colors |
+---------------+---------------------------------------------------+
|menu_cascade | A tile of an arrow of the foreground color |
+---------------+---------------------------------------------------+
|menu_checkmark | A tile of a checkmark of the foreground color |
+---------------+---------------------------------------------------+
|menu_dash | A tile of one horizontal line of the foreground |
| | color |
+---------------+---------------------------------------------------+
+---------------+---------------------------------------------------+
RETURN
Returns True when successful; returns False if NULL image, NULL image_name, or duplicate image_name is used as a parameter value.
RELATED XmUninstallImage(3), XmGetPixmap(3), and XmDestroyPixmap(3).
XmInstallImage(library call)
Check Out this Related Man Page
XmGetPixmap(3X)XmGetPixmap(3X)NAME
XmGetPixmap - A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap
SYNOPSIS
#include <Xm/Xm.h>
Pixmap XmGetPixmap (screen, image_name, foreground, background)
Screen *screen;
char *image_name;
Pixel foreground;
Pixel background;
DESCRIPTION
XmGetPixmap uses the parameter data to perform a lookup in the pixmap cache to see if a pixmap has already been generated that matches the
data. If one is found, a reference count is incremented and the pixmap is returned. Applications should use XmDestroyPixmap when the
pixmap is no longer needed.
If a pixmap is not found, image_name is used to perform a lookup in the image cache. If an image is found, it is used to generate the
pixmap, which is then cached and returned.
If an image is not found, the image_name is used as a filename, and a search is made for an X10 or X11 bitmap file. If it is found, the
file is read, converted into an image, and cached in the image cache. The image is then used to generate a pixmap, which is cached and
returned.
If image_name has a leading slash (/), it specifies a full pathname, and XmGetPixmap opens the file as specified. Otherwise, image_name
specifies a filename. In this case XmGetPixmap looks for the file along a search path specified by the XBMLANGPATH environment variable or
by a default search path, which varies depending on whether or not the XAPPLRESDIR environment variable is set.
The XBMLANGPATH environment variable specifies a search path for X bitmap files. It can contain the substitution field %B, where the
image_name argument to XmGetPixmap is substituted for %B. It can also contain the substitution fields accepted by XtResolvePathname. The
substitution field %T is always mapped to bitmaps, and %S is always mapped to NULL.
If XBMLANGPATH is not set but the environment variable XAPPLRESDIR is set, the following pathnames are searched:
%B
$XAPPLRESDIR/%L/bitmaps/%N/%B
$XAPPLRESDIR/%l/bitmaps/%N/%B
$XAPPLRESDIR/bitmaps/%N/%B
$XAPPLRESDIR/%L/bitmaps/%B
$XAPPLRESDIR/%l/bitmaps/%B
$XAPPLRESDIR/bitmaps/%B
$HOME/bitmaps/%B
$HOME/%B
/usr/lib/X11/%L/bitmaps/%N/%B
/usr/lib/X11/%l/bitmaps/%N/%B
/usr/lib/X11/bitmaps/%N/%B
/usr/lib/X11/%L/bitmaps/%B
/usr/lib/X11/%l/bitmaps/%B
/usr/lib/X11/bitmaps/%B
/usr/include/X11/bitmaps/%B
If neither XBMLANGPATH nor XAPPLRESDIR is set, the following pathnames are searched:
%B
$HOME/%L/bitmaps/%N/%B
$HOME/%l/bitmaps/%N/%B
$HOME/bitmaps/%N/%B
$HOME/%L/bitmaps/%B
$HOME/%l/bitmaps/%B
$HOME/bitmaps/%B
$HOME/%B
/usr/lib/X11/%L/bitmaps/%N/%B
/usr/lib/X11/%l/bitmaps/%N/%B
/usr/lib/X11/bitmaps/%N/%B
/usr/lib/X11/%L/bitmaps/%B
/usr/lib/X11/%l/bitmaps/%B
/usr/lib/X11/bitmaps/%B
/usr/include/X11/bitmaps/%B
These paths are defaults that vendors may change. For example, a vendor may use different directories for /usr/lib/X11 and
/usr/include/X11.
The following substitutions are used in these paths: The image name, from the image_name argument. The class name of the application. The
display's language string. The language component of the display's language string.
Parameter descriptions are listed below: Specifies the display screen on which the pixmap is to be drawn. The depth of the pixmap is the
default depth for this screen. Specifies the name of the image to be used to generate the pixmap Combines the image with the foreground
color to create the pixmap if the image referenced is a bit-per-pixel image Combines the image with the background color to create the
pixmap if the image referenced is a bit-per-pixel image
RETURN VALUE
Returns a pixmap when successful; returns XmUNSPECIFIED_PIXMAP if the image corresponding to the image_name cannot be found.
SEE ALSO XmDestroyPixmap(3X), XmGetPixmapByDepth(3X), XmInstallImage(3X), XmUninstallImage(3X)XmGetPixmap(3X)