/usr/share/gtk-doc/html/libcroco/libcroco-cr-doc-handler.html is in libcroco3-dev 0.6.12-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cr-doc-handler: Libcroco Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libcroco Reference Manual">
<link rel="up" href="ch01.html" title="Extensive APIs description">
<link rel="prev" href="libcroco-cr-declaration.html" title="cr-declaration">
<link rel="next" href="libcroco-cr-enc-handler.html" title="cr-enc-handler">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libcroco-cr-doc-handler.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libcroco-cr-declaration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libcroco-cr-enc-handler.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libcroco-cr-doc-handler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcroco-cr-doc-handler.top_of_page"></a>cr-doc-handler</span></h2>
<p>cr-doc-handler</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libcroco-cr-doc-handler.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="returnvalue">CRDocHandler</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-new" title="cr_doc_handler_new ()">cr_doc_handler_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-set-result" title="cr_doc_handler_set_result ()">cr_doc_handler_set_result</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-get-result" title="cr_doc_handler_get_result ()">cr_doc_handler_get_result</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-set-ctxt" title="cr_doc_handler_set_ctxt ()">cr_doc_handler_set_ctxt</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-get-ctxt" title="cr_doc_handler_get_ctxt ()">cr_doc_handler_get_ctxt</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-set-default-sac-handler" title="cr_doc_handler_set_default_sac_handler ()">cr_doc_handler_set_default_sac_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-associate-a-parser" title="cr_doc_handler_associate_a_parser ()">cr_doc_handler_associate_a_parser</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-ref" title="cr_doc_handler_ref ()">cr_doc_handler_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-unref" title="cr_doc_handler_unref ()">cr_doc_handler_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-doc-handler.html#cr-doc-handler-destroy" title="cr_doc_handler_destroy ()">cr_doc_handler_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-doc-handler.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler">CRDocHandler</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandlerPriv" title="CRDocHandlerPriv">CRDocHandlerPriv</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-doc-handler.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libcroco-cr-doc-handler.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cr-doc-handler-new"></a><h3>cr_doc_handler_new ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="returnvalue">CRDocHandler</span></a> *
cr_doc_handler_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the newly built instance of
<a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a></p>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-set-result"></a><h3>cr_doc_handler_set_result ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_doc_handler_set_result (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> a_result</code></em>);</pre>
<p>Sets the private parsing context.
This is used by libcroco only.</p>
<p>Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="cr-doc-handler-set-result.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_result</p></td>
<td class="parameter_description"><p>the new result.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-get-result"></a><h3>cr_doc_handler_get_result ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_doc_handler_get_result (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> const *a_this</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *a_result</code></em>);</pre>
<p>Gets the private parsing result.
The private parsing result is used by libcroco only.</p>
<p>Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="cr-doc-handler-get-result.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_result</p></td>
<td class="parameter_description"><p>out parameter. The returned result.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-set-ctxt"></a><h3>cr_doc_handler_set_ctxt ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_doc_handler_set_ctxt (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> a_ctxt</code></em>);</pre>
<p>Sets the private parsing context.
This is used by libcroco only.
Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="cr-doc-handler-set-ctxt.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_ctxt</p></td>
<td class="parameter_description"><p>a pointer to the parsing context.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-get-ctxt"></a><h3>cr_doc_handler_get_ctxt ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_doc_handler_get_ctxt (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> const *a_this</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *a_ctxt</code></em>);</pre>
<p>Gets the private parsing context associated to the document handler
The private parsing context is used by libcroco only.</p>
<p>Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="cr-doc-handler-get-ctxt.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_ctxt</p></td>
<td class="parameter_description"><p>out parameter. The new parsing context.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-set-default-sac-handler"></a><h3>cr_doc_handler_set_default_sac_handler ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_doc_handler_set_default_sac_handler
(<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>);</pre>
<p>Sets the sac handlers contained in the current
instance of DocHandler to the default handlers.
For the time being the default handlers are
test handlers. This is expected to change in a
near future, when the libcroco gets a bit debugged.</p>
<p>Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="cr-doc-handler-set-default-sac-handler.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>a pointer to the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-associate-a-parser"></a><h3>cr_doc_handler_associate_a_parser ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_doc_handler_associate_a_parser (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> a_parser</code></em>);</pre>
<p><em class="parameter"><code>a_this</code></em>
: the current instance of document handler.
<em class="parameter"><code>a_parser</code></em>
: the parser to associate.</p>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-ref"></a><h3>cr_doc_handler_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_doc_handler_ref (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>);</pre>
<div class="refsect3">
<a name="cr-doc-handler-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-unref"></a><h3>cr_doc_handler_unref ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
cr_doc_handler_unref (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>);</pre>
<p>Decreases the ref count of the current instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a>.
If the ref count reaches '0' then, destroys the instance.</p>
<p>Returns TRUE if the instance as been destroyed, FALSE otherwise.</p>
<div class="refsect3">
<a name="cr-doc-handler-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the currrent instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-doc-handler-destroy"></a><h3>cr_doc_handler_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_doc_handler_destroy (<em class="parameter"><code><a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> *a_this</code></em>);</pre>
<p>The destructor of the <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> class.</p>
<div class="refsect3">
<a name="cr-doc-handler-destroy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the instance of <a class="link" href="libcroco-cr-doc-handler.html#CRDocHandler" title="struct CRDocHandler"><span class="type">CRDocHandler</span></a> to
destroy.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libcroco-cr-doc-handler.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CRDocHandler"></a><h3>struct CRDocHandler</h3>
<pre class="programlisting">struct CRDocHandler {
CRDocHandlerPriv *priv ;
/**
*This pointer is to be used by the application for
*it custom needs. It is there to extend the doc handler.
*/
gpointer app_data ;
/**
*Is called at the beginning of the parsing of the document.
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*/
void (*start_document) (CRDocHandler *a_this) ;
/**
*Is called to notify the end of the parsing of the document.
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*/
void (*end_document) (CRDocHandler *a_this) ;
/**
*Is called to notify an at charset rule.
*@param a_this the document handler.
*@param a_charset the declared charset.
*/
void (*charset) (CRDocHandler *a_this,
CRString *a_charset,
CRParsingLocation *a_charset_sym_location) ;
/**
*Is called to notify an import statement in
*the stylesheet.
*@param a_this the current instance of #CRDocHandler.
*@param a_media_list a doubly linked list of GString objects.
*Each GString object contains a string which is the
*destination media for style information.
*@param a_uri the uri of the imported style sheet.
*@param a_uri_default_ns the default namespace of URI
*@param a_location the parsing location of the '\@import'
*keyword.
*of the imported style sheet.
*/
void (*import_style) (CRDocHandler *a_this,
GList *a_media_list,
CRString *a_uri,
CRString *a_uri_default_ns,
CRParsingLocation *a_location) ;
void (*import_style_result) (CRDocHandler *a_this,
GList *a_media_list,
CRString *a_uri,
CRString *a_uri_default_ns,
CRStyleSheet *a_sheet) ;
/**
*Is called to notify a namespace declaration.
*Not used yet.
*@param a_this the current instance of #CRDocHandler.
*@param a_prefix the prefix of the namespace.
*@param a_uri the uri of the namespace.
*@param a_location the location of the "@namespace" keyword.
*/
void (*namespace_declaration) (CRDocHandler *a_this,
CRString *a_prefix,
CRString *a_uri,
CRParsingLocation *a_location) ;
/**
*Is called to notify a comment.
*@param a_this a pointer to the current instance
*of #CRDocHandler.
*@param a_comment the comment.
*/
void (*comment) (CRDocHandler *a_this,
CRString *a_comment) ;
/**
*Is called to notify the beginning of a rule
*statement.
*@param a_this the current instance of #CRDocHandler.
*@param a_selector_list the list of selectors that precedes
*the rule declarations.
*/
void (*start_selector) (CRDocHandler * a_this,
CRSelector *a_selector_list) ;
/**
*Is called to notify the end of a rule statement.
*@param a_this the current instance of #CRDocHandler.
*@param a_selector_list the list of selectors that precedes
*the rule declarations. This pointer is the same as
*the one passed to start_selector() ;
*/
void (*end_selector) (CRDocHandler *a_this,
CRSelector *a_selector_list) ;
/**
*Is called to notify a declaration.
*@param a_this a pointer to the current instance
*of #CRDocHandler.
*@param a_name the name of the parsed property.
*@param a_expression a css expression that represents
*the value of the property. A css expression is
*actually a linked list of 'terms'. Each term can
*be linked to other using operators.
*
*/
void (*property) (CRDocHandler *a_this,
CRString *a_name,
CRTerm *a_expression,
gboolean a_is_important) ;
/**
*Is called to notify the start of a font face statement.
*The parser invokes this method at the beginning of every
*font face statement in the style sheet. There will
*be a corresponding end_font_face () event for every
*start_font_face () event.
*
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*@param a_location the parsing location of the "\@font-face"
*keyword.
*/
void (*start_font_face) (CRDocHandler *a_this,
CRParsingLocation *a_location) ;
/**
*Is called to notify the end of a font face statement.
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*/
void (*end_font_face) (CRDocHandler *a_this) ;
/**
*Is called to notify the beginning of a media statement.
*The parser will invoke this method at the beginning of
*every media statement in the style sheet. There will be
*a corresponding end_media() event for every start_media()
*event.
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*@param a_media_list a double linked list of
#CRString * objects.
*Each CRString objects is actually a destination media for
*the style information.
*/
void (*start_media) (CRDocHandler *a_this,
GList *a_media_list,
CRParsingLocation *a_location) ;
/**
*Is called to notify the end of a media statement.
*@param a_this a pointer to the current instance
*of #CRDocHandler.
*@param a_media_list a double linked list of GString * objects.
*Each GString objects is actually a destination media for
*the style information.
*/
void (*end_media) (CRDocHandler *a_this,
GList *a_media_list) ;
/**
*Is called to notify the beginning of a page statement.
*The parser invokes this function at the beginning of
*every page statement in the style sheet. There will be
*a corresponding end_page() event for every single
*start_page() event.
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*@param a_name the name of the page (if any, null otherwise).
*@param a_pseudo_page the pseudo page (if any, null otherwise).
*@param a_location the parsing location of the "\@page" keyword.
*/
void (*start_page) (CRDocHandler *a_this,
CRString *a_name,
CRString *a_pseudo_page,
CRParsingLocation *a_location) ;
/**
*Is called to notify the end of a page statement.
*@param a_this a pointer to the current instance of
*#CRDocHandler.
*@param a_name the name of the page (if any, null otherwise).
*@param a_pseudo_page the pseudo page (if any, null otherwise).
*/
void (*end_page) (CRDocHandler *a_this,
CRString *a_name,
CRString *pseudo_page) ;
/**
*Is Called to notify an unknown at-rule not supported
*by this parser.
*/
void (*ignorable_at_rule) (CRDocHandler *a_this,
CRString *a_name) ;
/**
*Is called to notify a parsing error. After this error
*the application must ignore the rule being parsed, if
*any. After completion of this callback,
*the parser will then try to resume the parsing,
*ignoring the current error.
*/
void (*error) (CRDocHandler *a_this) ;
/**
*Is called to notify an unrecoverable parsing error.
*This is the place to put emergency routines that free allocated
*resources.
*/
void (*unrecoverable_error) (CRDocHandler *a_this) ;
gboolean resolve_import ;
gulong ref_count ;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="CRDocHandlerPriv"></a><h3>CRDocHandlerPriv</h3>
<pre class="programlisting">typedef struct _CRDocHandlerPriv CRDocHandlerPriv;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|