'\" t
...\" BulletB.sgm /main/11 1996/09/08 20:25:26 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmBulletinBoard" "3"
.SH "NAME"
\fBXmBulletinBoard\fP \(em The BulletinBoard widget class
.iX "XmBulletinBoard"
.iX "widget class" "BulletinBoard"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/BulletinB\&.h>
.fi
.SH "DESCRIPTION"
.PP
BulletinBoard is a composite widget that provides simple geometry
management for child widgets\&.
It does not force positioning on its children, but can be set to reject
geometry requests that result in overlapping children\&.
BulletinBoard is the base widget for most dialog widgets and is also used
as a general container widget\&.
.PP
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, and so on) 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 communication
with the window manager\&.
.PP
The default value for \fBXmNinitialFocus\fP is the value of
\fBXmNdefaultButton\fP\&.
.PP
BulletinBoard uses the \fBXmQTtakesDefault\fP trait, and
holds the \fBXmQTdialogShellSavvy\fP and \fBXmQTspecifyRenderTable\fP
traits\&.
.SS "Classes"
.PP
BulletinBoard inherits behavior, resources, and traits
from the \fBCore\fP, \fBComposite\fP, \fBConstraint\fP,
and \fBXmManager\fP classes\&.
.PP
The class pointer is \fBxmBulletinBoardWidgetClass\fP\&.
.PP
The class name is \fBXmBulletinBoard\fP\&.
.SS "New Resources"
.PP
The following table defines a set of widget resources used by the programmer
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 \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or
\fBXmC\fP prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP prefix and use
the remaining letters (in either lowercase or uppercase, but include any
underscores between words)\&.
The codes in the access column indicate if the given resource can be
set at creation time (C),
set by using \fBXtSetValues\fP (S),
retrieved by using \fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmBulletinBoard Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNallowOverlapXmCAllowOverlapBooleanTrueCSG
_____
XmNautoUnmanageXmCAutoUnmanageBooleanTrueCG
_____
XmNbuttonFontListXmCButtonFontListXmFontListdynamicCSG
_____
XmNbuttonRenderTableXmCButtonRenderTableXmRenderTabledynamicCSG
_____
XmNcancelButtonXmCWidgetWidgetNULLSG
_____
XmNdefaultButtonXmCWidgetWidgetNULLSG
_____
XmNdefaultPositionXmCDefaultPositionBooleanTrueCSG
_____
XmNdialogStyleXmCDialogStyleunsigned chardynamicCSG
_____
XmNdialogTitleXmCDialogTitleXmStringNULLCSG
_____
XmNfocusCallbackXmCCallbackXtCallbackListNULLC
_____
XmNlabelFontListXmCLabelFontListXmFontListdynamicCSG
_____
XmNlabelRenderTableXmCLabelRenderTableXmRenderTabledynamicCSG
_____
XmNmapCallbackXmCCallbackXtCallbackListNULLC
_____
XmNmarginHeightXmCMarginHeightDimension10CSG
_____
XmNmarginWidthXmCMarginWidthDimension10CSG
_____
XmNnoResizeXmCNoResizeBooleanFalseCSG
_____
XmNresizePolicyXmCResizePolicyunsigned charXmRESIZE_ANYCSG
_____
XmNshadowTypeXmCShadowTypeunsigned charXmSHADOW_OUTCSG
_____
XmNtextFontListXmCTextFontListXmFontListdynamicCSG
_____
XmNtextRenderTableXmCTextRenderTableXmRenderTabledynamicCSG
_____
XmNtextTranslationsXmCTranslationsXtTranslationsNULLC
_____
XmNunmapCallbackXmCCallbackXtCallbackListNULLC
_____
.TE
.IP "\fBXmNallowOverlap\fP" 10
Controls the policy for overlapping child widgets\&.
If this resource is True, BulletinBoard allows geometry requests that result
in overlapping children\&.
.IP "\fBXmNautoUnmanage\fP" 10
Controls whether or not BulletinBoard is automatically unmanaged after a
button is activated\&.
If this resource is True on initialization and if the BulletinBoard\&'s
parent is a DialogShell, BulletinBoard adds a callback to button
children (PushButtons, PushButtonGadgets, and DrawnButtons) that
unmanages the BulletinBoard when a button is activated\&.
If this resource is False on initialization or if the BulletinBoard\&'s
parent is not a DialogShell, the
BulletinBoard is not automatically unmanaged\&.
For BulletinBoard subclasses with Apply or Help buttons, activating
those buttons does not automatically unmanage the BulletinBoard\&.
.IP "\fBXmNbuttonFontList\fP" 10
Specifies the font list used for button descendants\&. See the
\fBXmNbuttonRenderTable\fP resource\&.
.IP "\fBXmNbuttonRenderTable\fP" 10
Specifies the render table used for BulletinBoard\&'s button descendants\&.
If this value is NULL at initialization, the parent hierarchy of the widget
is searched for an ancestor that
holds the \fBXmQTspecifyRenderTable\fP trait\&.
If such an ancestor is found, the render table is initialized to the
\fBXmBUTTON_RENDER_TABLE\fP value of the ancestor widget\&. If no such
ancestor is
found, the default is implementation dependent\&. Refer to
\fBXmRenderTable\fP(3) for more information on the creation and structure
of a render table\&.
.IP "\fBXmNcancelButton\fP" 10
Specifies the widget ID of the \fBCancel\fP button\&. BulletinBoard\&'s
subclasses, which define a \fBCancel\fP button,
set this resource\&. BulletinBoard does not directly provide any behavior for
that button\&.
.IP "\fBXmNdefaultButton\fP" 10
Specifies the widget ID of the default button\&.
Some BulletinBoard subclasses, which define a default button,
set this resource\&. BulletinBoard defines translations and installs
accelerators that activate that button when \fBKActivate\fP is pressed
and the keyboard focus is not in another button\&.
.IP "\fBXmNdefaultPosition\fP" 10
Controls the positioning of a DialogShell managing a BulletinBoard\&.
If the BulletinBoard is not being managed by a DialogShell, then
this resource has no effect\&. If \fBXmNdefaultPosition\fP is True,
the DialogShell will center itself at the center of its own parent\&.
For example, if the parent of the DialogShell is an ApplicationShell,
then the center of the DialogShell will be at the same coordinates
as the center of the ApplicationShell\&.
If the DialogShell becomes unmapped (but stays managed) and then remapped,
this resource has no influence on the DialogShell\&'s position\&.
If this resource is False, the DialogShell does not automatically
center itself\&.
.IP "\fBXmNdialogStyle\fP" 10
Indicates the dialog style associated with the BulletinBoard\&.
If the parent of the BulletinBoard is a DialogShell, the parent\&'s
\fBXmNmwmInputMode\fP 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:
.RS
.IP "\fBXmDIALOG_SYSTEM_MODAL\fP" 10
Used for dialogs that
must be responded to before
any other interaction in any application\&.
.IP "\fBXmDIALOG_PRIMARY_APPLICATION_MODAL\fP" 10
Used for dialogs that must
be responded to before some other interactions in
ancestors of the widget\&.
.IP "\fBXmDIALOG_APPLICATION_MODAL\fP" 10
Used for dialogs that must be
responded to before some other interactions in
ancestors of the widget\&. This value is the same as
\fBXmDIALOG_PRIMARY_APPLICATION_MODAL\fP, and remains for compatibility\&.
.IP "\fBXmDIALOG_FULL_APPLICATION_MODAL\fP" 10
Used for dialogs that must be
responded to before some other interactions in
the same application\&.
.IP "\fBXmDIALOG_MODELESS\fP" 10
Used for dialogs that do not interrupt interaction
of any application\&.
This is the default when the parent of the BulletinBoard is a DialogShell\&.
.IP "\fBXmDIALOG_WORK_AREA\fP" 10
Used for BulletinBoard widgets whose
parents are not DialogShells\&.
\fBXmNdialogStyle\fP is forced to have this value when the parent of the
BulletinBoard is not a DialogShell\&.
.RE
.IP "" 10
Posting a modal dialog in response to a button down or key down event
(via translation actions or callbacks) can cause the corresponding
button up or key up event to be lost\&. For example, posting a modal
dialog from an \fBXmNincrementCallback\fP of \fBXmScrollBar\fP will cause
the loss of the button up event, causing the \fBXmScrollBar\fP to
auto-increment indefinitely\&.
.IP "\fBXmNdialogTitle\fP" 10
Specifies the dialog title\&. If this resource is not NULL, and the parent
of the BulletinBoard is a subclass of WMShell, BulletinBoard sets the
\fBXmNtitle\fP and \fBXmNtitleEncoding\fP of its parent\&.
If the only character set in \fBXmNdialogTitle\fP is ISO8859-1,
\fBXmNtitle\fP is set to the string of the title, and
\fBXmNtitleEncoding\fP is set to \fBSTRING\fP\&.
If \fBXmNdialogTitle\fP contains character sets other than ISO8859-1,
\fBXmNtitle\fP is set to the string of the title converted to a compound
text string, and \fBXmNtitleEncoding\fP is set to \fBCOMPOUND_TEXT\fP\&.
The direction of the title is based on the \fBXmNlayoutDirection\fP resource
of the widget\&.
.IP "\fBXmNfocusCallback\fP" 10
Specifies the list of callbacks that is called
when the BulletinBoard widget or one of its
descendants accepts the input focus\&.
The callback reason is \fBXmCR_FOCUS\fP\&.
.IP "\fBXmNlabelFontList\fP" 10
Specifies the font list used for label descendants\&. See the
\fBXmNlabelRenderTable\fP resource\&.
.IP "\fBXmNlabelRenderTable\fP" 10
Specifies the render table used for BulletinBoard\&'s label descendants\&.
If this value is NULL at initialization, the parent hierarchy of the widget
is searched for an ancestor that
holds the \fBXmQTspecifyRenderTable\fP trait\&.
If such an ancestor is found, the render table is initialized to the
\fBXmLABEL_RENDER_TABLE\fP value of the ancestor widget\&. If no such
ancestor is
found, the default is implementation dependent\&. Refer to
\fBXmRenderTable\fP(3) for more information on the creation and structure
of a render table\&.
.IP "\fBXmNmapCallback\fP" 10
Specifies the list of callbacks that is called
only when the parent of the BulletinBoard is a DialogShell\&. In this case,
this callback list is invoked when the BulletinBoard widget is mapped\&.
The callback reason is \fBXmCR_MAP\fP\&.
DialogShells are usually mapped when the DialogShell is managed\&.
.IP "\fBXmNmarginHeight\fP" 10
Specifies the minimum spacing in pixels between the top or bottom edge
of BulletinBoard and any child widget\&.
.IP "\fBXmNmarginWidth\fP" 10
Specifies the minimum spacing in pixels between the left or right edge
of BulletinBoard and any child widget\&.
.IP "\fBXmNnoResize\fP" 10
Controls whether or not resize controls are included in the window
manager frame around the BulletinBoard\&'s parent\&.
If this resource is
set to True, \fBmwm\fP 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 this resource is set to False,
the window manager frame does include resize controls\&.
Other controls provided by \fBmwm\fP can be included or excluded through
the \fBmwm\fP resources provided by VendorShell\&.
.IP "\fBXmNresizePolicy\fP" 10
Controls the policy for resizing BulletinBoard widgets\&.
Possible values include
.RS
.IP "\fBXmRESIZE_NONE\fP" 10
Fixed size
.IP "\fBXmRESIZE_ANY\fP" 10
Shrink or grow as needed
.IP "\fBXmRESIZE_GROW\fP" 10
Grow only
.RE
.IP "\fBXmNshadowType\fP" 10
Describes the shadow
drawing style for BulletinBoard\&. This resource can have the
following values:
.RS
.IP "\fBXmSHADOW_IN\fP" 10
Draws the BulletinBoard shadow
so that it appears inset\&.
This means that the bottom shadow visuals and top shadow visuals
are reversed\&.
.IP "\fBXmSHADOW_OUT\fP" 10
Draws the BulletinBoard shadow
so that it appears outset\&.
.IP "\fBXmSHADOW_ETCHED_IN\fP" 10
Draws the BulletinBoard shadow
using a double line giving the
effect of a line etched into the window, similar to the Separator widget\&.
.IP "\fBXmSHADOW_ETCHED_OUT\fP" 10
Draws the BulletinBoard shadow using a double
line giving the
effect of a line coming out of the window, similar to the Separator widget\&.
.RE
.IP "\fBXmNtextFontList\fP" 10
Specifies the font list used for text descendants\&. See the
\fBXmNtextRenderTable\fP resource\&.
.IP "\fBXmNtextRenderTable\fP" 10
Specifies the render table used for BulletinBoard\&'s text descendants\&.
If this value is NULL at initialization, the parent hierarchy of the widget
is searched for an ancestor that
holds the \fBXmQTspecifyRenderTable\fP trait\&.
If such an ancestor is found, the render table is initialized to the
\fBXmTEXT_RENDER_TABLE\fP value of the ancestor widget\&. If no such
ancestor is
found, the default is implementation dependent\&. Refer to
\fBXmRenderTable\fP(3) for more information on the creation and structure
of a render table\&.
.IP "\fBXmNtextTranslations\fP" 10
It adds translations to any Text widget or Text widget subclass that
is added as a child of BulletinBoard\&.
.IP "\fBXmNunmapCallback\fP" 10
Specifies the list of callbacks that is called only when the parent of
the BulletinBoard is a DialogShell\&.
In this case, this callback list is invoked when the BulletinBoard
widget is unmapped\&.
The callback reason is \fBXmCR_UNMAP\fP\&.
DialogShells are usually unmapped when the DialogShell is unmanaged\&.
.SS "Inherited Resources"
.PP
BulletinBoard inherits behavior and resources from the
superclasses described in the following tables\&.
For a complete description of each resource, refer to the
reference page for that superclass\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmManager Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
_____
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNforegroundXmCForegroundPixeldynamicCSG
_____
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
_____
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
_____
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
_____
XmNinitialFocusXmCInitialFocusWidgetdynamicCSG
_____
XmNlayoutDirectionXmCLayoutDirectionXmDirectiondynamicCG
_____
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmTAB_GROUPCSG
_____
XmNpopupHandlerCallbackXmCCallbackXtCallbackListNULLC
_____
XmNshadowThicknessXmCShadowThicknessDimensiondynamicCSG
_____
XmNstringDirectionXmCStringDirectionXmStringDirectiondynamicCG
_____
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
_____
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
_____
XmNtraversalOnXmCTraversalOnBooleanTrueCSG
_____
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
_____
XmNuserDataXmCUserDataXtPointerNULLCSG
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBComposite Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNchildrenXmCReadOnlyWidgetListNULLG
_____
XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG
_____
XmNnumChildrenXmCReadOnlyCardinal0G
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBCore Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicN/A
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
_____
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderWidthXmCBorderWidthDimension0CSG
_____
XmNcolormapXmCColormapColormapdynamicCG
_____
XmNdepthXmCDepthintdynamicCG
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
_____
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
_____
XmNscreenXmCScreenScreen *dynamicCG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.SS "Callback Information"
.PP
A pointer to the following structure is passed to each callback:
.PP
.nf
typedef struct
{
        int \fIreason\fP;
        XEvent \fI* event\fP;
} XmAnyCallbackStruct;
.fi
.IP "\fIreason\fP" 10
Indicates why the callback was invoked
.IP "\fIevent\fP" 10
Points to the \fBXEvent\fP that triggered the callback
.SS "Translations"
.PP
\fBXmBulletinBoard\fP includes the translations from \fBXmManager\fP\&.
.SS "Additional Behavior"
.PP
The \fBXmBulletinBoard\fP widget has the following additional behavior:
.IP "\fB<Key>\fP\fB<osfCancel>\fP:" 10
Calls the activate callbacks for the cancel button if it is sensitive\&.
If no cancel button exists and if the parent of the BulletinBoard is
a manager, passes the event to the parent\&.
.IP "\fB<Key>\fP\fB<osfActivate>\fP:" 10
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 associated with \fB<Key>\fP\fB<osfActivate>\fP
is called before the BulletinBoard actions associated with
\fB<Key>\fP\fB<osfActivate>\fP\&.
.IP "" 10
In a multiline Text widget, any \fB<Key>\fP\fB<osfActivate>\fP
event except \fB<Key>\fP\fB<Enter>\fP calls
the Text action associated with \fB<Key>\fP\fB<osfActivate>\fP,
then the BulletinBoard actions associated with \fB<Key>\fP\fB<osfActivate>\fP\&.
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\&.
.IP "\fB<FocusIn>\fP:" 10
Calls the callbacks for \fBXmNfocusCallback\fP\&.
When the focus policy is \fBXmPOINTER\fP, the callbacks are
called when the pointer
enters the window\&.
When the focus policy is \fBXmEXPLICIT\fP, the callbacks are called
when the user traverses to the widget\&.
.IP "\fB<Map>\fP:" 10
Calls the callbacks for \fBXmNmapCallback\fP\&.
.IP "\fB<Unmap>\fP:" 10
Calls the callbacks for \fBXmNunmapCallback\fP\&.
.SS "Virtual Bindings"
.PP
The bindings for virtual keys are vendor specific\&.
For information about bindings for virtual buttons and keys, see \fBVirtualBindings\fP(3)\&.
.SH "RELATED"
.PP
\fBComposite\fP(3),
\fBConstraint\fP(3),
\fBCore\fP(3),
\fBXmCreateBulletinBoard\fP(3),
\fBXmCreateBulletinBoardDialog\fP(3),
\fBXmDialogShell\fP(3), 
\fBXmManager\fP(3),
\fBXmVaCreateBulletinBoard\fP(3), and
\fBXmVaCreateManagedBulletinBoard\fP(3)\&.
