Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
XmString(3)		    Library Functions Manual		     XmString(3)

NAME
     XmString -- 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  de-
     termine 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 us-
     ing 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  ren-
     dition  tags  used  for  displaying a compound string text component with a
     rendition in a render table.

RELATED
     XmParseMapping(3),  XmParseMappingCreate(3),   XmParseMappingFree(3),   Xm-
     ParseMappingGetValues(3),	XmParseMappingSetValues(3), XmParseTable(3), Xm-
     ParseTableFree(3), XmStringBaseline(3),  XmStringByteCompare(3),  XmString-
     ByteStreamLength(3),  XmStringCompare(3),	XmStringComponentCreate(3),  Xm-
     StringComponentType(3),  XmStringConcat(3),  XmStringConcatAndFree(3),  Xm-
     StringCopy(3),  XmStringCreate(3), XmStringCreateLocalized(3), XmStringCre-
     ateLtoR(3), XmStringCreateSimple(3),  XmStringDirection(3),  XmStringDirec-
     tionCreate(3),  XmStringDirectionToDirection(3), XmStringDraw(3), XmString-
     DrawImage(3),   XmStringDrawUnderline(3),	 XmStringEmpty(3),   XmStringEx-
     tent(3),  XmStringFree(3), XmStringFreeContext(3), XmStringGenerate(3), Xm-
     StringGetLtoR(3),	XmStringGetNextComponent(3),  XmStringGetNextSegment(3),
     XmStringGetNextTriple(3),	XmStringHasSubstring(3),  XmStringHeight(3), Xm-
     StringInitContext(3),   XmStringIsVoid(3),   XmStringLength(3),   XmString-
     LineCount(3),  XmStringNConcat(3),  XmStringNCopy(3), XmStringParseText(3),
     XmStringPeekNextComponent(3), XmStringPeekNextTriple(3),  XmStringPutRendi-
     tion(3),	 XmStringSegmentCreate(3),    XmStringSeparatorCreate(3),    Xm-
     StringTable(3), XmStringTableParseStringArray(3),	XmStringTableProposeTab-
     list(3), XmStringTableToXmString(3), XmStringTableUnparse(3), XmStringToXm-
     StringTable(3),   XmStringUnparse(3),   XmStringWidth(3),	XmCvtXmStringTo-
     ByteStream(3),  XmCvtXmStringToCT(3),  XmCvtCTToXmString(3),   and   XmCvt-
     ByteStreamToXmString(3).

								     XmString(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmString&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help