From a139d2b36da39fbfb018ef6973e9316a64a4ca6c Mon Sep 17 00:00:00 2001
From: Jay Berkenbilt <ejb@ql.org>
Date: Fri, 1 Jan 2021 07:31:54 -0500
Subject: Add several methods for working with form XObjects (fixes #436)

Make some more methods in QPDFPageObjectHelper work with form
XObjects, provide forEach methods to walk through nested form
XObjects, possibly recursively. This should make it easier to work
with form XObjects from user code.
---
 manual/qpdf-manual.xml | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

(limited to 'manual/qpdf-manual.xml')

diff --git a/manual/qpdf-manual.xml b/manual/qpdf-manual.xml
index 0b7156b2..bae87536 100644
--- a/manual/qpdf-manual.xml
+++ b/manual/qpdf-manual.xml
@@ -4857,6 +4857,60 @@ print "\n";
           illustrates how to use this capability.
          </para>
         </listitem>
+        <listitem>
+         <para>
+          Add methods to <classname>QPDFPageObjectHelper</classname>
+          to iterate through XObjects on a page or form XObjects,
+          possibly recursing into nested form XObjects:
+          <function>forEachXObject</function>,
+          <function>ForEachImage</function>,
+          <function>forEachFormXObject</function>.
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          Enhance several methods in
+          <classname>QPDFPageObjectHelper</classname> to work with
+          form XObjects as well as pages, as noted in comments. See
+          <filename>ChangeLog</filename> for a full list.
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          Rename some functions in
+          <classname>QPDFPageObjectHelper</classname>, while keeping
+          old names for compatibility:
+          <itemizedlist>
+           <listitem>
+            <para>
+             <function>getPageImages</function> to
+             <function>getImages</function>
+            </para>
+           </listitem>
+           <listitem>
+            <para>
+             <function>filterPageContents</function> to
+             <function>filterContents</function>
+            </para>
+           </listitem>
+          </itemizedlist>
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          Add method
+          <function>QPDFPageObjectHelper::getFormXObjects</function>
+          to return a map of form XObjects directly on a page or form
+          XObject
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          Add new helper methods to
+          <classname>QPDFObjectHandle</classname>:
+          <function>isFormXObject</function>, <function>isImage</function>
+         </para>
+        </listitem>
         <listitem>
          <para>
           Add the optional <function>allow_streams</function>
-- 
cgit v1.2.3-54-g00ecf