Prototypes for select routines. More...

#include "global.h"

Include dependency graph for select.h:

This graph shows which files directly or indirectly include this file:

Defines
#define	SELECT_TYPES
Functions
bool	SelectObject (void)
	Toggles the selection of any kind of object.
bool	SelectBlock (BoxType *, bool)
	Selects/unselects all visible objects within the passed box.
bool	SelectedOperation (ObjectFunctionType *, bool, int)
	Performs several operations on selected objects which are also visible.
void *	ObjectOperation (ObjectFunctionType , int, void , void , void )
	Performs several operations on the passed object.
bool	SelectByFlag (int flag, bool select)
	Selects/unselects all objects which have (any of) the specified flag(s) set.
bool	SelectBuriedVias (bool select)
	Selects all blind/buried vias.

Detailed Description

Prototypes for select routines.

Copyright.

PCB, interactive printed circuit board design

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact addresses for paper mail and Email:

Thomas Nau, Schlehenweg 15, 88471 Baustetten, Germany

Thomas.Nau@rz.uni-ulm.de

Definition in file select.h.

Define Documentation

#define SELECT_TYPES

Value:

(VIA_TYPE | LINE_TYPE | TEXT_TYPE | POLYGON_TYPE | ELEMENT_TYPE |       \
         PIN_TYPE | PAD_TYPE | ELEMENTNAME_TYPE | RATLINE_TYPE | ARC_TYPE)

Definition at line 40 of file select.h.

Referenced by NotifyMode(), and SelectObject().

Function Documentation

void* ObjectOperation	(	ObjectFunctionType *	,
		int	,
		void *	,
		void *	,
		void *
	)

Performs several operations on the passed object.

Definition at line 449 of file select.c.

References ObjectFunctionType::Arc, ObjectFunctionType::Element, ObjectFunctionType::ElementName, ObjectFunctionType::Line, ObjectFunctionType::LinePoint, ObjectFunctionType::Pad, ObjectFunctionType::Pin, ObjectFunctionType::Point, ObjectFunctionType::Polygon, ObjectFunctionType::Rat, ObjectFunctionType::Text, and ObjectFunctionType::Via.

Referenced by ChangeObject2ndSize(), ChangeObjectClearSize(), ChangeObjectJoin(), ChangeObjectMaskSize(), ChangeObjectName(), ChangeObjectOctagon(), ChangeObjectSize(), ChangeObjectSquare(), ChangeObjectThermal(), ClrObjectJoin(), ClrObjectOctagon(), ClrObjectSquare(), CopyObject(), CopyObjectToBuffer(), DestroyObject(), InsertPointIntoObject(), MoveObject(), MoveObjectAndRubberband(), MoveObjectToBuffer(), MoveObjectToLayer(), RemoveObject(), RotateObject(), SetObjectJoin(), SetObjectOctagon(), and SetObjectSquare().

bool SelectBlock	(	BoxType *	Box,
		bool	select
	)

Selects/unselects all visible objects within the passed box.

"select" determines if the block is to be selected or unselected.

Returns:: true if the state of any object has changed.

Definition at line 224 of file select.c.

References AddObjectToFlagUndoList(), ARC_IN_BOX, ARC_LOOP, ASSIGN_FLAG, BOX_IN_BOX, PCBType::Data, Draw(), DrawArc(), DrawElement(), DrawElementName(), DrawLine(), DrawPad(), DrawPin(), DrawPolygon(), DrawRat(), DrawText(), DrawVia(), ELEMENT_IN_BOX, ELEMENT_LOOP, ELEMENT_TEXT, PCBType::ElementOn, ELEMENTTEXT_LOOP, END_LOOP, IncrementUndoSerialNumber(), PCBType::InvisibleObjectsOn, layer, LAYER_LOOP, line, LINE_IN_BOX, LINE_LOOP, max_copper_layer, PAD_IN_BOX, PAD_LOOP, PCB, pin, PIN_LOOP, PCBType::PinOn, POLYGON_IN_BOX, POLYGON_LOOP, RAT_LOOP, PCBType::RatOn, SILK_LAYER, SWAP_IDENT, TEST_FLAG, TEXT_IN_BOX, TEXT_IS_VISIBLE, TEXT_LOOP, VIA_LOOP, VIA_OR_PIN_IN_BOX, and PCBType::ViaOn.

