Symbols

Symbols — symbols API

Synopsis

struct              libscols_symbols;
struct libscols_symbols * scols_copy_symbols            (const struct libscols_symbols *sb);
struct libscols_symbols * scols_new_symbols             (void);
void                scols_ref_symbols                   (struct libscols_symbols *sy);
int                 scols_symbols_set_branch            (struct libscols_symbols *sb,
                                                         const char *str);
int                 scols_symbols_set_right             (struct libscols_symbols *sb,
                                                         const char *str);
int                 scols_symbols_set_vertical          (struct libscols_symbols *sb,
                                                         const char *str);
void                scols_unref_symbols                 (struct libscols_symbols *sy);

Description

An API to access and modify data and information per symbol/symbol group.

Details

struct libscols_symbols

struct libscols_symbols;

Symbol groups for printing tree hierarchies

scols_copy_symbols ()

struct libscols_symbols * scols_copy_symbols            (const struct libscols_symbols *sb);

sb :

 a pointer to a struct libscols_symbols instance

Returns :

 a newly allocated copy of the sb symbol group or NULL in caes of an error.

scols_new_symbols ()

struct libscols_symbols * scols_new_symbols             (void);

Returns :

 a pointer to a newly allocated struct libscols_symbols instance.

scols_ref_symbols ()

void                scols_ref_symbols                   (struct libscols_symbols *sy);

Increases the refcount of sy.

sy :

 a pointer to a struct libscols_symbols instance

scols_symbols_set_branch ()

int                 scols_symbols_set_branch            (struct libscols_symbols *sb,
                                                         const char *str);

sb :

 a pointer to a struct libscols_symbols instance

str :

 a string which will represent the branch part of a tree output

Returns :

 0, a negative value in case of an error.

scols_symbols_set_right ()

int                 scols_symbols_set_right             (struct libscols_symbols *sb,
                                                         const char *str);

sb :

 a pointer to a struct libscols_symbols instance

str :

 a string which will represent the right part of a tree output

Returns :

 0, a negative value in case of an error.

scols_symbols_set_vertical ()

int                 scols_symbols_set_vertical          (struct libscols_symbols *sb,
                                                         const char *str);

sb :

 a pointer to a struct libscols_symbols instance

str :

 a string which will represent the vertical part of a tree output

Returns :

 0, a negative value in case of an error.

scols_unref_symbols ()

void                scols_unref_symbols                 (struct libscols_symbols *sy);

Decreases the refcount of sy.

sy :

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