manual/old/fdata_img.lua

   1 -- $Id: fdata_img.lua 4106 2011-04-10 12:51:54Z hhenkel $
   2
   3 local fdata_img = {
   4   ["functions"] = {
   5     ["boxes"] = {
   6       ["arguments"] = {},
   7       ["returnvalues"] = {
   8             {
   9                ["name"] = "boxes",
  10                ["optional"] = false,
  11                ["type"] = "table",
  12             },
  13       },
  14       ["shortdesc"] = "Returns a list of supported image bounding box names.",
  15       ["type"] = "function",
  16     },
  17     ["copy"] = {
  18       ["arguments"] = {
  19             {
  20                ["name"] = "var",
  21                ["optional"] = false,
  22                ["type"] = "image",
  23             },
  24       },
  25       ["returnvalues"] = {
  26             {
  27                ["name"] = "var",
  28                ["optional"] = false,
  29                ["type"] = "image",
  30             },
  31       },
  32       ["shortdesc"] = "Copy an image.",
  33       ["type"] = "function",
  34     },
  35     ["immediatewrite"] = {
  36       ["arguments"] = {
  37             {
  38                ["name"] = "var",
  39                ["optional"] = false,
  40                ["type"] = "image",
  41             },
  42       },
  43       ["returnvalues"] = {
  44             {
  45                ["name"] = "var",
  46                ["optional"] = false,
  47                ["type"] = "image",
  48             },
  49       },
  50       ["shortdesc"] = "Write the image to the PDF file immediately.",
  51       ["type"] = "function",
  52     },
  53     ["keys"] = {
  54       ["arguments"] = {},
  55       ["returnvalues"] = {
  56             {
  57                ["name"] = "keys",
  58                ["optional"] = false,
  59                ["type"] = "table",
  60             },
  61       },
  62       ["shortdesc"] = "Returns a table with possible image table keys, including retrieved information.",
  63       ["type"] = "function",
  64     },
  65     ["new"] = {
  66       ["arguments"] = {
  67             {
  68                ["name"] = "var",
  69                ["optional"] = true,
  70                ["type"] = "table",
  71             },
  72          },
  73       ["returnvalues"] = {
  74             {
  75                ["name"] = "var",
  76                ["optional"] = false,
  77                ["type"] = "image",
  78             },
  79       },
  80       ["shortdesc"] = "This function creates an \\quote {image} object.  Allowed fields\
  81         in the table: \\aliteral{filename} (required), \\aliteral{width},\
  82         \\aliteral{depth}, \\aliteral{height}, \\aliteral{attr}, \\aliteral{page}, \\aliteral{pagebox}, \\aliteral{colorspace}).",
  83       ["type"] = "function",
  84     },
  85     ["node"] = {
  86       ["arguments"] = {
  87          {
  88             ["name"] = "var",
  89             ["optional"] = false,
  90             ["type"] = "image",
  91          },
  92       },
  93       ["returnvalues"] = {
  94          {
  95             ["name"] = "n",
  96             ["optional"] = false,
  97             ["type"] = "node",
  98          },
  99       },
 100       ["shortdesc"] = "Returns the node associated with an image.",
 101       ["type"] = "function",
 102     },
 103     ["scan"] = {
 104       ["arguments"] = {
 105          {
 106             ["name"] = "var",
 107             ["optional"] = false,
 108             ["type"] = "image",
 109          },
 110       },
 111       ["returnvalues"] = {
 112          {
 113             ["name"] = "var",
 114             ["optional"] = false,
 115             ["type"] = "image",
 116          },
 117       },
 118       ["shortdesc"] = "Processes an image file and stores the retrieved information in the image object.",
 119       ["type"] = "function",
 120     },
 121     ["types"] = {
 122       ["arguments"] = {},
 123       ["returnvalues"] = {
 124          {
 125             ["name"] = "types",
 126             ["optional"] = false,
 127             ["type"] = "table",
 128          },
 129       },
 130       ["shortdesc"] = "Returns a list of supported image types.",
 131       ["type"] = "function",
 132     },
 133     ["write"] = {
 134       ["arguments"] = {
 135          {
 136             ["name"] = "var",
 137             ["optional"] = false,
 138             ["type"] = "image",
 139          },
 140       },
 141       ["returnvalues"] = {
 142          {
 143             ["name"] = "var",
 144             ["optional"] = false,
 145             ["type"] = "image",
 146          },
 147       },
 148       ["shortdesc"] = "Write the image to the PDF file.",
 149       ["type"] = "function",
 150     },
 151   },
 152   ["methods"] = {
 153   },
 154 }
 155
 156 return fdata_img