XmString - Man Page

Data type for a compound string

Synopsis

#include <Xm/Xm​.h>

Description

XmString is the data type for a compound string​. Compound strings consist of a sequence of components, including, but not limited to, the following:

  ·

XmSTRING_COMPONENT_SEPARATOR

  ·

XmSTRING_COMPONENT_TAB

  ·

XmSTRING_COMPONENT_LAYOUT_POP

  ·

XmSTRING_COMPONENT_DIRECTION

  ·

XmSTRING_COMPONENT_LAYOUT_PUSH

  ·

XmSTRING_COMPONENT_CHARSET

  ·

XmSTRING_COMPONENT_FONTLIST_ELEMENT_TAG

  ·

XmSTRING_COMPONENT_LOCALE

  ·

XmSTRING_COMPONENT_LOCALE_TEXT

  ·

XmSTRING_COMPONENT_TAG

  ·

XmSTRING_COMPONENT_TEXT

  ·

XmSTRING_COMPONENT_END

  ·

XmSTRING_COMPONENT_RENDITION_BEGIN

  ·

XmSTRING_COMPONENT_RENDITION_END

  ·

XmSTRING_COMPONENT_UNKNOWN

  ·

XmSTRING_COMPONENT_WIDECHAR_TEXT

and also a rendition tags table, text, and text component​. When a compound string is displayed, the rendition tags and the direction are used to determine how to display the text​.

Calling XtGetValues for a resource whose type is XmString yields a copy of the compound string resource value​. The application is responsible for using XmStringFree to free the memory allocated for the copy​.

Please see the XmStringComponentType reference page for more detail about compound string components, and for a description of the order in which the components should appear in a compound string​. Refer to the XmRenderTable reference page for a description of the algorithm that associates the rendition tags used for displaying a compound string text component with a rendition in a render table​.