← Back to branch summary

~ubuntu-branches/ubuntu/quantal/openmotif/quantal

« back to all changes in this revision

Viewing changes to doc/man/man3/MrmRegisterNames.3

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Bauer
  • Date: 2010-06-23 12:12:31 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100623121231-u89gxdp51sg9wjj2
Tags: 2.3.0-1
http://bugs.debian.org/379258
http://bugs.debian.org/494375
http://bugs.debian.org/288537
* New Maintainer (Closes: #379258) 
* Acknowledge NMU changes
* New upstream release (Closes: #494375)
* Get rid of security patches as they are already part of new upstream
  release (00-xpmvuln.openmotif.patch, 342092-CVE-2005-3964.patch)
* Bump Standards to 3.8.4
* Added {misc:Depends} to make the package lintian cleaner
* Fix weak-library-dev-dependency by adding ${binary:Version}) for the
  -dev Package of openmotif
* Let package depend on autotools-dev to use newer autotools-helper-files
* Work around an autoconf-bug (Gentoo-Bug #1475)
* Added Client-side anti-aliased fonts support via XFT
* Added UTF-8 and UTF8_STRING atom support
* Ability to show text and pixmaps in Label, LabelGadget and all
  derived widgets
* Support of PNG/JPEG image formats in the same way as XPM is supported
* Increase FILE_OFFSET_BITS to 64 to show files >2GB in file-selector
  Idea taken from Magne Oestlyngen (Closes: #288537)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/MrmRegisterNames.3
 
1
'\" t
 
2
...\" RegisteB.sgm /main/8 1996/09/08 21:26:15 rws $
 
3
.de P!
 
4
.fl
 
5
\!!1 setgray
 
6
.fl
 
7
\\&.\"
 
8
.fl
 
9
\!!0 setgray
 
10
.fl                     \" force out current output buffer
 
11
\!!save /psv exch def currentpoint translate 0 0 moveto
 
12
\!!/showpage{}def
 
13
.fl                     \" prolog
 
14
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
 
15
\!!psv restore
 
16
.
 
17
.de pF
 
18
.ie     \\*(f1 .ds f1 \\n(.f
 
19
.el .ie \\*(f2 .ds f2 \\n(.f
 
20
.el .ie \\*(f3 .ds f3 \\n(.f
 
21
.el .ie \\*(f4 .ds f4 \\n(.f
 
22
.el .tm ? font overflow
 
23
.ft \\$1
 
24
..
 
25
.de fP
 
26
.ie     !\\*(f4 \{\
 
27
.       ft \\*(f4
 
28
.       ds f4\"
 
29
'       br \}
 
30
.el .ie !\\*(f3 \{\
 
31
.       ft \\*(f3
 
32
.       ds f3\"
 
33
'       br \}
 
34
.el .ie !\\*(f2 \{\
 
35
.       ft \\*(f2
 
36
.       ds f2\"
 
37
'       br \}
 
38
.el .ie !\\*(f1 \{\
 
39
.       ft \\*(f1
 
40
.       ds f1\"
 
41
'       br \}
 
42
.el .tm ? font underflow
 
43
..
 
44
.ds f1\"
 
45
.ds f2\"
 
46
.ds f3\"
 
47
.ds f4\"
 
48
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
 
49
.TH "MrmRegisterNames" "library call"
 
50
.SH "NAME"
 
51
\fBMrmRegisterNames\fP \(em Registers the values associated with the names referenced in UIL (for example, UIL callback function names or UIL identifier names)
 
52
.iX "MrmRegisterNames"
 
53
.iX "uil functions" "MrmRegisterNames"
 
54
.SH "SYNOPSIS"
 
55
.PP
 
56
.nf
 
57
#include <Mrm/MrmPublic\&.h>
 
58
\fBCardinal \fBMrmRegisterNames\fP\fR(
 
59
\fBMrmRegisterArglist \fBregister_list\fR\fR,
 
60
\fBMrmCount \fBregister_count\fR\fR);
 
61
.fi
 
62
.iX "MRM function" "MrmRegisterNames"
 
63
.iX "MrmRegisterNames" "definition"
 
64
.SH "DESCRIPTION"
 
65
.PP
 
66
The
 
67
\fBMrmRegisterNames\fP
 
68
function
 
69
.iX "MrmRegisterNames" "description"
 
70
registers a vector of names and associated values
 
71
for access in MRM\&.
 
72
The values can be callback functions, pointers
 
73
to user-defined data, or any other values\&.
 
74
The information provided is used to resolve symbolic references
 
75
occurring in UID files to their run-time values\&.
 
76
For callbacks, this information provides the procedure address required
 
77
by the Motif Toolkit\&.
 
78
For names used as identifiers in UIL, this information
 
79
provides any
 
80
run-time mapping the application needs\&.
 
81
.PP
 
82
This function is similar to
 
83
\fBMrmRegisterNamesInHierarchy\fP,
 
84
except that the scope of the names registered by
 
85
\fBMrmRegisterNamesInHierarchy\fP
 
86
is limited to the hierarchy specified in the call to that function,
 
87
whereas the names registered by
 
88
\fBMrmRegisterNames\fP
 
89
have global scope\&.
 
90
When MRM looks up a name, it first tries to find the name among those
 
91
registered for the given hierarchy\&.
 
92
If that lookup fails, it tries to find the name among those registered
 
93
globally\&.
 
94
.IP "\fIregister_list\fP" 10
 
95
Specifies a list of name/value pairs for the names to be registered\&.
 
96
Each name is a case-sensitive, NULL-terminated ASCII string\&.
 
97
Each value is a 32-bit quantity, interpreted as a procedure address if
 
98
the name is a callback function, and uninterpreted otherwise\&.
 
99
.IP "\fIregister_count\fP" 10
 
100
Specifies the number of entries in
 
101
\fIregister_list\fP\&.
 
102
.PP
 
103
The names in the list are case-sensitive\&.
 
104
The list can be either ordered or unordered\&.
 
105
.PP
 
106
Callback functions registered through
 
107
\fBMrmRegisterNames\fP
 
108
can be either
 
109
regular or creation callbacks\&.
 
110
Regular callbacks have declarations determined by Motif Toolkit and user
 
111
requirements\&.
 
112
Creation callbacks have the same format as any other callback:
 
113
.PP
 
114
.nf
 
115
\fBvoid \fBCallBackProc\fP\fR(
 
116
\fBWidget *\fBwidget_id\fR\fR,
 
117
\fBOpaque \fBtag\fR\fR,
 
118
\fBXmAnyCallbackStruct *\fBcallback_data\fR\fR);
 
119
.fi
 
120
.IP "\fIwidget_id\fP" 10
 
121
Specifies the widget ID associated with the widget performing the
 
122
callback (as in any callback function)\&.
 
123
.IP "\fItag\fP" 10
 
124
Specifies the tag value (as in any callback function)\&.
 
125
.IP "\fIcallback_data\fP" 10
 
126
Specifies a widget-specific data structure\&.
 
127
This data structure has a minimum of two members: event and reason\&.
 
128
The reason member is always set to
 
129
\fBMrmCR_CREATE\fP\&.
 
130
.PP
 
131
Note that the widget name and parent are available from the widget
 
132
record accessible through
 
133
\fIwidget_id\fP\&.
 
134
.SH "RETURN"
 
135
.iX "MrmSUCCESS"
 
136
.iX "MrmFAILURE"
 
137
.PP
 
138
This function returns one of the following status return constants:
 
139
.IP "\fBMrmSUCCESS\fP" 10
 
140
The function executed successfully\&.
 
141
.IP "\fBMrmFAILURE\fP" 10
 
142
The function failed\&.
 
143
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:17