g_select.c File Reference

#include <config.h>
#include "gschem.h"
#include "g_select.x"

Include dependency graph for g_select.c:

Go to the source code of this file.

Functions
	SCM_SYMBOL (object_state_sym,"object-state")
	SCM_DEFINE (page_selection,"%page-selection", 1, 0, 0,(SCM page_s),"Get a list of a page's selected objects")
	Get a list of selected objects on a page.
	SCM_DEFINE (select_object_x,"%select-object!", 1, 0, 0,(SCM obj_s),"Select an object.")
	Select an object.
	SCM_DEFINE (deselect_object_x,"%deselect-object!", 1, 0, 0,(SCM obj_s),"Deselect an object.")
	Deselect an object.
	SCM_DEFINE (object_selected_p,"%object-selected?", 1, 0, 0,(SCM obj_s),"Test if an object is selected.")
	Test if an object is selected.
static void	init_module_gschem_core_select ()
	Create the (gschem core selection) Scheme module.
void	g_init_select ()
	Initialise the selection manipulation procedures.

---

Function Documentation

SCM_SYMBOL	(	object_state_sym	,
		"object-state"
	)

SCM_DEFINE	(	page_selection	,
		"%page-selection"	,
		1	,
		0	,
		0	,
		(SCM page_s)	,
		"Get a list of a page's selected objects"
	)

Function Description

Retrieve a list of selected objects on page_s.

Note:

Scheme API: Implements the page-selection procedure in the (gschem core selection) module.

Parameters:

page_s

#PAGE smob for the page from which to get the selection.

Returns:

a list of #OBJECT smobs.

Definition at line 35 of file g_select.c.

SCM_DEFINE	(	select_object_x	,
		"%select-object!"	,
		1	,
		0	,
		0	,
		(SCM obj_s)	,
		"Select an object."
	)

Function Description

Add obj_s to its associated page's selection. If obj_s is not included directly in a page (i.e. inclusion in a component is not permitted), throws a Scheme error. If obj_s is already selected, does nothing.

Note:

Scheme API: Implements the select-object! procedure in the (gschem core selection) module.

Parameters:

obj_s

#OBJECT smob for object to be selected.

Returns:

obj_s.

Definition at line 66 of file g_select.c.

SCM_DEFINE	(	deselect_object_x	,
		"%deselect-object!"	,
		1	,
		0	,
		0	,
		(SCM obj_s)	,
		"Deselect an object."
	)

Function Description

Remove obj_s from its associated page's selection. If obj_s is not included directly in a page (i.e. not via inclusion in a component), throws a Scheme error. If obj_s is not selected, does nothing.

Note:

Scheme API: Implements the deselect-object! procedure in the (gschem core selection) module.

Parameters:

obj_s

#OBJECT smob for object to be deselected.

Returns:

obj_s.

Definition at line 103 of file g_select.c.

SCM_DEFINE	(	object_selected_p	,
		"%object-selected?"	,
		1	,
		0	,
		0	,
		(SCM obj_s)	,
		"Test if an object is selected."
	)

Function Description

If obj_s is selected, returns SCM_BOOL_T. Otherwise, returns SCM_BOOL_F. If obj_s is not included directly in a page (i.e. not via inclusion in a component), throws a Scheme error.

Note:

Scheme API: Implements the object-selected? procedure in the (gschem core selection) module.

Parameters:

obj_s

#OBJECT smob to be tested.

Returns:

SCM_BOOL_T if obj_s is selected, otherwise SCM_BOOL_F.

Definition at line 139 of file g_select.c.

static void init_module_gschem_core_select

(

)

[static]

Function Description

Defines procedures in the (gschem core selection) module. The module can be accessed using (use-modules (gschem core selection)).

Definition at line 164 of file g_select.c.

void g_init_select

(

)

Function Description

Registers some Scheme procedures for working with the selection. Should only be called by main_prog().

Definition at line 180 of file g_select.c.

Here is the call graph for this function: