[goffice] Fix strings inconsistencies (3d vs. 3D). [#681777]
- From: Jean BrÃfort <jbrefort src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [goffice] Fix strings inconsistencies (3d vs. 3D). [#681777]
- Date: Mon, 13 Aug 2012 16:27:24 +0000 (UTC)
commit f2b7099e793ef8ceb9869796ba8397965f8d873d
Author: Jean Brefort <jean brefort normalesup org>
Date: Mon Aug 13 18:27:14 2012 +0200
Fix strings inconsistencies (3d vs. 3D). [#681777]
ChangeLog | 8 +++
NEWS | 1 +
docs/reference/goffice-docs.xml | 1 -
goffice/canvas/goc-item.c | 5 +-
goffice/canvas/goc-item.h | 1 +
goffice/component/go-component.c | 8 ---
goffice/component/go-component.h | 3 +-
goffice/graph/goffice-graph.h | 4 +-
goffice/graph/gog-axis-line.c | 22 +++++++++
goffice/graph/gog-axis.c | 28 +++++++++++
goffice/graph/gog-chart-map.c | 10 ++++
goffice/graph/gog-data-allocator.c | 16 +++++++
goffice/graph/gog-data-set.c | 15 ++++++
goffice/graph/gog-data-set.h | 1 +
goffice/graph/gog-error-bar.c | 16 +++++++
goffice/graph/gog-graph.c | 78 +++++++++++++++++++++++++++++++
goffice/graph/gog-grid.c | 11 +++++
goffice/graph/gog-label.c | 6 +++
goffice/graph/gog-object.c | 86 +++++++++++++++++++++++++++++++++++
goffice/graph/gog-object.h | 6 ++-
goffice/graph/gog-outlined-object.c | 6 +++
goffice/graph/gog-plot-engine.c | 31 +++++++++++++
goffice/graph/gog-plot-impl.h | 1 -
goffice/graph/gog-plot.c | 49 +++++++++++++++++++-
goffice/graph/gog-reg-curve.c | 2 -
goffice/graph/gog-reg-curve.h | 1 +
goffice/graph/gog-series.c | 24 ++++++++--
goffice/graph/gog-view.c | 28 +++++++++++-
goffice/graph/gog-view.h | 1 +
plugins/plot_barcol/gog-1.5d.c | 4 +-
plugins/plot_pie/gog-pie.c | 4 +-
plugins/plot_xy/gog-xy.c | 4 +-
32 files changed, 448 insertions(+), 33 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 53c4373..c6da450 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2012-08-13 Jean BrÃfort <jean brefort normalesup org>
+
+ * goffice/graph/gog-plot-impl.h: removed unused field in GogPlotDesc.
+ * goffice/graph/gog-plot.c (gog_plot_class_init): 3d -> 3D. [#681777]
+ * plugins/plot_barcol/gog-1.5d.c (gog_plot1_5d_class_init): ditto.
+ * plugins/plot_pie/gog-pie.c (gog_pie_plot_class_init): ditto.
+ * plugins/plot_xy/gog-xy.c (gog_bubble_plot_class_init): ditto.
+
2012-08-11 Jean Brefort <jean brefort normalesup org>
* goffice/Makefile.am: changed the build system.
diff --git a/NEWS b/NEWS
index 38b3079..4c19c1a 100644
--- a/NEWS
+++ b/NEWS
@@ -7,6 +7,7 @@ Jean:
* Allow axis choice for pseudo-3d plots. [see #680636]
* Allow filling to axis limits. [#680513]
* Save axis Id for all axes, not only X and Y. [#680739]
+ * Fix strings inconsistencies (3d vs. 3D). [#681777]
Morten:
* Minute accuracy improvement to matrix inversion.
diff --git a/docs/reference/goffice-docs.xml b/docs/reference/goffice-docs.xml
index 541418f..ca73886 100644
--- a/docs/reference/goffice-docs.xml
+++ b/docs/reference/goffice-docs.xml
@@ -32,7 +32,6 @@
<xi:include href="xml/gog-object.xml"/>
<xi:include href="xml/gog-styled-object.xml"/>
<xi:include href="xml/gog-outlined-object.xml"/>
- <xi:include href="xml/gog-plot-impl.xml"/>
<xi:include href="xml/gog-plot.xml"/>
<xi:include href="xml/gog-series.xml"/>
<xi:include href="xml/gog-trend-line.xml"/>
diff --git a/goffice/canvas/goc-item.c b/goffice/canvas/goc-item.c
index 4a13dd2..4659d9e 100644
--- a/goffice/canvas/goc-item.c
+++ b/goffice/canvas/goc-item.c
@@ -113,6 +113,7 @@ enum {
* @notify_scrolled: callback for a notify scrolled event. This is useful to
* reposition children of the GtkLayout parent of the canvas to their new
* position.
+ * @get_window: returns the#GdkWindow for the item if any.
*
* The base class for all canvas items.
**/
@@ -768,7 +769,7 @@ goc_item_get_window (GocItem *item)
/**
* goc_item_set_operator: (skip)
* @item: #GocItem
- * op: #cairo_operator_t
+ * @op: #cairo_operator_t
*
* Set the operator used when drawing the item.
*/
@@ -795,7 +796,7 @@ goc_item_get_operator (GocItem *item)
/**
* goc_item_set_transform: (skip)
* @item: #GocItem
- * m: #cairo_matrix_t
+ * @m: #cairo_matrix_t
*
* Set the matrix used to transform the item.
*/
diff --git a/goffice/canvas/goc-item.h b/goffice/canvas/goc-item.h
index 264c4e2..4b2df64 100644
--- a/goffice/canvas/goc-item.h
+++ b/goffice/canvas/goc-item.h
@@ -65,6 +65,7 @@ struct _GocItemClass {
gboolean (*key_pressed) (GocItem *item, GdkEventKey* ev);
gboolean (*key_released) (GocItem *item, GdkEventKey* ev);
GdkWindow* (*get_window) (GocItem *item);
+ /* <private> */
#endif
void (*reserved1) (void);
void (*reserved2) (void);
diff --git a/goffice/component/go-component.c b/goffice/component/go-component.c
index 7b8218c..047b2b7 100644
--- a/goffice/component/go-component.c
+++ b/goffice/component/go-component.c
@@ -68,14 +68,6 @@ go_snapshot_type_from_string (char const *name)
* @render: displays the contents.
* @changed: callback called when the component contents changed.
* @set_font: sets the default font for the component.
- * @reserved1: reserved for future use.
- * @reserved2: reserved for future use.
- * @reserved3: reserved for future use.
- * @reserved4: reserved for future use.
- * @reserved_signal1: reserved for future use.
- * @reserved_signal2: reserved for future use.
- * @reserved_signal3: reserved for future use.
- * @reserved_signal4: reserved for future use.
*
* The component base object class.
**/
diff --git a/goffice/component/go-component.h b/goffice/component/go-component.h
index 471f85f..f974359 100644
--- a/goffice/component/go-component.h
+++ b/goffice/component/go-component.h
@@ -70,7 +70,7 @@ struct _GOComponentClass {
void (*render) (GOComponent *component, cairo_t *cr,
double width, double height);
void (*set_font) (GOComponent *component, PangoFontDescription *desc);
- /* private */
+ /*<private>*/
void (*reserved1) (void);
void (*reserved2) (void);
void (*reserved3) (void);
@@ -78,6 +78,7 @@ struct _GOComponentClass {
/* signals */
void (*changed) (GOComponent* component);
+ /*<private>*/
void (*reserved_signal1) (void);
void (*reserved_signal2) (void);
void (*reserved_signal3) (void);
diff --git a/goffice/graph/goffice-graph.h b/goffice/graph/goffice-graph.h
index 607eaa5..0e7c44d 100644
--- a/goffice/graph/goffice-graph.h
+++ b/goffice/graph/goffice-graph.h
@@ -189,9 +189,9 @@ typedef enum {
GOG_POSITION_ANCHOR_SW = 6 << 12,
GOG_POSITION_ANCHOR_W = 7 << 12,
GOG_POSITION_ANCHOR_CENTER = 8 << 12,
- GOG_POSITION_ANCHOR = 0xf000,
+ GOG_POSITION_ANCHOR = 0x1f000,
- GOG_POSITION_ANY_MANUAL = 0xff80,
+ GOG_POSITION_ANY_MANUAL = 0x1ff80,
GOG_POSITION_PADDING = 1 << 16,
diff --git a/goffice/graph/gog-axis-line.c b/goffice/graph/gog-axis-line.c
index 7c64fb8..0821cf9 100644
--- a/goffice/graph/gog-axis-line.c
+++ b/goffice/graph/gog-axis-line.c
@@ -28,6 +28,28 @@
#include <glib/gi18n-lib.h>
#include <string.h>
+/**
+ * GogAxisTickProperties:
+ * @tick_in: whether to have tick inside the plot area.
+ * @tick_out: whether to have tick outside the plot area.
+ * @size_pts: tick size.
+ **/
+
+/**
+ * GogAxisPosition:
+ * @GOG_AXIS_AT_LOW: crosses the other axis at low values.
+ * @GOG_AXIS_CROSS: crosses the other axis at a given value.
+ * @GOG_AXIS_AT_HIGH: crosses the other axis at high values.
+ * @GOG_AXIS_AUTO: crosses at an automatically determined position.
+ **/
+
+/**
+ * GogAxisTickTypes:
+ * @GOG_AXIS_TICK_NONE: no tick, should not occur.
+ * @GOG_AXIS_TICK_MAJOR: major tick.
+ * @GOG_AXIS_TICK_MINOR: minor tick.
+ **/
+
static GogViewClass *gab_view_parent_klass;
static GObjectClass *gab_parent_klass;
diff --git a/goffice/graph/gog-axis.c b/goffice/graph/gog-axis.c
index 4c44968..48ed61b 100644
--- a/goffice/graph/gog-axis.c
+++ b/goffice/graph/gog-axis.c
@@ -44,6 +44,34 @@
* #GogLabel objects in the role "Label".
*/
+/**
+ * GogAxisPolarUnit:
+ * @GOG_AXIS_POLAR_UNIT_DEGREES: units as degrees.
+ * @GOG_AXIS_POLAR_UNIT_RADIANS: units as radians.
+ * @GOG_AXIS_POLAR_UNIT_GRADS: units as grads.
+ * @GOG_AXIS_POLAR_UNIT_MAX: maximum values, should not occur.
+ **/
+
+/**
+ * GogAxisTick:
+ * @position: position on the axis.
+ * @type: #GogAxisTickTypes
+ * @str: label, might be rich text.
+ **/
+
+/**
+ * GogAxisElemType:
+ * @GOG_AXIS_ELEM_MIN: minimum value.
+ * @GOG_AXIS_ELEM_MAX: maximum value.
+ * @GOG_AXIS_ELEM_MAJOR_TICK: distance between two major ticks.
+ * @GOG_AXIS_ELEM_MINOR_TICK: distance between two minor ticks.
+ * @GOG_AXIS_ELEM_CROSS_POINT: position of the other axis crossing.
+ * @GOG_AXIS_ELEM_MAX_ENTRY: maximum value, should not occur.
+ *
+ * The indices of the #GOData associated to the axis.
+ **/
+
+
static struct {
GogAxisPolarUnit unit;
const char *name;
diff --git a/goffice/graph/gog-chart-map.c b/goffice/graph/gog-chart-map.c
index c4b3384..79f5ebb 100644
--- a/goffice/graph/gog-chart-map.c
+++ b/goffice/graph/gog-chart-map.c
@@ -22,6 +22,16 @@
#include <goffice/goffice-config.h>
#include <goffice/goffice.h>
+/**
+ * GogChartMapPolarData:
+ * @cx: center horizontal position.
+ * @cy: center vertical position.
+ * @rx: available horizontal space from the center.
+ * @ry: available vertical space from the center.
+ * @th0: start angle.
+ * @th1: end angle.
+ **/
+
struct _GogChartMap {
GogChart *chart;
GogViewAllocation area;
diff --git a/goffice/graph/gog-data-allocator.c b/goffice/graph/gog-data-allocator.c
index 3da3311..075dc8d 100644
--- a/goffice/graph/gog-data-allocator.c
+++ b/goffice/graph/gog-data-allocator.c
@@ -25,6 +25,22 @@
#include <goffice/graph/gog-graph.h>
#include <goffice/data/go-data.h>
+/**
+ * GogDataEditorClass:
+ * @base: base interface.
+ * @set_format: sets the #GOFormat
+ * @set_value_double: sets a value as a double.
+ *
+ * Interface to edit #GOData.
+ **/
+
+/**
+ * GogDataAllocatorClass:
+ * @base: base interface.
+ * @allocate: provides data to a #GogPlot.
+ * @editor: returns the #GogDataEditor.
+ **/
+
GType
gog_data_allocator_get_type (void)
{
diff --git a/goffice/graph/gog-data-set.c b/goffice/graph/gog-data-set.c
index 1206b90..97f7582 100644
--- a/goffice/graph/gog-data-set.c
+++ b/goffice/graph/gog-data-set.c
@@ -22,6 +22,21 @@
#include <goffice/goffice-config.h>
#include <goffice/goffice.h>
+/**
+ * GogDatasetElement:
+ * @data: the #GOData
+ * @set: the owner data set.
+ * @dim_i: the dimension iside the dataset.
+ **/
+
+/**
+ * GogDatasetClass:
+ * @get_elem: gets i-th element.
+ * @set_dim: sets the data for i-th element.
+ * @dims: gest first and last valid elements indices.
+ * @dim_changed: called when an element has changed.
+ **/
+
GType
gog_dataset_get_type (void)
{
diff --git a/goffice/graph/gog-data-set.h b/goffice/graph/gog-data-set.h
index a31a531..6505b67 100644
--- a/goffice/graph/gog-data-set.h
+++ b/goffice/graph/gog-data-set.h
@@ -30,6 +30,7 @@ typedef struct {
GOData *data;
GogDataset *set;
int dim_i;
+ /*<private>*/
gulong handler;
} GogDatasetElement;
diff --git a/goffice/graph/gog-error-bar.c b/goffice/graph/gog-error-bar.c
index dbb91b5..998bfa0 100644
--- a/goffice/graph/gog-error-bar.c
+++ b/goffice/graph/gog-error-bar.c
@@ -36,6 +36,22 @@
* @GOG_ERROR_BAR_TYPE_PERCENT: Relative errors as percent.
**/
+/**
+ * GogErrorBarDirection:
+ * @GOG_ERROR_BAR_DIRECTION_HORIZONTAL: horizontal (xy plots).
+ * @GOG_ERROR_BAR_DIRECTION_VERTICAL: vertical (xy plots).
+ * @GOG_ERROR_BAR_DIRECTION_ANGULAR: angular (polar plots).
+ * @GOG_ERROR_BAR_DIRECTION_RADIAL: radial (polar plots).
+ **/
+
+/**
+ * GogErrorBarDisplay:
+ * @GOG_ERROR_BAR_DISPLAY_NONE: no display.
+ * @GOG_ERROR_BAR_DISPLAY_POSITIVE: display positive deviations.
+ * @GOG_ERROR_BAR_DISPLAY_NEGATIVE: display negative deviations.
+ * @GOG_ERROR_BAR_DISPLAY_BOTH: display both positive and negative deviations.
+ **/
+
typedef GObjectClass GogErrorBarClass;
static GObjectClass *error_bar_parent_klass;
diff --git a/goffice/graph/gog-graph.c b/goffice/graph/gog-graph.c
index c01b317..4b17ac7 100644
--- a/goffice/graph/gog-graph.c
+++ b/goffice/graph/gog-graph.c
@@ -58,6 +58,84 @@
* A #GogGraph can have 1 or more children in the roles "Chart" and "Title".
*/
+/**
+ * GogGraphClass:
+ * @base: base class.
+ **/
+
+/**
+ * GogAxisSet:
+ * @GOG_AXIS_SET_UNKNOWN: unkown, should not occur.
+ * @GOG_AXIS_SET_NONE: no axis.
+ * @GOG_AXIS_SET_X: only an X axis.
+ * @GOG_AXIS_SET_XY: both X and Y axes.
+ * @GOG_AXIS_SET_XY_pseudo_3d: X, Y, and pseudo-3D axes.
+ * @GOG_AXIS_SET_XY_COLOR: X, Y, and color axes.
+ * @GOG_AXIS_SET_XY_BUBBLE: X, Y, and bubble axes.
+ * @GOG_AXIS_SET_XYZ: X, Y, and Z axes.
+ * @GOG_AXIS_SET_RADAR: circular and radial axes.
+ * @GOG_AXIS_SET_FUNDAMENTAL: mask for all fundamental axes.
+ * @GOG_AXIS_SET_ALL: mask for all known axis types.
+ *
+ * Gives the needed axes for a plot.
+ **/
+
+/**
+ * GogAxisType:
+ * @GOG_AXIS_UNKNOWN: invalid, should not occur.
+ * @GOG_AXIS_X: X axis.
+ * @GOG_AXIS_Y: Y axis.
+ * @GOG_AXIS_Z: Z axis.
+ * @GOG_AXIS_CIRCULAR: circular axis/
+ * @GOG_AXIS_RADIAL: radial axis.
+ * @GOG_AXIS_VIRTUAL: start of virtual axes.
+ * @GOG_AXIS_PSEUDO_3D: pseudo-3d axis.
+ * @GOG_AXIS_COLOR: color axis.
+ * @GOG_AXIS_BUBBLE: bubble axis.
+ * @GOG_AXIS_TYPES: maximum value, should not occur.
+ **/
+
+/**
+ * GogDataType:
+ * @GOG_DATA_SCALAR: scalar value.
+ * @GOG_DATA_VECTOR: vector data.
+ * @GOG_DATA_MATRIX: matrix data.
+ **/
+
+/**
+ * GogDimType:
+ * @GOG_DIM_INVALID: invalid should not occur.
+ * @GOG_DIM_LABEL: labels.
+ * @GOG_DIM_INDEX: indices.
+ * @GOG_DIM_VALUE: vector of values.
+ * @GOG_DIM_MATRIX: matrix of values.
+ * @GOG_DIM_TYPES: should not occur.
+ *
+ * Data types for plots.
+ **/
+
+/**
+ * GogMSDimType:
+ * @GOG_MS_DIM_LABELS: labels.
+ * @GOG_MS_DIM_VALUES: values.
+ * @GOG_MS_DIM_CATEGORIES: categories.
+ * @GOG_MS_DIM_BUBBLES: bubble values.
+ * @GOG_MS_DIM_TYPES: maximum value known by MS, should not occur.
+ * @GOG_MS_DIM_ERR_plus1: positive erros on first dimension, we made it up.
+ * @GOG_MS_DIM_ERR_minus1: negative erros on first dimension, we made it up.
+ * @GOG_MS_DIM_ERR_plus2: positive erros on second dimension, we made it up.
+ * @GOG_MS_DIM_ERR_minus2: negative erros on second dimension, we made it up
+ * @GOG_MS_DIM_START: start value, we made it up for dropbars.
+ * @GOG_MS_DIM_END: end value, we made it up for dropbars.
+ * @GOG_MS_DIM_LOW: low value, we made it up for hi-lo.
+ * @GOG_MS_DIM_HIGH: high value, we made it up for hi-lo.
+ * @GOG_MS_DIM_EXTRA1: we made it up for other uses.
+ * @GOG_MS_DIM_EXTRA2: we made it up for other uses.
+ *
+ * Data types classed according to what they become when exported to foreign
+ * formats.
+ **/
+
enum {
GRAPH_PROP_0,
GRAPH_PROP_THEME,
diff --git a/goffice/graph/gog-grid.c b/goffice/graph/gog-grid.c
index 659e085..fa3a9df 100644
--- a/goffice/graph/gog-grid.c
+++ b/goffice/graph/gog-grid.c
@@ -41,6 +41,17 @@
#include <gtk/gtk.h>
#endif
+/**
+ * GogGridType:
+ * @GOG_GRID_UNKNOWN: unkown, should not occur.
+ * @GOG_GRID_XY: XY plane.
+ * @GOG_GRID_YZ: YZ plane.
+ * @GOG_GRID_ZX: ZY plane.
+ * @GOG_GRID_TYPES: last defined, should not occur.
+ *
+ * Used for base planes in 3d plots.
+ **/
+
struct _GogGrid {
GogStyledObject base;
GogGridType type;
diff --git a/goffice/graph/gog-label.c b/goffice/graph/gog-label.c
index 7e1e6ea..d30b684 100644
--- a/goffice/graph/gog-label.c
+++ b/goffice/graph/gog-label.c
@@ -34,6 +34,12 @@
* Can for instance be used as a title of a #GogChart or #GogGraph.
*/
+/**
+ * GogTextClass:
+ * @get_str: returns the text associated with the object.
+ * @get_markup: returns the pango attributes.
+ **/
+
static GType gog_text_view_get_type (void);
enum {
diff --git a/goffice/graph/gog-object.c b/goffice/graph/gog-object.c
index 77697c4..f80d53b 100644
--- a/goffice/graph/gog-object.c
+++ b/goffice/graph/gog-object.c
@@ -27,6 +27,92 @@
#include <string.h>
#include <stdlib.h>
+/**
+ * GogObjectNamingConv:
+ * @GOG_OBJECT_NAME_BY_ROLE: named built from role.
+ * @GOG_OBJECT_NAME_BY_TYPE: named built from type.
+ * @GOG_OBJECT_NAME_MANUALLY: custom name.
+ **/
+
+/**
+ * GogManualSizeMode:
+ * @GOG_MANUAL_SIZE_AUTO: auto size, can't be changed.
+ * @GOG_MANUAL_SIZE_WIDTH: the width can be changed.
+ * @GOG_MANUAL_SIZE_HEIGHT: the height can be changed.
+ * @GOG_MANUAL_SIZE_FULL: both height and width can be changed.
+ **/
+
+/**
+ * GogObjectRole:
+ **/
+
+/**
+ * GogObjectClass:
+ * @roles: roles for the class.
+ * @view_type: view type.
+ * @update: updates the object.
+ * @parent_changed: called when parent changed.
+ * @type_name: gets the type public name.
+ * @populate_editor: populates the editor.
+ * @document_changed: the document changed.
+ * @get_manual_size_mode: resize mode.
+ **/
+
+/**
+ * GogObjectPosition:
+ * @GOG_POSITION_AUTO: automatic.
+ * @GOG_POSITION_N: north, might be combined with east or west.
+ * @GOG_POSITION_S: south, might be combined with east or west.
+ * @GOG_POSITION_E: east.
+ * @GOG_POSITION_W: west.
+ * @GOG_POSITION_COMPASS: mask of the four previous positions.
+ * @GOG_POSITION_ALIGN_FILL: fills.
+ * @GOG_POSITION_ALIGN_START: start.
+ * @GOG_POSITION_ALIGN_END: end.
+ * @GOG_POSITION_ALIGN_CENTER: centered.
+ * @GOG_POSITION_ALIGNMENT: mask for start or end.
+ * @GOG_POSITION_SPECIAL: special.
+ * @GOG_POSITION_MANUAL: manual.
+ * @GOG_POSITION_MANUAL_X_ABS: whether the x position is absolute or relative.
+ * @GOG_POSITION_MANUAL_Y_ABS: whether the y position is absolute or relative.
+ * @GOG_POSITION_MANUAL_X_END: x position relative to start or end.
+ * @GOG_POSITION_MANUAL_Y_END: y position relative to start or end.
+ * @GOG_POSITION_ANCHOR_NW: anchored north-west.
+ * @GOG_POSITION_ANCHOR_N: anchored north.
+ * @GOG_POSITION_ANCHOR_NE: anchored north-east.
+ * @GOG_POSITION_ANCHOR_E: anchored east.
+ * @GOG_POSITION_ANCHOR_SE: anchored south-east.
+ * @GOG_POSITION_ANCHOR_S: anchored south.
+ * @GOG_POSITION_ANCHOR_SW: anchored south-west.
+ * @GOG_POSITION_ANCHOR_W: anchored west.
+ * @GOG_POSITION_ANCHOR_CENTER: anchored at center.
+ * @GOG_POSITION_ANCHOR: mask for anchors.
+ * @GOG_POSITION_ANY_MANUAL: mask for all manual positions
+ * @GOG_POSITION_PADDING: padding.
+ * @GOG_POSITION_MANUAL_W: relative width.
+ * @GOG_POSITION_MANUAL_W_ABS: absolute width.
+ * @GOG_POSITION_MANUAL_H: relative height.
+ * @GOG_POSITION_MANUAL_H_ABS: absolute height.
+ * @GOG_POSITION_ANY_MANUAL_SIZE: mask for manual sizes.
+ **/
+
+/**
+ * GogObjectRole:
+ * @id: id for persistence.
+ * @is_a_typename: type name.
+ * @allowable_positions: allowed positions inside parent.
+ * @default_position: default position.
+ * @naming_conv: naming convention.
+ * @can_add: return %TRUE if a new child can be added.
+ * @can_remove: return %TRUE if the child can be removed.
+ * @allocate: optional allocator, g_object_new() is used if %NULL.
+ * @post_add: called after adding the child.
+ * @pre_remove: called before removing the child.
+ * @post_remove: called after removing the child.
+ *
+ * Describes allowable children for a #GogObject.
+ **/
+
static GogObjectRole*
gog_object_role_ref (GogObjectRole* role)
{
diff --git a/goffice/graph/gog-object.h b/goffice/graph/gog-object.h
index 6875a6f..ed5095f 100644
--- a/goffice/graph/gog-object.h
+++ b/goffice/graph/gog-object.h
@@ -92,7 +92,9 @@ typedef struct {
/* using some Private/Public statements to make gtk-doc happy since it does not like the ":1"*/
unsigned use_parent_as_proxy /*< private >*/:1/*< public >*/; /* when we change, pretend it was our parent */
- unsigned roles_allocated /*< private >*/:1/*< public >*/;
+ /*< private >*/
+ unsigned roles_allocated:1;
+ /*< public >*/
/* Virtuals */
void (*update) (GogObject *obj);
@@ -104,8 +106,10 @@ typedef struct {
GOCmdContext *cc);
void (*document_changed)(GogObject *obj, GODoc *doc);
GogManualSizeMode (*get_manual_size_mode) (GogObject *obj);
+ /*< private >*/
void (*reserved1) (GogObject *view);
void (*reserved2) (GogObject *view);
+ /*< public >*/
/* signals */
void (*changed) (GogObject *obj, gboolean size);
diff --git a/goffice/graph/gog-outlined-object.c b/goffice/graph/gog-outlined-object.c
index e0686ad..fa45fe2 100644
--- a/goffice/graph/gog-outlined-object.c
+++ b/goffice/graph/gog-outlined-object.c
@@ -96,6 +96,12 @@ gog_outlined_object_get_pad (GogOutlinedObject const *goo)
/*****************************************************************************/
+/**
+ * GogOutlinedViewClass:
+ * @call_parent_render: whether the parent class render() method must be
+ * called when done.
+ **/
+
static GogViewClass *oview_parent_klass;
static void
diff --git a/goffice/graph/gog-plot-engine.c b/goffice/graph/gog-plot-engine.c
index 97038b6..1ec3dd5 100644
--- a/goffice/graph/gog-plot-engine.c
+++ b/goffice/graph/gog-plot-engine.c
@@ -34,6 +34,29 @@
#include <gsf/gsf-impl-utils.h>
#include <string.h>
+/**
+ * GogPlotFamily:
+ * @name: family name.
+ * @sample_image_file: sample image for the graph editor.
+ * @priority: priority.
+ * @axis_set: #GogAxisSet used.
+ * @types: known types in the family.
+ *
+ * Plot types family.
+ **/
+
+/**
+ * GogPlotType:
+ * @family: plot family.
+ * @engine: plot engine.
+ * @name: plot type name.
+ * @sample_image_file: sample image for the graph editor.
+ * @description: untranslated description.
+ * @col: column where the plot type appears in the table inside the graph editor.
+ * @row: row.
+ * @properties: plot type properties.
+ **/
+
static gboolean debug;
static GSList *refd_plugins;
@@ -366,6 +389,14 @@ GSF_CLASS (GogPlotTypeService, gog_plot_type_service,
/***************************************************************************/
/* Support regression curves engines in plugins */
+/**
+ * GogTrendLineType:
+ * @engine: trend line engine.
+ * @name: trend line type name.
+ * @description: untranslated description.
+ * @properties: trend line type properties.
+ **/
+
#define GOG_TYPE_TREND_LINE_ENGINE_SERVICE (gog_trend_line_engine_service_get_type ())
#define GOG_TREND_LINE_ENGINE_SERVICE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_TYPE_TREND_LINE_ENGINE_SERVICE, GogTrendLineEngineService))
#define GOG_IS_TREND_LINE_ENGINE_SERVICE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_TYPE_TREND_LINE_ENGINE_SERVICE))
diff --git a/goffice/graph/gog-plot-impl.h b/goffice/graph/gog-plot-impl.h
index 45e71db..2d516cf 100644
--- a/goffice/graph/gog-plot-impl.h
+++ b/goffice/graph/gog-plot-impl.h
@@ -28,7 +28,6 @@ G_BEGIN_DECLS
struct _GogPlotDesc {
unsigned num_series_max;
- unsigned num_axis;
GogSeriesDesc series;
};
diff --git a/goffice/graph/gog-plot.c b/goffice/graph/gog-plot.c
index ba50f2d..7ba5f56 100644
--- a/goffice/graph/gog-plot.c
+++ b/goffice/graph/gog-plot.c
@@ -60,6 +60,51 @@
* GOffice ships a number of common plot implementations by default.
*/
+/**
+ * GogPlotClass:
+ * @desc: #GogPlotDesc
+ * @series_type: series type.
+ * @axis_set: set of use axes.
+ * @axis_get_bounds: requests the axis bounds
+ * @supports_vary_style_by_element: %TRUE if each element has its own style.
+ * @enum_in_reverse: %TRUE if the plot prefers to display series in reverse
+ * order for legends (e.g. stacked plots want top element to be the
+ * last series.
+ * @foreach_elem: enumerates the elements visible in the legend.
+ * @update_3d: updates 3D (and contour) plots.
+ * @guru_helper: customizes a new plot in the graph editor dialog.
+ * @get_percent: get the value as a percentage.
+ **/
+
+/**
+ * GogPlotViewClass:
+ * @get_data_at_point: returns the data index at the given position, -1 if none.
+ **/
+
+/**
+ * GogPlotBoundInfo:
+ * @is_discrete: whether the data are discrete.
+ * @center_on_ticks: whether to center data on ticks.
+ * @fmt: #GOFormat to use.
+ * @date_conv: the used #GODateConventions.
+ *
+ * Used by plots to give formating informations to each axis.
+ * GogPlotBoundInfo::val are the values limits, GogPlotBoundInfo::logical are
+ * the actual needed display limits.
+ **/
+
+/**
+ * GogPlotDesc:
+ * @series: series description.
+ **/
+
+/**
+ * GogPlotRenderingOrder:
+ * @GOG_PLOT_RENDERING_LAST: render after axis and grid lines.
+ * @GOG_PLOT_RENDERING_BEFORE_AXIS: render before axis but after grid lines.
+ * @GOG_PLOT_RENDERING_BEFORE_GRID: render before grid lines.
+ **/
+
enum {
PLOT_PROP_0,
PLOT_PROP_VARY_STYLE_BY_ELEMENT,
@@ -446,8 +491,8 @@ gog_plot_class_init (GogObjectClass *gog_klass)
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
g_object_class_install_property (gobject_klass, PLOT_PROP_AXIS_PSEUDO_3D,
g_param_spec_uint ("pseudo-3d-axis",
- _("Pseudo-3d axis"),
- _("Reference to pseudo-3d axis"),
+ _("Pseudo-3D axis"),
+ _("Reference to pseudo-3D axis"),
0, G_MAXINT, 0,
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
g_object_class_install_property (gobject_klass, PLOT_PROP_AXIS_COLOR,
diff --git a/goffice/graph/gog-reg-curve.c b/goffice/graph/gog-reg-curve.c
index 73e17eb..69e5ffb 100644
--- a/goffice/graph/gog-reg-curve.c
+++ b/goffice/graph/gog-reg-curve.c
@@ -37,8 +37,6 @@
* @get_value_at: returns the calculated value.
* @get_equation: gets the regresion equation as a string.
* @populate_editor: populates the editor.
- * @reserved1: reserved for future use.
- * @reserved2: reserved for future use.
**/
#define GOG_REG_CURVE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GOG_TYPE_REG_CURVE, GogRegCurveClass))
diff --git a/goffice/graph/gog-reg-curve.h b/goffice/graph/gog-reg-curve.h
index 1572232..a0eb1f7 100644
--- a/goffice/graph/gog-reg-curve.h
+++ b/goffice/graph/gog-reg-curve.h
@@ -52,6 +52,7 @@ typedef struct {
double (*get_value_at) (GogRegCurve *reg_curve, double x);
char const * (*get_equation) (GogRegCurve *reg_curve);
void (*populate_editor) (GogRegCurve *reg_curve, gpointer table);
+ /*<private>*/
void (*reserved1) (void);
void (*reserved2) (void);
} GogRegCurveClass;
diff --git a/goffice/graph/gog-series.c b/goffice/graph/gog-series.c
index 4ee44b3..98a8ebc 100644
--- a/goffice/graph/gog-series.c
+++ b/goffice/graph/gog-series.c
@@ -28,6 +28,13 @@
#include <string.h>
/**
+ * SECTION: gog-series
+ * @short_description: A single data series.
+ *
+ * A #GogSeries represents a data series that can be added to a #GogPlot.
+ */
+
+/**
* GogSeriesFillType:
* @GOG_SERIES_FILL_TYPE_Y_ORIGIN: from origin ox the X-axis.
* @GOG_SERIES_FILL_TYPE_X_ORIGIN: from the origin of the Y-axis
@@ -75,11 +82,18 @@
**/
/**
- * SECTION: gog-series
- * @short_description: A single data series.
- *
- * A #GogSeries represents a data series that can be added to a #GogPlot.
- */
+ * GogSeriesDesc:
+ * @dim: dimensions descriptions.
+ **/
+
+/**
+ * GogSeriesDimDesc:
+ * @name: name.
+ * @priority: priority.
+ * @is_shared: whether the dimension is shared among the series.
+ * @val_type: data type.
+ * @ms_type: data type for foreign formats.
+ **/
/* Keep in sync with GogSeriesFillType enum */
static struct {
diff --git a/goffice/graph/gog-view.c b/goffice/graph/gog-view.c
index e00c5bb..46d5222 100644
--- a/goffice/graph/gog-view.c
+++ b/goffice/graph/gog-view.c
@@ -27,6 +27,7 @@
/**
* GogViewClass:
+ * @base:Âbase class.
* @state_init: state intialization.
* @padding_request: padding request.
* @size_request: size request.
@@ -35,8 +36,31 @@
* @build_toolkit: builds the associated toolkit.
* @get_tip_at_point: gets tip at pointer position.
* @natural_size: gets natural size.
- * @reserved1: reserved for future use.
- * @reserved2: reserved for future use.
+ *
+ * the GogViewClass::clip firled should be set to %TRUE to clip drawings to
+ * the vew allocation.
+ **/
+
+/**
+ * GogViewAllocation:
+ * @w: width.
+ * @h: height.
+ * @x: horizontal position.
+ * @y: vertical position.
+ **/
+
+/**
+ * GogViewPadding:
+ * @wr: right padding.
+ * @hb: bottom padding.
+ * @wl: left pdding.
+ * @ht: top padding.
+ **/
+
+/**
+ * GogViewRequisition:
+ * @w: width.
+ * @h: height.
**/
static GogViewAllocation *
diff --git a/goffice/graph/gog-view.h b/goffice/graph/gog-view.h
index 2350adf..3713d72 100644
--- a/goffice/graph/gog-view.h
+++ b/goffice/graph/gog-view.h
@@ -97,6 +97,7 @@ typedef struct {
void (*build_toolkit) (GogView *view);
char *(*get_tip_at_point) (GogView *view, double x, double y);
void (*natural_size) (GogView *view, GogViewRequisition *req);
+ /*<private>*/
void (*reserved1) (GogView *view);
void (*reserved2) (GogView *view);
} GogViewClass;
diff --git a/plugins/plot_barcol/gog-1.5d.c b/plugins/plot_barcol/gog-1.5d.c
index 4281157..a5e1ccb 100644
--- a/plugins/plot_barcol/gog-1.5d.c
+++ b/plugins/plot_barcol/gog-1.5d.c
@@ -350,8 +350,8 @@ gog_plot1_5d_class_init (GogPlotClass *plot_klass)
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
g_object_class_install_property (gobject_klass, GOG_1_5D_PROP_IN_3D,
g_param_spec_boolean ("in-3d",
- _("In 3d"),
- _("Placeholder to allow us to round trip pseudo 3d state"),
+ _("In 3D"),
+ _("Placeholder to allow us to round trip pseudo 3D state"),
FALSE,
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
diff --git a/plugins/plot_pie/gog-pie.c b/plugins/plot_pie/gog-pie.c
index 3e49757..3f3fc7e 100644
--- a/plugins/plot_pie/gog-pie.c
+++ b/plugins/plot_pie/gog-pie.c
@@ -316,8 +316,8 @@ gog_pie_plot_class_init (GogPlotClass *plot_klass)
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
g_object_class_install_property (gobject_klass, PLOT_PROP_IN_3D,
g_param_spec_boolean ("in-3d",
- _("In 3d"),
- _("Draw 3d wedges"),
+ _("In 3D"),
+ _("Draw 3DS wedges"),
FALSE,
GSF_PARAM_STATIC | G_PARAM_READWRITE));
g_object_class_install_property (gobject_klass, PLOT_PROP_SPAN,
diff --git a/plugins/plot_xy/gog-xy.c b/plugins/plot_xy/gog-xy.c
index bea0306..2010f30 100644
--- a/plugins/plot_xy/gog-xy.c
+++ b/plugins/plot_xy/gog-xy.c
@@ -580,8 +580,8 @@ gog_bubble_plot_class_init (GogPlotClass *plot_klass)
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
g_object_class_install_property (gobject_klass, GOG_BUBBLE_PROP_IN_3D,
g_param_spec_boolean ("in-3d",
- _("In 3d"),
- _("Draw 3d bubbles"),
+ _("In 3D"),
+ _("Draw 3D bubbles"),
FALSE,
GSF_PARAM_STATIC | G_PARAM_READWRITE | GO_PARAM_PERSISTENT));
g_object_class_install_property (gobject_klass, GOG_BUBBLE_PROP_SCALE,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]