File: XmInstallImage.3

package info (click to toggle)
motif 2.3.4-13
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 81,160 kB
  • ctags: 51,769
  • sloc: ansic: 596,938; cpp: 3,951; yacc: 2,854; makefile: 2,070; csh: 1,199; sh: 1,070; lex: 455
file content (144 lines) | stat: -rw-r--r-- 3,457 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
'\" t
...\" InstIm.sgm /main/9 1996/09/08 20:49:08 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmInstallImage" "library call"
.SH "NAME"
\fBXmInstallImage\fP \(em A pixmap caching function that adds an image to the image cache
.iX "XmInstallImage"
.iX "pixmaps"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBBoolean \fBXmInstallImage\fP\fR(
\fBXImage \fB* image\fR\fR,
\fBchar \fB* image_name\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmInstallImage\fP 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
referenced in a \fB\&.Xdefaults\fP 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\&.
.IP "\fIimage\fP" 10
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\&.
.IP "\fIimage_name\fP" 10
Specifies a string that the application uses to name the image\&. After
installation, this name can be used in \fB\&.Xdefaults\fP for referencing
the image\&. A local copy of the name is created by the image caching
functions\&.
.PP
The image caching functions provide a set of eight preinstalled images\&.
These names can be used within a \fB\&.Xdefaults\fP file for generating pixmaps
for the resource for which they are provided\&.
.TS
tab() box;
l| l.
\fBImage Name\fP\fBDescription\fP
__
backgroundA tile of solid background
__
25_foregroundT{
A tile of 25% foreground, 75% background
T}
__
50_foregroundT{
A tile of 50% foreground, 50% background
T}
__
75_foregroundT{
A tile of 75% foreground, 25% background
T}
__
horizontalT{
A tile of horizontal lines of the two colors
T}
__
verticalT{
A tile of vertical lines of the two colors
T}
__
slant_rightT{
A tile of slanting lines of the two colors
T}
__
slant_leftT{
A tile of slanting lines of the two colors
T}
__
menu_cascadeT{
A tile of an arrow of the foreground color
T}
__
menu_checkmarkT{
A tile of a checkmark of the foreground color
T}
__
menu_dashT{
A tile of one horizontal line of the foreground color
T}
__
.TE
.SH "RETURN"
.PP
Returns True when successful; returns False if NULL \fIimage\fP, NULL
\fIimage_name\fP, or duplicate \fIimage_name\fP is used as a parameter
value\&.
.SH "RELATED"
.PP
\fBXmUninstallImage\fP(3), \fBXmGetPixmap\fP(3), and
\fBXmDestroyPixmap\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:25