bionic (3) XmMessageBox.3.gz

Provided by: libmotif-dev_2.3.8-2build1_amd64 bug

NAME

       XmMessageBox — The MessageBox widget class "XmMessageBox" "widget class" "MessageBox"

SYNOPSIS

       #include <Xm/MessageB.h>

DESCRIPTION

       MessageBox  is  a  dialog  class  used for creating simple message dialogs.  Convenience dialogs based on
       MessageBox are provided for several common interaction tasks, which include  giving  information,  asking
       questions, and reporting errors.

       A MessageBox dialog is typically transient in nature, displayed for the duration of a single interaction.
       MessageBox is a subclass of BulletinBoard and depends on it for much of its general dialog behavior.

       The default value for XmNinitialFocus is the value of XmNdefaultButton.

       A typical MessageBox contains a message symbol, a message, and up to three standard default  PushButtons:
       OK,  Cancel,  and  Help.   It  is  laid out with the symbol and message on top and the PushButtons on the
       bottom. The Help button is positioned to the side of the  other  push  buttons.   You  can  localize  the
       default symbols and button labels for MessageBox convenience dialogs.

       The  user can specify resources in a resource file for the gadgets created automatically that contain the
       MessageBox symbol pixmap and separator. The gadget names are Symbol and Separator.

       A MessageBox can also be customized by  creating  and  managing  new  children  that  are  added  to  the
       MessageBox  children  created  automatically  by the convenience dialogs.  In the case of TemplateDialog,
       only the separator child is created by default.  If the callback, string, or pixmap symbol resources  are
       specified, the appropriate child will be created.

       Additional children are laid out in the following manner:

          •  The  first  MenuBar  child is placed at the top of the window.  The XmQTmenuSystem trait is used to
             check that it is the first MenuBar child.

          •  All widgets or gadgets are placed after the OK button in the order of their creation (this order is
             checked using the XmQTactivatable trait).

          •  A  child that is not in the above categories is placed above the row of buttons. If a message label
             exists, the child is placed below the label. If a message pixmap exists, but  a  message  label  is
             absent,  the  child  is  placed on the same row as the pixmap. The child behaves as a work area and
             grows or shrinks to fill the space above the row of buttons.  The  layout  of  multiple  work  area
             children is undefined.

       At initialization, MessageBox looks for the following bitmap files:

          •  xm_errorxm_informationxm_questionxm_workingxm_warning

       See XmGetPixmap(3) for a list of the paths that are searched for these files.

       MessageBox uses the XmQTactivatable and XmQTmenuSystem traits.

   Descendants
       MessageBox  automatically  creates  the descendants shown in the following table.  An application can use
       XtNameToWidget to gain access to the named descendant. In addition, a user or an application can use  the
       named descendant when specifying resource values.

       ┌─────────────────┬────────────────────┬───────────────────────────────┐
       │Named DescendantClassIdentity                      │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       │CancelXmPushButtonGadget │ Cancel button                 │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       │HelpXmPushButtonGadget │ Help button                   │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       │MessageXmLabelGadget      │ displayed message             │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       │OKXmPushButtonGadget │ OK button                     │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       │SeparatorXmSeparatorGadget  │ dividing line between message │
       │                 │                    │ and buttons                   │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       │SymbolXmLabelGadget      │ icon symbolizing message type │
       ├─────────────────┼────────────────────┼───────────────────────────────┤
       └─────────────────┴────────────────────┴───────────────────────────────┘
   Classes
       MessageBox inherits behavior, resources, and traits from  Core,  Composite,  Constraint,  XmManager,  and
       XmBulletinBoard.

       The class pointer is xmMessageBoxWidgetClass.

       The class name is XmMessageBox.

   New Resources
       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 .Xdefaults file, remove the XmN or XmC prefix and use
       the remaining letters. To specify one of the defined values for a resource in a .Xdefaults  file,  remove
       the  Xm  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 XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable
       (N/A).

       ┌──────────────────────────────────────────────────────────────────────────────────────────────┐
--
       Composite(3),       Constraint(3),       Core(3),       XmBulletinBoard(3),       XmCreateErrorDialog(3),
       XmCreateInformationDialog(3), XmCreateMessageBox(3), XmCreateMessageDialog(3), XmCreateQuestionDialog(3),
       XmCreateTemplateDialog(3),     XmCreateWarningDialog(3),     XmCreateWorkingDialog(3),      XmManager(3),
       XmMessageBoxGetChild(3), XmVaCreateMessageBox(3), and XmVaCreateManagedMessageBox(3).

                                                                                                 XmMessageBox(3)