path: root/e-util/e-table-group.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/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

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

#ifndef _E_TABLE_GROUP_H_
#define _E_TABLE_GROUP_H_

#include <libgnomecanvas/libgnomecanvas.h>

#include <e-util/e-misc-utils.h>
#include <e-util/e-printable.h>
#include <e-util/e-table-defines.h>
#include <e-util/e-table-header.h>
#include <e-util/e-table-model.h>
#include <e-util/e-table-sort-info.h>

/* Standard GObject macros */
#define E_TYPE_TABLE_GROUP \
    (e_table_group_get_type ())
#define E_TABLE_GROUP(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_TABLE_GROUP, ETableGroup))
#define E_TABLE_GROUP_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_TABLE_GROUP, ETableGroupClass))
#define E_IS_TABLE_GROUP(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_TABLE_GROUP))
#define E_IS_TABLE_GROUP_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_TABLE_GROUP))
#define E_TABLE_GROUP_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_TABLE_GROUP, ETableGroupClass))

G_BEGIN_DECLS

typedef struct _ETableGroup ETableGroup;
typedef struct _ETableGroupClass ETableGroupClass;

struct _ETableGroup {
    GnomeCanvasGroup group;

    /*
     * The full header.
     */
    ETableHeader *full_header;
    ETableHeader *header;

    /*
     * The model we pull data from.
     */
    ETableModel *model;

    /*
     * Whether we should add indentation and open/close markers,
     * or if we just act as containers of subtables.
     */
    guint transparent : 1;

    guint has_focus : 1;

    guint frozen : 1;
};

struct _ETableGroupClass {
    GnomeCanvasGroupClass parent_class;

    /* Signals */
    void        (*cursor_change)    (ETableGroup *table_group,
                         gint row);
    void        (*cursor_activated) (ETableGroup *table_group,
                         gint row);
    void        (*double_click)     (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
    gboolean    (*right_click)      (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
    gboolean    (*click)        (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
    gboolean    (*key_press)        (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
    gint        (*start_drag)       (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);

    /* Virtual functions. */
    void        (*add)          (ETableGroup *table_group,
                         gint row);
    void        (*add_array)        (ETableGroup *table_group,
                         const gint *array,
                         gint count);
    void        (*add_all)      (ETableGroup *table_group);
    gboolean    (*remove)       (ETableGroup *table_group,
                         gint row);
    gint        (*row_count)        (ETableGroup *table_group);
    void        (*increment)        (ETableGroup *table_group,
                         gint position,
                         gint amount);
    void        (*decrement)        (ETableGroup *table_group,
                         gint position,
                         gint amount);
    void        (*set_focus)        (ETableGroup *table_group,
                         EFocus direction,
                         gint view_col);
    gboolean    (*get_focus)        (ETableGroup *table_group);
    gint        (*get_focus_column) (ETableGroup *table_group);
    EPrintable *    (*get_printable)    (ETableGroup *table_group);
    void        (*compute_location) (ETableGroup *table_group,
                         gint *x,
                         gint *y,
                         gint *row,
                         gint *col);
    void        (*get_mouse_over)   (ETableGroup *table_group,
                         gint *row,
                         gint *col);
    void        (*get_cell_geometry)    (ETableGroup *table_group,
                         gint *row,
                         gint *col,
                         gint *x,
                         gint *y,
                         gint *width,
                         gint *height);
};

GType       e_table_group_get_type      (void) G_GNUC_CONST;
ETableGroup *   e_table_group_new       (GnomeCanvasGroup *parent,
                         ETableHeader *full_header,
                         ETableHeader *header,
                         ETableModel *model,
                         ETableSortInfo *sort_info,
                         gint n);
void        e_table_group_construct     (GnomeCanvasGroup *parent,
                         ETableGroup *table_group,
                         ETableHeader *full_header,
                         ETableHeader *header,
                         ETableModel *model);

/* Virtual functions */
void        e_table_group_add       (ETableGroup *table_group,
                         gint row);
void        e_table_group_add_array     (ETableGroup *table_group,
                         const gint *array,
                         gint count);
void        e_table_group_add_all       (ETableGroup *table_group);
gboolean    e_table_group_remove        (ETableGroup *table_group,
                         gint row);
void        e_table_group_increment     (ETableGroup *table_group,
                         gint position,
                         gint amount);
void        e_table_group_decrement     (ETableGroup *table_group,
                         gint position,
                         gint amount);
gint        e_table_group_row_count     (ETableGroup *table_group);
void        e_table_group_set_focus     (ETableGroup *table_group,
                         EFocus direction,
                         gint view_col);
gboolean    e_table_group_get_focus     (ETableGroup *table_group);
gint        e_table_group_get_focus_column  (ETableGroup *table_group);
ETableHeader *  e_table_group_get_header    (ETableGroup *table_group);
EPrintable *    e_table_group_get_printable (ETableGroup *table_group);
void        e_table_group_compute_location  (ETableGroup *table_group,
                         gint *x,
                         gint *y,
                         gint *row,
                         gint *col);
void        e_table_group_get_mouse_over    (ETableGroup *table_group,
                         gint *row,
                         gint *col);
void        e_table_group_get_cell_geometry (ETableGroup *table_group,
                         gint *row,
                         gint *col,
                         gint *x,
                         gint *y,
                         gint *width,
                         gint *height);

/* For emitting the signals */
void        e_table_group_cursor_change (ETableGroup *table_group,
                         gint row);
void        e_table_group_cursor_activated  (ETableGroup *table_group,
                         gint row);
void        e_table_group_double_click  (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
gboolean    e_table_group_right_click   (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
gboolean    e_table_group_click     (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
gboolean    e_table_group_key_press     (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);
gint        e_table_group_start_drag    (ETableGroup *table_group,
                         gint row,
                         gint col,
                         GdkEvent *event);

typedef void (*ETableGroupLeafFn) (gpointer e_table_item, gpointer closure);
void        e_table_group_apply_to_leafs    (ETableGroup *table_group,
                         ETableGroupLeafFn fn,
                         gpointer closure);

gboolean    e_table_group_is_editing    (ETableGroup *table_group);

G_END_DECLS

#endif /* _E_TABLE_GROUP_H_ */