<!-- $XConsortium: GetTearO.sgm /main/7 1996/08/30 15:29:18 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN258.rsml.1">
<RefMeta>
<RefEntryTitle>XmGetTearOffControl</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmGetTearOffControl</Function></RefName>
<RefPurpose>A RowColumn function that obtains the widget ID for the tear-off control in a menu
<IndexTerm>
<Primary>XmGetTearOffControl</Primary>
</IndexTerm><IndexTerm>
<Primary>RowColumn functions</Primary>
<Secondary>XmGetTearOffControl</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/RowColumn.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>XmGetTearOffControl</Function></FuncDef>
<!--<ParamDef><Replaceable>menu</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>menu</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmGetTearOffControl</Function> provides the application with the means for
obtaining the widget ID of the internally created tear-off control in a
tear-off menu.
</Para>
<Para>RowColumn creates a tear-off control for a PulldownMenu or PopupMenu
when the <SystemItem Class="Resource">XmNtearOffModel</SystemItem> resource is initialized or set to
<SystemItem Class="Constant">XmTEAR_OFF_ENABLED</SystemItem>.
The tear-off control is a widget that appears as the first element in
the menu.
The user tears off the menu by means of mouse or keyboard events in the
tear-off control.
</Para>
<Para>The tear-off control has Separator-like behavior.
Once the application has obtained the widget ID of the tear-off control,
it can set resources to specify the appearance of the control.
The application or user can also set these resources in a resource file
by using the name of the control, which is <Literal>TearOffControl</Literal>.
For a list of the resources the application or user can set, see
&cdeman.XmRowColumn;.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">menu</Symbol></Term>
<ListItem>
<Para>Specifies the widget ID of the RowColumn PulldownMenu or PopupMenu
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For more information on tear-off menus and a complete definition of
RowColumn and its associated resources, see &cdeman.XmRowColumn;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the widget ID for the tear-off control, or NULL if no tear-off
control exists.
An application should not assume that the returned widget will be of any
particular class.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmRowColumn;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
