Inheritance diagram for pcbnew.SETTINGS_MANAGER:

Public Member Functions
def	__init__ (self, aHeadless=False)

def	IsOK (self)

def	SetKiway (self, aKiway)

def	Load (self, *args)

def	Save (self, *args)

def	FlushAndRelease (self, aSettings, aSave=True)

def	GetColorSettings (self, *args)

def	GetColorSettingsList (self)

def	SaveColorSettings (self, *args)

def	AddNewColorSettings (self, aFilename)

def	GetMigratedColorSettings (self)

def	GetCommonSettings (self)

def	GetPathForSettingsFile (self, aSettings)

def	MigrateIfNeeded (self)

def	SetMigrationSource (self, aSource)

def	SetMigrateLibraryTables (self, aMigrate=True)

def	GetPreviousVersionPaths (self, aName=None)

def	ReloadColorSettings (self)

def	LoadProject (self, aFullPath, aSetActive=True)

def	UnloadProject (self, aProject, aSave=True)

def	IsProjectOpen (self)

def	IsProjectOpenNotDummy (self)

def	Prj (self)

def	GetProject (self, aFullPath)

def	GetOpenProjects (self)

def	SaveProject (self, *args)

def	SaveProjectAs (self, aFullPath, aProject=None)

def	SaveProjectCopy (self, aFullPath, aProject=None)

def	GetProjectBackupsPath (self)

def	BackupProject (self, aReporter, aTarget)

def	TriggerBackupIfNeeded (self, aReporter)

Static Public Member Functions
def	IsSettingsPathValid (aPath)

def	GetColorSettingsPath ()

def	GetSettingsVersion ()

def	GetUserSettingsPath ()

Properties
property	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ SETTINGS_MANAGER class.

Definition at line 3595 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.SETTINGS_MANAGER.__init__	(	self,
		aHeadless = `False`
	)

__init__(SETTINGS_MANAGER self, bool aHeadless=False) -> SETTINGS_MANAGER

Definition at line 3601 of file pcbnew.py.

Member Function Documentation

◆ AddNewColorSettings()

def pcbnew.SETTINGS_MANAGER.AddNewColorSettings	(	self,
		aFilename
	)

AddNewColorSettings(SETTINGS_MANAGER self, wxString aFilename) -> COLOR_SETTINGS *

Definition at line 3644 of file pcbnew.py.

◆ BackupProject()

def pcbnew.SETTINGS_MANAGER.BackupProject	(	self,
		aReporter,
		aTarget
	)

BackupProject(SETTINGS_MANAGER self, REPORTER & aReporter, wxFileName & aTarget) -> bool

Definition at line 3724 of file pcbnew.py.

◆ FlushAndRelease()

def pcbnew.SETTINGS_MANAGER.FlushAndRelease	(	self,
		aSettings,
		aSave = `True`
	)

FlushAndRelease(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings, bool aSave=True)

Definition at line 3628 of file pcbnew.py.

◆ GetColorSettings()

def pcbnew.SETTINGS_MANAGER.GetColorSettings	(		self,
		*	args
	)

GetColorSettings(SETTINGS_MANAGER self, wxString aName="user") -> COLOR_SETTINGS

Definition at line 3632 of file pcbnew.py.

◆ GetColorSettingsList()

def pcbnew.SETTINGS_MANAGER.GetColorSettingsList ( self )

GetColorSettingsList(SETTINGS_MANAGER self) -> std::vector< COLOR_SETTINGS *,std::allocator< COLOR_SETTINGS * > >

Definition at line 3636 of file pcbnew.py.

◆ GetColorSettingsPath()

def pcbnew.SETTINGS_MANAGER.GetColorSettingsPath ( )

static

GetColorSettingsPath() -> wxString

Definition at line 3738 of file pcbnew.py.

◆ GetCommonSettings()

def pcbnew.SETTINGS_MANAGER.GetCommonSettings ( self )

GetCommonSettings(SETTINGS_MANAGER self) -> COMMON_SETTINGS *

Definition at line 3652 of file pcbnew.py.

◆ GetMigratedColorSettings()

def pcbnew.SETTINGS_MANAGER.GetMigratedColorSettings ( self )

GetMigratedColorSettings(SETTINGS_MANAGER self) -> COLOR_SETTINGS *

