output: Add support for captions.

[pspp] / src / output / table-item.h

diff --git a/src/output/table-item.h b/src/output/table-item.h
index 15f5c568f37b15350363dc40a0fd29692575f2e1..855324416fa066cd73d6c03896567071e4279d7a 100644 (file)
--- a/src/output/table-item.h
+++ b/src/output/table-item.h
@@ -20,8 +20,10 @@
 /* Table items.
 
    A table item is a subclass of an output item (see output-item.h) that
-   contains a table (see table.h) and some formatting properties (currently
-   just a title). */
+   contains a table (see table.h) and some formatting properties.  Currently
+   the formatting properties are an optional title (a brief description
+   typically displayed above the table) and an optional caption (a more verbose
+   description typically displayed below the table). */
 
 #include "libpspp/compiler.h"
 #include "output/output-item.h"
@@ -35,14 +37,19 @@ struct table_item
     struct output_item output_item; /* Superclass. */
     struct table *table;        /* The table to be rendered. */
     char *title;                /* May be null if there is no title. */
+    char *caption;              /* May be null if there is no caption. */
   };
 
-struct table_item *table_item_create (struct table *, const char *title);
+struct table_item *table_item_create (struct table *, const char *title,
+                                      const char *caption);
 
 const struct table *table_item_get_table (const struct table_item *);
 
 const char *table_item_get_title (const struct table_item *);
 void table_item_set_title (struct table_item *, const char *);
+
+const char *table_item_get_caption (const struct table_item *);
+void table_item_set_caption (struct table_item *, const char *);
 \f
 /* This boilerplate for table_item, a subclass of output_item, was
    autogenerated by mk-class-boilerplate. */