man/XtPopdown.man

   1 .\" Copyright 1993 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be
  12 .\" included in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .ds tk X Toolkit
  28 .ds xT X Toolkit Intrinsics \- C Language Interface
  29 .ds xI Intrinsics
  30 .ds xW X Toolkit Athena Widgets \- C Language Interface
  31 .ds xL Xlib \- C Language X Interface
  32 .ds xC Inter-Client Communication Conventions Manual
  33 .ds Rn 3
  34 .ds Vn 2.2
  35 .hw XtCallback-Popdown wid-get
  36 .na
  37 .de Ds
  38 .nf
  39 .\\$1D \\$2 \\$1
  40 .ft CW
  41 .ps \\n(PS
  42 .\".if \\n(VS>=40 .vs \\n(VSu
  43 .\".if \\n(VS<=39 .vs \\n(VSp
  44 ..
  45 .de De
  46 .ce 0
  47 .if \\n(BD .DF
  48 .nr BD 0
  49 .in \\n(OIu
  50 .if \\n(TM .ls 2
  51 .sp \\n(DDu
  52 .fi
  53 ..
  54 .de IN          \" send an index entry to the stderr
  55 ..
  56 .de Pn
  57 .ie t \\$1\fB\^\\$2\^\fR\\$3
  58 .el \\$1\fI\^\\$2\^\fP\\$3
  59 ..
  60 .de ZN
  61 .ie t \fB\^\\$1\^\fR\\$2
  62 .el \fI\^\\$1\^\fP\\$2
  63 ..
  64 .ny0
  65 .TH XtPopdown __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  66 .SH NAME
  67 XtPopdown, XtCallbackPopdown \- unmap a pop-up
  68 .SH SYNTAX
  69 .HP
  70 void XtPopdown(Widget \fIpopup_shell\fP);
  71 .HP
  72 void XtCallbackPopdown(Widget \fIw\fP, XtPointer \fIclient_data\fP, XtPointer
  73 \fIcall_data\fP);
  74 .HP
  75 void MenuPopdown(String \fIshell_name\fP);
  76 .SH ARGUMENTS
  77 .IP \fIcall_data\fP 1i
  78 Specifies the callback data,
  79 which is not used by this procedure.
  80 .IP \fIclient_data\fP 1i
  81 Specifies a pointer to the
  82 .ZN XtPopdownID
  83 structure.
  84 .ds Ps \ to pop down
  85 .IP \fIpopup_shell\fP 1i
  86 Specifies the widget shell\*(Ps.
  87 .ds Sn down
  88 .IP \fIshell_name\fP 1i
  89 Specifies the name of the widget shell to pop \*(Sn.
  90 .IP \fIw\fP 1i
  91 Specifies the widget.
  92 .SH DESCRIPTION
  93 The
  94 .ZN XtPopdown
  95 function performs the following:
  96 .IP \(bu 5
  97 Calls
  98 .ZN XtCheckSubclass
  99 .\".ZN XtCheckSubclass(popup_shell, popupShellWidgetClass)
 100 to ensure popup_shell is a subclass of
 101 .ZN Shell .
 102 .IP \(bu 5
 103 Checks that popup_shell is currently popped_up;
 104 otherwise, it generates an error.
 105 .IP \(bu 5
 106 Unmaps popup_shell's window.
 107 .IP \(bu 5
 108 If popup_shell's grab_kind is either
 109 .ZN XtGrabNonexclusive
 110 or
 111 .ZN XtGrabExclusive ,
 112 it calls
 113 .ZN XtRemoveGrab .
 114 .\".ZN XtRemoveGrab(popup_shell)
 115 .IP \(bu 5
 116 Sets pop-up shell's popped_up field to
 117 .ZN False .
 118 .IP \(bu 5
 119 Calls the callback procedures on the shell's popdown_callback list.
 120 .LP
 121 The
 122 .ZN XtCallbackPopdown
 123 function casts the client data parameter to an
 124 .ZN XtPopdownID
 125 pointer:
 126 .LP
 127 .Ds 0
 128 typedef struct {
 129         Widget shell_widget;
 130         Widget enable_widget;
 131 } XtPopdownIDRec, *XtPopdownID;
 132 .De
 133 .LP
 134 The shell_widget is the pop-up shell to pop down,
 135 and the enable_widget is the widget that was used to pop it up.
 136 .LP
 137 .ZN XtCallbackPopdown
 138 calls
 139 .ZN XtPopdown
 140 with the specified shell_widget
 141 and then calls
 142 .ZN XtSetSensitive
 143 to resensitize the enable_widget.
 144 .LP
 145 If a shell name is not given,
 146 .ZN MenuPopdown
 147 calls
 148 .ZN XtPopdown
 149 with the widget for which the translation is specified.
 150 If a shell_name is specified in the translation table,
 151 .ZN MenuPopdown
 152 tries to find the shell by looking up the widget tree starting at the
 153 parent of the widget in which it is invoked.
 154 If it finds a shell with the specified name in the pop-up children
 155 of that parent,
 156 it pops down the shell;
 157 otherwise, it moves up the parent chain as needed.
 158 If
 159 .ZN MenuPopdown
 160 gets to the application top-level shell widget
 161 and cannot find a matching shell,
 162 it generates an error.
 163 .SH "SEE ALSO"
 164 XtCreatePopupShell(__libmansuffix__),
 165 XtPopup(__libmansuffix__)
 166 .br
 167 \fI\*(xT\fP
 168 .br
 169 \fI\*(xL\fP