Definition at line 3648 of file pcbnew.py.

◆ GetOpenProjects()

def pcbnew.SETTINGS_MANAGER.GetOpenProjects ( self )

GetOpenProjects(SETTINGS_MANAGER self) -> std::vector< wxString,std::allocator< wxString > >

Definition at line 3704 of file pcbnew.py.

◆ GetPathForSettingsFile()

def pcbnew.SETTINGS_MANAGER.GetPathForSettingsFile	(	self,
		aSettings
	)

GetPathForSettingsFile(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings) -> wxString

Definition at line 3656 of file pcbnew.py.

◆ GetPreviousVersionPaths()

def pcbnew.SETTINGS_MANAGER.GetPreviousVersionPaths	(	self,
		aName = `None`
	)

GetPreviousVersionPaths(SETTINGS_MANAGER self, std::vector< wxString,std::allocator< wxString > > * aName=None) -> bool

Definition at line 3672 of file pcbnew.py.

◆ GetProject()

def pcbnew.SETTINGS_MANAGER.GetProject	(	self,
		aFullPath
	)

GetProject(SETTINGS_MANAGER self, wxString aFullPath) -> PROJECT *

Definition at line 3700 of file pcbnew.py.

◆ GetProjectBackupsPath()

def pcbnew.SETTINGS_MANAGER.GetProjectBackupsPath ( self )

GetProjectBackupsPath(SETTINGS_MANAGER self) -> wxString

Definition at line 3720 of file pcbnew.py.

◆ GetSettingsVersion()

def pcbnew.SETTINGS_MANAGER.GetSettingsVersion ( )

static

GetSettingsVersion() -> string

Definition at line 3743 of file pcbnew.py.

◆ GetUserSettingsPath()

def pcbnew.SETTINGS_MANAGER.GetUserSettingsPath ( )

static

GetUserSettingsPath() -> wxString

Definition at line 3748 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsOK()

def pcbnew.SETTINGS_MANAGER.IsOK ( self )

IsOK(SETTINGS_MANAGER self) -> bool

Definition at line 3606 of file pcbnew.py.

◆ IsProjectOpen()

def pcbnew.SETTINGS_MANAGER.IsProjectOpen ( self )

IsProjectOpen(SETTINGS_MANAGER self) -> bool

Definition at line 3688 of file pcbnew.py.

◆ IsProjectOpenNotDummy()

def pcbnew.SETTINGS_MANAGER.IsProjectOpenNotDummy ( self )

IsProjectOpenNotDummy(SETTINGS_MANAGER self) -> bool

Definition at line 3692 of file pcbnew.py.

◆ IsSettingsPathValid()

def pcbnew.SETTINGS_MANAGER.IsSettingsPathValid ( aPath )

static

IsSettingsPathValid(wxString aPath) -> bool

Definition at line 3733 of file pcbnew.py.

◆ Load()

def pcbnew.SETTINGS_MANAGER.Load	(		self,
		*	args
	)

    Load(SETTINGS_MANAGER self)
    Load(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings)

Definition at line 3614 of file pcbnew.py.

Here is the caller graph for this function:

◆ LoadProject()

def pcbnew.SETTINGS_MANAGER.LoadProject	(	self,
		aFullPath,
		aSetActive = `True`
	)

LoadProject(SETTINGS_MANAGER self, wxString aFullPath, bool aSetActive=True) -> bool

Definition at line 3680 of file pcbnew.py.

◆ MigrateIfNeeded()

def pcbnew.SETTINGS_MANAGER.MigrateIfNeeded ( self )

MigrateIfNeeded(SETTINGS_MANAGER self) -> bool

Definition at line 3660 of file pcbnew.py.

◆ Prj()

def pcbnew.SETTINGS_MANAGER.Prj ( self )

Prj(SETTINGS_MANAGER self) -> PROJECT &

Definition at line 3696 of file pcbnew.py.

◆ ReloadColorSettings()

def pcbnew.SETTINGS_MANAGER.ReloadColorSettings ( self )

ReloadColorSettings(SETTINGS_MANAGER self)

Definition at line 3676 of file pcbnew.py.

◆ Save()

def pcbnew.SETTINGS_MANAGER.Save	(		self,
		*	args
	)

    Save(SETTINGS_MANAGER self)
    Save(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings)

