summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/base/fdata_epdf.lua
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/luatex/base/fdata_epdf.lua')
-rw-r--r--Master/texmf-dist/doc/luatex/base/fdata_epdf.lua139
1 files changed, 132 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/luatex/base/fdata_epdf.lua b/Master/texmf-dist/doc/luatex/base/fdata_epdf.lua
index eea799d32c0..991b6223b39 100644
--- a/Master/texmf-dist/doc/luatex/base/fdata_epdf.lua
+++ b/Master/texmf-dist/doc/luatex/base/fdata_epdf.lua
@@ -1,4 +1,4 @@
--- $Id: fdata_epdf.lua 4165 2011-04-16 09:01:02Z taco $
+-- $Id: fdata_epdf.lua 4559 2013-01-20 19:58:26Z hhenkel $
local fdata_epdf = {
functions = {
@@ -351,13 +351,13 @@ local fdata_epdf = {
},
embeddedFile = {
type = "function",
- shortdesc = "Get embedded file.",
+ shortdesc = "Get file spec of embedded file.",
arguments = {
{type = "Catalog", name = "catalog", optional = false, },
{type = "integer", name = "integer", optional = false, },
},
returnvalues = {
- {type = "EmbFile", name = "var", optional = false, },
+ {type = "FileSpec", name = "var", optional = false, },
},
},
numJS = {
@@ -494,6 +494,70 @@ local fdata_epdf = {
{type = "boolean", name = "var", optional = false, },
},
},
+ save = {
+ type = "function",
+ shortdesc = "Save embedded file to disk.",
+ arguments = {
+ {type = "EmbFile", name = "embfile", optional = false, },
+ {type = "string", name = "var", optional = false, },
+ },
+ returnvalues = {
+ {type = "boolean", name = "var", optional = false, },
+ },
+ },
+ },
+------------------------------------------------------------------------
+ FileSpec = {
+ isOk = {
+ type = "function",
+ shortdesc = "Check if filespec is ok.",
+ arguments = {
+ {type = "FileSpec", name = "filespec", optional = false, },
+ },
+ returnvalues = {
+ {type = "boolean", name = "var", optional = false, },
+ },
+ },
+ getFileName = {
+ type = "function",
+ shortdesc = "Get file name of filespec.",
+ arguments = {
+ {type = "FileSpec", name = "filespec", optional = false, },
+ },
+ returnvalues = {
+ {type = "string", name = "string", optional = false, },
+ },
+ },
+ getFileNameForPlatform = {
+ type = "function",
+ shortdesc = "Get file name for platform of filespec.",
+ arguments = {
+ {type = "FileSpec", name = "filespec", optional = false, },
+ },
+ returnvalues = {
+ {type = "string", name = "string", optional = false, },
+ },
+ },
+ getDescription = {
+ type = "function",
+ shortdesc = "Get description of filespec.",
+ arguments = {
+ {type = "FileSpec", name = "filespec", optional = false, },
+ },
+ returnvalues = {
+ {type = "string", name = "string", optional = false, },
+ },
+ },
+ getEmbeddedFile = {
+ type = "function",
+ shortdesc = "Get embedded file of filespec.",
+ arguments = {
+ {type = "FileSpec", name = "filespec", optional = false, },
+ },
+ returnvalues = {
+ {type = "EmbFile", name = "embfile", optional = false, },
+ },
+ },
},
------------------------------------------------------------------------
Dict = {
@@ -559,7 +623,7 @@ local fdata_epdf = {
},
is = {
type = "function",
- shortdesc = "TODO",
+ shortdesc = "Check if Dict is of given /Type.",
arguments = {
{type = "Dict", name = "dict", optional = false, },
{type = "string", name = "string", optional = false, },
@@ -635,6 +699,42 @@ local fdata_epdf = {
{type = "Object", name = "var", optional = false, },
},
},
+ hasKey = {
+ type = "function",
+ shortdesc = "Check if Dict contains /Key.",
+ arguments = {
+ {type = "Dict", name = "dict", optional = false, },
+ {type = "string", name = "string", optional = false, },
+ },
+ returnvalues = {
+ {type = "boolean", name = "var", optional = false, },
+ },
+ },
+ },
+------------------------------------------------------------------------
+ Link = {
+ isOK = {
+ type = "function",
+ shortdesc = "Check if Link object is ok.",
+ arguments = {
+ {type = "Link", name = "link", optional = false, },
+ },
+ returnvalues = {
+ {type = "boolean", name = "var", optional = false, },
+ },
+ },
+ inRect = {
+ type = "function",
+ shortdesc = "Check if point is inside the link rectangle.",
+ arguments = {
+ {type = "Link", name = "link", optional = false, },
+ {type = "number", name = "number", optional = false, },
+ {type = "number", name = "number", optional = false, },
+ },
+ returnvalues = {
+ {type = "boolean", name = "var", optional = false, },
+ },
+ },
},
------------------------------------------------------------------------
LinkDest = {
@@ -780,6 +880,30 @@ local fdata_epdf = {
},
},
------------------------------------------------------------------------
+ Links = {
+ getNumLinks = {
+ type = "function",
+ shortdesc = "Get number of links.",
+ arguments = {
+ {type = "Links", name = "links", optional = false, },
+ },
+ returnvalues = {
+ {type = "integer", name = "var", optional = false, },
+ },
+ },
+ getLink = {
+ type = "function",
+ shortdesc = "Get link by number.",
+ arguments = {
+ {type = "Links", name = "links", optional = false, },
+ {type = "integer", name = "integer", optional = false, },
+ },
+ returnvalues = {
+ {type = "Link", name = "var", optional = false, },
+ },
+ },
+ },
+------------------------------------------------------------------------
Object = {
initBool = {
type = "function",
@@ -842,7 +966,7 @@ local fdata_epdf = {
},
initArray = {
type = "function",
- shortdesc = "Initialize an Array-type object.",
+ shortdesc = "Initialize an Array-type object with an empty array.",
arguments = {
{type = "Object", name = "object", optional = false, },
{type = "XRef", name = "xref", optional = false, },
@@ -852,7 +976,7 @@ local fdata_epdf = {
},
initDict = {
type = "function",
- shortdesc = "Initialize a Dict-type object.",
+ shortdesc = "Initialize a Dict-type object with an empty dictionary.",
arguments = {
{type = "Object", name = "object", optional = false, },
{type = "XRef", name = "xref", optional = false, },
@@ -1352,9 +1476,10 @@ local fdata_epdf = {
},
streamIs = {
type = "function",
- shortdesc = "TODO",
+ shortdesc = "Check if object contains a stream whose dictionary is of given /Type.",
arguments = {
{type = "Object", name = "object", optional = false, },
+ {type = "string", name = "string", optional = false, },
},
returnvalues = {
{type = "boolean", name = "var", optional = false, },