ETableHeader

Name

ETableHeader -- 

Synopsis



#define     E_TABLE_HEADER_TYPE
struct      ETableHeader;
ETableHeader* e_table_header_new            (void);
void        e_table_header_add_column       (ETableHeader *eth,
                                             ETableCol *tc,
                                             int pos);
ETableCol*  e_table_header_get_column       (ETableHeader *eth,
                                             int column);
int         e_table_header_count            (ETableHeader *eth);
int         e_table_header_index            (ETableHeader *eth,
                                             int col);
int         e_table_header_get_index_at     (ETableHeader *eth,
                                             int x_offset);
ETableCol** e_table_header_get_columns      (ETableHeader *eth);
int         e_table_header_get_selected     (ETableHeader *eth);
int         e_table_header_total_width      (ETableHeader *eth);
void        e_table_header_move             (ETableHeader *eth,
                                             int source_index,
                                             int target_index);
void        e_table_header_remove           (ETableHeader *eth,
                                             int idx);
void        e_table_header_set_size         (ETableHeader *eth,
                                             int idx,
                                             int size);
void        e_table_header_set_selection    (ETableHeader *eth,
                                             gboolean allow_selection);
int         e_table_header_col_diff         (ETableHeader *eth,
                                             int start_col,
                                             int end_col);
void        e_table_header_calc_widths      (ETableHeader *eth);
GList*      e_table_header_get_selected_indexes
                                            (ETableHeader *eth);

Object Hierarchy


  GtkObject
   +----ETableHeader

Signal Prototypes


"structure-change"
            void        user_function      (ETableHeader *etableheader,
                                            gpointer user_data);
"dimension-change"
            void        user_function      (ETableHeader *etableheader,
                                            gint arg1,
                                            gpointer user_data);
"request-width"
            gint        user_function      (ETableHeader *etableheader,
                                            gint arg1,
                                            gpointer user_data);

Description

Details

E_TABLE_HEADER_TYPE

#define E_TABLE_HEADER_TYPE        (e_table_header_get_type ())


struct ETableHeader

struct ETableHeader;


e_table_header_new ()

ETableHeader* e_table_header_new            (void);


e_table_header_add_column ()

void        e_table_header_add_column       (ETableHeader *eth,
                                             ETableCol *tc,
                                             int pos);

This function adds the tc ETableCol definition into the eth ETableHeader at position pos. This is the way you add new ETableCols to the ETableHeader. The header will assume ownership of the tc; you should not unref it after you add it.

This function will emit the "structure_change" signal on the eth object. The ETableCol is assumed


e_table_header_get_column ()

ETableCol*  e_table_header_get_column       (ETableHeader *eth,
                                             int column);


e_table_header_count ()

int         e_table_header_count            (ETableHeader *eth);


e_table_header_index ()

int         e_table_header_index            (ETableHeader *eth,
                                             int col);

ETableHeaders contain the visual list of columns that the user will view. The visible columns will typically map to different columns in the ETableModel (because the user reordered the data for example).

Returns: the column in the model that the col column in the ETableHeader points to. */ int e_table_header_index (ETableHeader *eth, int col) { g_return_val_if_fail (eth != NULL, -1); g_return_val_if_fail (E_IS_TABLE_HEADER (eth), -1); g_return_val_if_fail (col >= 0 && col < eth->col_count, -1);

return eth->columns [col]->col_idx; }

/** e_table_header_get_index_at: eth: the ETableHeader to query x_offset: a pixel count from the beginning of the ETableHeader

This will return the ETableHeader column that would contain the x_offset pixel.


e_table_header_get_index_at ()

int         e_table_header_get_index_at     (ETableHeader *eth,
                                             int x_offset);


e_table_header_get_columns ()

ETableCol** e_table_header_get_columns      (ETableHeader *eth);


e_table_header_get_selected ()

int         e_table_header_get_selected     (ETableHeader *eth);


e_table_header_total_width ()

int         e_table_header_total_width      (ETableHeader *eth);


e_table_header_move ()

void        e_table_header_move             (ETableHeader *eth,
                                             int source_index,
                                             int target_index);

This function moves the column source_index to target_index inside the eth ETableHeader. The signals "dimension_change" and "structure_change" will be emmited


e_table_header_remove ()

void        e_table_header_remove           (ETableHeader *eth,
                                             int idx);

Removes the column at idx position in the ETableHeader eth. This emmits the "structure_change" signal on the eth object.


e_table_header_set_size ()

void        e_table_header_set_size         (ETableHeader *eth,
                                             int idx,
                                             int size);


e_table_header_set_selection ()

void        e_table_header_set_selection    (ETableHeader *eth,
                                             gboolean allow_selection);


e_table_header_col_diff ()

int         e_table_header_col_diff         (ETableHeader *eth,
                                             int start_col,
                                             int end_col);

Computes the number of pixels between the columns start_col and end_col.


e_table_header_calc_widths ()

void        e_table_header_calc_widths      (ETableHeader *eth);


e_table_header_get_selected_indexes ()

GList*      e_table_header_get_selected_indexes
                                            (ETableHeader *eth);

Signals

The "structure-change" signal

void        user_function                  (ETableHeader *etableheader,
                                            gpointer user_data);


The "dimension-change" signal

void        user_function                  (ETableHeader *etableheader,
                                            gint arg1,
                                            gpointer user_data);


The "request-width" signal

gint        user_function                  (ETableHeader *etableheader,
                                            gint arg1,
                                            gpointer user_data);