Definition at line 3621 of file pcbnew.py.

Here is the caller graph for this function:

◆ SaveColorSettings()

def pcbnew.SETTINGS_MANAGER.SaveColorSettings	(		self,
		*	args
	)

SaveColorSettings(SETTINGS_MANAGER self, COLOR_SETTINGS * aSettings, string aNamespace="")

Definition at line 3640 of file pcbnew.py.

◆ SaveProject()

def pcbnew.SETTINGS_MANAGER.SaveProject	(		self,
		*	args
	)

SaveProject(SETTINGS_MANAGER self, wxString aFullPath=wxEmptyString, PROJECT * aProject=None) -> bool

Definition at line 3708 of file pcbnew.py.

◆ SaveProjectAs()

def pcbnew.SETTINGS_MANAGER.SaveProjectAs	(	self,
		aFullPath,
		aProject = `None`
	)

SaveProjectAs(SETTINGS_MANAGER self, wxString aFullPath, PROJECT * aProject=None)

Definition at line 3712 of file pcbnew.py.

◆ SaveProjectCopy()

def pcbnew.SETTINGS_MANAGER.SaveProjectCopy	(	self,
		aFullPath,
		aProject = `None`
	)

SaveProjectCopy(SETTINGS_MANAGER self, wxString aFullPath, PROJECT * aProject=None)

Definition at line 3716 of file pcbnew.py.

◆ SetKiway()

def pcbnew.SETTINGS_MANAGER.SetKiway	(	self,
		aKiway
	)

SetKiway(SETTINGS_MANAGER self, KIWAY * aKiway)

Definition at line 3610 of file pcbnew.py.

◆ SetMigrateLibraryTables()

def pcbnew.SETTINGS_MANAGER.SetMigrateLibraryTables	(	self,
		aMigrate = `True`
	)

SetMigrateLibraryTables(SETTINGS_MANAGER self, bool aMigrate=True)

Definition at line 3668 of file pcbnew.py.

◆ SetMigrationSource()

def pcbnew.SETTINGS_MANAGER.SetMigrationSource	(	self,
		aSource
	)

SetMigrationSource(SETTINGS_MANAGER self, wxString aSource)

Definition at line 3664 of file pcbnew.py.

◆ TriggerBackupIfNeeded()

def pcbnew.SETTINGS_MANAGER.TriggerBackupIfNeeded	(	self,
		aReporter
	)

TriggerBackupIfNeeded(SETTINGS_MANAGER self, REPORTER & aReporter) -> bool

Definition at line 3728 of file pcbnew.py.

◆ UnloadProject()

def pcbnew.SETTINGS_MANAGER.UnloadProject	(	self,
		aProject,
		aSave = `True`
	)

UnloadProject(SETTINGS_MANAGER self, PROJECT * aProject, bool aSave=True) -> bool

Definition at line 3684 of file pcbnew.py.

Property Documentation

◆ thisown

property pcbnew.SETTINGS_MANAGER.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 3598 of file pcbnew.py.

The documentation for this class was generated from the following file:

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ AddNewColorSettings()

◆ BackupProject()

◆ FlushAndRelease()

◆ GetColorSettings()

◆ GetColorSettingsList()

◆ GetColorSettingsPath()

◆ GetCommonSettings()

◆ GetMigratedColorSettings()

◆ GetOpenProjects()

◆ GetPathForSettingsFile()

◆ GetPreviousVersionPaths()

◆ GetProject()

◆ GetProjectBackupsPath()

◆ GetSettingsVersion()

◆ GetUserSettingsPath()

◆ IsOK()

◆ IsProjectOpen()

◆ IsProjectOpenNotDummy()

◆ IsSettingsPathValid()

◆ Load()

◆ LoadProject()

◆ MigrateIfNeeded()

◆ Prj()

◆ ReloadColorSettings()

◆ Save()

◆ SaveColorSettings()

◆ SaveProject()

◆ SaveProjectAs()

◆ SaveProjectCopy()

◆ SetKiway()

◆ SetMigrateLibraryTables()

◆ SetMigrationSource()

◆ TriggerBackupIfNeeded()

◆ UnloadProject()

Property Documentation

◆ thisown

◆ init()