


XmScreen(3X)							 XmScreen(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmSSccrreeeenn - The Screen	widget class

SYNOPSIS

  ##iinncclluuddee <<XXmm//SSccrreeeenn..hh>>

DESCRIPTION

  The XmScreen object is used by Motif widgets to store	information that is
  specific to a	screen.	 It also allows	the toolkit to store certain informa-
  tion on widget hierarchies that would	otherwise be unavailable.  Each
  client has one XmScreen object for each screen that it accesses.

  An XmScreen object is	automatically created when the application creates
  the first shell on a screen (usually accomplished by a call to XXttAAppppIInnii--
  ttiiaalliizzee or XXttAAppppCCrreeaatteeSShheellll).	 It is not necessary to	create an XmScreen
  object by any	other means.  An application can use the function
  XXmmGGeettXXmmSSccrreeeenn	to obtain the widget ID	of the XmScreen	object for a given
  screen.

  An application cannot	supply initial values for XmScreen resources as	argu-
  ments	to a call to any function that creates widgets.	 The application or
  user can supply initial values in a resource file.  After creating the
  first	shell on the screen, the application can use XXmmGGeettXXmmSSccrreeeenn to obtain
  the widget ID	of the XmScreen	object and then	call XXttSSeettVVaalluueess to set	the
  XmScreen resources.

  Classes

  Screen inherits behavior and resources from CCoorree.

  The class pointer is xxmmSSccrreeeennCCllaassss.

  The class name is XXmmSSccrreeeenn.

  New Resources

  The following	table defines a	set of widget resources	used by	the program-
  mer to specify data.	The programmer can also	set the	resource values	for
  the inherited	classes	to set attributes for this widget.  To reference a
  resource by name or by class in an ..XXddeeffaauullttss	file, remove the XXmmNN or	XXmmCC
  prefix and use the remaining letters.	 To specify one	of the defined values
  for a	resource in an ..XXddeeffaauullttss file,	remove the XXmm prefix and use the
  remaining letters (in	either lowercase or uppercase, but include any under-
  scores between words).  The codes in the access column indicate if the
  given	resource can be	set at creation	time (C), set by using XXttSSeettVVaalluueess
  (S), retrieved by using XXttGGeettVVaalluueess (G), or is not applicable	(N/A).

			     XXmmSSccrreeeenn RReessoouurrccee SSeett
       _________________________________________________________________
       NNaammee				   DDeeffaauulltt		  AAcccceessss
	     CCllaassss				 TTyyppee
       _________________________________________________________________
       _________________________________________________________________
       XmNdarkThreshold			   dynamic		  C
	     XmCDarkThreshold			  int
       _________________________________________________________________
       XmNdefaultCopyCursorIcon		   NULL			  CSG
	     XmCDefaultCopyCursorIcon		  Widget
       _________________________________________________________________
       XmNdefaultInvalidCursorIcon	   NULL			  CSG
	     XmCDefaultInvalidCursorIcon	  Widget
       _________________________________________________________________
       XmNdefaultLinkCursorIcon		   NULL			  CSG
	     XmCDefaultLinkCursorIcon		  Widget
       _________________________________________________________________
       XmNdefaultMoveCursorIcon		   NULL			  CSG
	     XmCDefaultMoveCursorIcon		  Widget
       _________________________________________________________________
       XmNdefaultNoneCursorIcon		   NULL			  CSG
	     XmCDefaultNoneCursorIcon		  Widget
       _________________________________________________________________
       XmNdefaultSourceCursorIcon	   NULL			  CSG
	     XmCDefaultSourceCursorIcon		  Widget
       _________________________________________________________________
       XmNdefaultValidCursorIcon	   NULL			  CSG
	     XmCDefaultValidCursorIcon		  Widget
       _________________________________________________________________
       XmNfont				   NULL			  CSG
	     XmCFont				  XFontStruct *
       _________________________________________________________________
       XmNforegroundThreshold		   dynamic		  C
	     XmCForegroundThreshold		  int
       _________________________________________________________________
       XmNhorizontalFontUnit		   dynamic		  CSG
	     XmCHorizontalFontUnit		  int
       _________________________________________________________________
       XmNlightThreshold		   dynamic		  C
	     XmCLightThreshold			  int
       _________________________________________________________________
       XmNmenuCursor			   arrow		  C
	     XmCCursor				  String
       _________________________________________________________________
       XmNmoveOpaque			   False		  CSG
	     XmCMoveOpaque			  Boolean
       _________________________________________________________________
       XmNunpostBehavior		   XmUNPOST_AND_REPLAY	  CSG
	     XmCUnpostBehavior			  unsigned char
       _________________________________________________________________
       XmNverticalFontUnit		   dynamic		  CSG
	     XmCVerticalFontUnit		  int
       _________________________________________________________________

  XXmmNNddaarrkkTThhrreesshhoolldd
      An integer between 0 and 100, inclusive, that specifies a	level of per-
      ceived brightness	for a color.  If the perceived brightness of the
      background color is below	this level, Motif treats the background	as
      "dark" when computing default shadow and select colors.  If this
      resource is specified for	a particular screen, it	applies	to widgets
      created on that screen; otherwise	it applies to widgets created on all
      screens.	The default value is implementation specific.

  XXmmNNddeeffaauullttCCooppyyCCuurrssoorrIIccoonn
      Specifies	the DragIcon used during a drag	operation when the operation
      is a copy	and no other pixmap is specified by the	application.  If
      NULL, a system default icon is used.

  XXmmNNddeeffaauullttIInnvvaalliiddCCuurrssoorrIIccoonn
      Specifies	the DragIcon used to indicate that the cursor is over an
      invalid drop site	during a drag operation	when no	other pixmap symbol
      is specified by the application.	If NULL, a system default icon is
      used.

  XXmmNNddeeffaauullttLLiinnkkCCuurrssoorrIIccoonn
      Specifies	the DragIcon used during a drag	operation when the operation
      is a link	and no other pixmap is specified by the	application.  If
      NULL, a system default icon is used.

  XXmmNNddeeffaauullttMMoovveeCCuurrssoorrIIccoonn
      Specifies	the DragIcon used during a drag	operation when the operation
      is a move	and no other pixmap is specified by the	application.  If
      NULL, a system default icon is used.

  XXmmNNddeeffaauullttNNoonneeCCuurrssoorrIIccoonn
      Specifies	the DragIcon used to indicate that the cursor is not over a
      drop site	during a drag operation	when no	other pixmap is	specified by
      the application.	If NULL, a system default icon is used.

  XXmmNNddeeffaauullttSSoouurrcceeCCuurrssoorrIIccoonn
      Specifies	the depth-1 pixmap used	as a cursor when an XXmmNNssoouurrcceeCCuurrssoorrII--
      ccoonn is not provided by the DragContext, or it is not usable.  If NULL,
      a	system default icon is used.

  XXmmNNddeeffaauullttVVaalliiddCCuurrssoorrIIccoonn
      Specifies	the DragIcon used to indicate that the cursor is over a	valid
      drop site	during a drag operation	when no	other pixmap is	specified by
      the application.	If NULL, a system default icon is used.

  XXmmNNffoonntt
      Specifies	a font for use in computing values for XXmmNNhhoorriizzoonnttaallFFoonnttUUnniitt
      and XXmmNNvveerrttiiccaallFFoonnttUUnniitt.	When an	application is initialized, this
      resource can be supplied in a resource file or through the standard
      command line options --ffnn,	--ffoonntt, and --xxrrmm.

  XXmmNNffoorreeggrroouunnddTThhrreesshhoolldd
      An integer between 0 and 100, inclusive, that specifies a	level of per-
      ceived brightness	for a color.  If the perceived brightness of the
      background color is equal	to or below this level,	Motif treats the
      background as "dark" when	computing the default foreground and
      highlight	colors.	 If the	perceived brightness of	the background color
      is above this level, Motif treats	the background as "light" when com-
      puting the default foreground and	highlight colors.  When	the back-
      ground is	"dark",	the default foreground and highlight is	white; when
      the background is	"light", the default foreground	and highlight is
      black.  If this resource is specified for	a particular screen, it
      applies to widgets created on that screen; otherwise, it applies to
      widgets created on all screens.  The default value is implementation
      specific.

  XXmmNNhhoorriizzoonnttaallFFoonnttUUnniitt
      Specifies	the horizontal component of the	font units used	by XXmmCCoonnvveerr--
      ttUUnniittss, and is used to interpret the values of geometry resources	when
      the XXmmNNsshheellllUUnniittTTyyppee resource of VendorShell or the XXmmNNuunniittTTyyppee
      resource of Gadget, Manager, or Primitive	has the	value
      XXmm110000TTHH__FFOONNTT__UUNNIITTSS.  If no initial value is supplied for this resource,
      the default is computed from the font specified in XXmmNNffoonntt.  If no ini-
      tial value is supplied for this resource or for XXmmNNffoonntt, the default is
      10.

      If a call	to XXttSSeettVVaalluueess specifies a value for XXmmNNhhoorriizzoonnttaallFFoonnttUUnniitt,
      this resource is set to that value.  If a	call to	XXttSSeettVVaalluueess specifies
      a	value for XXmmNNffoonntt but not for XXmmNNhhoorriizzoonnttaallFFoonnttUUnniitt, this resource is
      set to a value computed from the new XXmmNNffoonntt.

      A	horizontal font	unit is	derived	from a font as follows:

	oo++
	If the font has	an AAVVEERRAAGGEE__WWIIDDTTHH property, the horizontal font unit
	is the AAVVEERRAAGGEE__WWIIDDTTHH property divided by 10.

	oo++
	If the font has	no AAVVEERRAAGGEE__WWIIDDTTHH property but has a QQUUAADD__WWIIDDTTHH pro-
	perty, the horizontal font unit	is the QQUUAADD__WWIIDDTTHH property.

	oo++
	If the font has	no AAVVEERRAAGGEE__WWIIDDTTHH or QQUUAADD__WWIIDDTTHH property, the horizon-
	tal font unit is the sum of the	font structure's _m_i_n__b_o_u_n_d_s._w_i_d_t_h and
	_m_a_x__b_o_u_n_d_s._w_i_d_t_h divided by 2.3.

  XXmmNNlliigghhttTThhrreesshhoolldd
      An integer between 0 and 100, inclusive, that specifies a	level of per-
      ceived brightness	for a color.  If the perceived brightness of the
      background color is above	this level, Motif treats the background	as
      "light" when computing default shadow and	select colors.	If this
      resource is specified for	a particular screen, it	applies	to widgets
      created on that screen; otherwise, it applies to widgets created on all
      screens.	The default value is implementation specific.

  XXmmNNmmeennuuCCuurrssoorr
      Sets a variable that controls the	cursor used whenever this application
      posts a menu.  This resource can be specified only once at application
      startup time, either by placing it within	a defaults file	or by using
      the --xxrrmm command line argument.  For example

	   mmyyPPrroogg --xxrrmm ""**mmeennuuCCuurrssoorr:: aarrrrooww""

      The menu cursor can also be selected in the program through the func-
      tion XXmmSSeettMMeennuuCCuurrssoorr.  The following is a	list of	acceptable cursor
      names.  If the application does not specify a cursor or if an invalid
      name is supplied,	the default cursor (an arrow pointing up and to	the
      right) is	used.

      XX__ccuurrssoorr		    fflleeuurr	     ssaaiillbbooaatt
      aarrrrooww		    ggoobbbblleerr	     ssbb__ddoowwnn__aarrrrooww
      bbaasseedd__aarrrrooww__ddoowwnn	    gguummbbyy	     ssbb__hh__ddoouubbllee__aarrrrooww
      bbaasseedd__aarrrrooww__uupp	    hhaanndd11	     ssbb__lleefftt__aarrrrooww
      bbooaatt		    hhaanndd22	     ssbb__rriigghhtt__aarrrrooww
      bbooggoossiittyy		    hheeaarrtt	     ssbb__uupp__aarrrrooww
      bboottttoomm__lleefftt__ccoorrnneerr    iiccoonn	     ssbb__vv__ddoouubbllee__aarrrrooww
      bboottttoomm__rriigghhtt__ccoorrnneerr   iirroonn__ccrroossss	     sshhuuttttllee
      bboottttoomm__ssiiddee	    lleefftt__ppttrr	     ssiizziinngg
      bboottttoomm__tteeee	    lleefftt__ssiiddee	     ssppiiddeerr
      bbooxx__ssppiirraall	    lleefftt__tteeee	     sspprraayyccaann
      cceenntteerr__ppttrr	    lleeffttbbuuttttoonn	     ssttaarr
      cciirrccllee		    llll__aannggllee	     ttaarrggeett
      cclloocckk		    llrr__aannggllee	     ttccrroossss
      ccooffffeeee__mmuugg	    mmaann		     ttoopp__lleefftt__aarrrrooww
      ccrroossss		    mmiiddddlleebbuuttttoonn     ttoopp__lleefftt__ccoorrnneerr
      ccrroossss__rreevveerrssee	    mmoouussee	     ttoopp__rriigghhtt__ccoorrnneerr
      ccrroosssshhaaiirr		    ppeenncciill	     ttoopp__ssiiddee
      ddiiaammoonndd__ccrroossss	    ppiirraattee	     ttoopp__tteeee
      ddoott		    pplluuss	     ttrreekk
      ddoottbbooxx		    qquueessttiioonn__aarrrrooww   uull__aannggllee
      ddoouubbllee__aarrrrooww	    rriigghhtt__ppttrr	     uummbbrreellllaa
      ddrraafftt__llaarrggee	    rriigghhtt__ssiiddee	     uurr__aannggllee
      ddrraafftt__ssmmaallll	    rriigghhtt__tteeee	     wwaattcchh
      ddrraappeedd__bbooxx	    rriigghhttbbuuttttoonn	     xxtteerrmm
      eexxcchhaannggee		    rrttll__llooggoo

  XXmmNNmmoovveeOOppaaqquuee
      Specifies	whether	an interactive operation that moves a window, such as
      tearing off and dragging a tear-off menu or moving a window in MWM,
      displays an outline of the window	or a representation of the window
      itself during the	move.  If the value is True, the operation displays a
      representation of	the window during the move.  If	the value is False,
      the operation displays an	outline	of the window.

  XXmmNNuunnppoossttBBeehhaavviioorr
      Specifies	the behavior of	an active menu posted in traversal mode	when
      a	subsequent menu	button selection is made outside the posted menu.
      When the value is	XXmmUUNNPPOOSSTT__AANNDD__RREEPPLLAAYY, the resource unposts the menu
      hierarchy	and causes the server to replay	the event to the window	in
      which the	pointer	is located.  When the value is XXmmUUNNPPOOSSTT, the resource
      unposts the hierarchy without replaying the event.

  XXmmNNvveerrttiiccaallFFoonnttUUnniitt
      Specifies	the vertical component of the font units used by XXmmCCoonnvveerrttUUnn--
      iittss and used to interpret	the values of geometry resources when the
      XXmmNNsshheellllUUnniittTTyyppee resource	of VendorShell or the XXmmNNuunniittTTyyppee resource of
      Gadget, Manager, or Primitive has	the value XXmm110000TTHH__FFOONNTT__UUNNIITTSS.  If no
      initial value is supplied	for this resource, the default is computed
      from the font specified in XXmmNNffoonntt.  If no initial value is supplied
      for this resource	or for XXmmNNffoonntt,	the default is 10.

      If a call	to XXttSSeettVVaalluueess specifies a value for XXmmNNvveerrttiiccaallFFoonnttUUnniitt,
      this resource is set to that value.  If a	call to	XXttSSeettVVaalluueess specifies
      a	value for XXmmNNffoonntt but not for XXmmNNvveerrttiiccaallFFoonnttUUnniitt, this	resource is
      set to a value computed from the new XXmmNNffoonntt.

      A	vertical font unit is derived from a font as follows:

	oo++
	If the font has	a PPIIXXEELL__SSIIZZEE property, the vertical font unit is the
	PPIIXXEELL__SSIIZZEE property divided by 1.8.

	oo++
	If the font has	no PPIIXXEELL__SSIIZZEE property but has PPOOIINNTT__SSIIZZEE and
	RREESSOOLLUUTTIIOONN__YY properties, the vertical font unit	is the product of the
	PPOOIINNTT__SSIIZZEE and RREESSOOLLUUTTIIOONN__YY properties divided by 1400.

	oo++
	If the font has	no PPIIXXEELL__SSIIZZEE, PPOOIINNTT__SSIIZZEE, or RREESSOOLLUUTTIIOONN__YY proper-
	ties, the vertical font	unit is	the sum	of the font structure's
	_m_a_x__b_o_u_n_d_s._a_s_c_e_n_t and _m_a_x__b_o_u_n_d_s._d_e_s_c_e_n_t divided by 2.2.

  Inherited Resources

  All of the superclass	resources inherited by XmScreen	are designated N/A
  (not applicable).

RELATED	INFORMATION
  CCoorree((33XX)), XXmmDDiissppllaayy((33XX)), and XXmmGGeettXXmmSSccrreeeenn((33XX)).



















