Column

Column — column API

Synopsis

struct              libscols_column;
const char *        scols_column_get_color              (struct libscols_column *cl);
int                 scols_column_get_flags              (struct libscols_column *cl);
struct libscols_cell * scols_column_get_header          (struct libscols_column *cl);
double              scols_column_get_whint              (struct libscols_column *cl);
int                 scols_column_is_noextremes          (struct libscols_column *cl);
int                 scols_column_is_right               (struct libscols_column *cl);
int                 scols_column_is_strict_width        (struct libscols_column *cl);
int                 scols_column_is_tree                (struct libscols_column *cl);
int                 scols_column_is_trunc               (struct libscols_column *cl);
int                 scols_column_set_cmpfunc            (struct libscols_column *cl,
                                                         int (*cmp) (struct libscols_cell *a, struct libscols_cell *b, void *),
                                                         void *data);
int                 scols_column_set_color              (struct libscols_column *cl,
                                                         const char *color);
int                 scols_column_set_flags              (struct libscols_column *cl,
                                                         int flags);
int                 scols_column_set_whint              (struct libscols_column *cl,
                                                         double whint);
struct libscols_column * scols_copy_column              (const struct libscols_column *cl);
struct libscols_column * scols_new_column               (void);
void                scols_ref_column                    (struct libscols_column *cl);
void                scols_unref_column                  (struct libscols_column *cl);

Description

An API to access and modify per-column data and information.

Details

struct libscols_column

struct libscols_column;

A column - defines the number of columns and column names

scols_column_get_color ()

const char *        scols_column_get_color              (struct libscols_column *cl);

cl :

 a pointer to a struct libscols_column instance

Returns :

 The current color setting of the column cl.

scols_column_get_flags ()

int                 scols_column_get_flags              (struct libscols_column *cl);

cl :

 a pointer to a struct libscols_column instance

Returns :

 The flag mask of cl, a negative value in case of an error.

scols_column_get_header ()

struct libscols_cell * scols_column_get_header          (struct libscols_column *cl);

cl :

 a pointer to a struct libscols_column instance

Returns :

 A pointer to a struct libscols_cell instance, representing the header info of column cl or NULL in case of an error.

scols_column_get_whint ()

double              scols_column_get_whint              (struct libscols_column *cl);

cl :

 a pointer to a struct libscols_column instance

Returns :

 The width hint of column cl, a negative value in case of an error.

scols_column_is_noextremes ()

int                 scols_column_is_noextremes          (struct libscols_column *cl);

Gets the value of cl's flag no_extremes.

cl :

 a pointer to a struct libscols_column instance

Returns :

 no_extremes flag value, negative value in case of an error.

scols_column_is_right ()

int                 scols_column_is_right               (struct libscols_column *cl);

Gets the value of cl's flag right.

cl :

 a pointer to a struct libscols_column instance

Returns :

 right flag value, negative value in case of an error.

scols_column_is_strict_width ()

int                 scols_column_is_strict_width        (struct libscols_column *cl);

Gets the value of cl's flag strict_width.

cl :

 a pointer to a struct libscols_column instance

Returns :

 strict_width flag value, negative value in case of an error.

scols_column_is_tree ()

int                 scols_column_is_tree                (struct libscols_column *cl);

Gets the value of cl's flag tree.

cl :

 a pointer to a struct libscols_column instance

Returns :

 tree flag value, negative value in case of an error.

scols_column_is_trunc ()

int                 scols_column_is_trunc               (struct libscols_column *cl);

Gets the value of cl's flag trunc.

cl :

 a pointer to a struct libscols_column instance

Returns :

 trunc flag value, negative value in case of an error.

scols_column_set_cmpfunc ()

int                 scols_column_set_cmpfunc            (struct libscols_column *cl,
                                                         int (*cmp) (struct libscols_cell *a, struct libscols_cell *b, void *),
                                                         void *data);

cl :

 column

cmp :

 pointer to compare function

data :

 private data for cmp function

Returns :

 0, a negative value in case of an error.

scols_column_set_color ()

int                 scols_column_set_color              (struct libscols_column *cl,
                                                         const char *color);

The default color for data cells and column header.

If you want to set header specific color then use scols_column_get_header() and scols_cell_set_color().

If you want to set data cell specific color the use scols_line_get_cell() + scols_cell_set_color().

cl :

 a pointer to a struct libscols_column instance

color :

 color name or ESC sequence

Returns :

 0, a negative value in case of an error.

scols_column_set_flags ()

int                 scols_column_set_flags              (struct libscols_column *cl,
                                                         int flags);

Sets the flags of cl to flags.

cl :

 a pointer to a struct libscols_column instance

flags :

 a flag mask

Returns :

 0, a negative value in case of an error.

scols_column_set_whint ()

int                 scols_column_set_whint              (struct libscols_column *cl,
                                                         double whint);

Sets the width hint of column cl to whint.

cl :

 a pointer to a struct libscols_column instance

whint :

 a width hint

Returns :

 0, a negative value in case of an error.

scols_copy_column ()

struct libscols_column * scols_copy_column              (const struct libscols_column *cl);

Creates a new column and copies cl's data over to it.

cl :

 a pointer to a struct libscols_column instance

Returns :

 a pointer to a new struct libscols_column instance.

scols_new_column ()

struct libscols_column * scols_new_column               (void);

Allocates space for a new column.

Returns :

 a pointer to a new struct libscols_cell instance, NULL in case of an ENOMEM error.

scols_ref_column ()

void                scols_ref_column                    (struct libscols_column *cl);

Increases the refcount of cl.

cl :

 a pointer to a struct libscols_column instance

scols_unref_column ()

void                scols_unref_column                  (struct libscols_column *cl);

Decreases the refcount of cl. When the count falls to zero, the instance is automatically deallocated.

cl :

 a pointer to a struct libscols_column instance
Generated by GTK-Doc V1.19