man/xkb/XkbComputeSectionBounds.man

   1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XkbComputeSectionBounds __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbComputeSectionBounds \- Update the bounding box of a section
  25 .SH SYNOPSIS
  26 .HP
  27 .B Bool XkbComputeSectionBounds
  28 .BI "(\^XkbGeometryPtr " "geom" "\^,"
  29 .BI "XkbSectionPtr " "section" "\^);"
  30 .if n .ti +5n
  31 .if t .ti +.5i
  32 .SH ARGUMENTS
  33 .TP
  34 .I \- geom
  35 geometry that contains the section
  36 .TP
  37 .I \- section
  38 section to be examined and updated
  39 .SH DESCRIPTION
  40 .LP
  41  If you add or delete a row to or from a section, or if you change the geometry
  42 of any of the rows in that section, you may need to update the bounding box for
  43 that section.
  44
  45 .I XkbComputeSectionBounds
  46 examines all the rows of the
  47 .I section
  48 and updates the bounding box of that section so that it contains all rows.
  49 .I XkbComputeSectionBounds
  50 returns False if any of the arguments is NULL; otherwise, it returns True.