Linux Manuals session 3

XmStringParseText — A function that converts a character string to a compound string Synopsis #include <Xm/Xm.h> XmString XmStringParseText( XtPointer text, XtPointer *text_end, XmStringTag tag, XmTextType type, XmParseTable parse_table, Cardinal parse_count, XtPointer call_data); Description XmStringParseText converts characters specified in text to corresponding components in the returned compound string. The resulting compound string consists of at least…

XmStringNCopy — A compound string function that creates a copy of a compound string Synopsis #include <Xm/Xm.h> XmString XmStringNCopy( XmString s1, int num_bytes); Description This function is obsolete and exists for compatibility with previous releases. XmStringNCopy creates a copy of s1 that contains a specified number of bytes, including tags, directional indicators, and separators. It…

XmStringNConcat — A compound string function that appends a specified number of bytes to a compound string Synopsis #include <Xm/Xm.h> XmString XmStringNConcat( XmString s1, XmString s2, int num_bytes); Description This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringConcat. XmStringNConcat appends a specified number of bytes from s2 to…

XmStringLineCount — A compound string function that returns the number of separators plus one in the provided compound string Synopsis #include <Xm/Xm.h> int XmStringLineCount( XmString string); Description XmStringLineCount returns the number of separators plus one in the provided compound string. In effect, it counts the lines of text. string Specifies the string Return Returns the…

XmStringLength — A compound string function that obtains the length of a compound string Synopsis #include <Xm/Xm.h> int XmStringLength( XmString s1); Description This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringByteStreamLength. XmStringLength obtains the length of a compound string. It returns the number of bytes in s1 including…

XmStringIsVoid — A compound string function that provides information on the existence of non-zero-length text components, tab components, or separator components Synopsis #include <Xm/Xm.h> Boolean XmStringIsVoid( XmString s1); Description XmStringIsVoid returns a Boolean value indicating whether or not string s1 is void. s1 Specifies the compound string Return Returns True if any non-zero-length text components,…

XmStringInitContext — A compound string function that creates a data structure for scanning an XmString component by component Synopsis #include <Xm/Xm.h> Boolean XmStringInitContext( XmStringContext * context, XmString string); Description XmStringInitContext creates a context to allow applications to read out the contents of a compound string component by component. A Boolean status is returned to indicate…

XmStringHeight — A compound string function that returns the line height of the given compound string Synopsis #include <Xm/Xm.h> Dimension XmStringHeight( XmRenderTable rendertable, XmString string); Description XmStringHeight returns the height, in pixels, of the sum of all the line heights of the given compound string. Separator components delimit lines. rendertable Specifies the render table string…

XmStringHasSubstring — A compound string function that indicates whether one compound string is contained within another Synopsis #include <Xm/Xm.h> Boolean XmStringHasSubstring( XmString string, XmString substring); Description XmStringHasSubstring indicates whether or not one compound string is contained within another. string Specifies the compound string to be searched substring Specifies the compound string to be searched for…

XmStringGetNextTriple — An XmString function that returns the type, length, and value of the next component in the compound string Synopsis #include <Xm/Xm.h> XmStringComponentType XmStringGetNextTriple( XmStringContext context, unsigned int *length, XtPointer *value); Description XmStringGetNextTriple returns the type, length, and value of the next component in the compound string identified by context. This function returns one…

XmStringGetNextSegment — A compound string function that fetches the bytes in the next segment of a compound string Synopsis #include <Xm/Xm.h> Boolean XmStringGetNextSegment( XmStringContext context, char **text, XmStringTag *tag, XmStringDirection *direction, Boolean *separator); Description This routine is obsolete and exists for compatibility with previous releases. To read the contents of a compound string, read each…

XmStringGetNextComponent — A compound string function that returns the type and value of the next component in a compound string Synopsis #include <Xm/Xm.h> XmStringComponentType XmStringGetNextComponent( XmStringContext context, char **text, XmStringTag *tag, XmStringDirection *direction, XmStringComponentType *unknown_tag, unsigned short *unknown_length, unsigned char **unknown_value); Description This function is obsolete and exists for compatibility with previous releases. It is…

XmStringGetLtoR — A compound string function that searches for a text segment in the input compound string Synopsis #include <Xm/Xm.h> Boolean XmStringGetLtoR( XmString string, XmStringCharSet tag, char **text); Description This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringUnparse. XmStringGetLtoR returns the first text component in the input compound…

XmStringGenerate — A convenience function that generates a compound string Synopsis #include <Xm/Xm.h> XmString XmStringGenerate( XtPointer text, XmStringTag tag, XmTextType type, XmStringTag rendition); Description XmStringGenerate calls the XmStringParseText function with a default parse table of entries consisting of ‘&’, which maps to Separator, and ‘ ‘, which maps to Tab. Matching RENDITION_BEGIN and RENDITION_END components…

XmStringFreeContext — A compound string function that releases the string scanning context data structure Synopsis #include <Xm/Xm.h> void XmStringFreeContext( XmStringContext context); Description XmStringFreeContext releases the string scanning context data structure. context Specifies the string context structure that was allocated by the XmStringInitContext function Related XmStringCreate(3) and XmStringInitContext(3).

XmStringFree — A compound string function that conditionally deallocates memory Synopsis #include <Xm/Xm.h> void XmStringFree( XmString string); Description XmStringFree conditionally recovers memory used by a compound string. Applications should call XmStringFree when the application no longer needs string. string Specifies the compound string to be freed Related XmStringCreate(3).

XmStringExtent — A compound string function that determines the size of the smallest rectangle that will enclose the compound string Synopsis #include <Xm/Xm.h> void XmStringExtent( XmRenderTable rendertable, XmString string, Dimension *width, Dimension *height); Description XmStringExtent determines the width and height, in pixels, of the smallest rectangle that will enclose the provided compound string. rendertable Specifies…

XmStringEmpty — A compound string function that provides information on the existence of non-zero-length text components Synopsis #include <Xm/Xm.h> Boolean XmStringEmpty( XmString s1); Description XmStringEmpty returns a Boolean value indicating whether any non-zero-length text components exist in the provided compound string. It returns True if there are no text segments in the string. If this…

XmStringDrawUnderline — A compound string function that underlines a string drawn in an X Window Synopsis #include <Xm/Xm.h> void XmStringDrawUnderline( Display * d, Window w, XmRenderTable rendertable, XmString string, GC gc, Position x, Position y, Dimension width, unsigned char alignment, unsigned char layout_direction, XRectangle * clip, XmString underline); Description XmStringDrawUnderline draws a compound string in…

XmStringDrawImage — A compound string function that draws a compound string in an X Window and creates an image Synopsis #include <Xm/Xm.h> void XmStringDrawImage( Display * d, Window w, XmRenderTable rendertable, XmString string, GC gc, Position x, Position y, Dimension width, unsigned char alignment, unsigned char layout_direction, XRectangle * clip); Description XmStringDrawImage draws a compound…