CDE/cde/doc/C/guides/man/man4/Get_Geom.sgm

<!-- $XConsortium: Get_Geom.sgm /main/6 1996/08/30 14:48:30 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. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN286.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN286.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Geometry</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Geometry</Symbol></RefName>
<RefPurpose>get a tool's on-screen geometry
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Geom.sgm /main/6 1996/08/30 14:48:30 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Geometry(out width <Symbol Role="Variable">w</Symbol>,
        out height <Emphasis>h</Emphasis>,
        out xOffset <Symbol Role="Variable">x</Symbol>,
        out yOffset <Symbol Role="Variable">y</Symbol>
        [in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Geometry</Symbol> request
reports the on-screen geometry of the optionally specified
window, or of the window primarily associated with the recipient
procid (if no window is specified).
</Para>
<Para>The
<Symbol Role="Variable">w</Symbol>, <Emphasis>h</Emphasis>, <Symbol Role="Variable">x</Symbol> and
<Symbol Role="Variable">y</Symbol> arguments are integer geometry values, in pixels,
representing width, height, x-coordinate and y-coordinate,
respectively.
Negative offset values
are interpreted according to the
<![ %CDE.C.CDE; [<Filename MoreInfo="RefEntry">X11</Filename>(7) man page.
]]><![ %CDE.C.XO; [&str-Zl;.
]]></Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Get_Geometry</Symbol> request.
Also,
<Symbol Role="Message">Get_Geometry</Symbol> can be sent by
&cdeman.ttdt.sender.imprint.on;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.sender.imprint.on;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Geometry</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->