Sophie

Sophie

distrib > Mandriva > 10.2 > i586 > media > contrib > by-pkgid > a8d1ed0166ead8ba5e3035b537a5722e > files > 5

libXbae4-4.50.99-1mdk.i586.rpm

<!-- Creator     : groff version 1.19 -->
<!-- CreationDate: Fri Oct 29 22:10:31 2004 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<title>XbaeCaption</title>
</head>
<body>

<h1 align=center>XbaeCaption</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#RELEASE">RELEASE</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#Notice of Limitation">Notice of Limitation</a><br>

<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>XbaeCaption &minus; The Bellcore Application Environment
(BAE) XbaeCaption widget class.</p>
</td>
</table>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>#include &lt;Xbae/Caption.h&gt;</p>
</td>
</table>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XbaeCaption</b> is a simple manager used to associate
a label with its single child. The label may be either an
<b>XmString</b> or a Pixmap and can be displayed in any one
of twelve positions around the edge of the child.
<b>XbaeCaption</b> performs geometry management so that its
size always matches its child&rsquo;s size plus the size of
the label and label offset. By using <b>XbaeCaption</b> with
an <b>XmFrame</b> child, groups of related widgets can be
labeled in a visually appealing manner. <b>XbaeCaption</b>
is also useful for associating labels with individual
<b>XmTextFields</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>Classes</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XbaeCaption</b> inherits behavior and resources from
the <b>Core</b>, <b>Composite</b>, <b>Constraint</b> and
<b>XmManager</b> widget classes.<br>
The class pointer is <b>xbaeCaptionWidgetClass</b>.<br>
The class name is <b>XbaeCaption</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>New Resources</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>The following table lists the new resources defined by
<b>XbaeCaption</b>. The codes in the Access column indicate
whether the given resource can be set at creation time (C),
or set by using XtSetValues (S), or retrieved by using
XtGetValues (G).</p>
</td>
</table>


<p align=center><img src="images/grohtml-XbaeCaption1.png"></p>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNfontList</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the font of the text used in the caption label.
If this value is <small>NULL</small> at initialization, it
is initialized by looking up the parent hierarchy of the
widget for an ancestor that is a subclass of the
<b>XmBulletinBoard</b>, <b>VendorShell</b> or
<b>XmMenuShell</b> widget class. If such an ancestor is
found, the font list is initialized to the appropriate
default font list of the ancestor widget
<b>XmNdefaultFontList for VendorShell</b> and
<b>XmMenuShell</b>, <b>XmNlabelFontList</b> or
<b>XmNbuttonFontList</b> for <b>XmBulletinBoard.</b> Refer
to <b>XmFontList(3X)</b> for more information on the
creation and structure of a font list. This resource is
copied.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelAlignment</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the alignment of the caption label along the
side of the caption child. Must be one of the enumerated
<b>XbaeLabelAlignment</b> types:
<b>XbaeAlignmentTopOrLeft</b>, <b>XbaeAlignmentCenter</b>,
<b>XbaeAlignmentBottomOrRight</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelOffset</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the offset, in pixels, of the caption label
from the caption child. If the offset is negative, then the
caption label will overlap the caption child by that many
pixels.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelPixmap</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the caption label pixmap when
<b>XmNlabelType</b> is <b>XmPIXMAP</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelPosition</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies on which side of the caption child the caption
label should be placed. Must be one of the enumerated
<b>XbaeLabelPosition</b> types: <b>XbaePositionLeft</b>,
<b>XbaePositionRight</b>, <b>XbaePositionTop</b>,
<b>XbaePositionBottom</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelString</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the compound string when the <b>XmNlabelType is
XmSTRING</b>. If this value is <small>NULL,</small> it is
initialized by converting the name of the widget to a
compound string. Refer to <b>XmString(3X)</b> for more
information on the creation and structure of compound
strings.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelTextAlignment</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the text alignment for the caption label. This
resource is only useful for multi line caption labels. Valid
values are: <b>XmALIGNMENT_BEGINNING</b> left alignment
causes the left sides of the lines of text to be vertically
aligned. <b>XmALIGNMENT_CENTER</b> center alignment causes
the centers of the lines of text to be vertically aligned.
<b>XmALIGNMENT_END</b> right alignment causes the right
sides of the lines of text to be vertically aligned.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XmNlabelType</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Specifies the caption label type. Valid values are:
<b>XmSTRING</b> - the caption label will display the
<b>XmNlabelString</b>. <b>XmPIXMAP</b> - the caption label
will display the <b>XmNlabelPixmap</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>Inherited Resources</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>The following table lists the resources which
<b>XbaeCaption</b> inherits from it&rsquo;s superclasses
<b>XmManager</b>, <b>Compositeand Core</b>. For a complete
description of each resource, refer to the man page for that
superclass. The codes in the &quot;Access&quot; column
indicate whether the given resource can be set at creation
time (C), or set by using XtSetValues (S), or retrieved by
using XtGetValues (G).</p>
</td>
</table>


<p align=center><img src="images/grohtml-XbaeCaption2.png"></p>


<p align=center><img src="images/grohtml-XbaeCaption3.png"></p>