Referenced by ActionSelect(), ActionUnselect(), click_cb(), and ReleaseMode().

Here is the call graph for this function:

bool SelectBuriedVias ( bool select )

Selects all blind/buried vias.

Returns:: true if any object has been selected.

Definition at line 1027 of file select.c.

References AddObjectToFlagUndoList(), ASSIGN_FLAG, PCBType::Data, END_LOOP, PCB, TEST_FLAG, VIA_IS_BURIED, and VIA_LOOP.

Referenced by ActionSelect().

Here is the call graph for this function:

bool SelectByFlag	(	int	flag,
		bool	select
	)

Selects/unselects all objects which have (any of) the specified flag(s) set.

This is typically the FOUNDFLAG, assigned during a connection scan.

"select" determines if they are to be selected or unselected.

Returns:: true if the state of any object has changed.

Note:: Text objects and elements cannot be selected by this routine.

Definition at line 728 of file select.c.

References AddObjectToFlagUndoList(), ALLPAD_LOOP, ALLPIN_LOOP, ASSIGN_FLAG, PCBType::Data, DrawArc(), DrawLine(), DrawPad(), DrawPin(), DrawPolygon(), DrawRat(), DrawVia(), PCBType::ElementOn, END_LOOP, ENDALL_LOOP, layer, line, PCB, pin, PCBType::PinOn, RAT_LOOP, PCBType::RatOn, TEST_FLAG, VIA_LOOP, PCBType::ViaOn, VISIBLEARC_LOOP, VISIBLELINE_LOOP, and VISIBLEPOLYGON_LOOP.

Referenced by ActionSelect(), ActionUnselect(), nbcb_select_common(), and netlist_select_cb().

Here is the call graph for this function:

bool SelectedOperation	(	ObjectFunctionType *	F,
		bool	Reset,
		int	type
	)

Performs several operations on selected objects which are also visible.

The lowlevel procedures are passed together with additional information.

Resets the selected flag if requested.

Returns:: true if anything has changed.

Definition at line 531 of file select.c.

Referenced by AddSelectedToBuffer(), ChangeSelected2ndSize(), ChangeSelectedClearSize(), ChangeSelectedJoin(), ChangeSelectedOctagon(), ChangeSelectedSize(), ChangeSelectedSquare(), ChangeSelectedThermals(), ClrSelectedJoin(), ClrSelectedOctagon(), ClrSelectedSquare(), MoveSelectedObjectsToLayer(), RemoveSelected(), SetSelectedJoin(), SetSelectedOctagon(), and SetSelectedSquare().

Here is the call graph for this function:

bool SelectObject ( void )

Toggles the selection of any kind of object.

The various types are defined in search.h.

Definition at line 71 of file select.c.

References AddObjectToFlagUndoList(), Crosshair, Draw(), DrawArc(), DrawElementName(), DrawElementPackage(), DrawElementPinsAndPads(), DrawLine(), DrawPad(), DrawPin(), DrawPolygon(), DrawRat(), DrawText(), DrawVia(), PCBType::ElementOn, ELEMENTTEXT_LOOP, END_LOOP, IncrementUndoSerialNumber(), PCBType::InvisibleObjectsOn, layer, line, PAD_LOOP, PCB, pin, PIN_LOOP, PCBType::PinOn, poly, ptr1, ptr2, ptr3, SearchScreen(), SELECT_TYPES, SWAP_IDENT, TEST_FLAG, TOGGLE_FLAG, CrosshairType::X, and CrosshairType::Y.

Referenced by ActionSelect(), and ReleaseMode().

Here is the call graph for this function:

select.h File Reference

Defines

Functions

Detailed Description

Copyright.

Define Documentation

Function Documentation