girara
Functions
completion.h File Reference
#include "macros.h"
#include "types.h"
Include dependency graph for completion.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

girara_completion_tgirara_completion_init (void) GIRARA_VISIBLE
 
girara_completion_group_tgirara_completion_group_create (girara_session_t *session, const char *name) GIRARA_VISIBLE
 
void girara_completion_group_free (girara_completion_group_t *group) GIRARA_VISIBLE
 
void girara_completion_add_group (girara_completion_t *completion, girara_completion_group_t *group) GIRARA_VISIBLE
 
void girara_completion_free (girara_completion_t *completion) GIRARA_VISIBLE
 
void girara_completion_group_add_element (girara_completion_group_t *group, const char *value, const char *description) GIRARA_VISIBLE
 

Function Documentation

◆ girara_completion_add_group()

void girara_completion_add_group ( girara_completion_t completion,
girara_completion_group_t group 
)

Adds an group to a completion object

Parameters
completionThe completion object
groupThe completion group

◆ girara_completion_free()

void girara_completion_free ( girara_completion_t completion)

Frees an completion and all of its groups and elements

Parameters
completionThe completion

◆ girara_completion_group_add_element()

void girara_completion_group_add_element ( girara_completion_group_t group,
const char *  value,
const char *  description 
)

Adds an element to a completion group

Parameters
groupThe completion group
valueValue of the entry
descriptionDescription of the entry

◆ girara_completion_group_create()

girara_completion_group_t * girara_completion_group_create ( girara_session_t *  session,
const char *  name 
)

Creates an girara completion group

Returns
Completion object
NULL An error occurred

◆ girara_completion_group_free()

void girara_completion_group_free ( girara_completion_group_t group)

Frees a completion group

Parameters
groupThe group

◆ girara_completion_init()

girara_completion_t * girara_completion_init ( void  )

Creates an girara completion object

Returns
Completion object
NULL An error occurred