libs/gtkmm2/pango/src/pango_docs_override.xml

   1 <root>
   2
   3
   4 <function name="pango_font_face_describe">
   5 <description>
   6 Returns the family, style, variant, weight and stretch of
   7 a #PangoFontFace. The size field of the resulting font description
   8 will be unset.
   9
  10
  11 </description>
  12 <parameters>
  13 <parameter name="face">
  14 <parameter_description> a #PangoFontFace
  15 </parameter_description>
  16 </parameter>
  17 </parameters>
  18 <return> a  #PangoFontDescription
  19 holding the description of the face.
  20 </return>
  21 </function>
  22
  23
  24 <function name="pango_layout_get_tabs">
  25 <description>
  26 Get the current #PangoTabArray used by this layout. If no
  27 #PangoTabArray has been set, then the default tabs are in use
  28 and an invalid instance is returned. Default tabs are every 8 spaces.
  29
  30 </description>
  31 <parameters>
  32 <parameter name="layout">
  33 <parameter_description> a #PangoLayout
  34 </parameter_description>
  35 </parameter>
  36 </parameters>
  37 <return> a copy of the tabs for this layout.
  38 </return>
  39 </function>
  40
  41 <function name="pango_context_get_metrics">
  42 <description>
  43 Get overall metric information for a font particular font
  44 description.  Since the metrics may be substantially different for
  45 different scripts, a language tag can be provided to indicate that
  46 the metrics should be retrieved that correspond to the script(s)
  47 used by that language.
  48
  49 The #PangoFontDescription is interpreted in the same way as
  50 by pango_itemize(), and the family name may be a comma separated
  51 list of figures. If characters from multiple of these families
  52 would be used to render the string, then the returned fonts would
  53 be a composite of the metrics for the fonts loaded for the
  54 individual families.
  55
  56
  57 </description>
  58 <parameters>
  59 <parameter name="context">
  60 <parameter_description> a #PangoContext
  61 </parameter_description>
  62 </parameter>
  63 <parameter name="desc">
  64 <parameter_description> a #PangoFontDescription structure
  65 </parameter_description>
  66 </parameter>
  67 <parameter name="language">
  68 <parameter_description> language tag used to determine which script to get the metrics
  69 for.
  70 </parameter_description>
  71 </parameter>
  72 </parameters>
  73 <return> a #PangoMetrics object.
  74 </return>
  75 </function>
  76
  77 <function name="pango_font_get_glyph_extents">
  78 <description>
  79 Gets the logical and ink extents of a glyph within a font. The
  80 coordinate system for each rectangle has its origin at the
  81 base line and horizontal origin of the character with increasing
  82 coordinates extending to the right and down. The macros PANGO_ASCENT(),
  83 PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING can be used to convert
  84 from the extents rectangle to more traditional font metrics. The units
  85 of the rectangles are in 1/PANGO_SCALE of a device unit.
  86
  87 </description>
  88 <parameters>
  89 <parameter name="font">
  90 <parameter_description> a #PangoFont
  91 </parameter_description>
  92 </parameter>
  93 <parameter name="glyph">
  94 <parameter_description> the glyph index
  95 </parameter_description>
  96 </parameter>
  97 <parameter name="ink_rect">
  98 <parameter_description> rectangle used to store the extents of the glyph as drawn.
  99 </parameter_description>
 100 </parameter>
 101 <parameter name="logical_rect">
 102 <parameter_description> rectangle used to store the logical extents of the glyph.
 103 </parameter_description>
 104 </parameter>
 105 </parameters>
 106 <return></return>
 107 </function>
 108
 109 <function name="pango_glyph_string_extents_range">
 110 <description>
 111 Computes the extents of a sub-portion of a glyph string. The extents are
 112 relative to the start of the glyph string range (the origin of their
 113 coordinate system is at the start of the range, not at the start of the entire
 114 glyph string).
 115
 116 </description>
 117 <parameters>
 118 <parameter name="glyphs">
 119 <parameter_description>   a #PangoGlyphString
 120 </parameter_description>
 121 </parameter>
 122 <parameter name="start">
 123 <parameter_description>    start index
 124 </parameter_description>
 125 </parameter>
 126 <parameter name="end">
 127 <parameter_description>      end index (the range is the set of bytes with
 128               indices such that start &amp;lt;= index &amp;lt; end)
 129 </parameter_description>
 130 </parameter>
 131 <parameter name="font">
 132 <parameter_description>     a #PangoFont
 133 </parameter_description>
 134 </parameter>
 135 <parameter name="ink_rect">
 136 <parameter_description> rectangle used to store the extents of the glyph string range as drawn.
 137 </parameter_description>
 138 </parameter>
 139 <parameter name="logical_rect">
 140 <parameter_description> rectangle used to store the logical extents of the glyph string range.
 141 </parameter_description>
 142 </parameter>
 143 </parameters>
 144 <return></return>
 145 </function>
 146
 147 <function name="pango_layout_get_extents">
 148 <description>
 149 Compute the logical and ink extents of @layout. Logical extents
 150 are usually what you want for positioning things. The extents
 151 are given in layout coordinates; layout coordinates begin at the
 152 top left corner of the layout.
 153
 154 </description>
 155 <parameters>
 156 <parameter name="layout">
 157 <parameter_description>   a #PangoLayout
 158 </parameter_description>
 159 </parameter>
 160 <parameter name="ink_rect">
 161 <parameter_description> rectangle used to store the extents of the layout as drawn.
 162 </parameter_description>
 163 </parameter>
 164 <parameter name="logical_rect">
 165 <parameter_description> rectangle used to store the logical extents of the layout.
 166 </parameter_description>
 167 </parameter>
 168 </parameters>
 169 <return></return>
 170 </function>
 171
 172 <function name="pango_layout_get_pixel_extents">
 173 <description>
 174 Compute the logical and ink extents of @layout in device units.
 175 See pango_layout_get_extents(); this function just calls
 176 pango_layout_get_extents() and then converts the extents to
 177 pixels using the #PANGO_SCALE factor.
 178
 179 </description>
 180 <parameters>
 181 <parameter name="layout">
 182 <parameter_description>   a #PangoLayout
 183 </parameter_description>
 184 </parameter>
 185 <parameter name="ink_rect">
 186 <parameter_description> rectangle used to store the extents of the layout as drawn.
 187 </parameter_description>
 188 </parameter>
 189 <parameter name="logical_rect">
 190 <parameter_description> rectangle used to store the logical extents of the
 191 layout.
 192 </parameter_description>
 193 </parameter>
 194 </parameters>
 195 <return></return>
 196 </function>
 197
 198 <function name="pango_layout_set_font_description">
 199 <description>
 200 Set the default font description for the layout. If no font
 201 description is set on the layout, the font description from
 202 the layout&apos;s context is used.
 203
 204 </description>
 205 <parameters>
 206 <parameter name="layout">
 207 <parameter_description> a #PangoLayout
 208 </parameter_description>
 209 </parameter>
 210 <parameter name="desc">
 211 <parameter_description> the new pango font description.
 212 </parameter_description>
 213 </parameter>
 214 </parameters>
 215 <return></return>
 216 </function>
 217
 218 <function name="pango_layout_line_get_extents">
 219 <description>
 220 Compute the logical and ink extents of a layout line. See the documentation
 221 for pango_font_get_glyph_extents() for details about the interpretation
 222 of the rectangles.
 223
 224 </description>
 225 <parameters>
 226 <parameter name="line">
 227 <parameter_description>     a #PangoLayoutLine
 228 </parameter_description>
 229 </parameter>
 230 <parameter name="ink_rect">
 231 <parameter_description> rectangle used to store the extents of the glyph string as drawn.
 232 </parameter_description>
 233 </parameter>
 234 <parameter name="logical_rect">
 235 <parameter_description> rectangle used to store the logical extents of the glyph string.
 236 </parameter_description>
 237 </parameter>
 238 </parameters>
 239 <return></return>
 240 </function>
 241
 242 <function name="pango_layout_line_get_pixel_extents">
 243 <description>
 244 Compute the logical and ink extents of a layout line. See the documentation
 245 for pango_font_get_glyph_extents() for details about the interpretation
 246 of the rectangles. The returned rectangles are in device units, as
 247 opposed to pango_layout_line_get_extents(), which returns the extents in
 248 units of device unit / PANGO_SCALE.
 249
 250 </description>
 251 <parameters>
 252 <parameter name="layout_line">
 253 <parameter_description> a #PangoLayoutLine
 254 </parameter_description>
 255 </parameter>
 256 <parameter name="ink_rect">
 257 <parameter_description>    rectangle used to store the extents of the glyph string as drawn.
 258 </parameter_description>
 259 </parameter>
 260 <parameter name="logical_rect">
 261 <parameter_description> rectangle used to store the logical extents of the glyph string.
 262 </parameter_description>
 263 </parameter>
 264 </parameters>
 265 <return></return>
 266 </function>
 267
 268 <function name="pango_font_get_metrics">
 269 <description>
 270 Gets overall metric information for a font. Since the metrics may be
 271 substantially different for different scripts, a language tag can
 272 be provided to indicate that the metrics should be retrieved that
 273 correspond to the script(s) used by that language.
 274
 275
 276 </description>
 277 <parameters>
 278 <parameter name="font">
 279 <parameter_description> a #PangoFont
 280 </parameter_description>
 281 </parameter>
 282 <parameter name="language">
 283 <parameter_description> language tag used to determine which script to get the metrics
 284 for.
 285 </parameter_description>
 286 </parameter>
 287 </parameters>
 288 <return> a #PangoMetrics object.
 289 </return>
 290 </function>
 291
 292 <function name="pango_glyph_string_extents">
 293 <description>
 294 Compute the logical and ink extents of a glyph string. See the documentation
 295 for pango_font_get_glyph_extents() for details about the interpretation
 296 of the rectangles.
 297
 298 </description>
 299 <parameters>
 300 <parameter name="glyphs">
 301 <parameter_description>   a #PangoGlyphString
 302 </parameter_description>
 303 </parameter>
 304 <parameter name="font">
 305 <parameter_description>     a #PangoFont
 306 </parameter_description>
 307 </parameter>
 308 <parameter name="ink_rect">
 309 <parameter_description> rectangle used to store the extents of the glyph string as drawn.
 310 </parameter_description>
 311 </parameter>
 312 <parameter name="logical_rect">
 313 <parameter_description> rectangle used to store the logical extents of the glyph string.
 314 </parameter_description>
 315 </parameter>
 316 </parameters>
 317 <return></return>
 318 </function>
 319
 320 <function name="pango_font_description_to_string">
 321 <description>
 322 Creates a string representation of a font description. See
 323 pango_font_description_from_string() for a description of the
 324 format of the string representation. The family list in the
 325 string description will only have a terminating comma if the
 326 last word of the list is a valid style option.
 327
 328
 329 </description>
 330 <parameters>
 331 <parameter name="desc">
 332 <parameter_description> a #PangoFontDescription
 333 </parameter_description>
 334 </parameter>
 335 </parameters>
 336 <return> The string.
 337 </return>
 338 </function>
 339
 340 <function name="pango_font_description_to_filename">
 341 <description>
 342 Creates a filename representation of a font description. The
 343 filename is identical to the result from calling
 344 pango_font_description_to_string(), but with underscores instead of
 345 characters that are untypical in filenames, and in lower case only.
 346
 347
 348 </description>
 349 <parameters>
 350 <parameter name="desc">
 351 <parameter_description> a #PangoFontDescription
 352 </parameter_description>
 353 </parameter>
 354 </parameters>
 355 <return> The filename.
 356 </return>
 357 </function>
 358
 359 <function name="pango_color_parse">
 360 <description>
 361 Fill in the fields of a color from a string specification. The
 362 string can either one of a large set of standard names. (Taken
 363 from the X11 &amp;lt;filename&amp;gt;rgb.txt&amp;lt;/filename&amp;gt; file), or it can be a hex value in the
 364 form &apos;#rgb&apos; &apos;#rrggbb&apos; &apos;#rrrgggbbb&apos; or &apos;#rrrrggggbbbb&apos; where
 365 &apos;r&apos;, &apos;g&apos; and &apos;b&apos; are hex digits of the red, green, and blue
 366 components of the color, respectively. (White in the four
 367 forms is &apos;#fff&apos; &apos;#ffffff&apos; &apos;#fffffffff&apos; and &apos;#ffffffffffff&apos;)
 368 </description>
 369 </function>
 370
 371 </root>
 372