1XmInstallImage(library call)                      XmInstallImage(library call)
2
3
4

NAME

6       XmInstallImage  —  A  pixmap caching function that adds an image to the
7       image cache
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       Boolean XmInstallImage(
12       XImage * image,
13       char * image_name);
14

DESCRIPTION

16       XmInstallImage stores an image in an image cache that can later be used
17       to  generate  a  pixmap.  Part of the installation process is to extend
18       the resource converter used to reference  these  images.  The  resource
19       converter  is  given the image name so that the image can be referenced
20       in a .Xdefaults file.  Since an image can be  referenced  by  a  widget
21       through  its  pixmap  resources,  it is up to the application to ensure
22       that the image is installed before the widget is created.
23
24       image     Points to the image structure to be installed.  The installa‐
25                 tion  process does not make a local copy of the image. There‐
26                 fore, the application should not destroy the image  until  it
27                 is uninstalled from the caching functions.
28
29       image_name
30                 Specifies  a  string  that  the  application uses to name the
31                 image. After installation, this name can  be  used  in  .Xde‐
32                 faults for referencing the image. A local copy of the name is
33                 created by the image caching functions.
34
35       The image caching functions provide a set of eight preinstalled images.
36       These names can be used within a .Xdefaults file for generating pixmaps
37       for the resource for which they are provided.
38
39       ┌───────────────┬────────────────────────────┐
40Image Name     Description                
41       ├───────────────┼────────────────────────────┤
42       │background     │ A tile of solid background │
43       ├───────────────┼────────────────────────────┤
44       │25_foreground  │ A tile of 25%  foreground, │
45       │               │ 75% background             │
46       ├───────────────┼────────────────────────────┤
47       │50_foreground  │ A  tile of 50% foreground, │
48       │               │ 50% background             │
49       ├───────────────┼────────────────────────────┤
50       │75_foreground  │ A tile of 75%  foreground, │
51       │               │ 25% background             │
52       ├───────────────┼────────────────────────────┤
53       │horizontal     │ A tile of horizontal lines │
54       │               │ of the two colors          │
55       ├───────────────┼────────────────────────────┤
56       │vertical       │ A tile of  vertical  lines │
57       │               │ of the two colors          │
58       ├───────────────┼────────────────────────────┤
59       │slant_right    │ A  tile  of slanting lines │
60       │               │ of the two colors          │
61       ├───────────────┼────────────────────────────┤
62       │slant_left     │ A tile of  slanting  lines │
63       │               │ of the two colors          │
64       ├───────────────┼────────────────────────────┤
65       │menu_cascade   │ A  tile of an arrow of the │
66       │               │ foreground color           │
67       ├───────────────┼────────────────────────────┤
68       │menu_checkmark │ A tile of a  checkmark  of │
69       │               │ the foreground color       │
70       ├───────────────┼────────────────────────────┤
71       │menu_dash      │ A  tile  of one horizontal │
72       │               │ line  of  the   foreground │
73       │               │ color                      │
74       ├───────────────┼────────────────────────────┤
75       └───────────────┴────────────────────────────┘

RETURN

77       Returns  True  when  successful;  returns  False  if  NULL  image, NULL
78       image_name, or duplicate image_name is used as a parameter value.
79
81       XmUninstallImage(3), XmGetPixmap(3), and XmDestroyPixmap(3).
82
83
84
85                                                  XmInstallImage(library call)
Impressum