work on docs
[pspp] / src / output / chart.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2009, 2011 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program 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 General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #ifndef OUTPUT_CHART_H
18 #define OUTPUT_CHART_H 1
19
20 /* Charts.
21
22    A chart is abstract.  Every actual chart is a subclass of chart. */
23
24 #include <stdbool.h>
25
26 /* A chart.
27
28    The members of struct chart should not be accessed directly.  Use one
29    of the accessor functions defined below. */
30 struct chart
31   {
32     int ref_cnt;
33     const struct chart_class *class; /* Subclass. */
34     char *title;                /* May be null if there is no title. */
35   };
36
37 struct chart *chart_ref (const struct chart *);
38 void chart_unref (struct chart *);
39 bool chart_is_shared (const struct chart *);
40
41 const char *chart_get_title (const struct chart *);
42 void chart_set_title (struct chart *, const char *);
43
44 void chart_submit (struct chart *);
45
46 #endif /* output/chart.h */