geda_list.h File Reference

Go to the source code of this file.

Data Structures
struct	_GedaList
struct	_GedaListClass
Defines
#define	GEDA_TYPE_LIST   (geda_list_get_type())
#define	GEDA_LIST(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), GEDA_TYPE_LIST, GedaList))
#define	GEDA_LIST_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), GEDA_TYPE_LIST, GedaListClass))
#define	GEDA_IS_LIST(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GEDA_TYPE_LIST))
#define	GEDA_IS_LIST_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), GEDA_TYPE_LIST))
#define	GEDA_LIST_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), GEDA_TYPE_LIST, GedaListClass))
#define	geda_list_get_glist(list)   (list->glist)
Typedefs
typedef struct _GedaList	GedaList
typedef struct _GedaListClass	GedaListClass
Functions
GType	geda_list_get_type (void)
	Function to retrieve GedaList's GType identifier.
GedaList *	geda_list_new (void)
	Returns a pointer to a new GedaList object.
void	geda_list_add (GedaList *list, gpointer item)
	Adds the given item to the GedaList.
void	geda_list_add_glist (GedaList *list, GList *items)
	Adds the given glist of items to the GedaList.
void	geda_list_remove (GedaList *list, gpointer item)
	Removes the given item from the GedaList.
void	geda_list_remove_all (GedaList *list)
	Removes all the items in the given GedaList.

---

Define Documentation

#define GEDA_TYPE_LIST   (geda_list_get_type())

Definition at line 28 of file geda_list.h.

#define GEDA_LIST

(

obj

)

(G_TYPE_CHECK_INSTANCE_CAST((obj), GEDA_TYPE_LIST, GedaList))

Definition at line 29 of file geda_list.h.

#define GEDA_LIST_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_CAST((klass), GEDA_TYPE_LIST, GedaListClass))

Definition at line 30 of file geda_list.h.

#define GEDA_IS_LIST

(

obj

)

(G_TYPE_CHECK_INSTANCE_TYPE((obj), GEDA_TYPE_LIST))

Definition at line 31 of file geda_list.h.

#define GEDA_IS_LIST_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_TYPE((klass), GEDA_TYPE_LIST))

Definition at line 32 of file geda_list.h.

#define GEDA_LIST_GET_CLASS

(

obj

)

(G_TYPE_INSTANCE_GET_CLASS((obj), GEDA_TYPE_LIST, GedaListClass))

Definition at line 33 of file geda_list.h.

#define geda_list_get_glist

(

list

)

(list->glist)

Definition at line 60 of file geda_list.h.

---

Typedef Documentation

typedef struct _GedaList GedaList

Definition at line 36 of file geda_list.h.

typedef struct _GedaListClass GedaListClass

Definition at line 37 of file geda_list.h.

---

Function Documentation

GType geda_list_get_type

(

void

)

Function Description

Function to retrieve GedaList's GType identifier. Upon first call, this registers the GedaList in the GType system. Subsequently it returns the saved value from its first execution.

Returns:

the GType identifier associated with GedaList.

Definition at line 122 of file geda_list.c.

Here is the call graph for this function:

GedaList* geda_list_new

(

void

)

Function Description

Returns a pointer to a new GedaList object.

Returns:

pointer to the new GedaList object.

Definition at line 150 of file geda_list.c.

void geda_list_add	(	GedaList *	list,
		gpointer	item
	)

Function Description

Adds the given item to the GedaList

Parameters:

[in]	list	Pointer to the GedaList
[in]	item	item to add to the GedaList.

Definition at line 163 of file geda_list.c.

void geda_list_add_glist	(	GedaList *	list,
		GList *	items
	)

Function Description

Adds the given glist of items to the GedaList A copy is made, so the original GList is not modified.

Parameters:

[in]	list	Pointer to the GedaList
[in]	items	GList of items to add to the GedaList.

Definition at line 179 of file geda_list.c.

void geda_list_remove	(	GedaList *	list,
		gpointer	item
	)

Function Description

Removes the given item from the GedaList. It's ok to call this function with an item which is not necessarily in the list.

Parameters:

[in]	list	Pointer to the GedaList
[in]	item	to remove from the GedaList.

Definition at line 197 of file geda_list.c.

void geda_list_remove_all

(

GedaList *

list

)

Function Description

Removes all items in the given GedaList.

Parameters:

[in]

list

Pointer to the GedaList

Definition at line 214 of file geda_list.c.