<p align=center><img src="images/grohtml-XbaeCaption4.png"></p>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>Translations</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>XbaeCaption inherits translations from
XmManager</b>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>Type Converters</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>In addition to the standard type converters registered by
Xt and Motif, <b>XbaeCaption</b> registers the following
additional type converters:</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><tt>CvtStringToLabelAlignment()</tt></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="22%"></td>
<td width="78%">
<p>Converts a String to the enumerated
<b>XbaeLabelAlignment</b> type. The Strings
<b>TopOrLeft</b>, <b>Top</b> and <b>Left</b> are converted
to <b>XbaeAlignmentTopOrLeft</b>. The String <b>Center</b>
is converted to <b>XbaeAlignmentCenter</b>. The Strings
<b>BottomOrRight</b>, <b>Bottom</b> and <b>Right</b> are
converted to <b>XbaeAlignmentBottomOrRight</b>. This
converter allows the <b>XmNlabelAlignment</b> resource to be
specified in a resource file. The converter is case
insensitive.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><tt>CvtStringToLabelPosition()</tt></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="22%"></td>
<td width="78%">
<p>Converts a String to the enumerated
<b>XbaeLabelPosition</b> type. The String <b>Left</b> is
converted to <b>XbaePositionLeft</b>. The String
<b>Right</b> is converted to <b>XbaePositionRight</b>. The
String <b>Top is converted to XbaePositionTop</b>. The
String <b>Bottom is converted to XbaePositionBottom</b>.
This converter allows the <b>XmNlabelPosition</b> resource
to be specified in a resource file. The converter is case
insensitive.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>Public Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>The following external entry points to <b>XbaeCaption</b>
class methods are defined:</p>
<!-- INDENTATION -->
<p><b>XbaeCreateCaption()</b></p>
</td>
</table>


<p align=center><img src="images/grohtml-XbaeCaption5.png"></p>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
       cols="4" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="22%"></td>
<td width="12%">

<p><i>parent</i></p>
</td>
<td width="3%"></td>
<td width="63%">

<p>Specifies the parent widget ID.</p>
</td>
<tr valign="top" align="left">
<td width="22%"></td>
<td width="12%">

<p><i>name</i></p>
</td>
<td width="3%"></td>
<td width="63%">

<p>Specifies the name of the created widget</p>
</td>
<tr valign="top" align="left">
<td width="22%"></td>
<td width="12%">

<p><i>arglist</i></p>
</td>
<td width="3%"></td>
<td width="63%">

<p>Specifies the argument list</p>
</td>
<tr valign="top" align="left">
<td width="22%"></td>
<td width="12%">

<p><i>argcount</i></p>
</td>
<td width="3%"></td>
<td width="63%">

<p>Specifies the number of attribute/value pairs in the
argument list (arglist)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="22%"></td>
<td width="78%">
<p><b>XbaeCreateCaption()</b> creates an instance of an
XbaeCaption widget and returns the associated widget ID.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="5%"></td>
<td width="95%">
<p><b>Virtual Bindings</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>The bindings for virtual keys are vendor specific. For
information about bindings for virtual buttons and keys, see
<b>VirtualBindings(3X)</b>.</p>
</td>
</table>
<a name="AUTHOR"></a>
<h2>AUTHOR</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>Andrew Wason,</b> Bellcore, Piscataway NJ; author<br>
(aw@bae.bellcore.com)</p>
<!-- INDENTATION -->
<p><b>Andrew Lister</b><br>
(lister@db.com)</p>
</td>
</table>
<a name="RELEASE"></a>
<h2>RELEASE</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>This document describes XbaeCaption from Xbae Version
4.9.</p>
</td>
</table>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>Core(3X), Composite(3X), XmManager(3X),
XmLabel(3X)</b></p>
</td>
</table>
<a name="Notice of Limitation"></a>
<h2>Notice of Limitation</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p>Bellcore, previous and current maintainers of the Xbae
widgets (collectively &rsquo;authors&rsquo;) provide this
information solely to professionals who have the appropriate
degree of experience to understand and interpret its
contents in accordance with generally accepted engineering
or other professional standards and applicable regulations.
No recommendations as to products or vendors is made or
should be implied.</p>
<!-- INDENTATION -->
<p>While the information contained herein has been prepared
from sources deemed to be reliable, the authors reserve the
right to revise the information without notice, but have no
obligation to do so. Unless the recipient has been expressly
granted a license by Bellcore under separate applicable
written agreement with Bellcore, no license, expressed or
implied, is granted under any patents, copyrights or other
intellectual property rights. Use of the information is at
your discretion and shall not be deemed an inducement by
Bellcore to infringe any existing or later-issued patent,
copyrights or other intellectual property right.</p>
<!-- INDENTATION -->
<p>THE AUTHORS MAKE NO REPRESENTATIONS AND EXTENDS NO
WARRANTIES, EXPRESS OR IMPLIED, WITH RESPECT TO THE
INFORMATION, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ANY PARTICULAR
PURPOSE, AND THE WARRANTY AGAINST INFRINGEMENT OF PATENTS OR
OTHER INTELLECTUAL PROPERTY RIGHTS. THE INFORMATION IS
PROVIDED &lsquo;&lsquo;AS IS&rsquo;&rsquo;, AND IN NO EVENT
SHALL THE AUTHORS OR ANY OF ITS AFFILIATES BE LIABLE FOR ANY
DAMAGES, INCLUDING ANY LOST PROFITS OR OTHER INCIDENTAL OR
CONSEQUENTIAL DAMAGES RELATING TO THE INFORMATION.</p>
<!-- INDENTATION -->
<p>Copyright 1991 Bellcore. All Rights Reserved. Copyright
1995-99 Andrew Lister All Rights Reserved.<br>
Copyright 1999-2002 LessTif Developers</p>
<!-- INDENTATION -->
<p>The above no warranty extends to all additions and
contributions. No contributor shall be held liable; this
work is provided &lsquo;&lsquo;as is&rsquo;&rsquo;. If this
is a problem for you, then don&rsquo;t use this
software.</p>
</td>
</table>
<hr>
</body>
</html>