src/pango/PgEngine.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * duit is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with duit; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = pango-Engines.html
  26  * outPack = pango
  27  * outFile = PgEngine
  28  * strct   =
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = PgEngine
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - script_engine_
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  *      - glib.Str
  45  * structWrap:
  46  * local aliases:
  47  */
  48
  49 module pango.PgEngine;
  50
  51 private import pango.pangotypes;
  52
  53 private import lib.pango;
  54
  55 private import glib.Str;
  56
  57 /**
  58  * Description
  59  * Pango utilizes a module architecture in which the language-specific
  60  * and render-system-specific components are provided by loadable
  61  * modules. Each loadable module supplies one or more
  62  * engines. Each engine
  63  * has an associated engine type and
  64  * render type. These two types are represented by
  65  * strings.
  66  * Each dynamically-loaded module exports several functions which provide
  67  * the public API. These functions are script_engine_list(),
  68  * script_engine_init() and script_engine_exit, and
  69  * script_engine_create(). The latter three functions are used when
  70  * creating engines from the module at run time, while the first
  71  * function is used when building a catalog of all available modules.
  72  */
  73 public class PgEngine
  74 {
  75
  76         /**
  77          */
  78
  79
  80
  81
  82
  83
  84         /**
  85          * Function to be provided by a module to list the engines that the
  86          * module supplies. The function stores a pointer to an array
  87          * of PangoEngineInfo structures and the length of that array in
  88          * the given location.
  89          * Note that script_engine_init() will not be called before this
  90          * function.
  91          * engines:
  92          *  location to store a pointer to an array of engines.
  93          * n_engines:
  94          *  location to store the number of elements in engines.
  95          */
  96         public static void list(PangoEngineInfo** engines, int* nEngines)
  97         {
  98                 // void script_engine_list (PangoEngineInfo **engines,  int *n_engines);
  99                 script_engine_list(engines, nEngines);
 100         }
 101
 102         /**
 103          * Function to be provided by a module to register any
 104          * GObject types in the module.
 105          * module:
 106          *  a GTypeModule structure used to associate any
 107          *  GObject types created in this module with the module.
 108          */
 109         public static void init(GTypeModule* modul)
 110         {
 111                 // void script_engine_init (GTypeModule *module);
 112                 script_engine_init(modul);
 113         }
 114
 115         /**
 116          * Function to be provided by the module that is called
 117          * when the module is unloading. Frequently does nothing.
 118          */
 119         public static void exit()
 120         {
 121                 // void script_engine_exit (void);
 122                 script_engine_exit();
 123         }
 124
 125         /**
 126          * Function to be provided by the module to create an instance
 127          * of one of the engines implemented by the module.
 128          * id:
 129          *  the ID of an engine as reported by script_engine_list.
 130          * Returns:
 131          *  a newly created PangoEngine of the specified
 132          *  type, or NULL if an error occurred. (In normal operation,
 133          *  a module should not return NULL. A NULL return is only
 134          *  acceptable in the case where system misconfiguration or
 135          *  bugs in the driver routine are encountered.)
 136          */
 137         public static PangoEngine* create(char[] id)
 138         {
 139                 // PangoEngine* script_engine_create (const char *id);
 140                 return script_engine_create(Str.toStringz(id));
 141         }
 142 }