panel_snapping.cpp File Reference

#include <algorithm>
#include <config_map.h>
#include <dialogs/panel_snapping.h>

Go to the source code of this file.

Functions
std::vector< MAGNETIC_OPTIONS >	MagneticSnapOptions (bool aRouting)
	The object snapping modes an editor offers.
int	MagneticSnapIndex (const std::vector< MAGNETIC_OPTIONS > &aOptions, MAGNETIC_OPTIONS aValue)
	The position of aValue in aOptions, falling back to the "never" entry for a value the editor does not offer.
MAGNETIC_OPTIONS	MagneticSnapValue (const std::vector< MAGNETIC_OPTIONS > &aOptions, int aIndex)
	The mode at aIndex, or "never" if the index is out of range.
static wxString	magneticOptionLabel (MAGNETIC_OPTIONS aOption)
static void	fillMagneticChoice (wxChoice *aChoice, const std::vector< MAGNETIC_OPTIONS > &aOptions)

Variables
static const UTIL::CFG_MAP< KIGFX::GRID_SNAPPING >	gridSnapModeMap

Function Documentation

fillMagneticChoice()

static void fillMagneticChoice ( wxChoice * aChoice, const std::vector< MAGNETIC_OPTIONS > & aOptions )

static

Definition at line 71 of file panel_snapping.cpp.

References magneticOptionLabel().

Referenced by PANEL_SNAPPING::PANEL_SNAPPING().

magneticOptionLabel()

static wxString magneticOptionLabel ( MAGNETIC_OPTIONS aOption )

static

Definition at line 58 of file panel_snapping.cpp.

References _, CAPTURE_ALWAYS, CAPTURE_CURSOR_IN_TRACK_TOOL, and NO_EFFECT.

Referenced by fillMagneticChoice().

MagneticSnapIndex()

int MagneticSnapIndex	(	const std::vector< MAGNETIC_OPTIONS > &	aOptions,
		MAGNETIC_OPTIONS	aValue )

The position of aValue in aOptions, falling back to the "never" entry for a value the editor does not offer.

The grid helpers ignore modes an editor can't reach, so reading one back as "never" matches what the user actually gets.

Definition at line 38 of file panel_snapping.cpp.

References NO_EFFECT.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PANEL_SNAPPING::load().

MagneticSnapOptions()

std::vector< MAGNETIC_OPTIONS > MagneticSnapOptions

(

bool

aRouting

)

The object snapping modes an editor offers.

Only editors that route tracks have a mode that applies to the router alone; elsewhere the choice is between never and always.

Definition at line 26 of file panel_snapping.cpp.

References CAPTURE_ALWAYS, CAPTURE_CURSOR_IN_TRACK_TOOL, and NO_EFFECT.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PANEL_SNAPPING::PANEL_SNAPPING().

MagneticSnapValue()

MAGNETIC_OPTIONS MagneticSnapValue	(	const std::vector< MAGNETIC_OPTIONS > &	aOptions,
		int	aIndex )

The mode at aIndex, or "never" if the index is out of range.

Definition at line 49 of file panel_snapping.cpp.

References NO_EFFECT.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PANEL_SNAPPING::TransferDataFromWindow().

Variable Documentation

gridSnapModeMap

const UTIL::CFG_MAP<KIGFX::GRID_SNAPPING> gridSnapModeMap

static

Initial value:

= {
    
    { KIGFX::GRID_SNAPPING::ALWAYS,    0 },  
    { KIGFX::GRID_SNAPPING::WITH_GRID, 1 },
    { KIGFX::GRID_SNAPPING::NEVER,     2 },
    
}

Definition at line 79 of file panel_snapping.cpp.

Referenced by PANEL_SNAPPING::load(), PANEL_SNAPPING::PANEL_SNAPPING(), and PANEL_SNAPPING::TransferDataFromWindow().