


XmBulletinBoard(3X)					  XmBulletinBoard(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmBBuulllleettiinnBBooaarrdd - The	BulletinBoard widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//BBuulllleettiinnBB..hh>>

DESCRIPTION
  BulletinBoard	is a composite widget that provides simple geometry manage-
  ment for children widgets.  It does not force	positioning on its children,
  but can be set to reject geometry requests that result in overlapping	chil-
  dren.	 BulletinBoard is the base widget for most dialog widgets and is also
  used as a general container widget.

  Modal	and modeless dialogs are implemented as	collections of widgets that
  include a DialogShell, a BulletinBoard (or subclass) child of	the shell,
  and various dialog components	(buttons, labels, etc.)	that are children of
  BulletinBoard.  BulletinBoard	defines	callbacks useful for dialogs (focus,
  map, unmap), which are available for application use.	 If its	parent is a
  DialogShell, BulletinBoard passes title and input mode (based	on dialog
  style) information to	the parent, which is responsible for appropriate com-
  munication with the window manager.

  The default value for	XXmmNNiinniittiiaallFFooccuuss	is the value of	XXmmNNddeeffaauullttBBuuttttoonn.

  Classes

  BulletinBoard	inherits behavior and resources	from CCoorree, CCoommppoossiittee, CCoonn--
  ssttrraaiinntt, and XXmmMMaannaaggeerr classes.

  The class pointer is xxmmBBuulllleettiinnBBooaarrddWWiiddggeettCCllaassss.

  The class name is XXmmBBuulllleettiinnBBooaarrdd.

  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 a .Xdefaults 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 a .Xdefaults 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mBBuulllleettiinnBBooaarrdd 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
	   _________________________________________________________
	   _________________________________________________________
	   XmNallowOverlap	      True		      CSG
		 XmCAllowOverlap	     Boolean
	   _________________________________________________________
	   XmNautoUnmanage	      True		      CG
		 XmCAutoUnmanage	     Boolean
	   _________________________________________________________
	   XmNbuttonFontList	      dynamic		      CSG
		 XmCButtonFontList	     XmFontList
	   _________________________________________________________
	   XmNcancelButton	      NULL		      SG
		 XmCWidget		     Widget
	   _________________________________________________________
	   XmNdefaultButton	      NULL		      SG
		 XmCWidget		     Widget
	   _________________________________________________________
	   XmNdefaultPosition	      True		      CSG
		 XmCDefaultPosition	     Boolean
	   _________________________________________________________
	   XmNdialogStyle	      dynamic		      CSG
		 XmCDialogStyle		     unsigned char
	   _________________________________________________________
	   XmNdialogTitle	      NULL		      CSG
		 XmCDialogTitle		     XmString
	   _________________________________________________________
	   XmNfocusCallback	      NULL		      C
		 XmCCallback		     XtCallbackList
	   _________________________________________________________
	   XmNlabelFontList	      dynamic		      CSG
		 XmCLabelFontList	     XmFontList
	   _________________________________________________________
	   XmNmapCallback	      NULL		      C
		 XmCCallback		     XtCallbackList
	   _________________________________________________________
	   XmNmarginHeight	      10		      CSG
		 XmCMarginHeight	     Dimension
	   _________________________________________________________
	   XmNmarginWidth	      10		      CSG
		 XmCMarginWidth		     Dimension
	   _________________________________________________________
	   XmNnoResize		      False		      CSG
		 XmCNoResize		     Boolean
	   _________________________________________________________
	   XmNresizePolicy	      XmRESIZE_ANY	      CSG
		 XmCResizePolicy	     unsigned char
	   _________________________________________________________
	   XmNshadowType	      XmSHADOW_OUT	      CSG
		 XmCShadowType		     unsigned char
	   _________________________________________________________
	   XmNtextFontList	      dynamic		      CSG
		 XmCTextFontList	     XmFontList
	   _________________________________________________________
	   XmNtextTranslations	      NULL		      C
		 XmCTranslations	     XtTranslations
	   _________________________________________________________
	   XmNunmapCallback	      NULL		      C
		 XmCCallback		     XtCallbackList
	   _________________________________________________________

  XXmmNNaalllloowwOOvveerrllaapp
	    Controls the policy	for overlapping	children widgets.  If True,
	    BulletinBoard allows geometry requests that	result in overlapping
	    children.

  XXmmNNaauuttooUUnnmmaannaaggee
	    Controls whether or	not BulletinBoard is automatically unmanaged
	    after a button is activated.  If this resource is True on ini-
	    tialization	and if the BulletinBoard's parent is a DialogShell,
	    BulletinBoard adds a callback to button children (PushButtons,
	    PushButtonGadgets, and DrawnButtons) that unmanages	the Bulletin-
	    Board when a button	is activated.  If this resource	is False on
	    initialization or if the BulletinBoard's parent is not a Dialog-
	    Shell, the BulletinBoard is	not automatically unmanaged.  For
	    BulletinBoard subclasses with Apply	or Help	buttons, activating
	    those buttons does not automatically unmanage the BulletinBoard.

  XXmmNNbbuuttttoonnFFoonnttLLiisstt
	    Specifies the font list used for BulletinBoard's button descen-
	    dants.  If this value is NULL at initialization, the font list is
	    initialized	by looking up the parent hierarchy of the widget for
	    an ancestor	that is	a subclass of the XmBulletinBoard, Vendor-
	    Shell, or XmMenuShell widget class.	 If such an ancestor is
	    found, the font list is initialized	to the XXmmNNbbuuttttoonnFFoonnttLLiisstt of
	    the	ancestor widget.  If no	such ancestor is found,	the default
	    is implementation dependent.  Refer	to XXmmFFoonnttLLiisstt((33XX)) for more
	    information	on the creation	and structure of a font	list.

  XXmmNNccaanncceellBBuuttttoonn
	    Specifies the widget ID of the CCaanncceell button.  BulletinBoard's
	    subclasses,	which define a CCaanncceell button, set this resource.
	    BulletinBoard does not directly provide any	behavior for that
	    button.

  XXmmNNddeeffaauullttBBuuttttoonn
	    Specifies the widget ID of the default button.  Some Bulletin-
	    Board subclasses, which define a default button, set this
	    resource.  BulletinBoard defines translations and installs
	    accelerators that activate that button when	KKAAccttiivvaattee is pressed
	    and	the keyboard focus is not in another button.

  XXmmNNddeeffaauullttPPoossiittiioonn
	    Controls whether or	not the	BulletinBoard is automatically posi-
	    tioned by its parent.  If True, and	the parent of the Bulletin-
	    Board is a DialogShell, the	BulletinBoard is centered within or
	    around the parent of the DialogShell when the BulletinBoard	is
	    mapped and managed.	 If False, the BulletinBoard is	not automati-
	    cally positioned.

  XXmmNNddiiaallooggSSttyyllee
	    Indicates the dialog style associated with the BulletinBoard.  If
	    the	parent of the BulletinBoard is a DialogShell, the parent's
	    XXmmNNmmwwmmIInnppuuttMMooddee is set according to	the value of this resource.
	    This resource can be set only if the BulletinBoard is unmanaged.
	    Possible values for	this resource include the following:

	      oo++
	      XXmmDDIIAALLOOGG__SSYYSSTTEEMM__MMOODDAALL-used for dialogs that must be responded
	      to before	any other interaction in any application

	      oo++
	      XXmmDDIIAALLOOGG__PPRRIIMMAARRYY__AAPPPPLLIICCAATTIIOONN__MMOODDAALL-used for dialogs that must
	      be responded to before some other	interactions in	ancestors of
	      the widget









	      oo++
	      XXmmDDIIAALLOOGG__AAPPPPLLIICCAATTIIOONN__MMOODDAALL-used for dialogs that must be
	      responded	to before some other interactions in ancestors of the
	      widget.  This value is the same as
	      XXmmDDIIAALLOOGG__PPRRIIMMAARRYY__AAPPPPLLIICCAATTIIOONN__MMOODDAALL, and remains for
	      compatibility.

	      oo++
	      XXmmDDIIAALLOOGG__FFUULLLL__AAPPPPLLIICCAATTIIOONN__MMOODDAALL-used for dialogs that must be
	      responded	to before some other interactions in the same appli-
	      cation

	      oo++
	      XXmmDDIIAALLOOGG__MMOODDEELLEESSSS-used for dialogs that do not interrupt
	      interaction of any application.  This is the default when	the
	      parent of	the BulletinBoard is a DialogShell.

	      oo++
	      XXmmDDIIAALLOOGG__WWOORRKK__AARREEAA-used for BulletinBoard	widgets	whose parents
	      are not DialogShells.  XXmmNNddiiaallooggSSttyyllee is forced to have this
	      value when the parent of the BulletinBoard is not	a Dialog-
	      Shell.

  XXmmNNddiiaallooggTTiittllee
	    Specifies the dialog title.	 If this resource is not NULL, and
	    the	parent of the BulletinBoard is a subclass of WMShell, Bul-
	    letinBoard sets the	XXmmNNttiittllee and XXmmNNttiittlleeEEnnccooddiinngg of its parent.
	    If the only	character set in XXmmNNddiiaallooggTTiittllee	is ISO8859-1, XXmmNNttii--
	    ttllee	is set to the string of	the title, and XXmmNNttiittlleeEEnnccooddiinngg	is
	    set	to SSTTRRIINNGG.  If XXmmNNddiiaallooggTTiittllee contains character sets other
	    than ISO8859-1, XXmmNNttiittllee is	set to the string of the title con-
	    verted to a	compound text string, and XXmmNNttiittlleeEEnnccooddiinngg is set to
	    CCOOMMPPOOUUNNDD__TTEEXXTT.

  XXmmNNffooccuussCCaallllbbaacckk
	    Specifies the list of callbacks that is called when	the Bulletin-
	    Board widget or one	of its descendants accepts the input focus.
	    The	callback reason	is XXmmCCRR__FFOOCCUUSS.

  XXmmNNllaabbeellFFoonnttLLiisstt
	    Specifies the font list used for BulletinBoard's label descen-
	    dants (Labels and LabelGadgets).  If this value is NULL at ini-
	    tialization, the font list is initialized by looking up the
	    parent hierarchy of	the widget for an ancestor that	is a subclass
	    of the XmBulletinBoard, VendorShell, or XmMenuShell	widget class.
	    If such an ancestor	is found, the font list	is initialized to the
	    XXmmNNllaabbeellFFoonnttLLiisstt of	the ancestor widget.  If no such ancestor is
	    found, the default is implementation dependent.  Refer to
	    XXmmFFoonnttLLiisstt((33XX)) for more information	on the creation	and structure
	    of a font list.

  XXmmNNmmaappCCaallllbbaacckk
	    Specifies the list of callbacks that is called only	when the
	    parent of the BulletinBoard	is a DialogShell; in which case, this
	    callback list is invoked when the BulletinBoard widget is mapped.
	    The	callback reason	is XXmmCCRR__MMAAPP.  DialogShells are usually mapped
	    when the DialogShell is managed.

  XXmmNNmmaarrggiinnHHeeiigghhtt
	    Specifies the minimum spacing in pixels between the	top or bottom
	    edge of BulletinBoard and any child	widget.

  XXmmNNmmaarrggiinnWWiiddtthh
	    Specifies the minimum spacing in pixels between the	left or	right
	    edge of BulletinBoard and any child	widget.

  XXmmNNnnooRReessiizzee
	    Controls whether or	not resize controls are	included in the	win-
	    dow	manager	frame around the BulletinBoard's parent.  If set to
	    True, the mmwwmm does not include resize controls in the window
	    manager frame containing the parent	of the BulletinBoard if	the
	    parent is a	subclass of VendorShell.  If set to False, the window
	    manager frame does include resize controls.	 Other controls	pro-
	    vided by mmwwmm can be	included or excluded through the mmwwmm
	    resources provided by VendorShell.

  XXmmNNrreessiizzeePPoolliiccyy
	    Controls the policy	for resizing BulletinBoard widgets.  Possible
	    values include the following:

	      oo++
	      XXmmRREESSIIZZEE__NNOONNEE-fixed size

	      oo++
	      XXmmRREESSIIZZEE__AANNYY-shrink or grow as needed

	      oo++
	      XXmmRREESSIIZZEE__GGRROOWW-grow only

  XXmmNNsshhaaddoowwTTyyppee
	    Describes the shadow drawing style for BulletinBoard.  This
	    resource can have the following values:

	      oo++
	      XXmmSSHHAADDOOWW__IINN-draws	the BulletinBoard shadow so that it appears
	      inset.  This means that the bottom shadow	visuals	and top	sha-
	      dow visuals are reversed.

	      oo++
	      XXmmSSHHAADDOOWW__OOUUTT-draws the BulletinBoard shadow so that it appears
	      outset

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN-draws the BulletinBoard shadow	using a	dou-
	      ble line giving the effect of a line etched into the window,
	      similar to the Separator widget

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT-draws	the BulletinBoard shadow using a dou-
	      ble line giving the effect of a line coming out of the window,
	      similar to the Separator widget





















  XXmmNNtteexxttFFoonnttLLiisstt
	    Specifies the font list used for BulletinBoard's Text and List
	    descendants.  If this value	is NULL	at initialization, the font
	    list is initialized	by looking up the parent hierarchy of the
	    widget for an ancestor that	is a subclass of the XmBulletinBoard
	    or VendorShell widget class.  If such an ancestor is found,	the
	    font list is initialized to	the XXmmNNtteexxttFFoonnttLLiisstt of the ancestor
	    widget.  If	no such	ancestor is found, the default is implementa-
	    tion  dependent.  Refer to XXmmFFoonnttLLiisstt((33XX)) for more information on
	    the	creation and structure of a font list.

  XXmmNNtteexxttTTrraannssllaattiioonnss
	    Adds translations to any Text widget or Text widget	subclass that
	    is added as	a child	of BulletinBoard.

  XXmmNNuunnmmaappCCaallllbbaacckk
	    Specifies the list of callbacks that is called only	when the
	    parent of the BulletinBoard	is a DialogShell.  In that case, this
	    callback list is invoked when the BulletinBoard widget is
	    unmapped.  The callback reason is XXmmCCRR__UUNNMMAAPP.  DialogShells	are
	    usually unmapped when the DialogShell is unmanaged.

  Inherited Resources

  BulletinBoard	inherits behavior and resources	from the following superc-
  lasses.  For a complete description of each resource,	refer to the man page
  for that superclass.

			    XXmmMMaannaaggeerr 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
	_______________________________________________________________
	_______________________________________________________________
	XmNbottomShadowColor	      dynamic			 CSG
	      XmCBottomShadowColor	     Pixel
	_______________________________________________________________
	XmNbottomShadowPixmap	      XmUNSPECIFIED_PIXMAP	 CSG
	      XmCBottomShadowPixmap	     Pixmap
	_______________________________________________________________
	XmNforeground		      dynamic			 CSG
	      XmCForeground		     Pixel
	_______________________________________________________________
	XmNhelpCallback		      NULL			 C
	      XmCCallback		     XtCallbackList
	_______________________________________________________________
	XmNhighlightColor	      dynamic			 CSG
	      XmCHighlightColor		     Pixel
	_______________________________________________________________
	XmNhighlightPixmap	      dynamic			 CSG
	      XmCHighlightPixmap	     Pixmap
	_______________________________________________________________
	XmNinitialFocus		      dynamic			 CSG
	      XmCInitialFocus		     Widget
	_______________________________________________________________
	XmNnavigationType	      XmTAB_GROUP		 CSG
	      XmCNavigationType		     XmNavigationType
	_______________________________________________________________
	XmNshadowThickness	      dynamic			 CSG
	      XmCShadowThickness	     Dimension
	_______________________________________________________________
	XmNstringDirection	      dynamic			 CG
	      XmCStringDirection	     XmStringDirection
	_______________________________________________________________
	XmNtopShadowColor	      dynamic			 CSG
	      XmCTopShadowColor		     Pixel
	_______________________________________________________________
	XmNtopShadowPixmap	      dynamic			 CSG
	      XmCTopShadowPixmap	     Pixmap
	_______________________________________________________________
	XmNtraversalOn		      True			 CSG
	      XmCTraversalOn		     Boolean
	_______________________________________________________________
	XmNunitType		      dynamic			 CSG
	      XmCUnitType		     unsigned char
	_______________________________________________________________
	XmNuserData		      NULL			 CSG
	      XmCUserData		     XtPointer
	_______________________________________________________________

			    CCoommppoossiittee 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
	     _____________________________________________________
	     _____________________________________________________
	     XmNchildren	       NULL		    G
		   XmCReadOnly		      WidgetList
	     _____________________________________________________
	     XmNinsertPosition	       NULL		    CSG
		   XmCInsertPosition	      XtOrderProc
	     _____________________________________________________
	     XmNnumChildren	       0		    G
		   XmCReadOnly		      Cardinal
	     _____________________________________________________

			      CCoorree 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
     ____________________________________________________________________
     ____________________________________________________________________
     XmNaccelerators			   dynamic		   N/A
	   XmCAccelerators			  XtAccelerators
     ____________________________________________________________________
     XmNancestorSensitive		   dynamic		   G
	   XmCSensitive				  Boolean
     ____________________________________________________________________
     XmNbackground			   dynamic		   CSG
	   XmCBackground			  Pixel
     ____________________________________________________________________
     XmNbackgroundPixmap		   XmUNSPECIFIED_PIXMAP	   CSG
	   XmCPixmap				  Pixmap
     ____________________________________________________________________
     XmNborderColor			   XtDefaultForeground	   CSG
	   XmCBorderColor			  Pixel
     ____________________________________________________________________
     XmNborderPixmap			   XmUNSPECIFIED_PIXMAP	   CSG
	   XmCPixmap				  Pixmap
     ____________________________________________________________________
     XmNborderWidth			   0			   CSG
	   XmCBorderWidth			  Dimension
     ____________________________________________________________________
     XmNcolormap			   dynamic		   CG
	   XmCColormap				  Colormap
     ____________________________________________________________________
     XmNdepth				   dynamic		   CG
	   XmCDepth				  int
     ____________________________________________________________________
     XmNdestroyCallback			   NULL			   C
	   XmCCallback				  XtCallbackList
     ____________________________________________________________________
     XmNheight				   dynamic		   CSG
	   XmCHeight				  Dimension
     ____________________________________________________________________
     XmNinitialResourcesPersistent	   True			   C
	   XmCInitialResourcesPersistent	  Boolean
     ____________________________________________________________________
     XmNmappedWhenManaged		   True			   CSG
	   XmCMappedWhenManaged			  Boolean
     ____________________________________________________________________
     XmNscreen				   dynamic		   CG
	   XmCScreen				  Screen *
     ____________________________________________________________________
     XmNsensitive			   True			   CSG
	   XmCSensitive				  Boolean
     ____________________________________________________________________
     XmNtranslations			   dynamic		   CSG
	   XmCTranslations			  XtTranslations
     ____________________________________________________________________
     XmNwidth				   dynamic		   CSG
	   XmCWidth				  Dimension
     ____________________________________________________________________
     XmNx				   0			   CSG
	   XmCPosition				  Position
     ____________________________________________________________________
     XmNy				   0			   CSG
	   XmCPosition				  Position
     ____________________________________________________________________

  Callback Information

  A pointer to the following structure is passed to each callback:


  ttyyppeeddeeff ssttrruucctt
  {{
    iinntt	     _r_e_a_s_o_n;;
    XXEEvveenntt   * _e_v_e_n_t;;
  }} XXmmAAnnyyCCaallllbbaacckkSSttrruucctt;;

  _r_e_a_s_o_n Indicates why the callback was	invoked.

  _e_v_e_n_t	 Points	to the XXEEvveenntt that triggered the callback.

  Translations

  XmBulletinBoard includes the translations from XmManager.




















  Additional Behavior

  The XmBulletinBoard widget has the additional	behavior described below:

  MMAAnnyy KKCCaanncceell:
	    Calls the activate callbacks for the cancel	button if it is	sen-
	    sitive.  If	no cancel button exists	and if the parent of the Bul-
	    letinBoard is a manager, passes the	event to the parent.

  KKAAccttiivvaattee:
	    Calls the activate callbacks for the button	with the keyboard
	    focus.  If no button has the keyboard focus, calls the activate
	    callbacks for the default button if	it is sensitive.  In a List
	    widget or single-line Text widget, the List	or Text	action asso-
	    ciated with	KKAAccttiivvaattee is called before the BulletinBoard actions
	    associated with KKAAccttiivvaattee.	In a multi-line	Text widget, any KKAAcc--
	    ttiivvaattee event except	KKEEnntteerr calls the Text action associated	with
	    KKAAccttiivvaattee, then the	BulletinBoard actions associated with KKAAcc--
	    ttiivvaattee.  If	no button has the focus, no default button exists,
	    and	the parent of the BulletinBoard	is a manager, passes the
	    event to the parent.

  <<FFooccuussIInn>>:
	    Calls the callbacks	for XXmmNNffooccuussCCaallllbbaacckk.  When the	focus policy
	    is XXmmPPOOIINNTTEERR, this happens when the	pointer	enters the window.
	    When the focus policy is XXmmEEXXPPLLIICCIITT, this happens when the user
	    traverses to the widget.

  <<MMaapp>>:    Calls the callbacks	for XXmmNNmmaappCCaallllbbaacckk.

  <<UUnnmmaapp>>:  Calls the callbacks	for XXmmNNuunnmmaappCCaallllbbaacckk.

  Virtual Bindings

  The bindings for virtual keys	are vendor specific.  For information about
  bindings for virtual buttons and keys, see VViirrttuuaallBBiinnddiinnggss((33XX)).

RELATED	INFORMATION
  CCoommppoossiittee((33XX)), CCoonnssttrraaiinntt((33XX)), CCoorree((33XX)), XXmmCCrreeaatteeBBuulllleettiinnBBooaarrdd((33XX)),
  XXmmCCrreeaatteeBBuulllleettiinnBBooaarrddDDiiaalloogg((33XX)), XXmmDDiiaallooggSShheellll((33XX)),, and XXmmMMaannaaggeerr((33XX))..































