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

FreeBSD Manual Pages

  
 
  

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

NAME
     XmtLayoutString - an XmtLayout gadget that displays a string.

SYNOPSIS
     Include File:
	    #include <Xmt/LayoutG.h>

     Constructor:
	    XmtCreateLayoutString()

     Class Name:
	    XmtLayoutString

     Class Pointer:
	    xmtLayoutStringGadgetClass

     Class Hierarchy:
	    RectObj -> XmtLayoutGadget -> XmtLayoutString

DESCRIPTION
     The  XmtLayoutString  widget  is  a  gadget  that displays a Motif XmString
     within the XmtLayout widget. Because it is specially implemented  for  this
     purpose,  it is significantly cheaper to use than an XmLabel or an XmLabel-
     Gadget.  The text is displayed  using  the  Motif	XmStringDraw()	function
     which supports strings with multiple lines and multiple fonts.

     The  LayoutString gadget does not have an XmFontList of its own; the string
     is drawn using the XmtNfontList resource of the Layout  widget,  which  can
     contain  whatever	fonts  are needed for text throughout the Layout widget.
     When the XmtNfontList resource of the Layout widget  changes,  it	notifies
     all  of its LayoutString children so that they can redisplay themselves us-
     ing the new font list.

     RESOURCES

     XmtLayoutString inherits the resources of the RectObj  and  XmtLayoutGadget
     classes, and defines the following new resources:

     +-----------------+-------------+----------------+--------+-------------+
     | Name	       | Type	     | Class	      | Access | Default     |
     +-----------------+-------------+----------------+--------+-------------+
     | XmtNbackground  | XtRPixel    | XtCBackground  | CSG    | unspecified |
     +-----------------+-------------+----------------+--------+-------------+
     | XmtNforeground  | XtRPixel    | XtCForeground  | CSG    | unspecified |
     +-----------------+-------------+----------------+--------+-------------+
     | XmtNlabel       | XtRString   | XtCLabel       | CS     | NULL	     |
     +-----------------+-------------+----------------+--------+-------------+
     | XmtNlabelString | XmRXmString | XmCLabelString | CSG    | NULL	     |
     +-----------------+-------------+----------------+--------+-------------+

     XmtNbackground
	    The  background color to use for the displayed text. If unspecified,
	    the LayoutString gadget will use the background color of its  Layout
	    parent.

     XmtNforeground
	    The  foreground color to use for the displayed text. If unspecified,
	    the LayoutString gadget will use the foreground color of its  Layout
	    parent.

     XmtNlabel
	    The  string to display if the XmtNlabelString resource is not speci-
	    fied. If no XmString is specified for the XmtNlabelString  resource,
	    then this string (a normal NULL-terminated C string) is converted to
	    an	XmString  using XmtCreateXmString() and stored on the XmtNlabel-
	    String resource. Note that the value of this string is not copied by
	    the LayoutString gadget. It is converted to an  XmString,  and  then
	    the  LayoutString  gadget  ``forgets'' it, since it is not stored in
	    memory owned by the gadget. This means that querying  this	resource
	    will always return an empty string.

     XmtNlabelString
	    An XmString to be displayed by the LayoutString gadget.  If this re-
	    source  is	not  specified,  the XmtNlabel resource will be used in-
	    stead. Note that unlike XmtNlabel, this resource is  copied  by  the
	    gadget, and can be queried.

SEE ALSO
     Chapter 19, The Layout Widget: The Details, XmtCreateLayoutString(),
     XmtLayout, XmtLayoutBox, XmtLayoutPixmap, XmtLayoutSeparator,
     XmtLayoutSpace.

Xmt				   Motif Tools		      XmtLayoutString(3)

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

home | help