DEVEL/gdome_xslt/0.0.8-1/ocaml/gdome_xslt/gdome_xslt.mli

   1 (* This file is part of an ocaml binding of an XSLT engine working on Gdome
   2  * documents.
   3  *
   4  * The code is largely based on the code of T.J. Mather's XML::GDOME::XSLT
   5  * Perl module (http://kobesearch.cpan.org/search?dist=XML-GDOME-XSLT)
   6  *
   7  * Copyright (C) 2002:
   8  *      Claudio Sacerdoti Coen  <sacerdot@cs.unibo.it>
   9  *      Stefano Zacchiroli      <zack@cs.unibo.it>
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; either
  14  * version 2.1 of the License, or (at your option) any later version.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  *
  25  * For more information, please send an email to {sacerdot,zack}@cs.unibo.it
  26  *)
  27
  28 (** Main interface to GDome XSLT functionalities *)
  29
  30 (** processStylesheet stylesheet
  31  *
  32  * Process a stylesheet so that it can be subsequently used with
  33  * applyStylesheet. *)
  34 val processStylesheet:
  35  Gdome.document ->
  36    I_gdome_xslt.processed_stylesheet
  37
  38 (** applyStylesheet source stylesheet params
  39  * Applies a processed stylesheet to a source document, using the given list of
  40  * parameters (couples name,value) *)
  41 val applyStylesheet:
  42  source: Gdome.document ->
  43  stylesheet:I_gdome_xslt.processed_stylesheet ->
  44  params:(string * string) list ->
  45    Gdome.document
  46
  47 (** output the result of a previous XSLT transformation to an output channel *)
  48 val saveResultToChannel:
  49   outchan: out_channel ->
  50   result: Gdome.document ->
  51   stylesheet: I_gdome_xslt.processed_stylesheet ->
  52     unit
  53
  54 (** set error callback, that is a function invoked each time an error message is
  55  * generated. If None is passed, libxslt default error callback is used *)
  56 val setErrorCallback: (string -> unit) option -> unit
  57
  58 (** set debug callback, that is a function invoked each time a debugging message
  59  * is generated. If None is passed, libxslt default error callback is used *)
  60 val setDebugCallback: (string -> unit) option -> unit
  61