Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
cc [flag...] file... -ltsol -lDtTsol [library...]
#include <Dt/label_clipping.h> XmString Xbsltos(Display *display, const m_label_t *senslabel, Dimension width, const XmFontList fontlist, const int flags);
XmString Xbcleartos(Display *display, const m_label_t *clearance, Dimension width, const XmFontList fontlist, const int flags);
The calling process must have PRIV_SYS_TRANS_LABEL in its set of effective privileges to translate labels or clearances that dominate the current process' sensitivity label. display
The structure controlling the connection to an X Window System display.
The sensitivity label to be translated.
The clearance to be translated.
The width of the translated label or clearance in pixels. If the specified width is shorter than the full label, the label is clipped and the presence of clipped letters is indicated by an arrow. In this example, letters have been clipped to the right of: TS<-. See the sbltos(3TSOL) manual page for more information on the clipped indicator. If the specified width is equal to the display width (display), the label is not truncated, but word-wrapped using a width of half the display width.
A list of fonts and character sets where each font is associated with a character set.
The value of flags indicates which words in the label_encodings(4) file are used for the translation. See the bltos(3TSOL) manual page for a description of the flag values: LONG_WORDS, SHORT_WORDS, LONG_CLASSIFICATION, SHORT_CLASSIFICATION, ALL_ENTRIES, ACCESS_RELATED, VIEW_EXTERNAL, VIEW_INTERNAL, NO_CLASSIFICATION. BRACKETED is an additional flag that can be used with Xbsltos() only. It encloses the sensitivity label in square brackets as follows: [C].
These functions return a compound string that represents the character-coded form of the sensitivity label or clearance that is translated. The compound string uses the language and fonts specified in fontlist and is clipped to width. These functions return NULL if the label or clearance is not a valid, required type as defined in the label_encodings(4) file, or not dominated by the process' sensitivity label and the PRIV_SYS_TRANS_LABEL privilege is not asserted.
Header file for label clipping functions
The label encodings file contains the classification names, words, constraints, and values for the defined labels of this system.
Example 1 Translate and Clip a Clearance.
This example translates a clearance to text using the long words specified in the label_encodings(4) file, a font list, and clips the translated clearance to a width of 72 pixels.
xmstr = Xbcleartos(XtDisplay(topLevel), &clearance, 72, fontlist, LONG_WORDS
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Obsolete |
| MT-Level MT-Safe |
The labelclipping functions, Xbsltos() and Xbcleartos(), are obsolete. Use the label_to_str(3TSOL) function instead.
bltos(3TSOL), label_to_str(3TSOL), libtsol(3LIB), label_encodings(4), attributes(5)
See XmStringDraw(3) and FontList(3) for information on the creation and structure of a font list.
The functionality described on this manual page is available only if the system is configured with Trusted Extensions.