path: root/e-util/e-table-specification.h

/*
 * e-table-specification.h
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 */

#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif

#ifndef E_TABLE_SPECIFICATION_H
#define E_TABLE_SPECIFICATION_H

#include <libxml/tree.h>

#include <e-util/e-selection-model.h>
#include <e-util/e-table-column-specification.h>
#include <e-util/e-table-defines.h>
#include <e-util/e-table-state.h>

/* Standard GObject macros */
#define E_TYPE_TABLE_SPECIFICATION \
    (e_table_specification_get_type ())
#define E_TABLE_SPECIFICATION(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_TABLE_SPECIFICATION, ETableSpecification))
#define E_TABLE_SPECIFICATION_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_TABLE_SPECIFICATION, ETableSpecificationClass))
#define E_IS_TABLE_SPECIFICATION(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_TABLE_SPECIFICATION))
#define E_IS_TABLE_SPECIFICATION_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_TABLE_SPECIFICATION))
#define E_TABLE_SPECIFICATION_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_TABLE_SPECIFICATION, ETableSpecificationClass))

G_BEGIN_DECLS

typedef struct _ETableSpecification ETableSpecification;
typedef struct _ETableSpecificationClass ETableSpecificationClass;
typedef struct _ETableSpecificationPrivate ETableSpecificationPrivate;

struct _ETableSpecification {
    GObject parent;
    ETableSpecificationPrivate *priv;

    ETableState *state;

    guint alternating_row_colors : 1;
    guint no_headers : 1;
    guint click_to_add : 1;
    guint click_to_add_end : 1;
    guint horizontal_draw_grid : 1;
    guint vertical_draw_grid : 1;
    guint draw_focus : 1;
    guint horizontal_scrolling : 1;
    guint horizontal_resize : 1;
    guint allow_grouping : 1;
    GtkSelectionMode selection_mode;
    ECursorMode cursor_mode;

    gchar *click_to_add_message;
    gchar *domain;
};

struct _ETableSpecificationClass {
    GObjectClass parent_class;
};

GType       e_table_specification_get_type  (void) G_GNUC_CONST;
ETableSpecification *
        e_table_specification_new   (void);
GPtrArray * e_table_specification_ref_columns
                        (ETableSpecification *specification);
gint        e_table_specification_get_column_index
                        (ETableSpecification *specification,
                         ETableColumnSpecification *column_spec);
gboolean    e_table_specification_load_from_file
                        (ETableSpecification *specification,
                         const gchar *filename);
gboolean    e_table_specification_load_from_string
                        (ETableSpecification *specification,
                         const gchar *xml);
void        e_table_specification_load_from_node
                        (ETableSpecification *specification,
                         const xmlNode *node);

G_END_DECLS

#endif /* E_TABLE_SPECIFICATION_H */